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

A representation of a detector in a mosaic camera. More...

#include <Detector.h>

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

Classes
class	Builder
	A helper class for Detector that allows amplifiers and most fields to be modified. More...
class	Factory
class	InCameraBuilder
	A helper class that allows the properties of a detector to be modified in the course of modifying a full camera. More...
class	PartialRebuilder
	A helper class that allows the properties of a single detector to be modified in isolation. More...

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

Public Member Functions
std::shared_ptr< PartialRebuilder >	rebuild () const
	Return a Builder object initialized with the state of this Detector.
std::vector< lsst::geom::Point2D >	getCorners (CameraSys const &cameraSys) const
	Get the corners of the detector in the specified camera coordinate system.
std::vector< lsst::geom::Point2D >	getCorners (CameraSysPrefix const &cameraSysPrefix) const
	Get the corners of the detector in the specified camera coordinate system prefix.
lsst::geom::Point2D	getCenter (CameraSys const &cameraSys) const
	Get the center of the detector in the specified camera coordinate system.
lsst::geom::Point2D	getCenter (CameraSysPrefix const &cameraSysPrefix) const
	Get the center of the detector in the specified camera coordinate system prefix.
bool	hasTransform (CameraSys const &cameraSys) const
	Can this object convert between PIXELS and the specified camera coordinate system?
bool	hasTransform (CameraSysPrefix const &cameraSysPrefix) const
	Can this object convert between PIXELS and the specified camera coordinate system prefix?
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.
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.
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.
std::shared_ptr< TransformMap const >	getTransformMap () const
	Get the transform registry.
std::vector< std::shared_ptr< Amplifier const > > const &	getAmplifiers () const
	Return the sequence of Amplifiers directly.
auto	begin () const
	An iterator range over amplifers.
auto	end () const
std::shared_ptr< Amplifier const >	operator[] (size_t i) const
	Get the amplifier specified by index.
std::shared_ptr< Amplifier const >	operator[] (std::string const &name) const
	Get the amplifier specified by name.
std::size_t	size () const
	Get the number of amplifiers.
bool	isPersistable () const noexcept override
	Detector is always persistable.
template<typename FromSysT , typename ToSysT >
std::shared_ptr< geom::TransformPoint2ToPoint2 >	getTransform (FromSysT const &fromSys, ToSysT const &toSys) const
std::string	getName () const
	Get the detector name.
int	getId () const
	Get the detector ID.
DetectorType	getType () const
	Return the purpose of this detector.
std::string	getSerial () const
	Get the detector serial "number".
std::string	getPhysicalType () const
	Get the detector's physical type.
lsst::geom::Box2I	getBBox () const
	Get the bounding box.
Orientation	getOrientation () const
	Get detector's orientation in the focal plane.
lsst::geom::Extent2D	getPixelSize () const
	Get size of pixel along (mm)
bool	hasCrosstalk () const
	Have we got crosstalk coefficients?
CrosstalkMatrix	getCrosstalk () const
	Get the crosstalk coefficients.
CameraSys	makeCameraSys (CameraSys const &cameraSys) const
	Get a coordinate system from a coordinate system (return input unchanged and untested)
CameraSys	makeCameraSys (CameraSysPrefix const &cameraSysPrefix) const
	Get a coordinate system from a detector system prefix (add detector name)
CameraSys	getNativeCoordSys () const
	The "native" coordinate system of this detector.
virtual std::shared_ptr< Storable >	cloneStorable () const
	Create a new object that is a copy of this one (optional operation).
virtual std::string	toString () const
	Create a string representation of this object (optional operation).
virtual std::size_t	hash_value () const
	Return a hash of this object (optional operation).
virtual bool	equals (Storable const &other) const noexcept
	Compare this object to another Storable.
void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file.
void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory.
void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object.

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

Protected Types
using	OutputArchiveHandle = io::OutputArchiveHandle

Protected Member Functions
Fields const &	getFields () const override
	Return a reference to a Fields struct.

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.

Private Member Functions
std::string	getPersistenceName () const override
	Return the unique name used to persist this object and look up its factory.
std::string	getPythonModule () const override
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.
void	write (OutputArchiveHandle &handle) const override
	Write the object to one or more catalogs.

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

Detailed Description

A representation of a detector in a mosaic camera.

Detector holds both simple data fields (see DetectorBase) and a set of related coordinate systems and transforms, and acts as a container of Amplifier objects.

Detector is immutable, but copies can be modified via one of its Builder classes. A Detector must be created initially as part of a Camera (see Camera::Builder::add), but can then be modified either individually (see Detector::rebuild and Detector::PartialRebuilder) or as part of modifying the full Camera (see Detector::InCameraBuilder).

The coordinate systems and transforms known to a Detector are shared with its parent Camera and all other Detectors in that Camera.

Definition at line 181 of file Detector.h.

Member Typedef Documentation

CrosstalkMatrix

using lsst::afw::cameraGeom::DetectorBase::CrosstalkMatrix = ndarray::Array<float const, 2>

inherited

Definition at line 59 of file Detector.h.

OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle

protectedinherited

Definition at line 108 of file Persistable.h.

Member Function Documentation

begin()

auto lsst::afw::cameraGeom::Detector::begin ( ) const

inline

An iterator range over amplifers.

Iterators dereference to shared_ptr<Amplifier const>.

Definition at line 278 of file Detector.h.

{ return _amplifiers.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.

When called on Python classes, this method delegates to __deepcopy__ if it exists.

Reimplemented in lsst::afw::detection::Psf, lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::image::ApCorrMap, lsst::afw::image::CoaddInputs, lsst::afw::image::FilterLabel, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, and lsst::afw::typehandling::StorableHelper< Base >.

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 218 of file Persistable.cc.

end()

auto lsst::afw::cameraGeom::Detector::end ( ) const

inline

Definition at line 279 of file Detector.h.

{ return _amplifiers.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

Note

When called on Python classes, this method delegates to __eq__ if it exists.

Reimplemented in lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::image::PhotoCalib, and lsst::afw::image::VisitInfo.

Definition at line 48 of file Storable.cc.

{ return this == &other; }

getAmplifiers()

std::vector< std::shared_ptr< Amplifier const > > const & lsst::afw::cameraGeom::Detector::getAmplifiers ( ) const

inline

Return the sequence of Amplifiers directly.

Definition at line 270 of file Detector.h.

{ return _amplifiers; }

getBBox()

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

inlineinherited

Get the bounding box.

Definition at line 85 of file Detector.h.

{ return getFields().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 72 of file Detector.cc.

                                                                    {
    auto ctrPix = lsst::geom::Box2D(getBBox()).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 78 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 62 of file Detector.cc.

                                                                                {
    std::vector<lsst::geom::Point2D> nativeCorners = lsst::geom::Box2D(getBBox()).getCorners();
    auto nativeToCameraSys = _transformMap->getTransform(getNativeCoordSys(), 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 68 of file Detector.cc.

                                                                                            {
    return getCorners(makeCameraSys(cameraSysPrefix));
}

getCrosstalk()

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

inlineinherited

Get the crosstalk coefficients.

Definition at line 100 of file Detector.h.

{ return getFields().crosstalk; }

getFields()

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

inlineoverrideprotectedvirtual

Return a reference to a Fields struct.

Must be implemented by all subclasses.

Implements lsst::afw::cameraGeom::DetectorBase.

Definition at line 306 of file Detector.h.

{ return _fields; }

getId()

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

inlineinherited

Get the detector ID.

Definition at line 67 of file Detector.h.

{ return getFields().id; }

getName()

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

inlineinherited

Get the detector name.

Definition at line 64 of file Detector.h.

{ return getFields().name; }

getNativeCoordSys()

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

inlineinherited

The "native" coordinate system of this detector.

Definition at line 123 of file Detector.h.

{ return CameraSys(PIXELS, getName()); }

getOrientation()

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

inlineinherited

Get detector's orientation in the focal plane.

Definition at line 88 of file Detector.h.

{ return getFields().orientation; }

getPersistenceName()

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

overrideprivatevirtual

Return the unique name used to persist this object and look up its factory.

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

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

Definition at line 319 of file Detector.cc.

                                             {
    return "Detector";
}

getPhysicalType()

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

inlineinherited

Get the detector's physical type.

This may mean different things for different cameras; possibilities include the manufacturer ("ITL" vs "E2V") or fundamental technology ("CCD" vs "HgCdTe").

Definition at line 82 of file Detector.h.

{ return getFields().physicalType; }

getPixelSize()

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

inlineinherited

Get size of pixel along (mm)

Definition at line 91 of file Detector.h.

{ return getFields().pixelSize; }

getPythonModule()

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

overrideprivatevirtual

Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.

Must be less than ArchiveIndexSchema::MAX_MODULE_LENGTH characters.

Will be ignored if empty.

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

Definition at line 325 of file Detector.cc.

                                          {
    return "lsst.afw.cameraGeom";
}

getSerial()

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

inlineinherited

Get the detector serial "number".

Definition at line 73 of file Detector.h.

{ return getFields().serial; }

getTransform() [1/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.

getTransform() [2/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 89 of file Detector.cc.

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

getTransformMap()

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

inline

Get the transform registry.

Definition at line 267 of file Detector.h.

{ return _transformMap; }

getType()

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

inlineinherited

Return the purpose of this detector.

Definition at line 70 of file Detector.h.

{ return getFields().type; }

hasCrosstalk()

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

inlineinherited

Have we got crosstalk coefficients?

Definition at line 94 of file Detector.h.

                              {
        return !(getFields().crosstalk.isEmpty() ||
                 getFields().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

C++ subclass authors are responsible for any associated specializations of std::hash.

When called on Python classes, this method delegates to __hash__ if it exists.

Reimplemented in lsst::afw::geom::polygon::Polygon, lsst::afw::image::FilterLabel, lsst::afw::image::VisitInfo, and lsst::afw::typehandling::StorableHelper< Base >.

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 82 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 84 of file Detector.cc.

                                                                        {
    return hasTransform(makeCameraSys(cameraSysPrefix));
}

isPersistable()

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

inlineoverridevirtualnoexcept

Detector is always persistable.

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

Definition at line 302 of file Detector.h.

{ return true; }

makeCameraSys() [1/2]

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

inlineinherited

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

{ return cameraSys; }

makeCameraSys() [2/2]

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

inlineinherited

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

                                                                          {
        return CameraSys(cameraSysPrefix, getFields().name);
    }

operator[]() [1/2]

std::shared_ptr< Amplifier 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 287 of file Detector.h.

{ return _amplifiers.at(i); }

operator[]() [2/2]

std::shared_ptr< Amplifier const > 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 106 of file Detector.cc.

                                                                               {
    return *findAmpIterByName(_amplifiers.begin(), _amplifiers.end(), 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.

readFits() [2/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.

readFits() [3/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.

rebuild()

std::shared_ptr< Detector::PartialRebuilder > lsst::afw::cameraGeom::Detector::rebuild

(

)

const

Return a Builder object initialized with the state of this Detector.

This is simply a shortcut for Detector::PartialRebuilder(*this).

Definition at line 58 of file Detector.cc.

                                                                {
    return std::make_shared<PartialRebuilder>(*this);
}

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 151 of file Storable.h.

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

size()

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

inline

Get the number of amplifiers.

Renamed to __len__ in Python.

Definition at line 299 of file Detector.h.

{ return _amplifiers.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.

Note

When called on Python classes, this method delegates to __repr__.

Reimplemented in lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::image::FilterLabel, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, and lsst::afw::typehandling::StorableHelper< Base >.

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 95 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 101 of file Detector.cc.

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

write()

void lsst::afw::cameraGeom::Detector::write ( OutputArchiveHandle & handle ) const

overrideprivatevirtual

Write the object to one or more catalogs.

The handle object passed to this function provides an interface for adding new catalogs and adding nested objects to the same archive (while checking for duplicates). See OutputArchiveHandle for more information.

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

Definition at line 329 of file Detector.cc.

                                                      {
    auto const & keys = DetectorSchema();
 
    auto cat = handle.makeCatalog(keys.schema);
    auto record = cat.addNew();
    record->set(keys.name, getName());
    record->set(keys.id, getId());
    record->set(keys.type, static_cast<int>(getType()));
    record->set(keys.serial, getSerial());
    record->set(keys.bbox, getBBox());
    record->set(keys.pixelSize, lsst::geom::Point2D(getPixelSize()));
    auto orientation = getOrientation();
    record->set(keys.fpPosition, orientation.getFpPosition3());
    record->set(keys.refPoint, orientation.getReferencePoint());
    record->set(keys.yaw, orientation.getYaw());
    record->set(keys.pitch, orientation.getPitch());
    record->set(keys.roll, orientation.getRoll());
    record->set(keys.transformMap, handle.put(getTransformMap()));
 
    auto flattenMatrix = [](ndarray::Array<float const, 2> const & matrix) {
        // copy because the original isn't guaranteed to have
        // row-major contiguous elements
        ndarray::Array<float, 2, 2> copied = ndarray::copy(matrix);
        // make a view to the copy
        ndarray::Array<float, 1, 1> flattened = ndarray::flatten<1>(copied);
        return flattened;
    };
 
    record->set(keys.crosstalk, flattenMatrix(getCrosstalk()));
    record->set(keys.physicalType, getPhysicalType());
    record->set(keys.version, SERIALIZATION_VERSION);
    handle.saveCatalog(cat);
 
    auto ampCat = handle.makeCatalog(Amplifier::getRecordSchema());
    ampCat.reserve(getAmplifiers().size());
    for (auto const & amp : getAmplifiers()) {
        auto record = ampCat.addNew();
        amp->toRecord(*record);
    }
    handle.saveCatalog(ampCat);
}

writeFits() [1/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);
}

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 ( 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);
}

Friends And Related Symbol 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 174 of file Storable.h.

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

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g9726552aa6+10f999ec6a/include/lsst/afw/cameraGeom/Detector.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g9726552aa6+10f999ec6a/src/cameraGeom/Detector.cc