lsst::afw::image::ApCorrMap Class Reference

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
using	Iterator = Internal::const_iterator
	Iterator type returned by begin() and end().

Public Member Functions
	ApCorrMap ()=default
	ApCorrMap (ApCorrMap const &)=default
	ApCorrMap (ApCorrMap &&)=default
ApCorrMap &	operator= (ApCorrMap const &)=default
ApCorrMap &	operator= (ApCorrMap &&)=default
	~ApCorrMap () override=default
Iterator	begin () const
Iterator	end () const
std::size_t	size () const
std::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.
std::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.
void	set (std::string const &name, std::shared_ptr< math::BoundedField > field)
	Add or replace an aperture correction.
bool	isPersistable () const noexcept override
	Whether the map is persistable (true IFF all contained BoundedFields are persistable).
ApCorrMap &	operator*= (double const scale)
	Scale all fields by a constant.
ApCorrMap &	operator/= (double const scale)
std::shared_ptr< typehandling::Storable >	cloneStorable () const override
	Create a new ApCorrMap that is a copy of this one.
virtual std::string	toString () const
	Create a string representation of this object (optional operation).
virtual std::size_t	hash_value () const
	Return a hash of this object (optional operation).
virtual bool	equals (Storable const &other) const noexcept
	Compare this object to another Storable.
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< ApCorrMap >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object.
static std::shared_ptr< ApCorrMap >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file.
static std::shared_ptr< ApCorrMap >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory.
static std::shared_ptr< ApCorrMap >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr.

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

Protected Types
using	OutputArchiveHandle = io::OutputArchiveHandle

Static Protected Member Functions
template<class T >
static bool	singleClassEquals (T const &lhs, Storable const &rhs)
	Test if a Storable is of a particular class and equal to another object.

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.

Related Symbols
(Note that these are not member symbols.)
std::ostream &	operator<< (std::ostream &os, Storable const &storable)
	Output operator for Storable.

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 45 of file ApCorrMap.h.

Member Typedef Documentation

Iterator

using lsst::afw::image::ApCorrMap::Iterator = Internal::const_iterator

Iterator type returned by begin() and end().

Dereferences to a pair<string,std::shared_ptr<BoundedField>>.

Definition at line 54 of file ApCorrMap.h.

OutputArchiveHandle

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

protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

ApCorrMap() [1/3]

lsst::afw::image::ApCorrMap::ApCorrMap ( )

default

ApCorrMap() [2/3]

lsst::afw::image::ApCorrMap::ApCorrMap ( ApCorrMap const & )

default

ApCorrMap() [3/3]

lsst::afw::image::ApCorrMap::ApCorrMap ( ApCorrMap && )

default

~ApCorrMap()

lsst::afw::image::ApCorrMap::~ApCorrMap ( )

overridedefault

Member Function Documentation

begin()

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

inline

Definition at line 63 of file ApCorrMap.h.

{ return _internal.begin(); }

cloneStorable()

std::shared_ptr< typehandling::Storable > lsst::afw::image::ApCorrMap::cloneStorable ( ) const

overridevirtual

Create a new ApCorrMap that is a copy of this one.

Reimplemented from lsst::afw::typehandling::Storable.

Definition at line 147 of file ApCorrMap.cc.

                                                                   {
    return std::make_unique<ApCorrMap>(*this);
}

dynamicCast()

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

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

inline

Definition at line 64 of file ApCorrMap.h.

{ return _internal.end(); }

equals()

bool lsst::afw::typehandling::Storable::equals ( Storable const & other ) const

virtualnoexceptinherited

Compare this object to another Storable.

Subclasses that implement equality comparison must override this method to give results consistent with operator== for all inputs that are accepted by both.

Returns

This implementation returns whether the two objects are the same.

Warning

This method compares an object to any type of Storable, although cross-class comparisons should usually return false. If cross-class comparisons are valid, implementers should take care that they are symmetric and will give the same result no matter what the compile-time types of the left- and right-hand sides are.

See also

singleClassEquals

Note

When called on Python classes, this method delegates to __eq__ if it exists.

Reimplemented in lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::image::PhotoCalib, and lsst::afw::image::VisitInfo.

Definition at line 48 of file Storable.cc.

{ return this == &other; }

get()

std::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 53 of file ApCorrMap.cc.

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

getPersistenceName()

std::string lsst::afw::image::ApCorrMap::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 123 of file ApCorrMap.cc.

{ return getApCorrMapPersistenceName(); }

getPythonModule()

std::string lsst::afw::image::ApCorrMap::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 125 of file ApCorrMap.cc.

{ return "lsst.afw.image"; }

hash_value()

std::size_t lsst::afw::typehandling::Storable::hash_value ( ) const

virtualinherited

Return a hash of this object (optional operation).

Exceptions

UnsupportedOperationException

Thrown if this object is not hashable.

Note

C++ subclass authors are responsible for any associated specializations of std::hash.

When called on Python classes, this method delegates to __hash__ if it exists.

Reimplemented in lsst::afw::geom::polygon::Polygon, lsst::afw::image::FilterLabel, lsst::afw::image::VisitInfo, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 44 of file Storable.cc.

                                     {
    throw LSST_EXCEPT(UnsupportedOperationException, "Hashes are not supported.");
}

isPersistable()

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

overridevirtualnoexcept

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

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

Definition at line 116 of file ApCorrMap.cc.

                                             {
    for (auto const &i : *this) {
        if (!i.second->isPersistable()) return false;
    }
    return true;
}

operator*=()

ApCorrMap & lsst::afw::image::ApCorrMap::operator*=

(

double const

scale

)

Scale all fields by a constant.

Definition at line 138 of file ApCorrMap.cc.

                                                   {
    Internal replacement;
    for (auto const &i : *this) {
        replacement[i.first] = (*i.second) * scale;
    }
    _internal = replacement;
    return *this;
}

operator/=()

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

inline

Definition at line 82 of file ApCorrMap.h.

{ return *this *= 1.0 / scale; }

operator=() [1/2]

ApCorrMap & lsst::afw::image::ApCorrMap::operator= ( ApCorrMap && )

default

operator=() [2/2]

ApCorrMap & lsst::afw::image::ApCorrMap::operator= ( ApCorrMap const & )

default

operator[]()

std::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 44 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;
}

readFits() [1/3]

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

set()

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

Add or replace an aperture correction.

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

singleClassEquals()

template<class T >

static bool lsst::afw::typehandling::Storable::singleClassEquals ( T const & lhs, Storable const & rhs )

inlinestaticprotectedinherited

Test if a Storable is of a particular class and equal to another object.

This method template simplifies implementations of equals that delegate to operator== without supporting cross-class comparisons.

Template Parameters

T	The class expected of the two objects to be compared.

Parameters

lhs,rhs

The objects to compare. Note that rhs need not be a T, while lhs must be.

Returns

true if rhs is a T and lhs == rhs; false otherwise.

Exception Safety

Provides the same level of exception safety as operator==. Most implementations of operator== do not throw.

Note

This method template calls operator== with both arguments of compile-time type T const&. Its use is not recommended if there would be any ambiguity as to which operator== gets picked by overload resolution.

This method template is typically called from equals as:

bool MyType::equals(Storable const& other) const noexcept {
    return singleClassEquals(*this, other);
}

Definition at line 151 of file Storable.h.

                                                                     {
        auto typedRhs = dynamic_cast<T const*>(&rhs);
        if (typedRhs != nullptr) {
            return lhs == *typedRhs;
        } else {
            return false;
        }
    }

size()

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

inline

Definition at line 66 of file ApCorrMap.h.

{ return _internal.size(); }

toString()

std::string lsst::afw::typehandling::Storable::toString ( ) const

virtualinherited

Create a string representation of this object (optional operation).

Exceptions

UnsupportedOperationException

Thrown if this object does not have a string representation.

Note

When called on Python classes, this method delegates to __repr__.

Reimplemented in lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::image::FilterLabel, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 40 of file Storable.cc.

                                   {
    throw LSST_EXCEPT(UnsupportedOperationException, "No string representation available.");
}

write()

void lsst::afw::image::ApCorrMap::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 127 of file ApCorrMap.cc.

                                                       {
    PersistenceHelper const& keys = PersistenceHelper::get();
    table::BaseCatalog catalog = handle.makeCatalog(keys.schema);
    for (auto const &i : *this) {
        std::shared_ptr<table::BaseRecord> record = catalog.addNew();
        record->set(keys.name, i.first);
        record->set(keys.field, handle.put(i.second));
    }
    handle.saveCatalog(catalog);
}

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

Friends And Related Symbol Documentation

operator<<()

std::ostream & operator<< ( std::ostream & os, Storable const & storable )

related

Output operator for Storable.

Parameters

os	the desired output stream
storable	the object to print

Returns

a reference to os

Exceptions

UnsupportedOperationException

Thrown if storable does not have an implementation of Storable::toString.

Definition at line 174 of file Storable.h.

                                                                        {
    return os << storable.toString();
}

Member Data Documentation

MAX_NAME_LENGTH

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 50 of file ApCorrMap.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/include/lsst/afw/image/ApCorrMap.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/src/image/ApCorrMap.cc