lsst.pipe.tasks ga0be0691d8+ae2b9df503
Loading...
Searching...
No Matches
Functions
lsst.pipe.tasks.read_curated_calibs Namespace Reference

Functions

 read_one_chip (root, chip_name, chip_id)
 
 check_metadata (obj, valid_start, instrument, chip_id, filepath, data_name)
 
 read_all (root, camera)
 

Function Documentation

◆ check_metadata()

lsst.pipe.tasks.read_curated_calibs.check_metadata (   obj,
  valid_start,
  instrument,
  chip_id,
  filepath,
  data_name 
)
Check that the metadata is complete and self consistent

Parameters
----------
obj : object of same type as the factory
    Object to retrieve metadata from in order to compare with
    metadata inferred from the path.
valid_start : `datetime`
    Start of the validity range for data
instrument : `str`
    Name of the instrument in question
chip_id : `int`
    Identifier of the sensor in question
filepath : `str`
    Path of the file read to construct the data
data_name : `str`
    Name of the type of data being read

Returns
-------
None

Raises
------
ValueError
    If the metadata from the path and the metadata encoded
    in the path do not match for any reason.

Definition at line 75 of file read_curated_calibs.py.

◆ read_all()

lsst.pipe.tasks.read_curated_calibs.read_all (   root,
  camera 
)
Read all data from the standard format at a particular root.

Parameters
----------
root : `str`
    Path to the top level of the data tree.  This is expected to hold directories
    named after the sensor names.  They are expected to be lower case.
camera : `lsst.afw.cameraGeom.Camera`
    The camera that goes with the data being read.

Returns
-------
dict
    A dictionary of dictionaries of objects constructed with the appropriate factory class.
    The first key is the sensor name lowered, and the second is the validity
    start time as a `datetime` object.

Notes
-----
Each leaf object in the constructed dictionary has metadata associated with it.
The detector ID may be retrieved from the DETECTOR entry of that metadata.

Definition at line 120 of file read_curated_calibs.py.

◆ read_one_chip()

lsst.pipe.tasks.read_curated_calibs.read_one_chip (   root,
  chip_name,
  chip_id 
)
Read data for a particular sensor from the standard format at a particular root.

Parameters
----------
root : `str`
    Path to the top level of the data tree.  This is expected to hold directories
    named after the sensor names.  They are expected to be lower case.
chip_name : `str`
    The name of the sensor for which to read data.
chip_id : `int`
    The identifier for the sensor in question.

Returns
-------
`dict`
    A dictionary of objects constructed from the appropriate factory class.
    The key is the validity start time as a `datetime` object.

Definition at line 33 of file read_curated_calibs.py.