lsst.pipe.tasks.read_defects Namespace Reference

Functions
def	read_defects_one_chip (root, chip_name, chip_id)
def	check_metadata (defects, valid_start, instrument, chip_id, f)
def	read_all_defects (root, camera)

Function Documentation

check_metadata()

def lsst.pipe.tasks.read_defects.check_metadata	(		defects,
			valid_start,
			instrument,
			chip_id,
			f
	)

Check that the metadata is complete and self consistent

Parameters
----------
defects : `lsst.meas.algorithms.Defects`
    Object to retrieve metadata from in order to compare with
    metadata inferred from the path.
valid_start : datetime
    Start of the validity range for defects
instrument : str
    Name of the instrument in question
chip_id : int
    Identifier of the sensor in question
f : str
    Path of the file read to produce ``defects``

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 38 of file read_defects.py.

read_all_defects()

def lsst.pipe.tasks.read_defects.read_all_defects	(		root,
			camera
	)

Read all defects from the standard format at a particular root.

Parameters
----------
root : str
    Path to the top level of the defects 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 defects being read.

Returns
-------
dict
    A dictionary of dictionaries of `lsst.meas.algorithms.Defects`.
    The first key is the sensor name, and the second is the validity
    start time as a `datetime` object.

Definition at line 77 of file read_defects.py.

read_defects_one_chip()

def lsst.pipe.tasks.read_defects.read_defects_one_chip	(		root,
			chip_name,
			chip_id
	)

Read defects for a particular sensor from the standard format at a particular root.

Parameters
----------
root : str
    Path to the top level of the defects 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 defects.
chip_id : int
    The identifier for the sensor in question.

Returns
-------
dict
    A dictionary of `lsst.meas.algorithms.Defects`.
    The key is the validity start time as a `datetime` object.

Definition at line 7 of file read_defects.py.