Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04dff08e69+42feea4ef2,g0fba68d861+a0b9de4ea6,g1ec0fe41b4+f536777771,g1fd858c14a+42269675ea,g35bb328faa+fcb1d3bbc8,g4af146b050+bbef1ba6f0,g4d2262a081+8f21adb3a6,g53246c7159+fcb1d3bbc8,g5a012ec0e7+b20b785ecb,g60b5630c4e+43e3f0d37c,g6273192d42+e9a7147bac,g67b6fd64d1+4086c0989b,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g7bbe65ff3e+43e3f0d37c,g8352419a5c+fcb1d3bbc8,g87b7deb4dc+43704db330,g8852436030+eb2388797a,g89139ef638+4086c0989b,g9125e01d80+fcb1d3bbc8,g94187f82dc+43e3f0d37c,g989de1cb63+4086c0989b,g9d31334357+43e3f0d37c,g9f33ca652e+9b312035f9,gabe3b4be73+1e0a283bba,gabf8522325+fa80ff7197,gb1101e3267+61f2793e68,gb58c049af0+f03b321e39,gb89ab40317+4086c0989b,gc0bb628dac+834c1753f9,gcf25f946ba+eb2388797a,gd6cbbdb0b4+af3c3595f5,gde0f65d7ad+9e0145b227,ge278dab8ac+d65b3c2b70,ge410e46f29+4086c0989b,gf23fb2af72+37a5db1cfd,gf67bdafdda+4086c0989b,v29.0.0.rc7
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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
34namespace lsst {
35namespace afw {
36namespace image {
37
45class ApCorrMap final : public table::io::PersistableFacade<ApCorrMap>, public typehandling::Storable {
47
48public:
50 static std::size_t const MAX_NAME_LENGTH = 64;
51
54 using Iterator = Internal::const_iterator;
55
56 ApCorrMap() = default;
57 ApCorrMap(ApCorrMap const&) = default;
58 ApCorrMap(ApCorrMap&&) = default;
59 ApCorrMap& operator=(ApCorrMap const&) = 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
87private:
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
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
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
Definition ApCorrMap.cc:127
ApCorrMap(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
std::string getPythonModule() const override
Return the fully-qualified Python module that should be imported to guarantee that its factory is reg...
Definition ApCorrMap.cc:125
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
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
std::string getPersistenceName() const override
Return the unique name used to persist this object and look up its factory.
Definition ApCorrMap.cc:123
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
ApCorrMap & operator=(ApCorrMap const &)=default
Internal::const_iterator Iterator
Iterator type returned by begin() and end().
Definition ApCorrMap.h:54
ApCorrMap & operator=(ApCorrMap &&)=default
Iterator begin() const
Definition ApCorrMap.h:63
~ApCorrMap() override=default
A CRTP facade class for subclasses of Persistable.
io::OutputArchiveHandle OutputArchiveHandle
Interface supporting iteration over heterogenous containers.
Definition Storable.h:58