FgcmOutputProductsTask¶

class lsst.fgcmcal.FgcmOutputProductsTask(butler=None, **kwargs)¶

Bases: lsst.pipe.base.PipelineTask, lsst.pipe.base.CmdLineTask

Output products from FGCM global calibration.

Attributes Summary

canMultiprocess

Methods Summary

`applyOverrides`(config)	A hook to allow a task to change the values of its config after the camera-specific overrides are loaded but before any command-line overrides are applied.
`emptyMetadata`()	Empty (clear) the metadata for this Task and all sub-Tasks.
`generateTractOutputProducts`(dataRefDict, …)	Generate the output products for a given tract, as specified in the config.
`getAllSchemaCatalogs`()	Get schema catalogs for all tasks in the hierarchy, combining the results into a single dict.
`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.
`getSchemaCatalogs`()	Get the schemas generated by 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.
`parseAndRun`([args, config, log, doReturnResults])	Parse an argument list and run the command.
`run`(dataRefDict, physicalFilterMap[, …])	Run the output products task.
`runDataRef`(butler)	Make FGCM output products for use in the stack
`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.
`writeConfig`(butler[, clobber, doBackup])	Write the configuration used for processing the data, or check that an existing one is equal to the new one if present.
`writeMetadata`(dataRef)	Write the metadata produced from processing the data.
`writePackageVersions`(butler[, clobber, …])	Compare and write package versions.
`writeSchemas`(butler[, clobber, doBackup])	Write the schemas returned by `lsst.pipe.base.Task.getAllSchemaCatalogs`.

Attributes Documentation

canMultiprocess = True¶

Methods Documentation

classmethod applyOverrides(config)¶

A hook to allow a task to change the values of its config after the camera-specific overrides are loaded but before any command-line overrides are applied.

Parameters:	config : instance of task’s `ConfigClass` Task configuration.

Notes

This is necessary in some cases because the camera-specific overrides may retarget subtasks, wiping out changes made in ConfigClass.setDefaults. See LSST Trac ticket #2282 for more discussion.

Warning

This is called by CmdLineTask.parseAndRun; other ways of constructing a config will not apply these overrides.

emptyMetadata()¶: Empty (clear) the metadata for this Task and all sub-Tasks.

generateTractOutputProducts(dataRefDict, tract, visitCat, zptCat, atmCat, stdCat, fgcmBuildStarsConfig, returnCatalogs=True, butler=None)¶

Generate the output products for a given tract, as specified in the config.

This method is here to have an alternate entry-point for FgcmCalibrateTract.

Parameters:

dataRefDict : dict

All dataRefs are lsst.daf.persistence.ButlerDataRef (gen2) or lsst.daf.butler.DeferredDatasetHandle (gen3) dataRef dictionary with keys:

"camera": Camera object (lsst.afw.cameraGeom.Camera)
"fgcmLookUpTable": dataRef for the FGCM look-up table.

tract : int

Tract number

visitCat : lsst.afw.table.BaseCatalog

FGCM visitCat from FgcmBuildStarsTask

zptCat : lsst.afw.table.BaseCatalog

FGCM zeropoint catalog from FgcmFitCycleTask

atmCat : lsst.afw.table.BaseCatalog

FGCM atmosphere parameter catalog from FgcmFitCycleTask

stdCat : lsst.afw.table.SimpleCatalog

FGCM standard star catalog from FgcmFitCycleTask

fgcmBuildStarsConfig : lsst.fgcmcal.FgcmBuildStarsConfig

Configuration object from FgcmBuildStarsTask

returnCatalogs : bool, optional

Return photoCalibs as per-visit exposure catalogs.

butler: `lsst.daf.persistence.Butler`, optional

Gen2 butler used for reference star outputs

Returns:

retStruct : lsst.pipe.base.Struct

Output structure with keys:

offsets : np.ndarray: Final reference offsets, 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).

getAllSchemaCatalogs()¶

Get schema catalogs for all tasks in the hierarchy, combining the results into a single dict.

Returns:	schemacatalogs : `dict` Keys are butler dataset type, values are a empty catalog (an instance of the appropriate `lsst.afw.table` Catalog type) for all tasks in the hierarchy, from the top-level task down through all subtasks.

Notes

This method may be called on any task in the hierarchy; it will return the same answer, regardless.

The default implementation should always suffice. If your subtask uses schemas the override Task.getSchemaCatalogs, not this method.

getFullMetadata()¶

Get metadata for all tasks.

Returns:	metadata : `lsst.daf.base.PropertySet` or `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()¶

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()¶

Get the name of the task.

Returns:	taskName : `str` Name of the task.

See also

Task.getAllSchemaCatalogs

Notes

Warning

Subclasses that use schemas must override this method. The default implementation returns an empty dict.

This method may be called at any time after the Task is constructed, which means that all task schemas should be computed at construction time, not when data is actually processed. This reflects the philosophy that the schema should not depend on the data.

Returning catalogs rather than just schemas allows us to save e.g. slots for SourceCatalog as well.

getTaskDict()¶

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)¶

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, **keyArgs)¶

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.

classmethod parseAndRun(args=None, config=None, log=None, doReturnResults=False)¶

Parse an argument list and run the command.

Parameters:

args : list, optional: List of command-line arguments; if None use sys.argv.
config : lsst.pex.config.Config-type, optional: Config for task. If None use Task.ConfigClass.
log : logging.Logger-type, optional: Log. If None use the default log.
doReturnResults : bool, optional: If True, return the results of this task. Default is False. This is only intended for unit tests and similar use. It can easily exhaust memory (if the task returns enough data and you call it enough times) and it will fail when using multiprocessing if the returned data cannot be pickled.

Returns:

struct : lsst.pipe.base.Struct

Fields are:

argumentParser: the argument parser (lsst.pipe.base.ArgumentParser).
parsedCmd: the parsed command returned by the argument parser’s parse_args method (argparse.Namespace).
taskRunner: the task runner used to run the task (an instance of Task.RunnerClass).
resultList: results returned by the task runner’s run method, one entry per invocation (list). This will typically be a list of Struct, each containing at least an exitStatus integer (0 or 1); see Task.RunnerClass (TaskRunner by default) for more details.

Notes

Calling this method with no arguments specified is the standard way to run a command-line task from the command-line. For an example see pipe_tasks bin/makeSkyMap.py or almost any other file in that directory.

If one or more of the dataIds fails then this routine will exit (with a status giving the number of failed dataIds) rather than returning this struct; this behaviour can be overridden by specifying the --noExit command-line option.

run(dataRefDict, physicalFilterMap, returnCatalogs=True, butler=None)¶

Run the output products task.

Parameters:

dataRefDict : dict

All dataRefs are lsst.daf.persistence.ButlerDataRef (gen2) or lsst.daf.butler.DeferredDatasetHandle (gen3) dataRef dictionary with keys:

"camera": Camera object (lsst.afw.cameraGeom.Camera)
"fgcmLookUpTable": dataRef for the FGCM look-up table.
"fgcmVisitCatalog": dataRef for visit summary catalog.
"fgcmStandardStars": dataRef for the output standard star catalog.
"fgcmZeropoints": dataRef for the zeropoint data catalog.
"fgcmAtmosphereParameters": dataRef for the atmosphere parameter catalog.
"fgcmBuildStarsTableConfig": Config for lsst.fgcmcal.fgcmBuildStarsTableTask.

physicalFilterMap : dict

Dictionary of mappings from physical filter to FGCM band.

returnCatalogs : bool, optional

Return photoCalibs as per-visit exposure catalogs.

butler : lsst.daf.persistence.Butler, optional

Gen2 butler used for reference star outputs

Returns:

retStruct : lsst.pipe.base.Struct

Output structure with keys:

offsets : np.ndarray: Final reference offsets, 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).

runDataRef(butler)¶

Make FGCM output products for use in the stack

Parameters:	butler: `lsst.daf.persistence.Butler` cycleNumber: `int` Final fit cycle number, override config.
Returns:	offsets: `lsst.pipe.base.Struct` A structure with array of zeropoint offsets
Raises:	RuntimeError: Raised if any one of the following is true: butler cannot find “fgcmBuildStars_config” or “fgcmBuildStarsTable_config”. butler cannot find “fgcmFitCycle_config”. “fgcmFitCycle_config” does not refer to `self.config.cycleNumber`. butler cannot find “fgcmAtmosphereParameters” and `self.config.doAtmosphereOutput` is `True`. butler cannot find “fgcmStandardStars” and `self.config.doReferenceCalibration` is `True` or `self.config.doRefcatOutput` is `True`. butler cannot find “fgcmZeropoints” and `self.config.doZeropointOutput` is `True`.

runQuantum(butlerQC, inputRefs, outputRefs)¶

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, logLevel=10)¶

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

FgcmOutputProductsTask¶