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

Information about a CCD or other imaging detector. More...

#include <Detector.h>

Inheritance diagram for lsst::afw::cameraGeom::Detector:

Public Types
typedef ndarray::Array< float const, 2 >	CrosstalkMatrix

Public Member Functions
	Detector (std::string const &name, int id, DetectorType type, std::string const &serial, lsst::geom::Box2I const &bbox, lsst::afw::table::AmpInfoCatalog const &ampInfoCatalog, Orientation const &orientation, lsst::geom::Extent2D const &pixelSize, TransformMap::Transforms const &transforms, CrosstalkMatrix const &crosstalk=CrosstalkMatrix(), std::string const &physicalType="")
	Make a Detector. More...
	Detector (std::string const &name, int id, DetectorType type, std::string const &serial, lsst::geom::Box2I const &bbox, lsst::afw::table::AmpInfoCatalog const &ampInfoCatalog, Orientation const &orientation, lsst::geom::Extent2D const &pixelSize, std::shared_ptr< TransformMap const > transformMap, CrosstalkMatrix const &crosstalk=CrosstalkMatrix(), std::string const &physicalType="")
	Make a Detector. More...
	~Detector ()=default
	Detector (Detector const &)=delete
	Detector (Detector &&)=delete
Detector &	operator= (Detector const &)=delete
Detector &	operator= (Detector &&)=delete
std::string	getName () const
	Get the detector name. More...
int	getId () const
	Get the detector ID. More...
DetectorType	getType () const
	Get the "type" (really purpose) of the Detector. More...
std::string	getPhysicalType () const
	Get information about the physical type of the device (e.g. More...
std::string	getSerial () const
	Get the detector serial "number". More...
lsst::geom::Box2I	getBBox () const
	Get the bounding box. More...
std::vector< lsst::geom::Point2D >	getCorners (CameraSys const &cameraSys) const
	Get the corners of the detector in the specified camera coordinate system. More...
std::vector< lsst::geom::Point2D >	getCorners (CameraSysPrefix const &cameraSysPrefix) const
	Get the corners of the detector in the specified camera coordinate system prefix. More...
lsst::geom::Point2D	getCenter (CameraSys const &cameraSys) const
	Get the center of the detector in the specified camera coordinate system. More...
lsst::geom::Point2D	getCenter (CameraSysPrefix const &cameraSysPrefix) const
	Get the center of the detector in the specified camera coordinate system prefix. More...
table::AmpInfoCatalog const	getAmpInfoCatalog () const
	Get the amplifier information catalog. More...
Orientation const	getOrientation () const
	Get detector's orientation in the focal plane. More...
lsst::geom::Extent2D	getPixelSize () const
	Get size of pixel along (mm) More...
std::shared_ptr< TransformMap const >	getTransformMap () const
	Get the transform registry. More...
bool	hasCrosstalk () const
	Have we got crosstalk coefficients? More...
CrosstalkMatrix const	getCrosstalk () const
	Get the crosstalk coefficients. More...
table::AmpInfoCatalog::const_iterator	begin () const
	Get iterator to beginning of amplifier list. More...
table::AmpInfoCatalog::const_iterator	end () const
	Get iterator to end of amplifier list. More...
table::AmpInfoRecord const &	operator[] (size_t i) const
	Get the amplifier specified by index. More...
table::AmpInfoRecord const &	operator[] (std::string const &name) const
	Get the amplifier specified by name. More...
std::shared_ptr< table::AmpInfoRecord const >	_get (int i) const
	Get the amplifier specified by index, returning a shared pointer to an AmpInfo record. More...
std::shared_ptr< table::AmpInfoRecord const >	_get (std::string const &name) const
	Get the amplifier specified by name, returning a shared pointer to an AmpInfo record. More...
size_t	size () const
	Get the number of amplifiers. More...
bool	hasTransform (CameraSys const &cameraSys) const
	Can this object convert between PIXELS and the specified camera coordinate system? More...
bool	hasTransform (CameraSysPrefix const &cameraSysPrefix) const
	Can this object convert between PIXELS and the specified camera coordinate system prefix? More...
template<typename FromSysT , typename ToSysT >
std::shared_ptr< afw::geom::TransformPoint2ToPoint2 >	getTransform (FromSysT const &fromSys, ToSysT const &toSys) const
	Get a Transform from one camera coordinate system, or camera coordinate system prefix, to another. More...
CameraSys const	makeCameraSys (CameraSys const &cameraSys) const
	Get a coordinate system from a coordinate system (return input unchanged and untested) More...
CameraSys const	makeCameraSys (CameraSysPrefix const &cameraSysPrefix) const
	Get a coordinate system from a detector system prefix (add detector name) More...
template<typename FromSysT , typename ToSysT >
lsst::geom::Point2D	transform (lsst::geom::Point2D const &point, FromSysT const &fromSys, ToSysT const &toSys) const
	Transform a point from one camera system to another. More...
template<typename FromSysT , typename ToSysT >
std::vector< lsst::geom::Point2D >	transform (std::vector< lsst::geom::Point2D > const &points, FromSysT const &fromSys, ToSysT const &toSys) const
	Transform a vector of points from one camera system to another. More...
CameraSys	getNativeCoordSys () const
	The "native" coordinate system of this detector. More...
bool	isPersistable () const noexcept override
	Detectors are always peristable. More...
template<typename FromSysT , typename ToSysT >
std::shared_ptr< geom::TransformPoint2ToPoint2 >	getTransform (FromSysT const &fromSys, ToSysT const &toSys) const
virtual std::shared_ptr< Storable >	cloneStorable () const
	Create a new object that is a copy of this one (optional operation). More...
virtual std::string	toString () const
	Create a string representation of this object (optional operation). More...
virtual std::size_t	hash_value () const
	Return a hash of this object (optional operation). More...
virtual bool	equals (Storable const &other) const noexcept
	Compare this object to another Storable. More...
void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file. More...
void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory. More...
void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object. More...

Static Public Member Functions
static std::shared_ptr< Detector >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...
static std::shared_ptr< Detector >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file. More...
static std::shared_ptr< Detector >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory. More...
static std::shared_ptr< Detector >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr. More...

Protected Types
typedef io::OutputArchiveHandle	OutputArchiveHandle

Static Protected Member Functions
template<class T >
static bool	singleClassEquals (T const &lhs, Storable const &rhs)
	Test if a Storable is of a particular class and equal to another object. More...

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &os, Storable const &storable)
	Output operator for Storable. More...

Detailed Description

Information about a CCD or other imaging detector.

Supports transformation of points 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.

Definition at line 62 of file Detector.h.

Member Typedef Documentation

CrosstalkMatrix

typedef ndarray::Array<float const, 2> lsst::afw::cameraGeom::Detector::CrosstalkMatrix

Definition at line 64 of file Detector.h.

OutputArchiveHandle

typedef io::OutputArchiveHandle lsst::afw::table::io::Persistable::OutputArchiveHandle

protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

Detector() [1/4]

lsst::afw::cameraGeom::Detector::Detector	(	std::string const &	name,
		int	id,
		DetectorType	type,
		std::string const &	serial,
		lsst::geom::Box2I const &	bbox,
		lsst::afw::table::AmpInfoCatalog const &	ampInfoCatalog,
		Orientation const &	orientation,
		lsst::geom::Extent2D const &	pixelSize,
		TransformMap::Transforms const &	transforms,
		CrosstalkMatrix const &	crosstalk = CrosstalkMatrix(),
		std::string const &	physicalType = ""
	)

Make a Detector.

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: afw::geom::Transform, where each Transform's forward transform transforms from PIXELS to the specified camera system
crosstalk	matrix of crosstalk coefficients
physicalType	detector type, e.g. "CCD", "ITL-A", "HgCdTe"

Exceptions

lsst::pex::exceptions::InvalidParameterError

if any amplifier names are not unique

Warning

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

Definition at line 36 of file Detector.cc.

                                                  :
    Detector(name, id, type, serial, bbox, ampInfoCatalog, orientation, pixelSize,
             TransformMap::make(CameraSys(PIXELS, name), transforms),
             crosstalk, physicalType)
{}

Detector() [2/4]

lsst::afw::cameraGeom::Detector::Detector	(	std::string const &	name,
		int	id,
		DetectorType	type,
		std::string const &	serial,
		lsst::geom::Box2I const &	bbox,
		lsst::afw::table::AmpInfoCatalog const &	ampInfoCatalog,
		Orientation const &	orientation,
		lsst::geom::Extent2D const &	pixelSize,
		std::shared_ptr< TransformMap const >	transformMap,
		CrosstalkMatrix const &	crosstalk = CrosstalkMatrix(),
		std::string const &	physicalType = ""
	)

Make a Detector.

Parameters

name	name of detector's location in the camera
id	detector integer ID; used as keys in some tables
type	function of detector (e.g. SCIENCE, WAVEFRONT)
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)
transformMap	coordinate systems and transforms between them
crosstalk	matrix of crosstalk coefficients
physicalType	detector type, e.g. "CCD", "ITL-A", "HgCdTe"

Exceptions

lsst::pex::exceptions::InvalidParameterError

if: any amplifier names are not unique

Definition at line 46 of file Detector.cc.

                                                  :
    _name(name),
    _id(id),
    _type(type),
    _serial(serial),
    _bbox(bbox),
    _ampInfoCatalog(ampInfoCatalog),
    _ampNameIterMap(),
    _orientation(orientation),
    _pixelSize(pixelSize),
    _nativeSys(CameraSys(PIXELS, name)),
    _transformMap(std::move(transformMap)),
    _crosstalk(crosstalk),
    _physicalType(physicalType)
{
    // make _ampNameIterMap
    for (auto 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");
    }

    // ensure crosstalk coefficients matrix is square
    if (hasCrosstalk()) {
        auto shape = _crosstalk.getShape();
        assert(shape.size() == 2);  // we've declared this as a 2D array
        if (shape[0] != shape[1]) {
            std::ostringstream os;
            os << "Non-square crosstalk matrix: " << _crosstalk << " for detector \"" << _name << "\"";
            throw LSST_EXCEPT(pexExcept::InvalidParameterError, os.str());
        }
        if (shape[0] != _ampInfoCatalog.size()) {
            std::ostringstream os;
            os << "Wrong size crosstalk matrix: " << _crosstalk << " for detector \"" << _name << "\"";
            throw LSST_EXCEPT(pexExcept::InvalidParameterError, os.str());
        }
    }
}

~Detector()

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

default

Detector() [3/4]

lsst::afw::cameraGeom::Detector::Detector ( Detector const &  )

delete

Detector() [4/4]

lsst::afw::cameraGeom::Detector::Detector ( Detector &&  )

delete

Member Function Documentation

_get() [1/2]

std::shared_ptr< table::AmpInfoRecord const > lsst::afw::cameraGeom::Detector::_get

(

int

i

)

const

Get the amplifier specified by index, returning a shared pointer to an AmpInfo record.

Warning

Intended only for use by pybind11. This exists because Operator[] returns a data type that is difficult for pybind11 to use. Since we have it, we also take advantage of the fact that it is only for pybind11 to support negative indices in the python style.

Parameters

[in]

i

Ampifier index; if < 0 then treat as an offset from the end (the Python convention)

Exceptions

std::out_of_range

if index is out of range

Definition at line 113 of file Detector.cc.

                                                                  {
    if (i < 0) {
        i = _ampInfoCatalog.size() + i;
    };
    return _ampInfoCatalog.get(i);
}

_get() [2/2]

std::shared_ptr< table::AmpInfoRecord const > lsst::afw::cameraGeom::Detector::_get

(

std::string const &

name

)

const

Get the amplifier specified by name, returning a shared pointer to an AmpInfo record.

Warning

Intended only for internal and pybind11 use. This exists because Operator[] returns a data type that is difficult for pybind11 to use.

Parameters

[in]

name

Amplifier name

Exceptions

std::out_of_range

if index is out of range

Definition at line 120 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;
}

begin()

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

inline

Get iterator to beginning of amplifier list.

Definition at line 180 of file Detector.h.

{ return _ampInfoCatalog.begin(); }

cloneStorable()

std::shared_ptr< Storable > lsst::afw::typehandling::Storable::cloneStorable ( ) const

virtualinherited

Create a new object that is a copy of this one (optional operation).

This operation is required for Storables that are stored in GenericMap by value, but not for those stored by shared pointer.

Exceptions

UnsupportedOperationException

Thrown if this object is not cloneable.

Note

If this class supports a clone operation, the two should behave identically except for the formal return type.

Reimplemented in lsst::afw::image::PhotoCalib, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, lsst::afw::image::Filter, lsst::afw::image::VisitInfo, lsst::afw::detection::Psf, lsst::afw::image::ApCorrMap, and lsst::afw::image::CoaddInputs.

Definition at line 36 of file Storable.cc.

                                                      {
    throw LSST_EXCEPT(UnsupportedOperationException, "Cloning is not supported.");
}

dynamicCast()

template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< Detector >::dynamicCast ( std::shared_ptr< Persistable > const &  ptr )

staticinherited

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions

lsst::pex::exceptions::LogicError

if the cast fails

param[in] ptr The pointer to be cast.

Returns

The cast pointer.

Exceptions

lsst::pex::exceptions::TypeError

If the dynamic cast fails.

Definition at line 18 of file Persistable.cc.

                                                                                        {
    auto result = std::dynamic_pointer_cast<T>(ptr);
    if (!result) {
        throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
    }
    return result;
}

end()

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

inline

Get iterator to end of amplifier list.

Definition at line 183 of file Detector.h.

{ return _ampInfoCatalog.end(); }

equals()

bool lsst::afw::typehandling::Storable::equals ( Storable const &  other ) const

virtualnoexceptinherited

Compare this object to another Storable.

Subclasses that implement equality comparison must override this method to give results consistent with operator== for all inputs that are accepted by both.

Returns

This implementation returns whether the two objects are the same.

Warning

This method compares an object to any type of Storable, although cross-class comparisons should usually return false. If cross-class comparisons are valid, implementers should take care that they are symmetric and will give the same result no matter what the compile-time types of the left- and right-hand sides are.

See also

singleClassEquals

Reimplemented in lsst::afw::image::PhotoCalib, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, lsst::afw::image::Filter, and lsst::afw::image::VisitInfo.

Definition at line 48 of file Storable.cc.

{ return this == &other; }

getAmpInfoCatalog()

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

inline

Get the amplifier information catalog.

Definition at line 160 of file Detector.h.

{ return _ampInfoCatalog; }

getBBox()

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

inline

Get the bounding box.

Definition at line 145 of file Detector.h.

{ return _bbox; }

getCenter() [1/2]

lsst::geom::Point2D lsst::afw::cameraGeom::Detector::getCenter

(

CameraSys const &

cameraSys

)

const

Get the center of the detector in the specified camera coordinate system.

Definition at line 101 of file Detector.cc.

                                                                    {
    auto ctrPix = lsst::geom::Box2D(_bbox).getCenter();
    auto transform = getTransform(PIXELS, cameraSys);
    return transform->applyForward(ctrPix);
}

getCenter() [2/2]

lsst::geom::Point2D lsst::afw::cameraGeom::Detector::getCenter

(

CameraSysPrefix const &

cameraSysPrefix

)

const

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

Definition at line 107 of file Detector.cc.

                                                                                {
    return getCenter(makeCameraSys(cameraSysPrefix));
}

getCorners() [1/2]

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

(

CameraSys const &

cameraSys

)

const

Get the corners of the detector in the specified camera coordinate system.

Definition at line 91 of file Detector.cc.

                                                                                {
    std::vector<lsst::geom::Point2D> nativeCorners = lsst::geom::Box2D(_bbox).getCorners();
    auto nativeToCameraSys = _transformMap->getTransform(_nativeSys, cameraSys);
    return nativeToCameraSys->applyForward(nativeCorners);
}

getCorners() [2/2]

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

(

CameraSysPrefix const &

cameraSysPrefix

)

const

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

Definition at line 97 of file Detector.cc.

                                                                                            {
    return getCorners(makeCameraSys(cameraSysPrefix));
}

getCrosstalk()

CrosstalkMatrix const lsst::afw::cameraGeom::Detector::getCrosstalk ( ) const

inline

Get the crosstalk coefficients.

Definition at line 177 of file Detector.h.

{ return _crosstalk; }

getId()

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

inline

Get the detector ID.

Definition at line 133 of file Detector.h.

{ return _id; }

getName()

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

inline

Get the detector name.

Definition at line 130 of file Detector.h.

{ return _name; }

getNativeCoordSys()

CameraSys lsst::afw::cameraGeom::Detector::getNativeCoordSys ( ) const

inline

The "native" coordinate system of this detector.

Definition at line 305 of file Detector.h.

{ return _nativeSys; }

getOrientation()

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

inline

Get detector's orientation in the focal plane.

Definition at line 163 of file Detector.h.

{ return _orientation; }

getPhysicalType()

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

inline

Get information about the physical type of the device (e.g.

CCD, E2V, ITL-A, HgCdTe)

Definition at line 139 of file Detector.h.

{ return _physicalType; }

getPixelSize()

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

inline

Get size of pixel along (mm)

Definition at line 166 of file Detector.h.

{ return _pixelSize; }

getSerial()

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

inline

Get the detector serial "number".

Definition at line 142 of file Detector.h.

{ return _serial; }

getTransform() [1/2]

template<typename FromSysT , typename ToSysT >

std::shared_ptr<geom::TransformPoint2ToPoint2> lsst::afw::cameraGeom::Detector::getTransform	(	FromSysT const &	fromSys,
		ToSysT const &	toSys
	)		const

Definition at line 137 of file Detector.cc.

                                                                                                 {
    return _transformMap->getTransform(makeCameraSys(fromSys), makeCameraSys(toSys));
}

getTransform() [2/2]

template<typename FromSysT , typename ToSysT >

std::shared_ptr<afw::geom::TransformPoint2ToPoint2> lsst::afw::cameraGeom::Detector::getTransform	(	FromSysT const &	fromSys,
		ToSysT const &	toSys
	)		const

Get a Transform from one camera coordinate system, or camera coordinate system prefix, to another.

Template Parameters

FromSysT,ToSysT

Type of fromSys, toSys: one of CameraSys or CameraSysPrefix

Parameters

fromSys,toSys

camera coordinate systems or prefixes between which to transform

Returns

a Transform that converts from fromSys to toSys in the forward direction. The Transform will be invertible.

Exceptions

lsst::pex::exceptions::InvalidParameterError

Thrown if either fromSys or toSys is not supported.

getTransformMap()

std::shared_ptr<TransformMap const> lsst::afw::cameraGeom::Detector::getTransformMap ( ) const

inline

Get the transform registry.

Definition at line 169 of file Detector.h.

{ return _transformMap; }

getType()

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

inline

Get the "type" (really purpose) of the Detector.

Definition at line 136 of file Detector.h.

{ return _type; }

hasCrosstalk()

bool lsst::afw::cameraGeom::Detector::hasCrosstalk ( ) const

inline

Have we got crosstalk coefficients?

Definition at line 172 of file Detector.h.

                              {
        return !(_crosstalk.isEmpty() || _crosstalk.getShape() == ndarray::makeVector(0, 0));
    }

hash_value()

std::size_t lsst::afw::typehandling::Storable::hash_value ( ) const

virtualinherited

Return a hash of this object (optional operation).

Exceptions

UnsupportedOperationException

Thrown if this object is not hashable.

Note

Subclass authors are responsible for any associated specializations of std::hash.

Reimplemented in lsst::afw::image::Filter, lsst::afw::geom::polygon::Polygon, and lsst::afw::image::VisitInfo.

Definition at line 44 of file Storable.cc.

                                     {
    throw LSST_EXCEPT(UnsupportedOperationException, "Hashes are not supported.");
}

hasTransform() [1/2]

bool lsst::afw::cameraGeom::Detector::hasTransform

(

CameraSys const &

cameraSys

)

const

Can this object convert between PIXELS and the specified camera coordinate system?

Definition at line 130 of file Detector.cc.

{ return _transformMap->contains(cameraSys); }

hasTransform() [2/2]

bool lsst::afw::cameraGeom::Detector::hasTransform

(

CameraSysPrefix const &

cameraSysPrefix

)

const

Can this object convert between PIXELS and the specified camera coordinate system prefix?

Definition at line 132 of file Detector.cc.

                                                                        {
    return hasTransform(makeCameraSys(cameraSysPrefix));
}

isPersistable()

bool lsst::afw::cameraGeom::Detector::isPersistable ( ) const

inlineoverridevirtualnoexcept

Detectors are always peristable.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 308 of file Detector.h.

{ return true; }

makeCameraSys() [1/2]

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)

Parameters

[in]

cameraSys

Camera coordinate system

Returns

cameraSys unchanged

Note

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

Definition at line 260 of file Detector.h.

{ return cameraSys; }

makeCameraSys() [2/2]

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

inline

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

Parameters

[in]

cameraSysPrefix

Camera coordinate system prefix

Returns

cameraSysPrefix with the detector name added

Definition at line 268 of file Detector.h.

                                                                                {
        return CameraSys(cameraSysPrefix, _name);
    }

operator=() [1/2]

Detector& lsst::afw::cameraGeom::Detector::operator= ( Detector const &  )

delete

operator=() [2/2]

Detector& lsst::afw::cameraGeom::Detector::operator= ( Detector &&  )

delete

operator[]() [1/2]

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 190 of file Detector.h.

{ return _ampInfoCatalog.at(i); }

operator[]() [2/2]

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

(

std::string const &

name

)

const

Get the amplifier specified by name.

Exceptions

lsst::pex::exceptions::InvalidParameterError

if no such amplifier

Definition at line 111 of file Detector.cc.

{ return *(_get(name)); }

readFits() [1/3]

static std::shared_ptr<Detector > lsst::afw::table::io::PersistableFacade< Detector >::readFits ( fits::Fits &  fitsfile )

inlinestaticinherited

Read an object from an already open FITS object.

Parameters

[in]

fitsfile

FITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

                                                         {
        return dynamicCast(Persistable::_readFits(fitsfile));
    }

readFits() [2/3]

static std::shared_ptr<Detector > lsst::afw::table::io::PersistableFacade< Detector >::readFits ( std::string const &  fileName, int  hdu = fits::DEFAULT_HDU  )

inlinestaticinherited

Read an object from a regular FITS file.

Parameters

[in]	fileName	Name of the file to read.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

                                                                                           {
        return dynamicCast(Persistable::_readFits(fileName, hdu));
    }

readFits() [3/3]

static std::shared_ptr<Detector > lsst::afw::table::io::PersistableFacade< Detector >::readFits ( fits::MemFileManager &  manager, int  hdu = fits::DEFAULT_HDU  )

inlinestaticinherited

Read an object from a FITS file in memory.

Parameters

[in]	manager	Manager for the memory to read from.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

                                                                                             {
        return dynamicCast(Persistable::_readFits(manager, hdu));
    }

singleClassEquals()

template<class T >

static bool lsst::afw::typehandling::Storable::singleClassEquals ( T const &  lhs, Storable const &  rhs  )

inlinestaticprotectedinherited

Test if a Storable is of a particular class and equal to another object.

This method template simplifies implementations of equals that delegate to operator== without supporting cross-class comparisons.

Template Parameters

T	The class expected of the two objects to be compared.

Parameters

lhs,rhs

The objects to compare. Note that rhs need not be a T, while lhs must be.

Returns

true if rhs is a T and lhs == rhs; false otherwise.

Exception Safety

Provides the same level of exception safety as operator==. Most implementations of operator== do not throw.

Note

This method template calls operator== with both arguments of compile-time type T const&. Its use is not recommended if there would be any ambiguity as to which operator== gets picked by overload resolution.

This method template is typically called from equals as:

bool MyType::equals(Storable const& other) const noexcept {
    return singleClassEquals(*this, other);
}

Definition at line 136 of file Storable.h.

                                                                     {
        auto typedRhs = dynamic_cast<T const*>(&rhs);
        if (typedRhs != nullptr) {
            return lhs == *typedRhs;
        } else {
            return false;
        }
    }

size()

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

inline

Get the number of amplifiers.

Renamed to __len__ in Python.

Definition at line 228 of file Detector.h.

{ return _ampInfoCatalog.size(); }

toString()

std::string lsst::afw::typehandling::Storable::toString ( ) const

virtualinherited

Create a string representation of this object (optional operation).

Exceptions

UnsupportedOperationException

Thrown if this object does not have a string representation.

Reimplemented in lsst::afw::image::PhotoCalib, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, and lsst::afw::image::VisitInfo.

Definition at line 40 of file Storable.cc.

                                   {
    throw LSST_EXCEPT(UnsupportedOperationException, "No string representation available.");
}

transform() [1/2]

template<typename FromSysT , typename ToSysT >

lsst::geom::Point2D lsst::afw::cameraGeom::Detector::transform	(	lsst::geom::Point2D const &	point,
		FromSysT const &	fromSys,
		ToSysT const &	toSys
	)		const

Transform a point from one camera system to another.

Template Parameters

FromSysT	Class of fromSys: one of CameraSys or CameraSysPrefix
ToSysT	Class of toSys: one of CameraSys or CameraSysPrefix

Parameters

[in]	point	Camera point to transform
[in]	fromSys	Camera coordinate system of point
[in]	toSys	Camera coordinate system of returned point

Returns

The transformed point

Exceptions

pex::exceptions::InvalidParameterError

if fromSys or toSys is unknown

Definition at line 143 of file Detector.cc.

                                                                   {
    return _transformMap->transform(point, makeCameraSys(fromSys), makeCameraSys(toSys));
}

transform() [2/2]

template<typename FromSysT , typename ToSysT >

std::vector< lsst::geom::Point2D > lsst::afw::cameraGeom::Detector::transform	(	std::vector< lsst::geom::Point2D > const &	points,
		FromSysT const &	fromSys,
		ToSysT const &	toSys
	)		const

Transform a vector of points from one camera system to another.

Template Parameters

FromSysT	Class of fromSys: one of CameraSys or CameraSysPrefix
ToSysT	Class of toSys: one of CameraSys or CameraSysPrefix

Parameters

[in]	points	Camera points to transform
[in]	fromSys	Camera coordinate system of points
[in]	toSys	Camera coordinate system of returned points

Returns

The transformed points

Exceptions

pex::exceptions::InvalidParameterError

if fromSys or toSys is unknown

Definition at line 149 of file Detector.cc.

                                                                                                         {
    return _transformMap->transform(points, makeCameraSys(fromSys), makeCameraSys(toSys));
}

writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits ( std::string const &  fileName, std::string const &  mode = "w"  ) const

inherited

Write the object to a regular FITS file.

Parameters

[in]	fileName	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 24 of file Persistable.cc.

                                                                                  {
    fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::MemFileManager &  manager, std::string const &  mode = "w"  ) const

inherited

Write the object to a FITS image in memory.

Parameters

[in]	manager	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 29 of file Persistable.cc.

                                                                                    {
    fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::Fits &  fitsfile ) const

inherited

Write the object to an already-open FITS object.

Parameters

[in]

fitsfile

Open FITS object to write to.

Definition at line 18 of file Persistable.cc.

                                                    {
    OutputArchive archive;
    archive.put(this);
    archive.writeFits(fitsfile);
}

Friends And Related Function Documentation

operator<<()

std::ostream & operator<< ( std::ostream &  os, Storable const &  storable  )

related

Output operator for Storable.

Parameters

os	the desired output stream
storable	the object to print

Returns

a reference to os

Exceptions

UnsupportedOperationException

Thrown if storable does not have an implementation of Storable::toString.

Definition at line 159 of file Storable.h.

                                                                        {
    return os << storable.toString();
}

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/afw/18.1.0/include/lsst/afw/cameraGeom/Detector.h
• /j/snowflake/release/lsstsw/stack/Linux64/afw/18.1.0/src/cameraGeom/Detector.cc