DecamParseTask¶

class lsst.obs.decam.DecamParseTask(*args, **kwargs)¶

Bases: ParseTask

Parse an image filename to get the required information to put the file in the correct location and populate the registry.

Attributes Summary

translator_class

Metadata translation support (astro_metadata_translator.MetadataTranslator).

Methods Summary

`buildExpnumMapper`(basepath)	Extract exposure numbers from filenames to set self.expnumMapper
`emptyMetadata`()	Empty (clear) the metadata for this Task and all sub-Tasks.
`getAllSchemaCatalogs`()	Get schema catalogs for all tasks in the hierarchy, combining the results into a single dict.
`getDestination`(butler, info, filename[, ...])	Get destination for the file
`getExtensionName`(md)	Get the name of a FITS extension.
`getFullMetadata`()	Get metadata for all tasks.
`getFullName`()	Get the task name as a hierarchical name including parent task names.
`getInfo`(filename[, filetype])	Get metadata header info from multi-extension FITS decam image file.
`getInfoFromMetadata`(md[, info])	Attempt to pull the desired information out of the header
`getName`()	Get the name of the 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.
`timer`(name[, logLevel])	Context manager to log performance data for an arbitrary block of code.
`translate_date`(md)	Convert a full DATE-OBS to a mere date
`translate_filter`(md)	Translate a full filter description into a mere filter name

Attributes Documentation

translator_class = None¶

Metadata translation support (astro_metadata_translator.MetadataTranslator).

Notes

The default of None will attempt to guess the correct translator, but specifying one (e.g., in obs-package specific ingest) will be faster.

Methods Documentation

buildExpnumMapper(basepath)¶

Extract exposure numbers from filenames to set self.expnumMapper

Parameters:

basepathstr: Location on disk of instcal, dqmask, and wtmap subdirectories.

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

getAllSchemaCatalogs() → Dict[str, Any]¶

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

Returns:

schemacatalogsdict: 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.

getDestination(butler, info, filename, filetype='raw')¶

Get destination for the file

Parameters:

butlerlsst.daf.persistence.Butler: Data butler.
infodata ID: File properties, used as dataId for the butler.
filenamestr: Input filename.

Returns:

rawstr: Destination filename.

static getExtensionName(md)¶

Get the name of a FITS extension.

Parameters:

mdlsst.daf.base.PropertySet: FITS header metadata.

Returns:

resultstr or None: The string from the EXTNAME header card if it exists. None otherwise.

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”.

getInfo(filename, filetype='raw')¶

Get metadata header info from multi-extension FITS decam image file.

The science pixels, mask, and weight (inverse variance) are stored in separate files each with a unique name but with a common unique identifier EXPNUM in the FITS header. We have to aggregate the 3 filenames for a given EXPNUM and return this information along with that returned by the base class.

Parameters:

filenamestr: Image file to retrieve info from.
filetypestr: One of “raw” or “instcal”.

Returns:

phuInfodict: Primary header unit info.
infoListlist of dict: Info for the other HDUs.

Notes

For filetype=”instcal”, we expect a directory structure that looks like the following:

dqmask/
instcal/
wtmap/

The user creates the registry by running:

ingestImagesDecam.py outputRepository --filetype=instcal --mode=link instcal/*fits

getInfoFromMetadata(md, info=None)¶

Attempt to pull the desired information out of the header

This is done through two mechanisms: * translation: a property is set directly from the relevant header keyword * translator: a property is set with the result of calling a method

The translator methods receive the header metadata and should return the appropriate value, or None if the value cannot be determined.

@param md FITS header @param info File properties, to be supplemented @return info

getName() → str¶

Get the name of the task.

Returns:

taskNamestr: 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() → Dict[str, ReferenceType[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.

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

DecamParseTask¶