ForcedPhotCcdConfig#

class lsst.meas.base.ForcedPhotCcdConfig(*args, **kwargs)#

Bases: PipelineTaskConfig

Config class for forced measurement driver task.

Deprecated since version v29.0: This task is replaced by lsst.pipe.tasks.ForcedPhotCcdTask. This task will be removed after v30.

Attributes Summary

`applyApCorr`	Subtask to apply aperture corrections (`ConfigurableInstance`, default `<class 'lsst.meas.base.applyApCorr.ApplyApCorrConfig'>`)
`catalogCalculation`	Subtask to run catalogCalculation plugins on catalog (`ConfigurableInstance`, default `<class 'lsst.meas.base.catalogCalculation.CatalogCalculationConfig'>`)
`coaddName`	coadd name: typically one of deep or goodSeeing (`str`, default `'deep'`)
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`doApCorr`	Run subtask to apply aperture corrections (`bool`, default `True`)
`doApplySkyCorr`	Apply sky correction? (`bool`, default `False`)
`footprintSource`	Where to obtain footprints to install in the measurement catalog, prior to measurement.
`idGenerator`	Configuration for how to generate catalog IDs from data IDs.
`includePhotoCalibVar`	Add photometric calibration variance to warp variance plane? Deprecated: Deprecated and unused; will be removed after v29.
`measurement`	subtask to do forced measurement (`ConfigurableInstance`, default `<class 'lsst.meas.base.forcedMeasurement.ForcedMeasurementConfig'>`)
`psfFootprintScaling`	Scaling factor to apply to the PSF shape when footprintSource='psf' (ignored otherwise).
`refCatDecColumn`	Name of the column that provides the declination (in floating-point degrees) from the refCat connection.
`refCatIdColumn`	Name of the column that provides the object ID from the refCat connection.
`refCatRaColumn`	Name of the column that provides the right ascension (in floating-point degrees) from the refCat connection.
`refCatStorageClass`	The butler storage class for the refCat connection.
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`useVisitSummary`	Use updated WCS, PhotoCalib, ApCorr, and PSF from visit summary? This should be False if and only if the input image already has the best-available calibration objects attached.

Methods Summary

`configureParquetRefCat`([refCatStorageClass])	Set the refCatStorageClass option to a Parquet-based type, and reconfigure the measurement subtask and footprintSources accordingly.
`setDefaults`()	Subclass hook for computing defaults.
`validate`()	Validate the Config, raising an exception if invalid.

Attributes Documentation

applyApCorr#: Subtask to apply aperture corrections (ConfigurableInstance, default <class 'lsst.meas.base.applyApCorr.ApplyApCorrConfig'>)

catalogCalculation#: Subtask to run catalogCalculation plugins on catalog (ConfigurableInstance, default <class 'lsst.meas.base.catalogCalculation.CatalogCalculationConfig'>)

coaddName#: coadd name: typically one of deep or goodSeeing (str, default 'deep')

connections: pexConfig.ConfigField#: Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

doApCorr#: Run subtask to apply aperture corrections (bool, default True)

doApplySkyCorr#: Apply sky correction? (bool, default False)

footprintSource#

Where to obtain footprints to install in the measurement catalog, prior to measurement. (str, default 'transformed')

Allowed values:

'transformed': Transform footprints from the reference catalog (downgrades HeavyFootprints).
'psf': Use the scaled shape of the PSF at the position of each source (does not generate HeavyFootprints).
'None': Field is optional

idGenerator#: Configuration for how to generate catalog IDs from data IDs. (DetectorVisitIdGeneratorConfig, default <class 'lsst.meas.base._id_generator.DetectorVisitIdGeneratorConfig'>)

includePhotoCalibVar#: Add photometric calibration variance to warp variance plane? Deprecated: Deprecated and unused; will be removed after v29. (bool, default False)

measurement#: subtask to do forced measurement (ConfigurableInstance, default <class 'lsst.meas.base.forcedMeasurement.ForcedMeasurementConfig'>)

psfFootprintScaling#: Scaling factor to apply to the PSF shape when footprintSource=’psf’ (ignored otherwise). (float, default 3.0)

refCatDecColumn#: Name of the column that provides the declination (in floating-point degrees) from the refCat connection. Ignored if refCatStorageClass=’SourceCatalog’. (str, default 'dec')

refCatIdColumn#: Name of the column that provides the object ID from the refCat connection. measurement.copyColumns[‘id’] must be set to this value as well.Ignored if refCatStorageClass=’SourceCatalog’. (str, default 'diaObjectId')

refCatRaColumn#: Name of the column that provides the right ascension (in floating-point degrees) from the refCat connection. Ignored if refCatStorageClass=’SourceCatalog’. (str, default 'ra')

refCatStorageClass#

The butler storage class for the refCat connection. If set to something other than ‘SourceCatalog’, the ‘inputSchema’ connection will be ignored. (str, default 'SourceCatalog')

Allowed values:

'SourceCatalog': Read an lsst.afw.table.SourceCatalog.
'DataFrame': Read a pandas.DataFrame.
'ArrowAstropy': Read an astropy.table.Table saved to Parquet.
'None': Field is optional

saveLogOutput#: Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

useVisitSummary#: Use updated WCS, PhotoCalib, ApCorr, and PSF from visit summary? This should be False if and only if the input image already has the best-available calibration objects attached. (bool, default True)

Methods Documentation

configureParquetRefCat(refCatStorageClass: str = 'ArrowAstropy')#: Set the refCatStorageClass option to a Parquet-based type, and reconfigure the measurement subtask and footprintSources accordingly.

setDefaults()#: Subclass hook for computing defaults.

Notes#

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

validate()#

Validate the Config, raising an exception if invalid.

Raises#

lsst.pex.config.FieldValidationError: Raised if verification fails.

Notes#

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.