DiaForcedSourceTask¶

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

Bases: Task

Task for measuring and storing forced sources at DiaObject locations in both difference and direct images.

Methods Summary

`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.
`makeField`(doc)	Make a `lsst.pex.config.ConfigurableField` for this task.
`makeSubtask`(name, **keyArgs)	Create a subtask as a new instance as the `name` attribute of this task.
`run`(dia_objects, updatedDiaObjectIds, ...[, ...])	Measure forced sources on the direct and difference images.
`timer`(name[, logLevel])	Context manager to log performance data for an arbitrary block of code.

Methods Documentation

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.

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")

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.

run(dia_objects, updatedDiaObjectIds, expIdBits, exposure, diffim, idGenerator=None)¶

Measure forced sources on the direct and difference images.

Parameters:

dia_objectspandas.DataFrame: Catalog of previously observed and newly created DiaObjects contained within the difference and direct images. DiaObjects must be indexed on the diaObjectId column.
updatedDiaObjectIdsnumpy.ndarray: Array of diaObjectIds that were updated during this dia processing. Used to assure that the pipeline includes all diaObjects that were updated in case one falls on the edge of the CCD.
expIdBitsint: Bit length of the exposure id. Deprecated in favor of idGenerator, and ignored if that is present. Pass None explicitly to avoid a deprecation warning (a default is impossible given that later positional arguments are not defaulted).
exposurelsst.afw.image.Exposure: Direct image exposure.
diffimlsst.afw.image.Exposure: Difference image.
idGeneratorlsst.meas.base.IdGenerator, optional: Object that generates source IDs and random number generator seeds. Will be required after expIdBits is removed.

Returns:

output_forced_sourcespandas.DataFrame: Catalog of calibrated forced photometered fluxes on both the difference and direct images at DiaObject locations.

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

DiaForcedSourceTask¶