FgcmCalibrateTractBaseTask¶
- class lsst.fgcmcal.FgcmCalibrateTractBaseTask(initInputs=None, **kwargs)¶
Bases:
PipelineTask
,ABC
Base class to calibrate a single tract using fgcmcal
Attributes Summary
Methods Summary
Empty (clear) the metadata for this Task and all sub-Tasks.
Get metadata for all tasks.
Get the task name as a hierarchical name including parent task names.
getName
()Get the name of the task.
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
Methods Documentation
- getFullMetadata() 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.
- metadata
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”.
- fullName
- getName() str ¶
Get the name of the task.
- Returns:
- taskName
str
Name of the task.
- taskName
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:
- taskDict
dict
Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.
- taskDict
- classmethod makeField(doc: str) ConfigurableField ¶
Make a
lsst.pex.config.ConfigurableField
for this task.- Parameters:
- doc
str
Help text for the field.
- doc
- Returns:
- configurableField
lsst.pex.config.ConfigurableField
A
ConfigurableField
for this task.
- configurableField
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:
- 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
.
- name
Notes
The subtask must be defined by
Task.config.name
, an instance ofConfigurableField
orRegistryField
.
- 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.
- handleDict
- 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).
- offsets
- outstruct
- runQuantum(butlerQC: QuantumContext, inputRefs: InputQuantizedConnection, outputRefs: OutputQuantizedConnection) None ¶
Do butler IO and transform to provide in memory objects for tasks
run
method.- Parameters:
- butlerQC
QuantumContext
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 thelsst.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 thelsst.daf.butler.DatasetRef
objects associated with the defined output connections.
- butlerQC