lsst.meas.base  18.1.0-2-g9c63283+5
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddConfig Class Reference
Inheritance diagram for lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddConfig:
lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig

Public Member Functions

def setDefaults (self)
 
def validate (self)
 

Static Public Attributes

 footprintDatasetName
 
 hasFakes
 
 inputSchema
 
 outputSchema
 
 exposure
 
 refCat
 
 refWcs
 
 measCat
 
 references
 
 measurement
 
 coaddName
 
 doApCorr
 
 applyApCorr
 
 catalogCalculation
 

Detailed Description

Definition at line 32 of file forcedPhotCoadd.py.

Member Function Documentation

◆ setDefaults()

def lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddConfig.setDefaults (   self)

Definition at line 48 of file forcedPhotCoadd.py.

◆ validate()

def lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddConfig.validate (   self)

Definition at line 62 of file forcedPhotCoadd.py.

Member Data Documentation

◆ applyApCorr

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.applyApCorr
staticinherited
Initial value:
= lsst.pex.config.ConfigurableField(
target=ApplyApCorrTask,
doc="Subtask to apply aperture corrections"
)

Definition at line 104 of file forcedPhotImage.py.

◆ catalogCalculation

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.catalogCalculation
staticinherited
Initial value:
= lsst.pex.config.ConfigurableField(
target=CatalogCalculationTask,
doc="Subtask to run catalogCalculation plugins on catalog"
)

Definition at line 108 of file forcedPhotImage.py.

◆ coaddName

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.coaddName
staticinherited
Initial value:
= lsst.pex.config.Field(
doc="coadd name: typically one of deep or goodSeeing",
dtype=str,
default="deep",
)

Definition at line 94 of file forcedPhotImage.py.

◆ doApCorr

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.doApCorr
staticinherited
Initial value:
= lsst.pex.config.Field(
dtype=bool,
default=True,
doc="Run subtask to apply aperture corrections"
)

Definition at line 99 of file forcedPhotImage.py.

◆ exposure

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.exposure
staticinherited
Initial value:
= lsst.pipe.base.InputDatasetField(
doc="Input exposure to perform photometry on.",
nameTemplate="{inputCoaddName}Coadd",
scalar=True,
storageClass="ExposureF",
dimensions=["abstract_filter", "skymap", "tract", "patch"],
)

Definition at line 55 of file forcedPhotImage.py.

◆ footprintDatasetName

lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddConfig.footprintDatasetName
static
Initial value:
= lsst.pex.config.Field(
doc="Dataset (without coadd prefix) that should be used to obtain (Heavy)Footprints for sources. "
"Must have IDs that match those of the reference catalog."
"If None, Footprints will be generated by transforming the reference Footprints.",
dtype=str,
default="meas",
optional=True
)

Definition at line 33 of file forcedPhotCoadd.py.

◆ hasFakes

lsst.meas.base.forcedPhotCoadd.ForcedPhotCoaddConfig.hasFakes
static
Initial value:
= lsst.pex.config.Field(
dtype=bool,
default=False,
doc="Should be set to True if fake sources have been inserted into the input data."
)

Definition at line 42 of file forcedPhotCoadd.py.

◆ inputSchema

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.inputSchema
staticinherited
Initial value:
= lsst.pipe.base.InitInputDatasetField(
doc="Schema for the input measurement catalogs.",
nameTemplate="{inputCoaddName}Coadd_ref_schema",
storageClass="SourceCatalog",
)

Definition at line 45 of file forcedPhotImage.py.

◆ measCat

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.measCat
staticinherited
Initial value:
= lsst.pipe.base.OutputDatasetField(
doc="Output forced photometry catalog.",
nameTemplate="{outputCoaddName}Coadd_forced_src",
scalar=True,
storageClass="SourceCatalog",
dimensions=["abstract_filter", "skymap", "tract", "patch"],
)

Definition at line 77 of file forcedPhotImage.py.

◆ measurement

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.measurement
staticinherited
Initial value:
= lsst.pex.config.ConfigurableField(
target=ForcedMeasurementTask,
doc="subtask to do forced measurement"
)

Definition at line 90 of file forcedPhotImage.py.

◆ outputSchema

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.outputSchema
staticinherited
Initial value:
= lsst.pipe.base.InitOutputDatasetField(
doc="Schema for the output forced measurement catalogs.",
nameTemplate="{outputCoaddName}Coadd_forced_src_schema",
storageClass="SourceCatalog",
)

Definition at line 50 of file forcedPhotImage.py.

◆ refCat

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.refCat
staticinherited
Initial value:
= lsst.pipe.base.InputDatasetField(
doc="Catalog of shapes and positions at which to force photometry.",
nameTemplate="{inputCoaddName}Coadd_ref",
scalar=True,
storageClass="SourceCatalog",
dimensions=["skymap", "tract", "patch"],
)

Definition at line 62 of file forcedPhotImage.py.

◆ references

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.references
staticinherited
Initial value:
= lsst.pex.config.ConfigurableField(
target=MultiBandReferencesTask,
doc="subtask to retrieve reference source catalog"
)

Definition at line 86 of file forcedPhotImage.py.

◆ refWcs

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.refWcs
staticinherited
Initial value:
= lsst.pipe.base.InputDatasetField(
doc="Reference world coordinate system.",
nameTemplate="{inputCoaddName}Coadd",
scalar=True,
manualLoad=True,
storageClass="ExposureF",
dimensions=["abstract_filter", "skymap", "tract", "patch"],
)

Definition at line 69 of file forcedPhotImage.py.


The documentation for this class was generated from the following file: