lsst.afw  22.0.0-22-gf1d71818e+0d6c1a9e28
ApCorrMap.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008-2014 LSST Corporation.
5  *
6  * This product includes software developed by the
7  * LSST Project (http://www.lsst.org/).
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the LSST License Statement and
20  * the GNU General Public License along with this program. If not,
21  * see <http://www.lsstcorp.org/LegalNotices/>.
22  */
23 
24 #ifndef LSST_AFW_IMAGE_ApCorrMap_h_INCLUDED
25 #define LSST_AFW_IMAGE_ApCorrMap_h_INCLUDED
26 
27 #include <string>
28 #include <map>
29 
33 
34 namespace lsst {
35 namespace afw {
36 namespace image {
37 
47 
48 public:
50  static std::size_t const MAX_NAME_LENGTH = 64;
51 
54  typedef Internal::const_iterator Iterator;
55 
56  ApCorrMap() = default;
57  ApCorrMap(ApCorrMap const&) = default;
58  ApCorrMap(ApCorrMap&&) = default;
59  ApCorrMap& operator=(ApCorrMap const&) = default;
60  ApCorrMap& operator=(ApCorrMap&&) = default;
61  ~ApCorrMap() override = default;
62 
63  Iterator begin() const { return _internal.begin(); }
64  Iterator end() const { return _internal.end(); }
65 
66  std::size_t size() const { return _internal.size(); }
67 
70 
73 
76 
78  bool isPersistable() const noexcept override;
79 
81  ApCorrMap& operator*=(double const scale);
82  ApCorrMap& operator/=(double const scale) { return *this *= 1.0 / scale; }
83 
86 
87 private:
88  std::string getPersistenceName() const override;
89 
90  std::string getPythonModule() const override;
91 
92  void write(OutputArchiveHandle& handle) const override;
93 
94  Internal _internal;
95 };
96 } // namespace image
97 } // namespace afw
98 } // namespace lsst
99 
100 #endif // !LSST_AFW_IMAGE_ApCorrMap_h_INCLUDED
table::Key< std::string > name
Definition: Amplifier.cc:116
table::Key< int > field
Definition: ApCorrMap.cc:77
T begin(T... args)
A thin wrapper around std::map to allow aperture corrections to be attached to Exposures.
Definition: ApCorrMap.h:45
std::shared_ptr< typehandling::Storable > cloneStorable() const override
Create a new ApCorrMap that is a copy of this one.
Definition: ApCorrMap.cc:147
std::size_t size() const
Definition: ApCorrMap.h:66
Internal::const_iterator Iterator
Iterator type returned by begin() and end().
Definition: ApCorrMap.h:54
ApCorrMap(ApCorrMap const &)=default
ApCorrMap & operator=(ApCorrMap const &)=default
Iterator end() const
Definition: ApCorrMap.h:64
bool isPersistable() const noexcept override
Whether the map is persistable (true IFF all contained BoundedFields are persistable).
Definition: ApCorrMap.cc:116
void set(std::string const &name, std::shared_ptr< math::BoundedField > field)
Add or replace an aperture correction.
Definition: ApCorrMap.cc:61
ApCorrMap(ApCorrMap &&)=default
ApCorrMap & operator=(ApCorrMap &&)=default
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.
Definition: ApCorrMap.cc:53
static std::size_t const MAX_NAME_LENGTH
Maximum number of characters for an aperture correction name (required for persistence).
Definition: ApCorrMap.h:50
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.
Definition: ApCorrMap.cc:44
Iterator begin() const
Definition: ApCorrMap.h:63
~ApCorrMap() override=default
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
io::OutputArchiveHandle OutputArchiveHandle
Definition: Persistable.h:108
Interface supporting iteration over heterogenous containers.
Definition: Storable.h:58
T end(T... args)
def scale(algorithm, min, max=None, frame=None)
Definition: ds9.py:108
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
class[[deprecated("Removed with no replacement (but see lsst::afw::image::TransmissionCurve). Will be " "removed after v22.")]] FilterProperty final
Describe the properties of a Filter (e.g.
Definition: Filter.h:53
A base class for image defects.
T size(T... args)