DiaPipelineTask¶
DiaPipelineTask associates DIASources with previously-known DIAObjects.
Python API summary¶
from lsst.ap.association.diaPipe import DiaPipelineTask
-
class
DiaPipelineTask(initInputs=None, **kwargs) Task for loading, associating and storing Difference Image Analysis (DIA) Objects and Sources
...
- attributeconfig
Access configuration fields and retargetable subtasks.
-
method
run(diaSourceTable, legacySolarSystemTable, diffIm, exposure, template, preloadedDiaObjects, preloadedDiaSources, preloadedDiaForcedSources, band, idGenerator, solarSystemObjectTable=None) Process DiaSources and DiaObjects
...
See also
See the DiaPipelineTask API reference for complete details.
Retargetable subtasks¶
alertPackager¶
- Default
lsst.ap.association.packageAlerts.PackageAlertsTask- Field type
Subtask for packaging Ap data into alerts.
apdb¶
- Default
lsst.dax.apdb.sql.apdbSql.ApdbSql- Field type
Database connection for storing associated DiaSources and DiaObjects. Must already be initialized. Deprecated: This field has been replaced by apdb_config_url; set doConfigureApdb=False to use it. Will be removed after v28.
associator¶
- Default
lsst.ap.association.association.AssociationTask- Field type
Task used to associate DiaSources with DiaObjects.
diaCalculation¶
- Default
lsst.meas.base.diaCalculation.DiaObjectCalculationTask- Field type
Task to compute summary statistics for DiaObjects.
diaForcedSource¶
- Default
lsst.ap.association.diaForcedSource.DiaForcedSourceTask- Field type
Task used for force photometer DiaObject locations in direct and difference images.
solarSystemAssociator¶
- Default
lsst.ap.association.ssoAssociation.SolarSystemAssociationTask- Field type
Task used to associate DiaSources with SolarSystemObjects.
Configuration fields¶
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.
coaddName¶
coadd name: typically one of deep, goodSeeing, or dcr
connections¶
- Data type
lsst.pipe.base.config.DiaPipelineConfigConnections- Field type
Configurations describing the connections of the PipelineTask to datatypes
doConfigureApdb¶
Use the deprecated apdb sub-config to set up the APDB, instead of the new config (apdb_config_url). This field is provided for backward-compatibility ONLY and will be removed without notice after v28.
doPackageAlerts¶
Package Dia-data into serialized alerts for distribution and write them to disk.
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.
doSolarSystemAssociation¶
Process SolarSystem objects through the pipeline.
doWriteAssociatedSources¶
Write out associated DiaSources, DiaForcedSources, and DiaObjects, formatted following the Science Data Model.
idGenerator¶
- Data type
lsst.meas.base._id_generator.DetectorVisitIdGeneratorConfig- Field type
Configuration for how to generate catalog IDs from data IDs.
imagePixelMargin¶
- Default
10- Field type
- Range
[0,inf)
Pad the image by this many pixels before removing off-image diaObjects for association.
saveLogOutput¶
Flag to enable/disable saving of log output for a task, enabled by default.
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.