ProcessCcdWithFakesConfig#

class lsst.pipe.tasks.processCcdWithFakes.ProcessCcdWithFakesConfig(*args, **kwargs)#

Bases: PipelineTaskConfig

Config for inserting fake sources

Notes#

The default column names are those from the UW sims database.

Deprecated since version v28.0: This task will be removed in v28.0 as it is replaced by source_injection tasks.

Attributes Summary

calibrate

The calibration task to use.

coaddName

The name of the type of coadd used (str, default 'deep')

connections

Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

doApplyExternalGlobalPhotoCalib

Whether to apply an external photometric calibration via an lsst.afw.image.PhotoCalib object.

doApplyExternalGlobalSkyWcs

Whether to apply an external astrometric calibration via an lsst.afw.geom.SkyWcs object.

doApplyExternalTractPhotoCalib

Whether to apply an external photometric calibration via an lsst.afw.image.PhotoCalib object.

doApplyExternalTractSkyWcs

Whether to apply an external astrometric calibration via an lsst.afw.geom.SkyWcs object.

doMatchVisit

Match visit to trim the fakeCat (bool, default False)

externalPhotoCalibName

What type of external photo calib to use.

externalSkyWcsName

What type of updated WCS calib to use.

idGenerator

Configuration for how to generate catalog IDs from data IDs.

insertFakes

Configuration for the fake sources (ConfigurableInstance, default <class 'lsst.pipe.tasks.insertFakes.InsertFakesConfig'>)

matchRadiusPix

Match radius for matching icSourceCat objects to sourceCat objects (pixels) (float, default 3)

saveLogOutput

Flag to enable/disable saving of log output for a task, enabled by default.

srcFieldsToCopy

Fields to copy from the src catalog to the output catalog for matching sources Any missing fields will trigger a RuntimeError exception.

Methods Summary

setDefaults()

Subclass hook for computing defaults.

Attributes Documentation

calibrate#

The calibration task to use. (ConfigurableInstance, default <class 'lsst.pipe.tasks.calibrate.CalibrateConfig'>)

coaddName#

The name of the type of coadd used (str, default 'deep')

connections: pexConfig.ConfigField#

Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

doApplyExternalGlobalPhotoCalib#

Whether to apply an external photometric calibration via an lsst.afw.image.PhotoCalib object. Uses the externalPhotoCalibName config option to determine which calibration to use. Uses a global calibration. (bool, default False)

doApplyExternalGlobalSkyWcs#

Whether to apply an external astrometric calibration via an lsst.afw.geom.SkyWcs object. Uses the externalSkyWcsName config option to determine which calibration to use. Uses a global calibration. (bool, default False)

doApplyExternalTractPhotoCalib#

Whether to apply an external photometric calibration via an lsst.afw.image.PhotoCalib object. Uses the externalPhotoCalibName config option to determine which calibration to use. Uses a per tract calibration. (bool, default False)

doApplyExternalTractSkyWcs#

Whether to apply an external astrometric calibration via an lsst.afw.geom.SkyWcs object. Uses the externalSkyWcsName config option to determine which calibration to use. Uses a per tract calibration. (bool, default False)

doMatchVisit#

Match visit to trim the fakeCat (bool, default False)

externalPhotoCalibName#

What type of external photo calib to use. (str, default 'jointcal')

Allowed values:

'jointcal'

Use jointcal_photoCalib

'fgcm'

Use fgcm_photoCalib

'fgcm_tract'

Use fgcm_tract_photoCalib

'None'

Field is optional

externalSkyWcsName#

What type of updated WCS calib to use. (str, default 'gbdesAstrometricFit')

Allowed values:

'gbdesAstrometricFit'

Use gbdesAstrometricFit_wcs

'None'

Field is optional

idGenerator#

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

insertFakes#

Configuration for the fake sources (ConfigurableInstance, default <class 'lsst.pipe.tasks.insertFakes.InsertFakesConfig'>)

matchRadiusPix#

Match radius for matching icSourceCat objects to sourceCat objects (pixels) (float, default 3)

saveLogOutput#

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

srcFieldsToCopy#

Fields to copy from the src catalog to the output catalog for matching sources Any missing fields will trigger a RuntimeError exception. (List, default ('calib_photometry_reserved', 'calib_photometry_used', 'calib_astrometry_used', 'calib_psf_candidate', 'calib_psf_used', 'calib_psf_reserved'))

Methods Documentation

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.