FractionUpdatedDiaObjectsMetricTask#

class lsst.ap.association.metrics.FractionUpdatedDiaObjectsMetricTask(**kwargs)#

Bases: MetadataMetricTask

Task that computes the fraction of previously created DIAObjects that have a new association in this image, visit, etc..

Methods Summary

getInputMetadataKeys(config)

Return the metadata keys read by this task.

makeMeasurement(values)

Compute the number of non-updated DIAObjects.

Methods Documentation

classmethod getInputMetadataKeys(config)#

Return the metadata keys read by this task.

Parameters#

configcls.ConfigClass

Configuration for this task.

Returns#

keysdict [str, str]

The keys are the (arbitrary) names of values to use in task code, the values are the metadata keys to be looked up (see the metadataKeys parameter to extractMetadata). Metadata keys are assumed to include task prefixes in the format of lsst.pipe.base.Task.getFullMetadata(). This method may return a substring of the desired (full) key, but the string must match a unique metadata key.

makeMeasurement(values)#

Compute the number of non-updated DIAObjects.

AssociationTask reports each pre-existing DIAObject as either updated (associated with a new DIASource) or unassociated.

Parameters#

valuesdict [str, int or None]

A dict representation of the metadata. Each dict has the following keys:

updatedObjects

The number of DIAObjects updated for this image (int or None). May be None if the image was not successfully associated.

unassociatedObjects

The number of DIAObjects not associated with a DiaSource in this image (int or None). May be None if the image was not successfully associated.

Returns#

measurementlsst.verify.Measurement or None

The total number of unassociated objects.