LoadDiaCatalogsTask¶

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

Bases: lsst.pipe.base.Task

Retrieve DiaObjects and associated DiaSources from the Apdb given an input exposure.

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.
`loadDiaForcedSources`(diaObjects, region, …)	Load DiaObjects from the Apdb based on their HTM location.
`loadDiaObjects`(region, apdb)	Load DiaObjects from the Apdb based on their HTM location.
`loadDiaSources`(diaObjects, region, dateTime, …)	Load DiaSources from the Apdb based on their diaObjectId or location.
`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`(exposure, apdb)	Preload all DiaObjects and DiaSources from the Apdb given the current exposure.
`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() → lsst.pipe.base._task_metadata.TaskMetadata¶

Get metadata for all tasks.

Returns:	metadata : `TaskMetadata` 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:	fullName : `str` 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:	taskName : `str` Name of the task.

See also

getFullName

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

Get a dictionary of all tasks as a shallow copy.

Returns:	taskDict : `dict` Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.

loadDiaForcedSources(diaObjects, region, dateTime, apdb)¶

Load DiaObjects from the Apdb based on their HTM location.

Parameters:	diaObjects : `pandas.DataFrame` DiaObjects loaded from the Apdb. region : `sphgeom.Region` Region of interest. dateTime : `lsst.daf.base.DateTime` Time of the current visit apdb : `lsst.dax.apdb.Apdb` Database connection object to load from.
Returns:	diaObjects : `pandas.DataFrame` DiaObjects loaded from the Apdb that are within the area defined by `pixelRanges`.

loadDiaObjects(region, apdb)¶

Load DiaObjects from the Apdb based on their HTM location.

Parameters:	region : `sphgeom.Region` Region of interest. apdb : `lsst.dax.apdb.Apdb` Database connection object to load from.
Returns:	diaObjects : `pandas.DataFrame` DiaObjects loaded from the Apdb that are within the area defined by `pixelRanges`.

loadDiaSources(diaObjects, region, dateTime, apdb)¶

Load DiaSources from the Apdb based on their diaObjectId or location.

Variable used to load sources is set in config.

Parameters:	diaObjects : `pandas.DataFrame` DiaObjects loaded from the Apdb that are within the area defined by `pixelRanges`. region : `sphgeom.Region` Region of interest. dateTime : `lsst.daf.base.DateTime` Time of the current visit apdb : `lsst.dax.apdb.Apdb` Database connection object to load from.
Returns:	DiaSources : `pandas.DataFrame` DiaSources loaded from the Apdb that are within the area defined by `pixelRange` and associated with `diaObjects`.

classmethod makeField(doc: str) → lsst.pex.config.configurableField.ConfigurableField¶

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

Parameters:	doc : `str` Help text for the field.
Returns:	configurableField : `lsst.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) → None¶

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

Parameters:	name : `str` 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(exposure, apdb)¶

Preload all DiaObjects and DiaSources from the Apdb given the current exposure.

Parameters:

exposure : lsst.afw.image.Exposure: An exposure with a bounding box.
apdb : lsst.dax.apdb.Apdb: AP database connection object.

Returns:

result : lsst.pipe.base.Struct

Results struct with components.

diaObjects : Complete set of DiaObjects covering the input exposure padded by pixelMargin. DataFrame is indexed by the diaObjectId column. (pandas.DataFrame)
diaSources : Complete set of DiaSources covering the input exposure padded by pixelMargin. DataFrame is indexed by diaObjectId, filterName, diaSourceId columns. (pandas.DataFrame)

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

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

Parameters:	name : `str` Name of code being timed; data will be logged using item name: `Start` and `End`. logLevel A `logging` level constant.

Navigation

LoadDiaCatalogsTask¶