DiaPipelineConfig#

class lsst.ap.association.DiaPipelineConfig(*args, **kw)#

Bases: PipelineTaskConfig

Config for DiaPipelineTask.

Attributes Summary

`alertPackager`	Subtask for packaging Ap data into alerts.
`angleMargin`	Padding to add when loading diaObjects if `doReloadDiaObjects=True` (`float`, default `2`)
`apdb_config_url`	A config file specifying the APDB and its connection parameters, typically written by the apdb-cli command-line utility.
`associator`	Task used to associate DiaSources with DiaObjects.
`coaddName`	coadd name: typically one of deep, goodSeeing, or dcr (`str`, default `'deep'`)
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`diaCalculation`	Task to compute summary statistics for DiaObjects.
`diaForcedSource`	Task used for force photometer DiaObject locations in direct and difference images.
`doPackageAlerts`	Package Dia-data into serialized alerts for distribution and write them to disk.
`doReloadDiaObjects`	Drop preloaded DiaObjects and reload them from the APDB?Used in production when the very latest objects from the APDB are needed.
`doRunForcedMeasurement`	Run forced measurement on all of the diaObjects? This should only be turned off for debugging purposes.
`doSolarSystemAssociation`	Process SolarSystem objects through the pipeline.
`doWriteAssociatedSources`	Write out associated DiaSources, DiaForcedSources, and DiaObjects, formatted following the Science Data Model.
`filterUnAssociatedSources`	Check unassociated diaSources for quality before creating new .diaObjects.
`idGenerator`	Configuration for how to generate catalog IDs from data IDs.
`imagePixelMargin`	Pad the image by this many pixels before removing off-image diaObjects for association.
`maxNewDiaObjects`	Maximum number of new DiaObjects to create before raising an error.Set to zero to disable.
`newObjectBadFlags`	If `filterUnAssociatedSources` is set, exclude diaSources with these flags set before creating new diaObjects.
`newObjectFluxField`	Name of the flux field in the standardized diaSource catalog to use for checking the signal-to-noise before creating new diaObjects.
`newObjectLowReliabilitySnrThreshold`	If `filterUnAssociatedSources` is set, exclude diaSources with signal-to-noise ratios less than this threshold if they have low reliability scores before creating new diaObjects.Set to zero to disable.
`newObjectLowSnrReliabilityThreshold`	If `filterUnAssociatedSources` is set, exclude diaSources with low signal-to-noise and reliability scores below this threshold before creating new diaObjects.Set to zero to disable.
`newObjectReliabilityThreshold`	If `filterUnAssociatedSources` is set, exclude diaSources with reliability scores less than this threshold before creating new diaObjects.Set to zero to disable.
`newObjectSnrThreshold`	If `filterUnAssociatedSources` is set, exclude diaSources with Abs(flux/fluxErr) less than this threshold before creating new diaObjects.Set to zero to disable.
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`solarSystemAssociator`	Task used to associate DiaSources with SolarSystemObjects.
`validBands`	List of bands that are valid for AP processing.

Methods Summary

setDefaults()

Subclass hook for computing defaults.

Attributes Documentation

alertPackager#: Subtask for packaging Ap data into alerts. (ConfigurableInstance, default <class 'lsst.ap.association.packageAlerts.PackageAlertsConfig'>)

angleMargin#

Padding to add when loading diaObjects if doReloadDiaObjects=True (float, default 2)

Valid Range = [0,inf)

apdb_config_url#: A config file specifying the APDB and its connection parameters, typically written by the apdb-cli command-line utility. The database must already be initialized. (str)

associator#: Task used to associate DiaSources with DiaObjects. (ConfigurableInstance, default <class 'lsst.ap.association.association.AssociationConfig'>)

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

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

diaCalculation#: Task to compute summary statistics for DiaObjects. (ConfigurableInstance, default <class 'lsst.meas.base.diaCalculation.DiaObjectCalculationConfig'>)

diaForcedSource#: Task used for force photometer DiaObject locations in direct and difference images. (ConfigurableInstance, default <class 'lsst.ap.association.diaForcedSource.DiaForcedSourcedConfig'>)

doPackageAlerts#: Package Dia-data into serialized alerts for distribution and write them to disk. (bool, default False)

doReloadDiaObjects#: Drop preloaded DiaObjects and reload them from the APDB?Used in production when the very latest objects from the APDB are needed. (bool, default True)

doRunForcedMeasurement#: Run forced measurement on all of the diaObjects? This should only be turned off for debugging purposes. Deprecated: Added to allow disabling forced sources for performance reasons during the ops rehearsal. It is expected to be removed. (bool, default True)

doSolarSystemAssociation#: Process SolarSystem objects through the pipeline. (bool, default True)

doWriteAssociatedSources#: Write out associated DiaSources, DiaForcedSources, and DiaObjects, formatted following the Science Data Model. (bool, default True)

filterUnAssociatedSources#: Check unassociated diaSources for quality before creating new .diaObjects. DiaSources that are associated with existing diaObjects will not be affected. (bool, default True)

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

imagePixelMargin#

Pad the image by this many pixels before removing off-image diaObjects for association. (int, default 10)

Valid Range = [0,inf)

maxNewDiaObjects#

Maximum number of new DiaObjects to create before raising an error.Set to zero to disable. (float, default 0)

Valid Range = [0,inf)

newObjectBadFlags#: If filterUnAssociatedSources is set, exclude diaSources with these flags set before creating new diaObjects. (List, default ('centroid_flag', 'pixelFlags_crCenter', 'pixelFlags_nodataCenter', 'pixelFlags_interpolatedCenter', 'pixelFlags_saturatedCenter', 'pixelFlags_suspectCenter', 'pixelFlags_streakCenter', 'glint_trail'))

newObjectFluxField#: Name of the flux field in the standardized diaSource catalog to use for checking the signal-to-noise before creating new diaObjects. (str, default 'apFlux')

newObjectLowReliabilitySnrThreshold#

If filterUnAssociatedSources is set, exclude diaSources with signal-to-noise ratios less than this threshold if they have low reliability scores before creating new diaObjects.Set to zero to disable. (float, default 0)

Valid Range = [0,inf)

newObjectLowSnrReliabilityThreshold#

If filterUnAssociatedSources is set, exclude diaSources with low signal-to-noise and reliability scores below this threshold before creating new diaObjects.Set to zero to disable. (float, default 0.1)

Valid Range = [0,1)

newObjectReliabilityThreshold#

If filterUnAssociatedSources is set, exclude diaSources with reliability scores less than this threshold before creating new diaObjects.Set to zero to disable. (float, default 0.1)

Valid Range = [0,1)

newObjectSnrThreshold#

If filterUnAssociatedSources is set, exclude diaSources with Abs(flux/fluxErr) less than this threshold before creating new diaObjects.Set to zero to disable. (float, default 0)

Valid Range = [0,inf)

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

solarSystemAssociator#: Task used to associate DiaSources with SolarSystemObjects. (ConfigurableInstance, default <class 'lsst.pipe.tasks.ssoAssociation.SolarSystemAssociationConfig'>)

validBands#: List of bands that are valid for AP processing. To process a band not on this list, the appropriate band specific columns must be added to the Apdb schema in dax_apdb. (List, default ['u', 'g', 'r', 'i', 'z', 'y'])

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.

DiaPipelineConfig#

Notes#