A thin wrapper around std::map to allow aperture corrections to be attached to Exposures. More...

#include <ApCorrMap.h>

Inheritance diagram for lsst::afw::image::ApCorrMap:

Public Types
typedef Internal::const_iterator	Iterator
	Iterator type returned by begin() and end(). Dereferences to a pair<string,PTR(BoundedField)>. More...

Public Member Functions
Iterator	begin () const

Iterator	end () const

std::size_t	size () const

boost::shared_ptr < math::BoundedField > const	operator[] (std::string const &name) const
	Return the field with the given name, throwing NotFoundError when the name is not present. More...

boost::shared_ptr < math::BoundedField > const	get (std::string const &name) const
	Return the field with the given name, returning an empty pointer when the name is not present. More...

void	set (std::string const &name, boost::shared_ptr< math::BoundedField > field)
	Add or replace an aperture correction. More...

virtual bool	isPersistable () const
	Whether the map is persistable (true IFF all contained BoundedFields are persistable). More...

void	operator*= (double const scale)
	Scale all fields by a constant. More...

void	operator/= (double const scale)

Public Member Functions inherited from lsst::afw::table::io::Persistable
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...

virtual	~Persistable ()

Static Public Attributes
static std::size_t const	MAX_NAME_LENGTH = 64
	Maximum number of characters for an aperture correction name (required for persistence). More...

Private Types
typedef std::map< std::string, boost::shared_ptr < math::BoundedField > >	Internal

Private Member Functions
virtual std::string	getPersistenceName () const
	Return the unique name used to persist this object and look up its factory. More...

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

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

Private Attributes
Internal	_internal

Additional Inherited Members
Static Public Member Functions inherited from lsst::afw::table::io::PersistableFacade< ApCorrMap >
static boost::shared_ptr < ApCorrMap >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...

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

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

Protected Types inherited from lsst::afw::table::io::Persistable
typedef io::OutputArchiveHandle	OutputArchiveHandle

Protected Member Functions inherited from lsst::afw::table::io::Persistable
	Persistable ()

	Persistable (Persistable const &other)

void	operator= (Persistable const &other)

Detailed Description

A thin wrapper around std::map to allow aperture corrections to be attached to Exposures.

ApCorrMap simply adds error handling accessors, persistence, and a bit of encapsulation to std::map (given the simplified interface, for instance, we could switch to unordered_map or some other underyling container in the future).

Definition at line 42 of file ApCorrMap.h.

Member Typedef Documentation

typedef std::map<std::string,boost::shared_ptr< math::BoundedField > > lsst::afw::image::ApCorrMap::Internal

private

Definition at line 43 of file ApCorrMap.h.

typedef Internal::const_iterator lsst::afw::image::ApCorrMap::Iterator

Iterator type returned by begin() and end(). Dereferences to a pair<string,PTR(BoundedField)>.

Definition at line 50 of file ApCorrMap.h.

Member Function Documentation

Iterator lsst::afw::image::ApCorrMap::begin ( ) const

inline

Definition at line 52 of file ApCorrMap.h.

52 { return _internal.begin(); }

lsst::afw::image::ApCorrMap::_internal

Internal _internal

Definition: ApCorrMap.h:81

Iterator lsst::afw::image::ApCorrMap::end ( ) const

inline

Definition at line 53 of file ApCorrMap.h.

53 { return _internal.end(); }

lsst::afw::image::ApCorrMap::_internal

Internal _internal

Definition: ApCorrMap.h:81

boost::shared_ptr< math::BoundedField > const lsst::afw::image::ApCorrMap::get ( std::string const & name ) const

Return the field with the given name, returning an empty pointer when the name is not present.

Definition at line 48 of file ApCorrMap.cc.

                                                                        {
     Iterator i = _internal.find(name);
     if (i == _internal.end()) {
         return PTR(math::BoundedField)();
     }
     return i->second;
 }

std::string lsst::afw::image::ApCorrMap::getPersistenceName ( ) const

privatevirtual

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 131 of file ApCorrMap.cc.

                                               {
     return getApCorrMapPersistenceName();
 }

std::string lsst::afw::image::ApCorrMap::getPythonModule ( ) const

privatevirtual

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 135 of file ApCorrMap.cc.

                                            {
     return "lsst.afw.image";
 }

bool lsst::afw::image::ApCorrMap::isPersistable ( ) const

virtual

Whether the map is persistable (true IFF all contained BoundedFields are persistable).

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

Definition at line 124 of file ApCorrMap.cc.

                                     {
     for (Iterator i = begin(); i != end(); ++i) {
         if (!i->second->isPersistable()) return false;
     }
     return true;
 }

void lsst::afw::image::ApCorrMap::operator*= ( double const scale )

Scale all fields by a constant.

Definition at line 150 of file ApCorrMap.cc.

                                              {
     Internal replacement;
     for (Iterator i = begin(); i != end(); ++i) {
         replacement[i->first] = (*i->second)*scale;
     }
     _internal = replacement;
 }

void lsst::afw::image::ApCorrMap::operator/= ( double const scale )

inline

Definition at line 71 of file ApCorrMap.h.

71 { *this *= 1.0/scale; }

lsst::afw.display.ds9.scale

def scale

Definition: ds9.py:91

boost::shared_ptr< math::BoundedField > const lsst::afw::image::ApCorrMap::operator[] ( std::string const & name ) const

Return the field with the given name, throwing NotFoundError when the name is not present.

Definition at line 37 of file ApCorrMap.cc.

                                                                               {
     Iterator i = _internal.find(name);
     if (i == _internal.end()) {
         throw LSST_EXCEPT(
             pex::exceptions::NotFoundError,
             (boost::format("Aperture correction with name '%s' not found") % name).str()
         );
     }
     return i->second;
 }

void lsst::afw::image::ApCorrMap::set	(	std::string const &	name,
		boost::shared_ptr< math::BoundedField >	field
	)

Add or replace an aperture correction.

Definition at line 56 of file ApCorrMap.cc.

                                                                        {
     if (name.size() > MAX_NAME_LENGTH) {
         throw LSST_EXCEPT(
             pex::exceptions::LengthError,
             (boost::format("Aperture correction name '%s' exceeds size limit of %d characters")
              % name % MAX_NAME_LENGTH).str()
         );
     }
     _internal.insert(std::make_pair(name, field));
 }

std::size_t lsst::afw::image::ApCorrMap::size ( ) const

inline

Definition at line 55 of file ApCorrMap.h.

55 { return _internal.size(); }

lsst::afw::image::ApCorrMap::_internal

Internal _internal

Definition: ApCorrMap.h:81

void lsst::afw::image::ApCorrMap::write ( OutputArchiveHandle & handle ) const

privatevirtual

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 139 of file ApCorrMap.cc.

                                                         {
     PersistenceHelper const & keys = PersistenceHelper::get();
     table::BaseCatalog catalog = handle.makeCatalog(keys.schema);
     for (Iterator i = begin(); i != end(); ++i) {
         PTR(table::BaseRecord) record = catalog.addNew();
         record->set(keys.name, i->first);
         record->set(keys.field, handle.put(i->second));
     }
     handle.saveCatalog(catalog);
 }

Member Data Documentation

Internal lsst::afw::image::ApCorrMap::_internal

private

Definition at line 81 of file ApCorrMap.h.

std::size_t const lsst::afw::image::ApCorrMap::MAX_NAME_LENGTH = 64

static

Maximum number of characters for an aperture correction name (required for persistence).

Definition at line 47 of file ApCorrMap.h.

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

/home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/image/ApCorrMap.h
/home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/image/ApCorrMap.cc

Public Types

Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Function Documentation

Member Data Documentation