PhotodiodeIngestTask

class lsst.obs.lsst.PhotodiodeIngestTask(butler, instrument, config=None, **kwargs)

Bases: lsst.pipe.base.Task

Task to ingest photodiode data into a butler repository.

Parameters:

config : PhotodiodeIngestConfig

Configuration for the task.

instrument : Instrument

The instrument these photodiode datasets are from.

butler : Butler

Writable butler instance, with butler.run set to the appropriate RUN collection for these datasets.

**kwargs

Additional keyword arguments.

Methods Summary

emptyMetadata()	Empty (clear) the metadata for this Task and all sub-Tasks.
getDatasetType()	Return the DatasetType of the photodiode datasets.
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(locations[, run, file_filter, …])	Ingest photodiode data into a Butler data repository.
timer(name, logLevel)	Context manager to log performance data for an arbitrary block of code.

Methods Documentation

emptyMetadata() → None

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

getDatasetType()

Return the DatasetType of the photodiode datasets.

getFullMetadata() → lsst.pipe.base._task_metadata.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.

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

getName() → str

Get the name of the task.

Returns:

taskName : str

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:

taskDict : dict

Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.

classmethod makeField(doc: str) → lsst.pex.config.configurableField.ConfigurableField

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: str, **keyArgs) → 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”.

Notes

The subtask must be defined by Task.config.name, an instance of ConfigurableField or RegistryField.

run(locations, run=None, file_filter='.*Photodiode_Readings.*txt', track_file_attrs=None)

Ingest photodiode data into a Butler data repository.

Parameters:

files : iterable over lsst.resources.ResourcePath

URIs to the files to be ingested.

run : str, optional

Name of the RUN-type collection to write to, overriding the default derived from the instrument name.

skip_existing_exposures : bool, optional

If True, skip photodiodes that have already been ingested (i.e. raws for which we already have a dataset with the same data ID in the target collection).

track_file_attrs : bool, optional

Control whether file attributes such as the size or checksum should be tracked by the datastore. Whether this parameter is honored depends on the specific datastore implementation.

Returns:

refs : list [lsst.daf.butler.DatasetRef]

Dataset references for ingested raws.

Raises:

RuntimeError

Raised if the number of exposures found for a photodiode file is not one

timer(name: str, logLevel: int = 10) → Iterator[None]

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.

See also

timer.logInfo

Examples

Creating a timer context:

with self.timer("someCodeToTime"):
    pass  # code to time