lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig Class Reference

Inheritance diagram for lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig:

Public Member Functions
def	setDefaults (self)
def	formatTemplateNames (self, templateParamsDict)

Static Public Attributes
	inputSchema
	outputSchema
	exposure
	refCat
	refWcs
	measCat
	references
	measurement
	coaddName
	doApCorr
	applyApCorr
	catalogCalculation
	quantum

Detailed Description

Config class for forced measurement driver task.

Definition at line 42 of file forcedPhotImage.py.

Member Function Documentation

formatTemplateNames()

def lsst.pipe.base.config.PipelineTaskConfig.formatTemplateNames (   self,   templateParamsDict  )

inherited

Definition at line 326 of file config.py.

    def formatTemplateNames(self, templateParamsDict):
        # Look up the stored parameters for the specific instance of this config
        # class
        storedParamsDict = PIPELINETASK_CONFIG_TEMPLATE_DICT.setdefault(id(self), {})
        storedParamsDict.update(templateParamsDict)
        for key, value in self.items():
            if isinstance(value, _BaseDatasetTypeConfig) and value.nameTemplate != '':
                value.name = value.nameTemplate.format(**storedParamsDict)

setDefaults()

def lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.setDefaults

(

self

)

Definition at line 113 of file forcedPhotImage.py.

    def setDefaults(self):
        # Docstring inherited.
        # Make catalogCalculation a no-op by default as no modelFlux is setup by default in
        # ForcedMeasurementTask
        super().setDefaults()

        self.catalogCalculation.plugins.names = []
        self.formatTemplateNames({"inputCoaddName": "deep",
                                  "outputCoaddName": "deep",
                                  "inputName": None})
        self.quantum.dimensions = ("abstract_filter", "skymap", "tract", "patch")

Member Data Documentation

applyApCorr

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.applyApCorr

static

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

static

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

static

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

static

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

static

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.

inputSchema

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.inputSchema

static

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

static

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

static

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

static

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.

quantum

lsst.pipe.base.config.PipelineTaskConfig.quantum

staticinherited

Initial value:

=  pexConfig.ConfigField(dtype=QuantumConfig,
                                    doc="configuration for PipelineTask quantum")

Definition at line 323 of file config.py.

refCat

lsst.meas.base.forcedPhotImage.ForcedPhotImageConfig.refCat

static

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

static

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

static

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:

• /j/snowflake/release/lsstsw/stack/Linux64/meas_base/18.1.0-2-g9c63283+13/python/lsst/meas/base/forcedPhotImage.py