FgcmCalibrateTractTableTask¶

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

Bases: FgcmCalibrateTractBaseTask

Calibrate a single tract using fgcmcal, using sourceTable_visit (parquet) input catalogs.

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.
`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)	Do butler IO and transform 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: ClassVar[bool] = False¶

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

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

Run the calibrations for a single tract with fgcm.

Parameters:

handleDictdict

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.

tractint

Tract number

buildStarsRefObjLoaderlsst.meas.algorithms.ReferenceObjectLoader, optional

Reference object loader object for fgcmBuildStars.

returnCatalogsbool, optional

Return photoCalibs as per-visit exposure catalogs.

Returns:

outstructlsst.pipe.base.Struct

Output structure with keys:

offsetsnp.ndarray: Final reference offsets, per band.
repeatabilitynp.ndarray: Raw fgcm repeatability for bright stars, per band.
atmospheresgenerator [(int, lsst.afw.image.TransmissionCurve)]: Generator that returns (visit, transmissionCurve) tuples.
photoCalibsgenerator [(int, int, str, lsst.afw.image.PhotoCalib)]: Generator that returns (visit, ccd, filtername, photoCalib) tuples. (returned if returnCatalogs is False).
photoCalibCatalogsgenerator [(int, lsst.afw.table.ExposureCatalog)]: Generator that returns (visit, exposureCatalog) tuples. (returned if returnCatalogs is True).

runQuantum(butlerQC, inputRefs, outputRefs)¶

Do butler IO and transform to provide in memory objects for tasks run method.

Parameters:

butlerQCQuantumContext: A butler which is specialized to operate in the context of a lsst.daf.butler.Quantum.
inputRefsInputQuantizedConnection: 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.
outputRefsOutputQuantizedConnection: 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:

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

Navigation

FgcmCalibrateTractTableTask¶