PackageAlertsTask¶

class lsst.ap.association.PackageAlertsTask(**kwargs)¶

Bases: Task

Tasks for packaging Dia and Pipelines data into Avro alert packages.

Methods Summary

`createCcdDataCutout`(image, skyCenter, ...[, ...])	Grab an image as a cutout and return a calibrated CCDData image.
`createDiaSourceExtent`(bboxSize)	Create an extent for a box for the cutouts given the size of the square BBox that covers the source footprint.
`emptyMetadata`()	Empty (clear) the metadata for this Task and all sub-Tasks.
`getFullMetadata`()	Get metadata for all tasks.
`getFullName`()	Get the task name as a hierarchical name including parent task names.
`getName`()	Get the name of the task.
`getTaskDict`()	Get a dictionary of all tasks as a shallow copy.
`makeAlertDict`(alertId, diaSource, diaObject, ...)	Convert data and package into a dictionary alert.
`makeField`(doc)	Make a `lsst.pex.config.ConfigurableField` for this task.
`makeLocalTransformMatrix`(wcs, center, skyCenter)	Create a local, linear approximation of the wcs transformation matrix.
`makeSubtask`(name, **keyArgs)	Create a subtask as a new instance as the `name` attribute of this task.
`produceAlerts`(alerts, visit, detector, ...)	Serialize alerts and send them to the alert stream using confluent_kafka's producer.
`run`(diaSourceCat, diaObjectCat, ...[, ...])	Package DiaSources/Object and exposure data into Avro alerts.
`streamCcdDataToBytes`(cutout)	Serialize a cutout into bytes.
`timer`(name[, logLevel])	Context manager to log performance data for an arbitrary block of code.

Methods Documentation

createCcdDataCutout(image, skyCenter, pixelCenter, extent, photoCalib, srcId, averagePsf=None)¶

Grab an image as a cutout and return a calibrated CCDData image.

Parameters:

imagelsst.afw.image.ExposureF: Image to pull cutout from.
skyCenterlsst.geom.SpherePoint: Center point of DiaSource on the sky.
pixelCenterlsst.geom.Point2D: Pixel center of DiaSource on the sky.
extentlsst.geom.Extent2I: Bounding box to cutout from the image.
photoCaliblsst.afw.image.PhotoCalib: Calibrate object of the image the cutout is cut from.
srcIdint: Unique id of DiaSource. Used for when an error occurs extracting a cutout.
averagePsfnumpy.array, optional: Average PSF to attach to the cutout. Used if self.config.useAveragePsf is set.

Returns:

ccdDataastropy.nddata.CCDData or None: CCDData object storing the calibrate information from the input difference or template image.

createDiaSourceExtent(bboxSize)¶

Create an extent for a box for the cutouts given the size of the square BBox that covers the source footprint.

Parameters:

bboxSizeint: Size of a side of the square bounding box in pixels.

Returns:

extentlsst.geom.Extent2I: Geom object representing the size of the bounding box.

emptyMetadata() → None¶: Empty (clear) the metadata for this Task and all sub-Tasks.

getFullMetadata() → TaskMetadata¶

Get metadata for all tasks.

Returns:

metadataTaskMetadata: The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.

Notes

The returned metadata includes timing information (if @timer.timeMethod is used) and any metadata set by the task. The name of each item consists of the full task name with . replaced by :, followed by . and the name of the item, e.g.:

topLevelTaskName:subtaskName:subsubtaskName.itemName

using : in the full task name disambiguates the rare situation that a task has a subtask and a metadata item with the same name.

getFullName() → str¶

Get the task name as a hierarchical name including parent task names.

Returns:

fullNamestr

The full name consists of the name of the parent task and each subtask separated by periods. For example:

The full name of top-level task “top” is simply “top”.
The full name of subtask “sub” of top-level task “top” is “top.sub”.
The full name of subtask “sub2” of subtask “sub” of top-level task “top” is “top.sub.sub2”.

getName() → str¶

Get the name of the task.

Returns:

taskNamestr: Name of the task.

See also

getFullName: Get the full name of the task.

getTaskDict() → dict[str, weakref.ReferenceType[lsst.pipe.base.task.Task]]¶

Get a dictionary of all tasks as a shallow copy.

Returns:

taskDictdict: Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.

makeAlertDict(alertId, diaSource, diaObject, objDiaSrcHistory, objDiaForcedSources, diffImCutout, calexpCutout, templateCutout)¶

Convert data and package into a dictionary alert.

Parameters:

diaSourcepandas.DataFrame: New single DiaSource to package.
diaObjectpandas.DataFrame: DiaObject that diaSource is matched to.
objDiaSrcHistorypandas.DataFrame: 12 month history of diaObject excluding the latest DiaSource.
objDiaForcedSourcespandas.DataFrame: 12 month history of diaObject forced measurements.
diffImCutoutastropy.nddata.CCDData or None: Cutout of the difference image around the location of diaSource with a min size set by the cutoutSize configurable.
calexpCutoutastropy.nddata.CCDData or None: Cutout of the calexp around the location of diaSource with a min size set by the cutoutSize configurable.
templateCutoutastropy.nddata.CCDData or None: Cutout of the template image around the location of diaSource with a min size set by the cutoutSize configurable.

classmethod makeField(doc: str) → ConfigurableField¶

Make a lsst.pex.config.ConfigurableField for this task.

Parameters:

docstr: Help text for the field.

Returns:

configurableFieldlsst.pex.config.ConfigurableField: A ConfigurableField for this task.

Examples

Provides a convenient way to specify this task is a subtask of another task.

Here is an example of use:

class OtherTaskConfig(lsst.pex.config.Config):
    aSubtask = ATaskClass.makeField("brief description of task")

makeLocalTransformMatrix(wcs, center, skyCenter)¶

Create a local, linear approximation of the wcs transformation matrix.

The approximation is created as if the center is at RA=0, DEC=0. All comparing x,y coordinate are relative to the position of center. Matrix is initially calculated with units arcseconds and then converted to degrees. This yields higher precision results due to quirks in AST.

Parameters:

wcslsst.afw.geom.SkyWcs: Wcs to approximate
centerlsst.geom.Point2D: Point at which to evaluate the LocalWcs.
skyCenterlsst.geom.SpherePoint: Point on sky to approximate the Wcs.

Returns:

localMatrixnumpy.ndarray: Matrix representation the local wcs approximation with units degrees.

makeSubtask(name: str, **keyArgs: Any) → None¶

Create a subtask as a new instance as the name attribute of this task.

Parameters:

namestr

Brief name of the subtask.

**keyArgs

Extra keyword arguments used to construct the task. The following arguments are automatically provided and cannot be overridden:

config.
parentTask.

Notes

The subtask must be defined by Task.config.name, an instance of ConfigurableField or RegistryField.

produceAlerts(alerts, visit, detector, midpoint_unix, exposure_time)¶

Serialize alerts and send them to the alert stream using confluent_kafka’s producer.

Parameters:

alertsdict: Dictionary of alerts to be sent to the alert stream.
visit, detectorint: Visit and detector ids of these alerts. Used to write out alerts which fail to be sent to the alert stream.

run(diaSourceCat, diaObjectCat, diaSrcHistory, diaForcedSources, diffIm, calexp, template, doRunForcedMeasurement=True, forcedSourceHistoryThreshold=0)¶

Package DiaSources/Object and exposure data into Avro alerts.

Alerts can be sent to the alert stream if doProduceAlerts is set and written to disk if doWriteAlerts is set. Both can be set at the same time, and are independent of one another.

Writes Avro alerts to a location determined by the alertWriteLocation configurable.

Parameters:

diaSourceCatpandas.DataFrame: New DiaSources to package. DataFrame should be indexed on ["diaObjectId", "band", "diaSourceId"]
diaObjectCatpandas.DataFrame: New and updated DiaObjects matched to the new DiaSources. DataFrame is indexed on ["diaObjectId"]
diaSrcHistorypandas.DataFrame: 12 month history of DiaSources matched to the DiaObjects. Excludes the newest DiaSource and is indexed on ["diaObjectId", "band", "diaSourceId"]
diaForcedSourcespandas.DataFrame: 12 month history of DiaForcedSources matched to the DiaObjects. ["diaObjectId"]
diffImlsst.afw.image.ExposureF: Difference image the sources in diaSourceCat were detected in.
calexplsst.afw.image.ExposureF: Calexp used to create the diffIm.
templatelsst.afw.image.ExposureF or None: Template image used to create the diffIm.
doRunForcedMeasurementbool, optional: Flag to indicate whether forced measurement was run. This should only be turned off for debugging purposes. Added to allow disabling forced sources for performance reasons during the ops rehearsal.
forcedSourceHistoryThresholdint, optional: Minimum number of detections of a diaObject required to run forced photometry. Set to 1 to include all diaObjects.

streamCcdDataToBytes(cutout)¶

Serialize a cutout into bytes.

Parameters:

cutoutastropy.nddata.CCDData: Cutout to serialize.

Returns:

coutputBytesbytes: Input cutout serialized into byte data.

timer(name: str, logLevel: int = 10) → Iterator[None]¶

Context manager to log performance data for an arbitrary block of code.

Parameters:

namestr: Name of code being timed; data will be logged using item name: Start and End.
logLevelint: A logging level constant.

Navigation

PackageAlertsTask¶