detectorCollection.py

Go to the documentation of this file.

#
# LSST Data Management System
# Copyright 2014 LSST Corporation.
#
# This product includes software developed by the
# LSST Project (http://www.lsst.org/).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the LSST License Statement and
# the GNU General Public License along with this program.  If not,
# see <http://www.lsstcorp.org/LegalNotices/>.
#
from __future__ import absolute_import, division
from lsst.afw.geom import Box2D
from .cameraGeomLib import FOCAL_PLANE

class DetectorCollection(object):
    """!An immutable collection of Detectors that can be accessed by name or ID
    """
    def __init__(self, detectorList):
        """!Construct a DetectorCollection
        
        @param[in] detectorList  a sequence of detectors in index order
        """
        self._idDetectorDict = dict((d.getId(), d) for d in detectorList)
        self._nameDetectorDict = dict((d.getName(), d) for d in detectorList)
        self._fpBBox = Box2D()
        for detector in detectorList:
            for corner in detector.getCorners(FOCAL_PLANE):
                self._fpBBox.include(corner)
        if len(self._idDetectorDict) < len(detectorList):
            raise RuntimeError("Detector IDs are not unique")
        if len(self._nameDetectorDict) < len(detectorList):
            raise RuntimeError("Detector names are not unique")

    def __iter__(self):
        """!Support the iter function: return an iterator over all detectors in this collection
        """
        return self._idDetectorDict.itervalues()

    def __len__(self):
        """!Support the len function: return the number of detectors
        """
        return len(self._idDetectorDict)

    def __getitem__(self, key):
        """!Support the [key] operator: return the specified detector

        @param[in] key  detector name or ID
        """
        if isinstance(key, basestring):
            return self._nameDetectorDict[key]
        else:
            return self._idDetectorDict[key]

    def __contains__(self, key):
        """!Implement the "in" operator: return true if the specified detector is in the collection

        @param[in] key  detector name or ID
        """
        if isinstance(key, basestring):
            return key in self._nameDetectorDict
        else:
            return key in self._idDetectorDict

    def getNameIter(self):
        """!Get an iterator over detector names
        """
        return self._nameDetectorDict.iterkeys()

    def getIdIter(self):
        """!Get an iterator over detector IDs
        """
        return self._idDetectorDict.iterkeys()
    
    def getFpBBox(self):
        """!Return a focal plane bounding box that encompasses all detectors
        """
        return self._fpBBox