LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Static Protected Member Functions | Related Functions | List of all members
lsst::afw::image::ApCorrMap Class Referencefinal

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:
lsst::afw::table::io::PersistableFacade< ApCorrMap > lsst::afw::typehandling::Storable lsst::afw::table::io::Persistable

Public Types

using Iterator = Internal::const_iterator
 Iterator type returned by begin() and end(). More...
 

Public Member Functions

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

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

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. More...
 

Related Functions

(Note that these are not member functions.)

std::ostreamoperator<< (std::ostream &os, Storable const &storable)
 Output operator for Storable. More...
 

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.

63 { return _internal.begin(); }
T begin(T... args)

◆ 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.

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

◆ dynamicCast()

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::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

18  {
19  auto result = std::dynamic_pointer_cast<T>(ptr);
20  if (!result) {
21  throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22  }
23  return result;
24 }
py::object result
Definition: _schema.cc:429
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
uint64_t * ptr
Definition: RangeSet.cc:88

◆ end()

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

Definition at line 64 of file ApCorrMap.h.

64 { return _internal.end(); }
T end(T... args)

◆ 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::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 48 of file Storable.cc.

48 { 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.

53  {
54  Iterator i = _internal.find(name);
55  if (i == _internal.end()) {
57  }
58  return i->second;
59 }
table::Key< std::string > name
Definition: ApCorrMap.cc:76
Internal::const_iterator Iterator
Iterator type returned by begin() and end().
Definition: ApCorrMap.h:54
T find(T... args)

◆ hash_value()

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

Return a hash of this object (optional operation).

Exceptions
UnsupportedOperationExceptionThrown 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::typehandling::StorableHelper< Base >, lsst::afw::image::VisitInfo, lsst::afw::image::FilterLabel, and lsst::afw::geom::polygon::Polygon.

Definition at line 44 of file Storable.cc.

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

◆ 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.

116  {
117  for (auto const &i : *this) {
118  if (!i.second->isPersistable()) return false;
119  }
120  return true;
121 }

◆ operator*=()

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

Scale all fields by a constant.

Definition at line 138 of file ApCorrMap.cc.

138  {
139  Internal replacement;
140  for (auto const &i : *this) {
141  replacement[i.first] = (*i.second) * scale;
142  }
143  _internal = replacement;
144  return *this;
145 }
def scale(algorithm, min, max=None, frame=None)
Definition: ds9.py:108

◆ operator/=()

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

Definition at line 82 of file ApCorrMap.h.

82 { 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.

44  {
45  Iterator i = _internal.find(name);
46  if (i == _internal.end()) {
47  throw LSST_EXCEPT(pex::exceptions::NotFoundError,
48  (boost::format("Aperture correction with name '%s' not found") % name).str());
49  }
50  return i->second;
51 }
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174

◆ 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]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }
static std::shared_ptr< ApCorrMap > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18

◆ 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]managerManager for the memory to read from.
[in]hduHDU 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.

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

◆ 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]fileNameName of the file to read.
[in]hduHDU 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.

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

◆ 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.

61  {
62  if (name.size() > MAX_NAME_LENGTH) {
63  throw LSST_EXCEPT(
64  pex::exceptions::LengthError,
65  (boost::format("Aperture correction name '%s' exceeds size limit of %d characters") % name %
67  .str());
68  }
69  _internal.insert(std::make_pair(name, field));
70 }
table::Key< int > field
Definition: ApCorrMap.cc:77
static std::size_t const MAX_NAME_LENGTH
Maximum number of characters for an aperture correction name (required for persistence).
Definition: ApCorrMap.h:50
T insert(T... args)
T make_pair(T... args)

◆ 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
TThe class expected of the two objects to be compared.
Parameters
lhs,rhsThe 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.

151  {
152  auto typedRhs = dynamic_cast<T const*>(&rhs);
153  if (typedRhs != nullptr) {
154  return lhs == *typedRhs;
155  } else {
156  return false;
157  }
158  }

◆ size()

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

Definition at line 66 of file ApCorrMap.h.

66 { return _internal.size(); }
T size(T... args)

◆ toString()

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

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

Exceptions
UnsupportedOperationExceptionThrown if this object does not have a string representation.
Note
When called on Python classes, this method delegates to __repr__.

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

Definition at line 40 of file Storable.cc.

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

◆ 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]fitsfileOpen FITS object to write to.

Definition at line 18 of file Persistable.cc.

18  {
19  OutputArchive archive;
20  archive.put(this);
21  archive.writeFits(fitsfile);
22 }

◆ 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]managerName of the file to write to.
[in]modeIf "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.

29  {
30  fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
31  writeFits(fitsfile);
32 }
void writeFits(std::string const &fileName, std::string const &mode="w") const
Write the object to a regular FITS file.
Definition: Persistable.cc:24

◆ 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]fileNameName of the file to write to.
[in]modeIf "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.

24  {
25  fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
26  writeFits(fitsfile);
27 }

Friends And Related Function Documentation

◆ operator<<()

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

Output operator for Storable.

Parameters
osthe desired output stream
storablethe object to print
Returns
a reference to os
Exceptions
UnsupportedOperationExceptionThrown if storable does not have an implementation of Storable::toString.

Definition at line 174 of file Storable.h.

174  {
175  return os << storable.toString();
176 }
std::ostream * os
Definition: Schema.cc:557

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: