GbdesGlobalAstrometricFitTask¶
- class lsst.drp.tasks.gbdesAstrometricFit.GbdesGlobalAstrometricFitTask(**kwargs)¶
Bases:
GbdesAstrometricFitTask
Calibrate the WCS across multiple visits and multiple fields using the GBDES package.
This class assumes that the input visits can be separated into contiguous groups, for which an individual group covers an area of less than a hemisphere.
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.make_yaml
(inputVisitSummary[, inputFile])Make a YAML-type object that describes the parameters of the fit model.
run
(inputVisitSummaries, ...[, ...])Run the WCS fit for a given set of visits
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
.
- make_yaml(inputVisitSummary, inputFile=None)¶
Make a YAML-type object that describes the parameters of the fit model.
- Parameters:
- inputVisitSummary
lsst.afw.table.ExposureCatalog
Catalog with per-detector summary information.
- inputFile
str
Path to a file that contains a basic model.
- inputVisitSummary
- Returns:
- run(inputVisitSummaries, isolatedStarSources, isolatedStarCatalogs, instrumentName='', refEpoch=None, refObjectLoader=None)¶
Run the WCS fit for a given set of visits
- Parameters:
- inputVisitSummaries
list
[lsst.afw.table.ExposureCatalog
] List of catalogs with per-detector summary information.
- isolatedStarSources
list
[DeferredDatasetHandle
] List of handles pointing to isolated star sources.
- isolatedStarCatalog: `list` [`DeferredDatasetHandle`]
List of handles pointing to isolated star catalogs.
- instrumentName
str
, optional Name of the instrument used. This is only used for labelling.
- refEpoch
float
, optional Epoch of the reference objects in MJD.
- refObjectLoaderinstance of
lsst.meas.algorithms.loadReferenceObjects.ReferenceObjectLoader
, optional Reference object loader instance.
- inputVisitSummaries
- Returns:
- result
lsst.pipe.base.Struct
outputWcss
list
[lsst.afw.table.ExposureCatalog
]List of exposure catalogs (one per visit) with the WCS for each detector set by the new fitted WCS.
fitModel
wcsfit.WCSFit
Model-fitting object with final model parameters.
outputCatalog
pyarrow.Table
Catalog with fit residuals of all sources used.
starCatalog
pyarrow.Table
Catalog with best-fit positions of the objects fit.
modelParams
dict
Parameters and covariance of the best-fit WCS model.
- result
- runQuantum(butlerQC, inputRefs, outputRefs)¶
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