lsst.afw.cameraGeom.fitsUtils.HeaderAmpMap Class Reference

Inheritance diagram for lsst.afw.cameraGeom.fitsUtils.HeaderAmpMap:

Public Member Functions
def	addEntry (self, keyname, attribute_name, default=None, transform=lambda x:x)
def	setAttributes (self, obj, metadata, doRaise=True)

Detailed Description

Class to hold mapping of header cards to AmpInfoTable attributes
    The amp info is stored using setters, thus calling the attribute as a function.

Definition at line 137 of file fitsUtils.py.

Member Function Documentation

addEntry()

def lsst.afw.cameraGeom.fitsUtils.HeaderMap.addEntry (   self,   keyname,   attribute_name,   default = None,   transform = lambda x: x  )

inherited

Adds an entry to the registry.

Parameters
----------
keyname : `str`
    Key used to retrieve the header record.
attribute_name : `str`
    Name of the attribute to store the value in.
default : `object`
    Default value to store if the header card is not available.
transform : `callable`
    Transform to apply to the header value before assigning it to the
    attribute.

Definition at line 81 of file fitsUtils.py.

    def addEntry(self, keyname, attribute_name, default=None, transform=lambda x: x):
        """Adds an entry to the registry.

        Parameters
        ----------
        keyname : `str`
            Key used to retrieve the header record.
        attribute_name : `str`
            Name of the attribute to store the value in.
        default : `object`
            Default value to store if the header card is not available.
        transform : `callable`
            Transform to apply to the header value before assigning it to the
            attribute.
        """
        self.__setitem__(attribute_name, {'keyName': keyname,
                                          'default': default,
                                          'transform': transform})

setAttributes()

def lsst.afw.cameraGeom.fitsUtils.HeaderMap.setAttributes (   self,   obj,   metadata,   doRaise = True  )

inherited

Sets the attributes on the given object given a metadata object.

Parameters
----------
obj : `object`
    Object on which to operate in place.
metadata : `lsst.daf.base.PropertySet`
    Metadata object used for applying the mapping.
doRaise : `bool`
    Raise exceptions on calling methods on the input object that
    do not exist?

Definition at line 100 of file fitsUtils.py.

    def setAttributes(self, obj, metadata, doRaise=True):
        """Sets the attributes on the given object given a metadata object.

        Parameters
        ----------
        obj : `object`
            Object on which to operate in place.
        metadata : `lsst.daf.base.PropertySet`
            Metadata object used for applying the mapping.
        doRaise : `bool`
            Raise exceptions on calling methods on the input object that
            do not exist?
        """
        for key, attrDict in self.items():
            try:
                value = getByKey(metadata, attrDict['keyName'])
                # if attrDict['keyName'] == "RDCRNR" and value == 0:
                #     import ipdb; ipdb.set_trace()
                if value is not None:
                    self._applyVal(obj, value, key, attrDict['transform'])
                else:
                    # Only apply transform if the metadata has a value for this key
                    # otherwise assume the default value is transformed.
                    value = attrDict['default']
                    if value is not None:
                        self._applyVal(obj, value, key, lambda x: x)
            except Exception as e:
                if doRaise:
                    raise
                else:
                    warnings.warn('WARNING: Failed to set %s attribute with %s value: %s' %
                                  (key, value, str(e)))

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/Linux64/afw/18.1.0-22-g936f6a9b4/python/lsst/afw/cameraGeom/fitsUtils.py