lsst::afw::cameraGeom::TransformMap Class Reference

A registry of 2-dimensional coordinate transforms for a specific camera. More...

#include <TransformMap.h>

Inheritance diagram for lsst::afw::cameraGeom::TransformMap:

Classes
struct	Connection
	Representation of a single edge in the graph defined by a TransformMap. More...
class	Factory

Public Types
using	Transforms = std::unordered_map<CameraSys, std::shared_ptr<geom::TransformPoint2ToPoint2>>
using	CameraSysIterator = boost::transform_iterator<GetKey, CameraSysFrameIdMap::const_iterator>

Public Member Functions
	~TransformMap () noexcept
lsst::geom::Point2D	transform (lsst::geom::Point2D const &point, CameraSys const &fromSys, CameraSys const &toSys) const
	Convert a point from one camera coordinate system to another.
std::vector< lsst::geom::Point2D >	transform (std::vector< lsst::geom::Point2D > const &pointList, CameraSys const &fromSys, CameraSys const &toSys) const
	Convert a list of points from one coordinate system to another.
CameraSysIterator	begin () const
CameraSysIterator	end () const
bool	contains (CameraSys const &system) const noexcept
	Can this transform to and from the specified coordinate system?
std::shared_ptr< geom::TransformPoint2ToPoint2 >	getTransform (CameraSys const &fromSys, CameraSys const &toSys) const
	Get a Transform from one camera coordinate system to another.
size_t	size () const noexcept
	Get the number of supported coordinate systems.
std::vector< Connection >	getConnections () const
	Return the sequence of connections used to construct this Transform.
bool	isPersistable () const noexcept override
	TransformMaps should always be Persistable.
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.
	TransformMap (TransformMap const &other)=delete
	TransformMap (TransformMap &&other)=delete
TransformMap &	operator= (TransformMap const &)=delete
TransformMap &	operator= (TransformMap &&)=delete

Static Public Member Functions
static std::shared_ptr< TransformMap const >	make (CameraSys const &reference, Transforms const &transforms)
	Construct a TransformMap with all transforms relative to a single reference CameraSys.
static std::shared_ptr< TransformMap const >	make (CameraSys const &reference, std::vector< Connection > const &connections)
	Construct a TransformMap from a sequence of Connections.
static std::shared_ptr< TransformMap >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object.
static std::shared_ptr< TransformMap >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file.
static std::shared_ptr< TransformMap >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory.
static std::shared_ptr< TransformMap >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr.

Protected Types
using	OutputArchiveHandle = io::OutputArchiveHandle

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.

Detailed Description

A registry of 2-dimensional coordinate transforms for a specific camera.

Represents the interrelationships between camera coordinate systems for a particular camera. It can be seen as a mapping between a pair of CameraSys and a Transform between them (though it does not conform to either the C++ map or Python dictionary APIs).

TransformMap supports:

• Transforming between any two supported CameraSys using the transform methods.
• Retrieving a transform between any two supported CameraSys using getTransform.
• Iteration over supported CameraSys using begin and end in C++ and standard Python iteration in Python.

TransformMap is immutable and must always be held by shared_ptr; this is enforced by making all non-deleted constructors private, and instead providing static make member functions for construction (in Python, these are exposed as regular constructors).

Exception Safety

Unless otherwise specified, all methods guarantee only basic exception safety.

Definition at line 62 of file TransformMap.h.

Member Typedef Documentation

CameraSysIterator

using lsst::afw::cameraGeom::TransformMap::CameraSysIterator = boost::transform_iterator<GetKey, CameraSysFrameIdMap::const_iterator>

Definition at line 75 of file TransformMap.h.

OutputArchiveHandle

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

protectedinherited

Definition at line 108 of file Persistable.h.

Transforms

using lsst::afw::cameraGeom::TransformMap::Transforms = std::unordered_map<CameraSys, std::shared_ptr<geom::TransformPoint2ToPoint2>>

Definition at line 74 of file TransformMap.h.

Constructor & Destructor Documentation

TransformMap() [1/2]

lsst::afw::cameraGeom::TransformMap::TransformMap ( TransformMap const & other )

delete

TransformMap is immutable, so both moving and copying are prohibited. It is also always held by shared_ptr, so there is no good reason to copy it.

TransformMap() [2/2]

lsst::afw::cameraGeom::TransformMap::TransformMap ( TransformMap && other )

delete

TransformMap is immutable, so both moving and copying are prohibited. It is also always held by shared_ptr, so there is no good reason to copy it.

~TransformMap()

lsst::afw::cameraGeom::TransformMap::~TransformMap ( )

defaultnoexcept

Member Function Documentation

begin()

CameraSysIterator lsst::afw::cameraGeom::TransformMap::begin ( ) const

inline

Definition at line 164 of file TransformMap.h.

{ return boost::make_transform_iterator(_frameIds.begin(), GetKey()); }

contains()

bool lsst::afw::cameraGeom::TransformMap::contains ( CameraSys const & system ) const

noexcept

Can this transform to and from the specified coordinate system?

Parameters

system

The coordinate system to search for

Returns

true if system is supported, false otherwise

Exception Safety

Shall not throw exceptions.

Definition at line 215 of file TransformMap.cc.

{ return _frameIds.count(system) > 0; }

dynamicCast()

template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< TransformMap >::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()

CameraSysIterator lsst::afw::cameraGeom::TransformMap::end ( ) const

inline

Definition at line 166 of file TransformMap.h.

{ return boost::make_transform_iterator(_frameIds.end(), GetKey()); }

getConnections()

std::vector< TransformMap::Connection > lsst::afw::cameraGeom::TransformMap::getConnections

(

)

const

Return the sequence of connections used to construct this Transform.

The order of the connections may differ from the original order, but is guaranteed to yield the same TransformMap when passed to make with the same reference system.

Definition at line 278 of file TransformMap.cc.

{ return _connections; }

getPersistenceName()

std::string lsst::afw::cameraGeom::TransformMap::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 381 of file TransformMap.cc.

                                                 {
    return "TransformMap";
}

getPythonModule()

std::string lsst::afw::cameraGeom::TransformMap::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 385 of file TransformMap.cc.

                                              {
    return "lsst.afw.cameraGeom";
}

getTransform()

std::shared_ptr< geom::TransformPoint2ToPoint2 > lsst::afw::cameraGeom::TransformMap::getTransform	(	CameraSys const &	fromSys,
		CameraSys const &	toSys ) const

Get a Transform from one camera coordinate system to another.

Parameters

fromSys,toSys

Camera coordinate systems 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.

Definition at line 217 of file TransformMap.cc.

                                                                                                        {
    return std::make_shared<geom::TransformPoint2ToPoint2>(*_getMapping(fromSys, toSys));
}

isPersistable()

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

inlineoverridevirtualnoexcept

TransformMaps should always be Persistable.

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

Definition at line 210 of file TransformMap.h.

{ return true; }

make() [1/2]

std::shared_ptr< TransformMap const > lsst::afw::cameraGeom::TransformMap::make ( CameraSys const & reference, std::vector< Connection > const & connections )

static

Construct a TransformMap from a sequence of Connections.

Parameters

reference	Initial coordinate system that must be connected to all other coordinate systems in the map.
connections	Sequence of Connection structs, each of which relates two CameraSys via the Transform that connects them.

Exceptions

lsst::pex::exceptions::InvalidParameterError

Thrown if the graph defined by the given connections does not define a single unique path (which may involve multiple Connections) between any CameraSys and the reference CameraSys.

This method is wrapped as a regular constructor in Python.

Definition at line 188 of file TransformMap.cc.

  {
    // We can't use make_shared because TransformMap ctor is private.
    return std::shared_ptr<TransformMap>(
        new TransformMap(standardizeConnections(reference, connections))
    );
}

make() [2/2]

std::shared_ptr< TransformMap const > lsst::afw::cameraGeom::TransformMap::make ( CameraSys const & reference, Transforms const & transforms )

static

Construct a TransformMap with all transforms relative to a single reference CameraSys.

Parameters

reference	Coordinate system from which each Transform in transforms converts.
transforms	A map whose keys are camera coordinate systems, and whose values point to Transforms that convert from reference to the corresponding key. All Transforms must be invertible.

Exceptions

lsst::pex::exceptions::InvalidParameterError

Thrown if transforms contains the reference camera system as a key, or if any Transform is not invertible.

This method is wrapped as a regular constructor in Python.

Definition at line 173 of file TransformMap.cc.

  {
    std::vector<Connection> connections;
    connections.reserve(transforms.size());
    for (auto const & pair : transforms) {
        connections.push_back(Connection{pair.second, reference, pair.first});
    }
    // We can't use make_shared because TransformMap ctor is private.
    return std::shared_ptr<TransformMap>(
        new TransformMap(standardizeConnections(reference, std::move(connections)))
    );
}

operator=() [1/2]

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

delete

TransformMap is immutable, so both moving and copying are prohibited. It is also always held by shared_ptr, so there is no good reason to copy it.

operator=() [2/2]

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

delete

TransformMap is immutable, so both moving and copying are prohibited. It is also always held by shared_ptr, so there is no good reason to copy it.

readFits() [1/3]

static std::shared_ptr< TransformMap > lsst::afw::table::io::PersistableFacade< TransformMap >::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< TransformMap > lsst::afw::table::io::PersistableFacade< TransformMap >::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< TransformMap > lsst::afw::table::io::PersistableFacade< TransformMap >::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.

size()

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

noexcept

Get the number of supported coordinate systems.

Exception Safety

Shall not throw exceptions.

Definition at line 237 of file TransformMap.cc.

{ return _frameIds.size(); }

transform() [1/2]

lsst::geom::Point2D lsst::afw::cameraGeom::TransformMap::transform	(	lsst::geom::Point2D const &	point,
		CameraSys const &	fromSys,
		CameraSys const &	toSys ) const

Convert a point from one camera coordinate system to another.

Parameters

point	Point from which to transform
fromSys,toSys	Camera coordinate systems between which to transform

Returns

the transformed value. Equivalent to getTransform(fromSys, toSys).applyForward(point).

Exceptions

lsst::pex::exceptions::InvalidParameterError

Thrown if either fromSys or toSys is not supported.

Definition at line 202 of file TransformMap.cc.

                                                                          {
    auto mapping = _getMapping(fromSys, toSys);
    return POINT2_ENDPOINT.pointFromData(mapping->applyForward(POINT2_ENDPOINT.dataFromPoint(point)));
}

transform() [2/2]

std::vector< lsst::geom::Point2D > lsst::afw::cameraGeom::TransformMap::transform	(	std::vector< lsst::geom::Point2D > const &	pointList,
		CameraSys const &	fromSys,
		CameraSys const &	toSys ) const

Convert a list of points from one coordinate system to another.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 208 of file TransformMap.cc.

                                                                                       {
    auto mapping = _getMapping(fromSys, toSys);
    return POINT2_ENDPOINT.arrayFromData(mapping->applyForward(POINT2_ENDPOINT.dataFromArray(pointList)));
}

write()

void lsst::afw::cameraGeom::TransformMap::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 389 of file TransformMap.cc.

                                                          {
    auto const & keys = PersistenceHelper::get();
 
    auto cat = handle.makeCatalog(keys.schema);
    for (auto const & connection : _connections) {
        auto record = cat.addNew();
        record->set(keys.fromSysName, connection.fromSys.getSysName());
        record->set(keys.fromSysDetectorName, connection.fromSys.getDetectorName());
        record->set(keys.toSysName, connection.toSys.getSysName());
        record->set(keys.toSysDetectorName, connection.toSys.getDetectorName());
        record->set(keys.transform, handle.put(connection.transform));
    }
    handle.saveCatalog(cat);
}

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

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+66d966b544/include/lsst/afw/cameraGeom/TransformMap.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+66d966b544/src/cameraGeom/TransformMap.cc