LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
CameraSys.h
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2014 LSST Corporation.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <http://www.lsstcorp.org/LegalNotices/>.
21  */
22 
23 #if !defined(LSST_AFW_CAMERAGEOM_CAMERASYS_H)
24 #define LSST_AFW_CAMERAGEOM_CAMERASYS_H
25 
26 #include <functional>
27 #include <string>
28 #include <ostream>
29 #include <sstream>
30 
31 namespace lsst {
32 namespace afw {
33 namespace cameraGeom {
34 
44 class CameraSysPrefix final {
45 public:
47  )
48  : _sysName(sysName) {}
49 
50  ~CameraSysPrefix() noexcept = default;
51  CameraSysPrefix(CameraSysPrefix const &) = default;
52  CameraSysPrefix(CameraSysPrefix &&) noexcept = default;
53  CameraSysPrefix &operator=(CameraSysPrefix const &) = default;
54  CameraSysPrefix &operator=(CameraSysPrefix &&) noexcept = default;
55 
59  std::string getSysName() const { return _sysName; };
60 
61  bool operator==(CameraSysPrefix const &rhs) const noexcept { return _sysName == rhs.getSysName(); }
62 
63  bool operator!=(CameraSysPrefix const &rhs) const noexcept { return !(*this == rhs); }
64 
74  std::size_t hash_value() const noexcept;
75 
76 private:
77  std::string _sysName;
78 };
79 
83 class CameraSys final {
84 public:
88  explicit CameraSys(std::string const &sysName,
89  std::string const &detectorName = ""
90  )
91  : _sysName(sysName), _detectorName(detectorName){};
92 
96  explicit CameraSys(CameraSysPrefix const &sysPrefix,
97  std::string const &detectorName = ""
98  )
99  : _sysName(sysPrefix.getSysName()), _detectorName(detectorName){};
100 
102  CameraSys() : _sysName("?"), _detectorName(){};
103 
104  ~CameraSys() noexcept = default;
105  CameraSys(CameraSys const &) = default;
106  CameraSys(CameraSys &&) noexcept = default;
107  CameraSys &operator=(CameraSys const &) = default;
108  CameraSys &operator=(CameraSys &&) noexcept = default;
109 
113  std::string getSysName() const { return _sysName; };
114 
118  std::string getDetectorName() const { return _detectorName; };
119 
123  bool hasDetectorName() const noexcept { return !_detectorName.empty(); }
124 
125  bool operator==(CameraSys const &rhs) const noexcept {
126  return _sysName == rhs.getSysName() && _detectorName == rhs.getDetectorName();
127  }
128 
129  bool operator!=(CameraSys const &rhs) const noexcept { return !(*this == rhs); }
130 
131  // less-than operator required for use in std::map
132  bool operator<(CameraSys const &rhs) const noexcept {
133  if (_sysName == rhs.getSysName()) {
134  return _detectorName < rhs.getDetectorName();
135  } else {
136  return _sysName < rhs.getSysName();
137  }
138  }
139 
148  size_t hash_value() const noexcept;
149 
150 private:
151  std::string _sysName;
152  std::string _detectorName;
153 };
154 
155 // *** Standard camera coordinate systems ***
156 
167 extern CameraSys const FOCAL_PLANE;
168 
174 extern CameraSys const FIELD_ANGLE;
175 
187 extern CameraSysPrefix const PIXELS;
188 
204 extern CameraSysPrefix const TAN_PIXELS;
205 
212 extern CameraSysPrefix const ACTUAL_PIXELS;
213 
214 std::ostream &operator<<(std::ostream &os, CameraSysPrefix const &detSysPrefix);
215 
217 } // namespace cameraGeom
218 } // namespace afw
219 } // namespace lsst
220 
221 namespace std {
222 template <>
223 struct hash<lsst::afw::cameraGeom::CameraSysPrefix> {
226  size_t operator()(lsst::afw::cameraGeom::CameraSysPrefix const &obj) const noexcept {
227  return obj.hash_value();
228  }
229 };
230 
231 template <>
232 struct hash<lsst::afw::cameraGeom::CameraSys> {
235  size_t operator()(lsst::afw::cameraGeom::CameraSys const &obj) const noexcept { return obj.hash_value(); }
236 };
237 } // namespace std
238 
239 #endif
Camera coordinate system; used as a key in in TransformMap.
Definition: CameraSys.h:83
std::size_t hash_value() const noexcept
Hash function for this object.
Definition: CameraSys.cc:40
std::string getSysName() const
Get coordinate system name.
Definition: CameraSys.h:59
CameraSysPrefix const PIXELS
Pixel coordinates: Nominal position on the entry surface of a given detector (x, y unbinned pixels)...
Definition: CameraSys.cc:34
STL namespace.
table::Key< std::string > detectorName
bool operator!=(CameraSys const &rhs) const noexcept
Definition: CameraSys.h:129
CameraSysPrefix const ACTUAL_PIXELS
The actual pixels where the photon lands and electrons are generated (x,y unbinned) This takes into a...
Definition: CameraSys.cc:38
std::ostream & operator<<(std::ostream &os, CameraSysPrefix const &detSysPrefix)
Definition: CameraSys.cc:47
CameraSys(std::string const &sysName, std::string const &detectorName="")
Construct a CameraSys from a sysName and a detectorName.
Definition: CameraSys.h:88
STL class.
CameraSys()
default constructor so SWIG can wrap a vector of pairs containing these
Definition: CameraSys.h:102
std::string getSysName() const
Get coordinate system name.
Definition: CameraSys.h:113
A base class for image defects.
std::string getDetectorName() const
Get detector name, or "" if not a detector-specific coordinate system.
Definition: CameraSys.h:118
bool operator!=(CameraSysPrefix const &rhs) const noexcept
Definition: CameraSys.h:63
table::Key< std::string > sysName
Camera coordinate system prefix.
Definition: CameraSys.h:44
bool operator<(CameraSys const &rhs) const noexcept
Definition: CameraSys.h:132
CameraSys(CameraSysPrefix const &sysPrefix, std::string const &detectorName="")
Construct a CameraSys from a CameraSysPrefix and a detectorName.
Definition: CameraSys.h:96
bool hasDetectorName() const noexcept
Does this have a non-blank detector name?
Definition: CameraSys.h:123
CameraSysPrefix(std::string const &sysName)
Definition: CameraSys.h:46
CameraSys const FIELD_ANGLE
Field angle coordinates: Angle of a principal ray relative to the optical axis (x,y radians).
Definition: CameraSys.cc:32
CameraSysPrefix const TAN_PIXELS
Tangent-plane pixels on the detector (x, y unbinned pixels)
Definition: CameraSys.cc:36
size_t operator()(lsst::afw::cameraGeom::CameraSysPrefix const &obj) const noexcept
Definition: CameraSys.h:226
CameraSysPrefix & operator=(CameraSysPrefix const &)=default
size_t operator()(lsst::afw::cameraGeom::CameraSys const &obj) const noexcept
Definition: CameraSys.h:235
bool operator==(CameraSys const &rhs) const noexcept
Definition: CameraSys.h:125
STL class.
CameraSys const FOCAL_PLANE
Focal plane coordinates: Position on a 2-d planar approximation to the focal plane (x...
Definition: CameraSys.cc:30
std::ostream * os
Definition: Schema.cc:746
bool operator==(CameraSysPrefix const &rhs) const noexcept
Definition: CameraSys.h:61