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< Detector > >

using	IdMap = std::map< int, std::shared_ptr< Detector > >

using	List = std::vector< std::shared_ptr< Detector > >

Public Member Functions
	DetectorCollection (List const &detectorList)

	DetectorCollection (DetectorCollection const &)=delete

	DetectorCollection (DetectorCollection &&)=delete

DetectorCollection &	operator= (DetectorCollection const &)=delete

DetectorCollection &	operator= (DetectorCollection &&)=delete

virtual	~DetectorCollection () noexcept

NameMap const &	getNameMap () const noexcept
	Get an unordered map over detector names. More...

IdMap const &	getIdMap () const noexcept
	Get an unordered map over detector IDs. More...

lsst::geom::Box2D const &	getFpBBox () const noexcept
	Return a focal plane bounding box that encompasses all detectors. More...

std::size_t	size () const noexcept
	Get the number of detectors. More...

bool	empty () const noexcept
	Determine if the DetectorCollection contains any Detectors. More...

std::shared_ptr< Detector >	operator[] (std::string const &name) const
	Implement the [name] operator. More...

std::shared_ptr< Detector >	operator[] (int id) const
	Implement the [id] operator. More...

std::shared_ptr< Detector >	get (std::string const &name, std::shared_ptr< Detector > def=nullptr) const
	Support the "in" operator. More...

std::shared_ptr< Detector >	get (int id, std::shared_ptr< Detector > def=nullptr) const
	Support the "in" operator. More...

bool	isPersistable () const noexcept override
	DetectorCollections are always persistable. 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< DetectorCollection >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...

static std::shared_ptr< DetectorCollection >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file. More...

static std::shared_ptr< DetectorCollection >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory. More...

static std::shared_ptr< DetectorCollection >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr. More...

Protected Types
typedef io::OutputArchiveHandle	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. More...

std::string	getPythonModule () const override
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...

void	write (OutputArchiveHandle &handle) const override
	Write the object to one or more catalogs. More...

Detailed Description

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

Definition at line 40 of file DetectorCollection.h.

Member Typedef Documentation

◆ IdMap

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

Definition at line 44 of file DetectorCollection.h.

◆ List

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

Definition at line 45 of file DetectorCollection.h.

◆ NameMap

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

Definition at line 43 of file DetectorCollection.h.

◆ OutputArchiveHandle

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

protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

◆ DetectorCollection() [1/4]

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

explicit

Definition at line 32 of file DetectorCollection.cc.

                                                                 {
     for (auto const & detector : detectorList) {
         _nameDict[detector->getName()] = detector;
         _idDict[detector->getId()] = detector;
         for (auto const & corner : detector->getCorners(FOCAL_PLANE)) {
             _fpBBox.include(corner);
         }
     }
 
     if (_idDict.size() < detectorList.size()) {
         throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Detector IDs are not unique");
     }
     if (_nameDict.size() < detectorList.size()) {
         throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Detector names are not unique");
     }
 }

◆ DetectorCollection() [2/4]

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

delete

◆ DetectorCollection() [3/4]

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

delete

◆ ~DetectorCollection()

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

virtualdefaultnoexcept

◆ DetectorCollection() [4/4]

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

protected

Definition at line 149 of file DetectorCollection.cc.

152 : DetectorCollection(PersistenceHelper::get().makeDetectorList(archive, catalogs))

153 {}

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

DetectorCollection(List const &detectorList)

Definition: DetectorCollection.cc:32

Member Function Documentation

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

◆ empty()

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

inlinenoexcept

Determine if the DetectorCollection contains any Detectors.

Definition at line 77 of file DetectorCollection.h.

77 { return _idDict.empty(); }

std::map::empty

T empty(T... args)

◆ get() [1/2]

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

Support the "in" operator.

Parameters

[in]	name	detector name
[in]	def	default detector to return. This defaults to the NULL pointer

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

Definition at line 67 of file DetectorCollection.cc.

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

◆ get() [2/2]

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

Support the "in" operator.

Parameters

[in]	id	detector id
[in]	def	default detector to return. This defaults to the NULL pointer

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

Definition at line 76 of file DetectorCollection.cc.

                                                                                          {
     auto i = _idDict.find(id);
     if (i == _idDict.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 67 of file DetectorCollection.h.

67 { return _fpBBox; }

◆ getIdMap()

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

inlinenoexcept

Get an unordered map over detector IDs.

Definition at line 64 of file DetectorCollection.h.

64 { return _idDict; }

◆ getNameMap()

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

inlinenoexcept

Get an unordered map over detector names.

Definition at line 61 of file DetectorCollection.h.

61 { 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 155 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 159 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 114 of file DetectorCollection.h.

                                                  {
         return true;
     }

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

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

delete

◆ operator[]() [1/2]

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

Implement the [name] operator.

Parameters

[in] name detector name

Returns: pointer to detector entry

Definition at line 51 of file DetectorCollection.cc.

                                                                                    {
     auto det = get(name);
     if (det == nullptr) {
         throw LSST_EXCEPT(pex::exceptions::NotFoundError, "Detector name not found");
     }
     return det;
 }

◆ operator[]() [2/2]

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

Implement the [id] operator.

Parameters

[in] id detector name

Returns: pointer to detector entry

Definition at line 59 of file DetectorCollection.cc.

                                                                    {
     auto det = get(id);
     if (det == nullptr) {
         throw LSST_EXCEPT(pex::exceptions::NotFoundError, "Detector id not found");
     }
     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.

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

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

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

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

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

◆ size()

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

inlinenoexcept

Get the number of detectors.

Renamed to __len__ in Python.

Definition at line 72 of file DetectorCollection.h.

72 { return _idDict.size(); }

std::map::size

T size(T... args)

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

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

/j/snowflake/release/lsstsw/stack/Linux64/afw/17.0.1-30-g596af8797/include/lsst/afw/cameraGeom/DetectorCollection.h
/j/snowflake/release/lsstsw/stack/Linux64/afw/17.0.1-30-g596af8797/src/cameraGeom/DetectorCollection.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ IdMap

◆ List

◆ NameMap

◆ OutputArchiveHandle

Constructor & Destructor Documentation

◆ DetectorCollection() [1/4]

◆ DetectorCollection() [2/4]

◆ DetectorCollection() [3/4]

◆ ~DetectorCollection()

◆ DetectorCollection() [4/4]

Member Function Documentation

◆ dynamicCast()

◆ empty()

◆ get() [1/2]

◆ get() [2/2]

◆ getFpBBox()

◆ getIdMap()

◆ getNameMap()

◆ getPersistenceName()

◆ getPythonModule()

◆ isPersistable()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ readFits() [1/3]

◆ readFits() [2/3]

◆ readFits() [3/3]

◆ size()

◆ write()

◆ writeFits() [1/3]

◆ writeFits() [2/3]

◆ writeFits() [3/3]