lsst.afw.cameraGeom.fitsUtils Namespace Reference

Classes
class	DetectorBuilder
class	HeaderAmpMap
class	HeaderDetectorMap
class	HeaderMap

Functions
def	getByKey (metadata, key)
def	setByKey (metadata, key, value, clobber)

Function Documentation

getByKey()

def lsst.afw.cameraGeom.fitsUtils.getByKey	(		metadata,
			key
	)

Wrapper for getting a value from a metadata object by key.

Parameters
----------
metadata : `lsst.daf.base.PropertySet`
    Metadata object to query for value.
key : `str`
    Key to use for value lookup.

   Returns
   -------
   value : `object`
   Value associated with key, None if key does not exist.

Definition at line 36 of file fitsUtils.py.

def getByKey(metadata, key):
    """Wrapper for getting a value from a metadata object by key.

    Parameters
    ----------
    metadata : `lsst.daf.base.PropertySet`
        Metadata object to query for value.
    key : `str`
        Key to use for value lookup.

   Returns
   -------
   value : `object`
       Value associated with key, None if key does not exist.
    """
    mdKeys = metadata.paramNames()
    if key in mdKeys:
        return metadata.getScalar(key)
    else:
        return None

setByKey()

def lsst.afw.cameraGeom.fitsUtils.setByKey	(		metadata,
			key,
			value,
			clobber
	)

Wrapper for setting a value in a metadata object.  Deals with case
where the key already exists.

Parameters
----------
metadata : `lsst.daf.base.PropertySet`
    Metadata object ot modify in place.
key : `str`
    Key to associate with value.
value : `object`
    Value to assign in the metadata object.
clobber : `bool`
    Clobber the value if the key already exists?

Definition at line 58 of file fitsUtils.py.

def setByKey(metadata, key, value, clobber):
    """Wrapper for setting a value in a metadata object.  Deals with case
    where the key already exists.

    Parameters
    ----------
    metadata : `lsst.daf.base.PropertySet`
        Metadata object ot modify in place.
    key : `str`
        Key to associate with value.
    value : `object`
        Value to assign in the metadata object.
    clobber : `bool`
        Clobber the value if the key already exists?
    """
    mdKeys = metadata.paramNames()
    if key not in mdKeys or (key in mdKeys and clobber):
        metadata.set(key, value)