lsst::afw::cameraGeom::DetectorCollection Class Reference

An immutable collection of Detectors that can be accessed by name or ID. More...

#include <DetectorCollection.h>

Inheritance diagram for lsst::afw::cameraGeom::DetectorCollection:

Classes
class	Factory

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

Public Member Functions
	DetectorCollection (List const &list)
virtual	~DetectorCollection () noexcept
lsst::geom::Box2D const &	getFpBBox () const noexcept
	Return a focal plane bounding box that encompasses all detectors.
	DetectorCollection (DetectorCollection const &)=delete
	DetectorCollection (DetectorCollection &&)=delete
DetectorCollection &	operator= (DetectorCollection const &)=delete
DetectorCollection &	operator= (DetectorCollection &&)=delete
bool	isPersistable () const noexcept override
	DetectorCollections are always persistable.
NameMap const &	getNameMap () const noexcept
	Get a map keyed and ordered by name.
IdMap const &	getIdMap () const noexcept
	Get a map keyed and ordered by ID.
std::size_t	size () const noexcept
	Get the number of detectors.
bool	empty () const noexcept
	Determine if the collection contains any detectors.
std::shared_ptr< T >	operator[] (std::string const &name) const
	Implement the [name] operator.
std::shared_ptr< T >	operator[] (int id) const
	Implement the [id] operator.
std::shared_ptr< T >	get (std::string const &name, std::shared_ptr< T > def=nullptr) const
	Retrieve a detector by name, or fall back to a default.
std::shared_ptr< T >	get (int id, std::shared_ptr< T > def=nullptr) const
	Retrieve a detector by ID, or fall back to a default.
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< DetectorCollection >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object.
static std::shared_ptr< DetectorCollection >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file.
static std::shared_ptr< DetectorCollection >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory.
static std::shared_ptr< DetectorCollection >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr.

Protected Types
using	OutputArchiveHandle = io::OutputArchiveHandle

Protected Member Functions
	DetectorCollection (table::io::InputArchive const &archive, table::io::CatalogVector const &catalogs)
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.
void	add (std::shared_ptr< T > detector)
	Add a detector to the collection.
void	remove (std::string const &name)
void	remove (int id)

Detailed Description

An immutable collection of Detectors that can be accessed by name or ID.

Definition at line 149 of file DetectorCollection.h.

Member Typedef Documentation

IdMap

template<typename T >

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

inherited

Definition at line 53 of file DetectorCollection.h.

List

template<typename T >

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

inherited

Definition at line 54 of file DetectorCollection.h.

NameMap

template<typename T >

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

inherited

Definition at line 52 of file DetectorCollection.h.

OutputArchiveHandle

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

protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

DetectorCollection() [1/4]

lsst::afw::cameraGeom::DetectorCollection::DetectorCollection

(

List const &

list

)

Definition at line 207 of file DetectorCollection.cc.

                                                                :
    DetectorCollectionBase<Detector const>(detectorList)
{
    for (auto const & detector : detectorList) {
        for (auto const & corner : detector->getCorners(FOCAL_PLANE)) {
            _fpBBox.include(corner);
        }
    }
}

~DetectorCollection()

lsst::afw::cameraGeom::DetectorCollection::~DetectorCollection ( )

virtualdefaultnoexcept

DetectorCollection() [2/4]

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

delete

DetectorCollection() [3/4]

lsst::afw::cameraGeom::DetectorCollection::DetectorCollection ( DetectorCollection && )

delete

DetectorCollection() [4/4]

lsst::afw::cameraGeom::DetectorCollection::DetectorCollection ( table::io::InputArchive const & archive, table::io::CatalogVector const & catalogs )

protected

Definition at line 234 of file DetectorCollection.cc.

  : DetectorCollection(PersistenceHelper::get().makeDetectorList(archive, catalogs))
{}

Member Function Documentation

add()

template<typename T >

void lsst::afw::cameraGeom::DetectorCollectionBase< T >::add ( std::shared_ptr< T > 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 89 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
        }
    }
}

dynamicCast()

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

empty()

template<typename T >

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

inlinenoexceptinherited

Determine if the collection contains any detectors.

Definition at line 72 of file DetectorCollection.h.

{ return _idDict.empty(); }

get() [1/2]

template<typename T >

std::shared_ptr< T > lsst::afw::cameraGeom::DetectorCollectionBase< T >::get ( int id, std::shared_ptr< T > 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 65 of file DetectorCollection.cc.

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

get() [2/2]

template<typename T >

std::shared_ptr< T > lsst::afw::cameraGeom::DetectorCollectionBase< T >::get ( std::string const & name, std::shared_ptr< T > 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 56 of file DetectorCollection.cc.

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

getFpBBox()

lsst::geom::Box2D const & lsst::afw::cameraGeom::DetectorCollection::getFpBBox ( ) const

inlinenoexcept

Return a focal plane bounding box that encompasses all detectors.

Definition at line 159 of file DetectorCollection.h.

{ return _fpBBox; }

getIdMap()

template<typename T >

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

inlinenoexceptinherited

Get a map keyed and ordered by ID.

Definition at line 62 of file DetectorCollection.h.

{ return _idDict; }

getNameMap()

template<typename T >

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

inlinenoexceptinherited

Get a map keyed and ordered by name.

Definition at line 59 of file DetectorCollection.h.

{ return _nameDict; }

getPersistenceName()

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

overrideprotectedvirtual

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 242 of file DetectorCollection.cc.

                                                       {
    return "DetectorCollection";
}

getPythonModule()

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

overrideprotectedvirtual

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 246 of file DetectorCollection.cc.

                                                    {
    return "lsst.afw.cameraGeom";
}

isPersistable()

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

inlineoverridevirtualnoexcept

DetectorCollections are always persistable.

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

Definition at line 171 of file DetectorCollection.h.

                                                 {
        return true;
    }

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

operator[]() [1/2]

template<typename T >

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

inherited

Implement the [id] operator.

Parameters

[in]

id

detector name

Returns

pointer to detector entry

Definition at line 46 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]

template<typename T >

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

inherited

Implement the [name] operator.

Parameters

[in]

name

detector name

Returns

pointer to detector entry

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

readFits() [1/3]

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

remove() [1/2]

template<typename T >

void lsst::afw::cameraGeom::DetectorCollectionBase< T >::remove ( int id )

protectedinherited

Definition at line 144 of file DetectorCollection.cc.

                                             {
    auto idIter = _idDict.find(id);
    if (idIter == _idDict.end()) {
        throw LSST_EXCEPT(
            pex::exceptions::NotFoundError,
            (boost::format("Detector with ID %s not found.") % id).str()
        );
    }
    auto nameIter = _nameDict.find(idIter->second->getName());
    assert(nameIter != _nameDict.end());
    _nameDict.erase(nameIter);
    _idDict.erase(idIter);
}

remove() [2/2]

template<typename T >

void lsst::afw::cameraGeom::DetectorCollectionBase< T >::remove ( std::string const & name )

protectedinherited

Definition at line 129 of file DetectorCollection.cc.

                                                             {
    auto nameIter = _nameDict.find(name);
    if (nameIter == _nameDict.end()) {
        throw LSST_EXCEPT(
            pex::exceptions::NotFoundError,
            (boost::format("Detector with name %s not found.") % name).str()
        );
    }
    auto idIter = _idDict.find(nameIter->second->getId());
    assert(idIter != _idDict.end());
    _nameDict.erase(nameIter);
    _idDict.erase(idIter);
}

size()

template<typename T >

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

inlinenoexceptinherited

Get the number of detectors.

Renamed to __len__ in Python.

Definition at line 67 of file DetectorCollection.h.

{ return _idDict.size(); }

write()

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

overrideprotectedvirtual

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 250 of file DetectorCollection.cc.

                                                                {
    auto const & keys = PersistenceHelper::get();
    auto cat = handle.makeCatalog(keys.schema);
    for (auto const & pair : getIdMap()) {
        auto record = cat.addNew();
        record->set(keys.detector, handle.put(pair.second));
    }
    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-9.0.0/Linux64/afw/g2160c40384+da0d0eec6b/include/lsst/afw/cameraGeom/DetectorCollection.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g2160c40384+da0d0eec6b/src/cameraGeom/DetectorCollection.cc