DiaPipelineTask

DiaPipelineTask associates DIASources with previously-known DIAObjects.

Python API summary

from lsst.ap.association.diaPipe import DiaPipelineTask
classDiaPipelineTask(initInputs=None, **kwargs)

Task for loading, associating and storing Difference Image Analysis (DIA) Objects and Sources...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(diaSourceTable, solarSystemObjectTable, diffIm, exposure, template, ccdExposureIdBits, band, idGenerator=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

ConfigurableField

Subtask for packaging Ap data into alerts.

apdb

Default

lsst.dax.apdb.apdbSql.ApdbSql

Field type

ConfigurableField

Database connection for storing associated DiaSources and DiaObjects. Must already be initialized.

associator

Default

lsst.ap.association.association.AssociationTask

Field type

ConfigurableField

Task used to associate DiaSources with DiaObjects.

diaCalculation

Default

lsst.meas.base.diaCalculation.DiaObjectCalculationTask

Field type

ConfigurableField

Task to compute summary statistics for DiaObjects.

diaCatalogLoader

Default

lsst.ap.association.loadDiaCatalogs.LoadDiaCatalogsTask

Field type

ConfigurableField

Task to load DiaObjects and DiaSources from the Apdb.

diaForcedSource

Default

lsst.ap.association.diaForcedSource.DiaForcedSourceTask

Field type

ConfigurableField

Task used for force photometer DiaObject locations in direct and difference images.

solarSystemAssociator

Default

lsst.ap.association.ssoAssociation.SolarSystemAssociationTask

Field type

ConfigurableField

Task used to associate DiaSources with SolarSystemObjects.

Configuration fields

coaddName

Default
'deep'
Field type

str Field

coadd name: typically one of deep, goodSeeing, or dcr

connections

Data type

lsst.pipe.base.config.DiaPipelineConfigConnections

Field type

ConfigField

Configurations describing the connections of the PipelineTask to datatypes

doPackageAlerts

Default
False
Field type

bool Field

Package Dia-data into serialized alerts for distribution and write them to disk.

doSolarSystemAssociation

Default
False
Field type

bool Field

Process SolarSystem objects through the pipeline.

doWriteAssociatedSources

Default
False
Field type

bool Field

Write out associated DiaSources, DiaForcedSources, and DiaObjects, formatted following the Science Data Model.

idGenerator

Data type

lsst.meas.base._id_generator.DetectorVisitIdGeneratorConfig

Field type

ConfigField

Configuration for how to generate catalog IDs from data IDs.

imagePixelMargin

Default
10
Field type

int RangeField

Range

[0,inf)

Pad the image by this many pixels before removing off-image diaObjects for association.

saveLogOutput

Default
True
Field type

bool Field

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

saveMetadata

Default
True
Field type

bool Field

Flag to enable/disable metadata saving for a task, enabled by default. Deprecated: This field is deprecated and will be removed after v26.

validBands

Default
['u', 'g', 'r', 'i', 'z', 'y']
Field type

str ListField

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.