FgcmCalibrateTractBaseTask

class lsst.fgcmcal.FgcmCalibrateTractBaseTask(initInputs=None, **kwargs)

Bases: lsst.pipe.base.PipelineTask, abc.ABC

Base class to calibrate a single tract using fgcmcal

Attributes Summary

canMultiprocess

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.
getResourceConfig()	Return resource configuration for this 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(handleDict, tract[, …])	Run the calibrations for a single tract with fgcm.
runQuantum(butlerQC, inputRefs, outputRefs)	Method to do butler IO and or transforms to provide in memory objects for tasks run method
timer(name, logLevel)	Context manager to log performance data for an arbitrary block of code.

Attributes Documentation

canMultiprocess = True

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

getResourceConfig() → Optional[ResourceConfig]

Return resource configuration for this task.

Returns:

Object of type ResourceConfig or None if resource

configuration is not defined for this task.

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.

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(handleDict, tract, buildStarsRefObjLoader=None, returnCatalogs=True)

Run the calibrations for a single tract with fgcm.

Parameters:

handleDict : dict

All handles are lsst.daf.butler.DeferredDatasetHandle handle dictionary with the following keys. Note that all keys need not be set based on config parameters.

"camera"

Camera object (lsst.afw.cameraGeom.Camera)

"source_catalogs"

list of handles for input source catalogs.

"sourceSchema"

Schema for the source catalogs.

"fgcmLookUpTable"

handle for the FGCM look-up table.

"calexps"

list of handles for the input calexps

"fgcmPhotoCalibs"

dict of output photoCalib handles. Key is (tract, visit, detector). Present if doZeropointOutput is True.

"fgcmTransmissionAtmospheres"

dict of output atmosphere transmission handles. Key is (tract, visit). Present if doAtmosphereOutput is True.

tract : int

Tract number

buildStarsRefObjLoader : lsst.meas.algorithms.ReferenceObjectLoader, optional

Reference object loader object for fgcmBuildStars.

returnCatalogs : bool, optional

Return photoCalibs as per-visit exposure catalogs.

Returns:

outstruct : lsst.pipe.base.Struct

Output structure with keys:

offsets : np.ndarray

Final reference offsets, per band.

repeatability : np.ndarray

Raw fgcm repeatability for bright stars, per band.

atmospheres : generator [(int, lsst.afw.image.TransmissionCurve)]

Generator that returns (visit, transmissionCurve) tuples.

photoCalibs : generator [(int, int, str, lsst.afw.image.PhotoCalib)]

Generator that returns (visit, ccd, filtername, photoCalib) tuples. (returned if returnCatalogs is False).

photoCalibCatalogs : generator [(int, lsst.afw.table.ExposureCatalog)]

Generator that returns (visit, exposureCatalog) tuples. (returned if returnCatalogs is True).

runQuantum(butlerQC: lsst.pipe.base.butlerQuantumContext.ButlerQuantumContext, inputRefs: lsst.pipe.base.connections.InputQuantizedConnection, outputRefs: lsst.pipe.base.connections.OutputQuantizedConnection) → None

Method to do butler IO and or transforms to provide in memory objects for tasks run method

Parameters:

butlerQC : ButlerQuantumContext

A butler which is specialized to operate in the context of a lsst.daf.butler.Quantum.

inputRefs : InputQuantizedConnection

Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined input/prerequisite connections.

outputRefs : OutputQuantizedConnection

Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined output connections.

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.

See also

timer.logInfo

Examples

Creating a timer context:

with self.timer("someCodeToTime"):
    pass  # code to time