lsst::afw::cameraGeom::Camera::Builder Class Reference

A helper class for creating and modifying cameras. More...

#include <Camera.h>

Inheritance diagram for lsst::afw::cameraGeom::Camera::Builder:

Public Types
using	NameMap = std::unordered_map< std::string, std::shared_ptr< Detector::InCameraBuilder > >
using	IdMap = std::map< int, std::shared_ptr< Detector::InCameraBuilder > >
using	List = std::vector< std::shared_ptr< Detector::InCameraBuilder > >

Public Member Functions
virtual	~Builder () noexcept
	Builder (std::string const &name)
	Construct a Builder for a completely new Camera with the given name. More...
	Builder (Camera const &camera)
	Construct a Builder with the state of an existing Camera. More...
std::shared_ptr< Camera const >	finish () const
	Construct a new Camera from the state of the Builder. More...
std::string	getName () const
	Return the name of the camera. More...
void	setName (std::string const &name)
	Set the name of the camera. More...
std::string	getPupilFactoryName () const
	Return the fully-qualified name of the Python class that provides this Camera's PupilFactory. More...
void	setPupilFactoryName (std::string const &pupilFactoryName)
	Set the fully-qualified name of the Python class that provides this Camera's PupilFactory. More...
void	setTransformFromFocalPlaneTo (CameraSys const &toSys, std::shared_ptr< afw::geom::TransformPoint2ToPoint2 const > transform)
	Set the transformation from FOCAL_PLANE to the given coordinate system. More...
bool	discardTransformFromFocalPlaneTo (CameraSys const &toSys)
	Remove any transformation from FOCAL_PLANE to the given coordinate system. More...
std::shared_ptr< Detector::InCameraBuilder >	add (std::string const &name, int id)
	Add a new Detector with the given name and ID. More...
void	remove (std::string const &name)
	Remove the detector with the given name or ID. More...
void	remove (int id)
NameMap const &	getNameMap () const noexcept
	Get a map keyed and ordered by name. More...
IdMap const &	getIdMap () const noexcept
	Get a map keyed and ordered by ID. More...
std::size_t	size () const noexcept
	Get the number of detectors. More...
bool	empty () const noexcept
	Determine if the collection contains any detectors. More...
std::shared_ptr< Detector::InCameraBuilder >	operator[] (std::string const &name) const
	Implement the [name] operator. More...
std::shared_ptr< Detector::InCameraBuilder >	operator[] (int id) const
	Implement the [id] operator. More...
std::shared_ptr< Detector::InCameraBuilder >	get (std::string const &name, std::shared_ptr< Detector::InCameraBuilder > def=nullptr) const
	Retrieve a detector by name, or fall back to a default. More...
std::shared_ptr< Detector::InCameraBuilder >	get (int id, std::shared_ptr< Detector::InCameraBuilder > def=nullptr) const
	Retrieve a detector by ID, or fall back to a default. More...

Protected Member Functions
void	add (std::shared_ptr< Detector::InCameraBuilder > detector)
	Add a detector to the collection. More...

Detailed Description

A helper class for creating and modifying cameras.

Camera and Camera::Builder have no direct inheritance relationship, but both inherit from different specializations of DetectorCollectionBase, so their container-of-detectors interfaces can generally be used the same way in both Python and templated C++.

Definition at line 208 of file Camera.h.

Member Typedef Documentation

IdMap

using lsst::afw::cameraGeom::DetectorCollectionBase< Detector::InCameraBuilder >::IdMap = std::map<int, std::shared_ptr<Detector::InCameraBuilder > >

inherited

Definition at line 53 of file DetectorCollection.h.

List

using lsst::afw::cameraGeom::DetectorCollectionBase< Detector::InCameraBuilder >::List = std::vector<std::shared_ptr<Detector::InCameraBuilder > >

inherited

Definition at line 54 of file DetectorCollection.h.

NameMap

using lsst::afw::cameraGeom::DetectorCollectionBase< Detector::InCameraBuilder >::NameMap = std::unordered_map<std::string, std::shared_ptr<Detector::InCameraBuilder > >

inherited

Definition at line 52 of file DetectorCollection.h.

Constructor & Destructor Documentation

~Builder()

lsst::afw::cameraGeom::Camera::Builder::~Builder ( )

virtualdefaultnoexcept

Builder() [1/2]

lsst::afw::cameraGeom::Camera::Builder::Builder ( std::string const &  name )

explicit

Construct a Builder for a completely new Camera with the given name.

Definition at line 204 of file Camera.cc.

: _name(name) {}

Builder() [2/2]

lsst::afw::cameraGeom::Camera::Builder::Builder ( Camera const &  camera )

explicit

Construct a Builder with the state of an existing Camera.

Definition at line 206 of file Camera.cc.

                                            :
    _name(camera.getName()),
    _pupilFactoryName(camera.getPupilFactoryName())
{
    // Add Detector Builders for all Detectors; does not (yet) include
    // coordinate transform information.
    for (auto const & pair : camera.getIdMap()) {
        BaseCollection::add(Camera::makeDetectorBuilder(*pair.second));
    }
    // Iterate over connections in TransformMap, distributing them between the
    // Camera Builder and the Detector Builders.
    for (auto const & connection : camera.getTransformMap()->getConnections()) {
        // asserts below are on Detector, Camera, and TransformMap invariants:
        //  - Connections should always be from native sys to something else.
        //  - The only connections between full-camera and per-detector sys
        //    should be from the camera native sys (FOCAL_PLANE) to the
        //    detector native sys (PIXELS).
        //  - When TransformMap standardizes connections, it should maintain
        //    these directions, as that's consistent with "pointing away" from
        //    the overall reference sys (the camera native sys).
        if (connection.fromSys.hasDetectorName()) {
            assert(connection.toSys.getDetectorName() == connection.fromSys.getDetectorName());
            auto detector = (*this)[connection.fromSys.getDetectorName()];
            assert(connection.fromSys == detector->getNativeCoordSys());
            detector->setTransformFromPixelsTo(CameraSysPrefix(connection.toSys.getSysName()),
                                               connection.transform);
        } else {
            assert(connection.fromSys == getNativeCameraSys());
            if (!connection.toSys.hasDetectorName()) {
                _connections.push_back(connection);
            }
            // We ignore the FOCAL_PLANE to PIXELS transforms transforms, as
            // those are always regenerated from the Orientation when we
            // rebuild the Camera.
        }
    }
}

Member Function Documentation

add() [1/2]

void lsst::afw::cameraGeom::DetectorCollectionBase< Detector::InCameraBuilder >::add ( std::shared_ptr< Detector::InCameraBuilder >  detector )

protectedinherited

Add a detector to the collection.

Parameters

[in]

detector

New detector to add to the collection.

Exceptions

pex::exceptions::RuntimeError

Thrown if the ID and/or name conflict with those of detectors already in the collection.

Exception Safety

Strong for pex::exceptions::RuntimeError, weak (collection is made empty) otherwise.

Definition at line 135 of file DetectorCollection.cc.

                                                             {
    auto idIter = _idDict.find(detector->getId());
    auto nameIter = _nameDict.find(detector->getName());
    if (idIter == _idDict.end()) {
        if (nameIter == _nameDict.end()) {
            try {
                _idDict.emplace(detector->getId(), detector);
                _nameDict.emplace(detector->getName(), detector);
            } catch (...) {
                _idDict.clear();
                _nameDict.clear();
                throw;
            }
        } else {
            throw LSST_EXCEPT(
                pex::exceptions::RuntimeError,
                (boost::format("Detector name %s is not unique.") % detector->getName()).str()
            );
        }
    } else {
        if (nameIter == _nameDict.end()) {
            throw LSST_EXCEPT(
                pex::exceptions::RuntimeError,
                (boost::format("Detector ID %s is not unique.") % detector->getId()).str()
            );
        } else {
            if (nameIter->second != detector) {
                assert(idIter->second != detector);
                throw LSST_EXCEPT(
                    pex::exceptions::RuntimeError,
                    (boost::format("Detector name %s and ID %s are not unique.") % detector->getName()
                     % detector->getId()).str()
                );
            }
            // detector is already present; do nothing
        }
    }
}

add() [2/2]

std::shared_ptr< Detector::InCameraBuilder > lsst::afw::cameraGeom::Camera::Builder::add	(	std::string const &	name,
		int	id
	)

Add a new Detector with the given name and ID.

This is the only way to create a completely new detector (as opposed to a copy of an existing one), and it permanently sets that Detector's name and ID.

Exceptions

pex::exceptions::RuntimeError

Thrown if the ID and/or name conflict with those of detectors already in the collection.

Exception Safety

Strong for pex::exceptions::RuntimeError, none otherwise.

Definition at line 329 of file Camera.cc.

                                                                                        {
    auto detector = makeDetectorBuilder(name, id);
    BaseCollection::add(detector);
    return detector;
}

discardTransformFromFocalPlaneTo()

bool lsst::afw::cameraGeom::Camera::Builder::discardTransformFromFocalPlaneTo

(

CameraSys const &

toSys

)

Remove any transformation from FOCAL_PLANE to the given coordinate system.

Parameters

toSys

Coordinate system this transform returns points in.

Returns

true if a transform was removed; false otherwise.

Definition at line 320 of file Camera.cc.

                                                                            {
    auto iter = findConnection(_connections.begin(), _connections.end(), toSys);
    if (iter != _connections.end()) {
        _connections.erase(iter);
        return true;
    }
    return false;
}

empty()

bool lsst::afw::cameraGeom::DetectorCollectionBase< Detector::InCameraBuilder >::empty ( ) const

inlinenoexceptinherited

Determine if the collection contains any detectors.

Definition at line 72 of file DetectorCollection.h.

{ return _idDict.empty(); }

finish()

std::shared_ptr< Camera const > lsst::afw::cameraGeom::Camera::Builder::finish

(

)

const

Construct a new Camera from the state of the Builder.

Definition at line 246 of file Camera.cc.

                                                        {
    // Make a big vector of all coordinate transform connections;
    // start with general transforms for the camera as a whole:
    std::vector<TransformMap::Connection> connections(_connections);
    // Loop over detectors and add the transforms from FOCAL_PLANE
    // to PIXELS (via the Orientation), and then any extra transforms
    // from PIXELS to other things.
    for (auto const & pair : getIdMap()) {
        auto const & detectorBuilder = *pair.second;
        connections.push_back(
            TransformMap::Connection{
                detectorBuilder.getOrientation().makeFpPixelTransform(detectorBuilder.getPixelSize()),
                getNativeCameraSys(),
                detectorBuilder.getNativeCoordSys()
            }
        );
        connections.insert(connections.end(),
                           getDetectorBuilderConnections(detectorBuilder).begin(),
                           getDetectorBuilderConnections(detectorBuilder).end());
    }
    // Make a single big TransformMap.
    auto transformMap = TransformMap::make(getNativeCameraSys(), connections);
    // Make actual Detector objects, giving each the full TransformMap.
    DetectorList detectors;
    detectors.reserve(size());
    for (auto const & pair : getIdMap()) {
        auto const & detectorBuilder = *pair.second;
        detectors.push_back(detectorBuilder.finish(transformMap));
    }
    return std::shared_ptr<Camera>(new Camera(_name, std::move(detectors), std::move(transformMap),
                                              _pupilFactoryName));
}

get() [1/2]

std::shared_ptr< Detector::InCameraBuilder > lsst::afw::cameraGeom::DetectorCollectionBase< Detector::InCameraBuilder >::get ( int  id, std::shared_ptr< Detector::InCameraBuilder >  def = nullptr  ) const

inherited

Retrieve a detector by ID, or fall back to a default.

Parameters

[in]	id	detector id
[in]	def	default detector to return. This defaults to nullptr.

Returns

pointer to detector entry if the entry exists, else return the default value

Definition at line 110 of file DetectorCollection.cc.

                                                                                  {
    auto i = _idDict.find(id);
    if (i == _idDict.end()) {
        return def;
    }
    return i->second;
}

get() [2/2]

std::shared_ptr< Detector::InCameraBuilder > lsst::afw::cameraGeom::DetectorCollectionBase< Detector::InCameraBuilder >::get ( std::string const &  name, std::shared_ptr< Detector::InCameraBuilder >  def = nullptr  ) const

inherited

Retrieve a detector by name, or fall back to a default.

Parameters

[in]	name	detector name
[in]	def	default detector to return. This defaults to nullptr.

Returns

pointer to detector entry if the entry exists, else return the default value

Definition at line 99 of file DetectorCollection.cc.

                                                                                                  {
    auto i = _nameDict.find(name);
    if (i == _nameDict.end()) {
        return def;
    }
    return i->second;
}

getIdMap()

IdMap const& lsst::afw::cameraGeom::DetectorCollectionBase< Detector::InCameraBuilder >::getIdMap ( ) const

inlinenoexceptinherited

Get a map keyed and ordered by ID.

Definition at line 62 of file DetectorCollection.h.

{ return _idDict; }

getName()

std::string lsst::afw::cameraGeom::Camera::Builder::getName ( ) const

inline

Return the name of the camera.

Definition at line 230 of file Camera.h.

{ return _name; }

getNameMap()

NameMap const& lsst::afw::cameraGeom::DetectorCollectionBase< Detector::InCameraBuilder >::getNameMap ( ) const

inlinenoexceptinherited

Get a map keyed and ordered by name.

Definition at line 59 of file DetectorCollection.h.

{ return _nameDict; }

getPupilFactoryName()

std::string lsst::afw::cameraGeom::Camera::Builder::getPupilFactoryName ( ) const

inline

Return the fully-qualified name of the Python class that provides this Camera's PupilFactory.

Definition at line 236 of file Camera.h.

{ return _pupilFactoryName; }

operator[]() [1/2]

std::shared_ptr< Detector::InCameraBuilder > lsst::afw::cameraGeom::DetectorCollectionBase< Detector::InCameraBuilder >::operator[] ( int  id ) const

inherited

Implement the [id] operator.

Parameters

[in]

id

detector name

Returns

pointer to detector entry

Definition at line 88 of file DetectorCollection.cc.

                                                                   {
    auto det = get(id);
    if (det == nullptr) {
        throw LSST_EXCEPT(pex::exceptions::NotFoundError,
                          (boost::format("Detector with ID %s not found") % id).str());
    }
    return det;
}

operator[]() [2/2]

std::shared_ptr< Detector::InCameraBuilder > lsst::afw::cameraGeom::DetectorCollectionBase< Detector::InCameraBuilder >::operator[] ( std::string const &  name ) const

inherited

Implement the [name] operator.

Parameters

[in]

name

detector name

Returns

pointer to detector entry

Definition at line 80 of file DetectorCollection.cc.

                                                                                   {
    auto det = get(name);
    if (det == nullptr) {
        throw LSST_EXCEPT(pex::exceptions::NotFoundError,
                          (boost::format("Detector with name %s not found") % name).str());
    }
    return det;
}

remove() [1/2]

void lsst::afw::cameraGeom::Camera::Builder::remove ( int  id )

inline

Definition at line 284 of file Camera.h.

{ return BaseCollection::remove(id); }

remove() [2/2]

void lsst::afw::cameraGeom::Camera::Builder::remove ( std::string const &  name )

inline

Remove the detector with the given name or ID.

Wrapped as __delitem__ in Python.

Exceptions

pex::exceptions::NotFoundError

if no such detector exists.

Definition at line 283 of file Camera.h.

{ return BaseCollection::remove(name); }

setName()

void lsst::afw::cameraGeom::Camera::Builder::setName ( std::string const &  name )

inline

Set the name of the camera.

Definition at line 233 of file Camera.h.

{ _name = name; }

setPupilFactoryName()

void lsst::afw::cameraGeom::Camera::Builder::setPupilFactoryName ( std::string const &  pupilFactoryName )

inline

Set the fully-qualified name of the Python class that provides this Camera's PupilFactory.

Definition at line 239 of file Camera.h.

{ _pupilFactoryName = pupilFactoryName; }

setTransformFromFocalPlaneTo()

void lsst::afw::cameraGeom::Camera::Builder::setTransformFromFocalPlaneTo	(	CameraSys const &	toSys,
		std::shared_ptr< afw::geom::TransformPoint2ToPoint2 const >	transform
	)

Set the transformation from FOCAL_PLANE to the given coordinate system.

Parameters

toSys	Coordinate system this transform returns points in.
transform	Transform from FOCAL_PLANE to toSys.

If a transform already exists from FOCAL_PLANE to toSys, it is overwritten.

Definition at line 299 of file Camera.cc.

  {
    if (toSys.hasDetectorName()) {
        throw LSST_EXCEPT(
            pex::exceptions::LogicError,
            (boost::format("%s should be added to Detector %s, not Camera") %
             toSys.getSysName() % toSys.getDetectorName()).str()
        );
    }
    auto iter = findConnection(_connections.begin(), _connections.end(), toSys);
    if (iter == _connections.end()) {
        _connections.push_back(
            TransformMap::Connection{transform, getNativeCameraSys(), toSys}
        );
    } else {
        iter->transform = transform;
    }
}

size()

std::size_t lsst::afw::cameraGeom::DetectorCollectionBase< Detector::InCameraBuilder >::size ( ) const

inlinenoexceptinherited

Get the number of detectors.

Renamed to __len__ in Python.

Definition at line 67 of file DetectorCollection.h.

{ return _idDict.size(); }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/cameraGeom/Camera.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/cameraGeom/Camera.cc