FractionDiaSourcesToSciSourcesMetricTask¶

FractionDiaSourcesToSciSourcesMetricTask computes the fraction of science sources that become DIASources when processed through image differencing (as the ip_diffim.fracDiaSourcesToSciSources metric). It requires source catalogs as input, and can operate at image-level granularity.

Processing summary¶

FractionDiaSourcesToSciSourcesMetricTask reads source catalogs (src and deepDiff_diaSrc datasets, by default) and counts the number of sources. It then computes the ratio of DIASources to science sources for those catalogs. Non-primary sources are excluded from computations.

Python API summary¶

from lsst.ip.diffim.metrics import FractionDiaSourcesToSciSourcesMetricTask

classFractionDiaSourcesToSciSourcesMetricTask(**kwargs): Task that computes the ratio of difference image sources to science sources in an image, visit, etc...

attributeconfig: Access configuration fields and retargetable subtasks.

methodrun(sciSources, diaSources): Compute the ratio of DIASources to non-primary science sources...

Butler datasets¶

Input datasets¶

sciSources: The catalog type for science sources (default: src).
diaSources: The catalog type for DIASources (default: deepDiff_diaSrc).

Retargetable subtasks¶

No subtasks.

Configuration fields¶

connections¶

Data type: lsst.pipe.base.config.FractionDiaSourcesToSciSourcesMetricConfigConnections
Field type: ConfigField

Configurations describing the connections of the PipelineTask to datatypes

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.

Navigation