LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
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 
32 
33 namespace lsst { namespace afw { namespace image {
34 
43  typedef std::map<std::string,PTR(math::BoundedField)> Internal;
44 public:
45 
47  static std::size_t const MAX_NAME_LENGTH = 64;
48 
50  typedef Internal::const_iterator Iterator;
51 
52  Iterator begin() const { return _internal.begin(); }
53  Iterator end() const { return _internal.end(); }
54 
55  std::size_t size() const { return _internal.size(); }
56 
58  PTR(math::BoundedField) const operator[](std::string const & name) const;
59 
61  PTR(math::BoundedField) const get(std::string const & name) const;
62 
64  void set(std::string const & name, PTR(math::BoundedField) field);
65 
67  virtual bool isPersistable() const;
68 
70  void operator*=(double const scale);
71  void operator/=(double const scale) { *this *= 1.0/scale; }
72 
73 private:
74 
75  virtual std::string getPersistenceName() const;
76 
77  virtual std::string getPythonModule() const;
78 
79  virtual void write(OutputArchiveHandle & handle) const;
80 
82 };
83 
84 }}} // lsst::afw::image
85 
86 #endif // !LSST_AFW_IMAGE_ApCorrMap_h_INCLUDED
Iterator begin() const
Definition: ApCorrMap.h:52
virtual std::string getPythonModule() const
Return the fully-qualified Python module that should be imported to guarantee that its factory is reg...
Definition: ApCorrMap.cc:135
static std::size_t const MAX_NAME_LENGTH
Maximum number of characters for an aperture correction name (required for persistence).
Definition: ApCorrMap.h:47
void set(std::string const &name, boost::shared_ptr< math::BoundedField > field)
Add or replace an aperture correction.
Definition: ApCorrMap.cc:56
table::Key< std::string > name
Definition: ApCorrMap.cc:71
A thin wrapper around std::map to allow aperture corrections to be attached to Exposures.
Definition: ApCorrMap.h:42
#define PTR(...)
Definition: base.h:41
std::size_t size() const
Definition: ApCorrMap.h:55
table::Key< table::Array< Kernel::Pixel > > image
Definition: FixedKernel.cc:117
A base class for objects that can be persisted via afw::table::io Archive classes.
Definition: Persistable.h:74
virtual std::string getPersistenceName() const
Return the unique name used to persist this object and look up its factory.
Definition: ApCorrMap.cc:131
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...
Definition: ApCorrMap.cc:48
Iterator end() const
Definition: ApCorrMap.h:53
virtual bool isPersistable() const
Whether the map is persistable (true IFF all contained BoundedFields are persistable).
Definition: ApCorrMap.cc:124
virtual void write(OutputArchiveHandle &handle) const
Write the object to one or more catalogs.
Definition: ApCorrMap.cc:139
An abstract base class for 2-d functions defined on an integer bounding boxes.
Definition: BoundedField.h:49
io::OutputArchiveHandle OutputArchiveHandle
Definition: Persistable.h:114
Internal::const_iterator Iterator
Iterator type returned by begin() and end(). Dereferences to a pair&lt;string,PTR(BoundedField)&gt;.
Definition: ApCorrMap.h:50
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:182
std::map< std::string, boost::shared_ptr< math::BoundedField > > Internal
Definition: ApCorrMap.h:43
table::Key< int > field
Definition: ApCorrMap.cc:72