lsst::afw::cameraGeom::Detector Class Reference

#include <Detector.h>

Public Member Functions
	Detector (std::string const &name, int id, DetectorType type, std::string const &serial, geom::Box2I const &bbox, lsst::afw::table::AmpInfoCatalog const &ampInfoCatalog, Orientation const &orientation, geom::Extent2D const &pixelSize, CameraTransformMap::Transforms const &Transforms)
	~Detector ()
std::string	getName () const
int	getId () const
DetectorType	getType () const
std::string	getSerial () const
lsst::afw::geom::Box2I	getBBox () const
std::vector< geom::Point2D >	getCorners (CameraSys const &cameraSys) const
std::vector< geom::Point2D >	getCorners (CameraSysPrefix const &cameraSysPrefix) const
CameraPoint	getCenter (CameraSys const &cameraSys) const
CameraPoint	getCenter (CameraSysPrefix const &cameraSysPrefix) const
lsst::afw::table::AmpInfoCatalog const	getAmpInfoCatalog () const
Orientation const	getOrientation () const
geom::Extent2D	getPixelSize () const
CameraTransformMap const	getTransformMap () const
lsst::afw::table::AmpInfoCatalog::const_iterator	begin () const
lsst::afw::table::AmpInfoCatalog::const_iterator	end () const
lsst::afw::table::AmpInfoRecord const &	operator[] (size_t i) const
lsst::afw::table::AmpInfoRecord const &	operator[] (std::string const &name) const
size_t	size () const
CameraPoint	makeCameraPoint (geom::Point2D point, CameraSys cameraSys) const
CameraPoint	makeCameraPoint (geom::Point2D point, CameraSysPrefix cameraSysPrefix) const
CameraSys const	makeCameraSys (CameraSys const &cameraSys) const
CameraSys const	makeCameraSys (CameraSysPrefix const &cameraSysPrefix) const
CameraPoint	transform (CameraPoint const &fromCameraPoint, CameraSys const &toSys) const
CameraPoint	transform (CameraPoint const &fromCameraPoint, CameraSysPrefix const &toSys) const

Private Types
typedef boost::unordered_map < std::string, table::AmpInfoCatalog::const_iterator >	_AmpInfoMap

Private Member Functions
void	_init ()

Private Attributes
std::string	_name
	name of detector's location in the camera More...
int	_id
	detector numeric ID More...
DetectorType	_type
	type of detectorsize_t More...
std::string	_serial
	serial "number" that identifies the physical detector More...
geom::Box2I	_bbox
	bounding box More...
table::AmpInfoCatalog	_ampInfoCatalog
	list of amplifier data More...
_AmpInfoMap	_ampNameIterMap
	map of amplifier name: catalog iterator More...
Orientation	_orientation
	position and orientation of detector in focal plane More...
geom::Extent2D	_pixelSize
	pixel size (mm) More...
CameraTransformMap	_transformMap
	registry of coordinate transforms More...

Detailed Description

Information about a CCD or other imaging detector

Supports conversion of CameraPoint between FOCAL_PLANE and pixel-based coordinate systems. Also an iterator over amplifiers (in C++ use begin(), end(), in Python use "for amplifier in detector").

Todo:

: this would probably be a bit more robust if it used a ConstAmpInfoCatalog (a catalog with const records) but I don't think const catalogs really work yet; for instance it is not possible to construct one from a non-const catalog, so I don't know how to construct one.

Note

: code definitions use lsst::afw::table:: instead of table:: because the latter confused swig when I tried it. This is a known issue: ticket #2461.

Definition at line 64 of file Detector.h.

Member Typedef Documentation

typedef boost::unordered_map<std::string, table::AmpInfoCatalog::const_iterator> lsst::afw::cameraGeom::Detector::_AmpInfoMap

private

Definition at line 220 of file Detector.h.

Constructor & Destructor Documentation

lsst::afw::cameraGeom::Detector::Detector ( std::string const &  name, int  id, DetectorType  type, std::string const &  serial, geom::Box2I const &  bbox, lsst::afw::table::AmpInfoCatalog const &  ampInfoCatalog, Orientation const &  orientation, geom::Extent2D const &  pixelSize, CameraTransformMap::Transforms const &  Transforms  )

explicit

Make a Detector

Warning

* The keys for the detector-specific coordinate systems in the transform registry must include the detector name (even though this is redundant).

Exceptions

lsst::pex::exceptions::InvalidParameterError

if: any amplifier names are not unique any CamerSys in transformMap has a detector name other than "" or this detector's name

Parameters

name	name of detector's location in the camera
id	detector integer ID; used as keys in some tables
type	type of detector
serial	serial "number" that identifies the physical detector
bbox	bounding box
ampInfoCatalog	catalog of amplifier information
orientation	detector position and orientation in focal plane
pixelSize	pixel size (mm)
Transforms	map of CameraSys: XYTranform, where each XYTransform's "forward" method transforms from PIXELS to the specified camera system

Definition at line 31 of file Detector.cc.

  :
    _name(name),
    _id(id),
    _type(type),
    _serial(serial),
    _bbox(bbox),
    _ampInfoCatalog(ampInfoCatalog),
    _ampNameIterMap(),
    _orientation(orientation),
    _pixelSize(pixelSize),
    _transformMap(CameraSys(PIXELS.getSysName(), name), transforms)
{
    _init();
}

lsst::afw::cameraGeom::Detector::~Detector ( )

inline

Definition at line 90 of file Detector.h.

{}

Member Function Documentation

void lsst::afw::cameraGeom::Detector::_init ( )

private

Finish constructing this object

Set _ampNameIterMap from _ampInfoCatalog Check detector name in the CoordSys in the transform registry

Exceptions

lsst::pex::exceptions::InvalidParameterError

if: any amplifier names are not unique any CamerSys in transformMap has a detector name other than "" or this detector's name

Definition at line 84 of file Detector.cc.

                      {
    // make _ampNameIterMap
    for (table::AmpInfoCatalog::const_iterator ampIter = _ampInfoCatalog.begin();
        ampIter != _ampInfoCatalog.end(); ++ampIter) {
        _ampNameIterMap.insert(std::make_pair(ampIter->getName(), ampIter));
    }
    if (_ampNameIterMap.size() != _ampInfoCatalog.size()) {
        throw LSST_EXCEPT(pexExcept::InvalidParameterError,
            "Invalid ampInfoCatalog: not all amplifier names are unique");
    }

    // check detector name in CoordSys in transform registry
    for (CameraTransformMap::Transforms::const_iterator trIter = _transformMap.begin();
        trIter != _transformMap.end(); ++trIter) {
            if (trIter->first.hasDetectorName() && trIter->first.getDetectorName() != _name) {
                std::ostringstream os;
                os << "Invalid transformMap: " << trIter->first << " detector name != \"" << _name << "\"";
                throw LSST_EXCEPT(pexExcept::InvalidParameterError, os.str());
            }
    }
}

lsst::afw::table::AmpInfoCatalog::const_iterator lsst::afw::cameraGeom::Detector::begin ( ) const

inline

Get iterator to beginning of amplifier list

Definition at line 131 of file Detector.h.

{ return _ampInfoCatalog.begin(); }

lsst::afw::table::AmpInfoCatalog::const_iterator lsst::afw::cameraGeom::Detector::end ( ) const

inline

Get iterator to end of amplifier list

Definition at line 134 of file Detector.h.

{ return _ampInfoCatalog.end(); }

lsst::afw::table::AmpInfoCatalog const lsst::afw::cameraGeom::Detector::getAmpInfoCatalog ( ) const

inline

Get the amplifier information catalog

Definition at line 119 of file Detector.h.

{ return _ampInfoCatalog; }

lsst::afw::geom::Box2I lsst::afw::cameraGeom::Detector::getBBox ( ) const

inline

Get the bounding box

Definition at line 104 of file Detector.h.

{ return _bbox; }

CameraPoint lsst::afw::cameraGeom::Detector::getCenter

(

CameraSys const &

cameraSys

)

const

Get the center of the detector in the specified coordinate system

Definition at line 65 of file Detector.cc.

                                                                {
    CameraPoint ctrPix = makeCameraPoint(geom::Box2D(_bbox).getCenter(), _transformMap.getNativeCoordSys());
    return transform(ctrPix, cameraSys);
}

CameraPoint lsst::afw::cameraGeom::Detector::getCenter

(

CameraSysPrefix const &

cameraSysPrefix

)

const

Get the center of the detector in the specified coordinate system prefix

Definition at line 70 of file Detector.cc.

                                                                            {
    return getCenter(makeCameraSys(cameraSysPrefix));
}

std::vector< geom::Point2D > lsst::afw::cameraGeom::Detector::getCorners

(

CameraSys const &

cameraSys

)

const

Get the corners of the detector in the specified coordinate system

Definition at line 56 of file Detector.cc.

                                                                            {
    std::vector<geom::Point2D> fromVec = geom::Box2D(_bbox).getCorners();
    return _transformMap.transform(fromVec, _transformMap.getNativeCoordSys(), cameraSys);
}

std::vector< geom::Point2D > lsst::afw::cameraGeom::Detector::getCorners

(

CameraSysPrefix const &

cameraSysPrefix

)

const

Get the corners of the detector in the specified coordinate system prefix

Definition at line 61 of file Detector.cc.

                                                                                        {
    return getCorners(makeCameraSys(cameraSysPrefix));
}

int lsst::afw::cameraGeom::Detector::getId ( ) const

inline

Get the detector ID

Definition at line 96 of file Detector.h.

{ return _id; }

std::string lsst::afw::cameraGeom::Detector::getName ( ) const

inline

Get the detector name

Definition at line 93 of file Detector.h.

{ return _name; }

Orientation const lsst::afw::cameraGeom::Detector::getOrientation ( ) const

inline

Get detector's orientation in the focal plane

Definition at line 122 of file Detector.h.

{ return _orientation; }

geom::Extent2D lsst::afw::cameraGeom::Detector::getPixelSize ( ) const

inline

Get size of pixel along (mm)

Definition at line 125 of file Detector.h.

{ return _pixelSize; }

std::string lsst::afw::cameraGeom::Detector::getSerial ( ) const

inline

Get the detector serial "number"

Definition at line 101 of file Detector.h.

{ return _serial; }

CameraTransformMap const lsst::afw::cameraGeom::Detector::getTransformMap ( ) const

inline

Get the transform registry

Definition at line 128 of file Detector.h.

{ return _transformMap; }

DetectorType lsst::afw::cameraGeom::Detector::getType ( void  ) const

inline

Definition at line 98 of file Detector.h.

{ return _type; }

CameraPoint lsst::afw::cameraGeom::Detector::makeCameraPoint ( geom::Point2D  point, CameraSys  cameraSys  ) const

inline

Make a CameraPoint from a point and a camera system

Note

the CameraSysPrefix version needs the detector name, which is why this is not static.

Parameters

point	2-d point
cameraSys	coordinate system

Definition at line 160 of file Detector.h.

            {
        return CameraPoint(point, cameraSys);
    }

CameraPoint lsst::afw::cameraGeom::Detector::makeCameraPoint ( geom::Point2D  point, CameraSysPrefix  cameraSysPrefix  ) const

inline

Make a CameraPoint from a point and a camera system prefix

Parameters

point	2-d point
cameraSysPrefix	coordinate system prefix

Definition at line 170 of file Detector.h.

            {
        return CameraPoint(point, makeCameraSys(cameraSysPrefix));
    }

CameraSys const lsst::afw::cameraGeom::Detector::makeCameraSys ( CameraSys const &  cameraSys ) const

inline

Get a coordinate system from a coordinate system (return input unchanged and untested)

Note

the CameraSysPrefix version needs the detector name, which is why this is not static.

Definition at line 182 of file Detector.h.

{ return cameraSys; }

CameraSys const lsst::afw::cameraGeom::Detector::makeCameraSys ( CameraSysPrefix const &  cameraSysPrefix ) const

inline

Get a coordinate system from a detector system prefix (add detector name)

Definition at line 187 of file Detector.h.

                                                                                {
        return CameraSys(cameraSysPrefix.getSysName(), _name);
    }

lsst::afw::table::AmpInfoRecord const& lsst::afw::cameraGeom::Detector::operator[] ( size_t  i ) const

inline

Get the amplifier specified by index

Exceptions

std::out_of_range)

if index is out of range

Definition at line 141 of file Detector.h.

{ return _ampInfoCatalog.at(i); }

const table::AmpInfoRecord & lsst::afw::cameraGeom::Detector::operator[]

(

std::string const &

name

)

const

Get the amplifier specified by name

Exceptions

lst::pex::exceptions::InvalidParameterError

if no such amplifier

Definition at line 74 of file Detector.cc.

                                                                           {
    _AmpInfoMap::const_iterator ampIter = _ampNameIterMap.find(name);
    if (ampIter == _ampNameIterMap.end()) {
        std::ostringstream os;
        os << "Unknown amplifier \"" << name << "\"";
        throw LSST_EXCEPT(pexExcept::InvalidParameterError, os.str());
    }
    return *(ampIter->second);
}

size_t lsst::afw::cameraGeom::Detector::size ( ) const

inline

Get number of amplifiers. Renamed to __len__ in Python.

Definition at line 153 of file Detector.h.

{return _ampInfoCatalog.size(); }

CameraPoint lsst::afw::cameraGeom::Detector::transform ( CameraPoint const &  fromCameraPoint, CameraSys const &  toSys  ) const

inline

Convert a CameraPoint from one coordinate system to another

Exceptions

pexExcept::InvalidParameterError

if from or to coordinate system is unknown

Parameters

fromCameraPoint	camera point to transform
toSys	coordinate system to which to transform

Definition at line 196 of file Detector.h.

            {
        return CameraPoint(
            _transformMap.transform(fromCameraPoint.getPoint(), fromCameraPoint.getCameraSys(), toSys),
            toSys);
    }

CameraPoint lsst::afw::cameraGeom::Detector::transform ( CameraPoint const &  fromCameraPoint, CameraSysPrefix const &  toSys  ) const

inline

Convert a CameraPoint from one coordinate system to a coordinate system prefix

The coordinate system prefix is filled in with this detector's name

Exceptions

pexExcept::InvalidParameterError

if from or to coordinate system is unknown

Parameters

fromCameraPoint	camera point to transform
toSys	coordinate system prefix to which to transform

Definition at line 212 of file Detector.h.

            {
        return transform(fromCameraPoint, makeCameraSys(toSys));
    }

Member Data Documentation

table::AmpInfoCatalog lsst::afw::cameraGeom::Detector::_ampInfoCatalog

private

list of amplifier data

Definition at line 238 of file Detector.h.

_AmpInfoMap lsst::afw::cameraGeom::Detector::_ampNameIterMap

private

map of amplifier name: catalog iterator

Definition at line 239 of file Detector.h.

geom::Box2I lsst::afw::cameraGeom::Detector::_bbox

private

bounding box

Definition at line 237 of file Detector.h.

int lsst::afw::cameraGeom::Detector::_id

private

detector numeric ID

Definition at line 234 of file Detector.h.

std::string lsst::afw::cameraGeom::Detector::_name

private

name of detector's location in the camera

Definition at line 233 of file Detector.h.

Orientation lsst::afw::cameraGeom::Detector::_orientation

private

position and orientation of detector in focal plane

Definition at line 240 of file Detector.h.

geom::Extent2D lsst::afw::cameraGeom::Detector::_pixelSize

private

pixel size (mm)

Definition at line 241 of file Detector.h.

std::string lsst::afw::cameraGeom::Detector::_serial

private

serial "number" that identifies the physical detector

Definition at line 236 of file Detector.h.

CameraTransformMap lsst::afw::cameraGeom::Detector::_transformMap

private

registry of coordinate transforms

Definition at line 242 of file Detector.h.

DetectorType lsst::afw::cameraGeom::Detector::_type

private

type of detectorsize_t

Definition at line 235 of file Detector.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/afw/master-gae20e2b580+3/include/lsst/afw/cameraGeom/Detector.h
• /lsst/home/lsstsw/stack/Linux64/afw/master-gae20e2b580+3/src/cameraGeom/Detector.cc