LSSTApplications  20.0.0
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 
101  ~CameraSys() noexcept = default;
102  CameraSys(CameraSys const &) = default;
103  CameraSys(CameraSys &&) noexcept = default;
104  CameraSys &operator=(CameraSys const &) = default;
105  CameraSys &operator=(CameraSys &&) noexcept = default;
106 
107  void swap(CameraSys & other) noexcept {
108  std::swap(_sysName, other._sysName);
109  std::swap(_detectorName, other._detectorName);
110  }
111 
115  std::string getSysName() const { return _sysName; };
116 
120  std::string getDetectorName() const { return _detectorName; };
121 
125  bool hasDetectorName() const noexcept { return !_detectorName.empty(); }
126 
127  bool operator==(CameraSys const &rhs) const noexcept {
128  return _sysName == rhs.getSysName() && _detectorName == rhs.getDetectorName();
129  }
130 
131  bool operator!=(CameraSys const &rhs) const noexcept { return !(*this == rhs); }
132 
133  // less-than operator required for use in std::map
134  bool operator<(CameraSys const &rhs) const noexcept {
135  if (_sysName == rhs.getSysName()) {
136  return _detectorName < rhs.getDetectorName();
137  } else {
138  return _sysName < rhs.getSysName();
139  }
140  }
141 
150  size_t hash_value() const noexcept;
151 
152 private:
153  std::string _sysName;
154  std::string _detectorName;
155 };
156 
157 inline void swap(CameraSys & a, CameraSys & b) {
158  a.swap(b);
159 }
160 
161 
162 // *** Standard camera coordinate systems ***
163 
174 extern CameraSys const FOCAL_PLANE;
175 
181 extern CameraSys const FIELD_ANGLE;
182 
194 extern CameraSysPrefix const PIXELS;
195 
211 extern CameraSysPrefix const TAN_PIXELS;
212 
219 extern CameraSysPrefix const ACTUAL_PIXELS;
220 
221 std::ostream &operator<<(std::ostream &os, CameraSysPrefix const &detSysPrefix);
222 
223 std::ostream &operator<<(std::ostream &os, CameraSys const &cameraSys);
224 } // namespace cameraGeom
225 } // namespace afw
226 } // namespace lsst
227 
228 namespace std {
229 
231  a.swap(b);
232 }
233 
234 template <>
235 struct hash<lsst::afw::cameraGeom::CameraSysPrefix> {
238  size_t operator()(lsst::afw::cameraGeom::CameraSysPrefix const &obj) const noexcept {
239  return obj.hash_value();
240  }
241 };
242 
243 template <>
244 struct hash<lsst::afw::cameraGeom::CameraSys> {
247  size_t operator()(lsst::afw::cameraGeom::CameraSys const &obj) const noexcept { return obj.hash_value(); }
248 };
249 } // namespace std
250 
251 #endif
std::string
STL class.
lsst::afw::cameraGeom::CameraSys::operator<
bool operator<(CameraSys const &rhs) const noexcept
Definition: CameraSys.h:134
lsst::afw::cameraGeom::CameraSys::operator!=
bool operator!=(CameraSys const &rhs) const noexcept
Definition: CameraSys.h:131
std::hash< lsst::afw::cameraGeom::CameraSysPrefix >::operator()
size_t operator()(lsst::afw::cameraGeom::CameraSysPrefix const &obj) const noexcept
Definition: CameraSys.h:238
std::swap
void swap(lsst::afw::cameraGeom::CameraSys &a, lsst::afw::cameraGeom::CameraSys &b) noexcept
Definition: CameraSys.h:230
lsst::afw::cameraGeom::CameraSys::getSysName
std::string getSysName() const
Get coordinate system name.
Definition: CameraSys.h:115
sysName
table::Key< std::string > sysName
Definition: TransformMap.cc:338
lsst::afw::cameraGeom::CameraSys::CameraSys
CameraSys(std::string const &sysName, std::string const &detectorName="")
Construct a CameraSys from a sysName and a detectorName.
Definition: CameraSys.h:88
lsst::afw::cameraGeom::TAN_PIXELS
CameraSysPrefix const TAN_PIXELS
Tangent-plane pixels on the detector (x, y unbinned pixels)
Definition: CameraSys.cc:36
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::cameraGeom::operator<<
std::ostream & operator<<(std::ostream &os, CameraSysPrefix const &detSysPrefix)
Definition: CameraSys.cc:47
lsst::afw::cameraGeom::CameraSysPrefix::operator!=
bool operator!=(CameraSysPrefix const &rhs) const noexcept
Definition: CameraSys.h:63
lsst::afw::cameraGeom::CameraSys::~CameraSys
~CameraSys() noexcept=default
lsst::afw::cameraGeom::ACTUAL_PIXELS
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
lsst::afw::cameraGeom::CameraSys::CameraSys
CameraSys(CameraSysPrefix const &sysPrefix, std::string const &detectorName="")
Construct a CameraSys from a CameraSysPrefix and a detectorName.
Definition: CameraSys.h:96
lsst::afw::cameraGeom::CameraSys::operator==
bool operator==(CameraSys const &rhs) const noexcept
Definition: CameraSys.h:127
std::ostream
STL class.
other
ItemVariant const * other
Definition: Schema.cc:56
b
table::Key< int > b
Definition: TransmissionCurve.cc:467
lsst::afw::cameraGeom::CameraSysPrefix::operator==
bool operator==(CameraSysPrefix const &rhs) const noexcept
Definition: CameraSys.h:61
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
std::swap
T swap(T... args)
os
std::ostream * os
Definition: Schema.cc:746
lsst::afw::cameraGeom::FOCAL_PLANE
CameraSys const FOCAL_PLANE
Focal plane coordinates: Position on a 2-d planar approximation to the focal plane (x,...
Definition: CameraSys.cc:30
a
table::Key< int > a
Definition: TransmissionCurve.cc:466
std
STL namespace.
lsst::afw::cameraGeom::CameraSys::getDetectorName
std::string getDetectorName() const
Get detector name, or "" if not a detector-specific coordinate system.
Definition: CameraSys.h:120
std::hash< lsst::afw::cameraGeom::CameraSys >::operator()
size_t operator()(lsst::afw::cameraGeom::CameraSys const &obj) const noexcept
Definition: CameraSys.h:247
lsst::afw::cameraGeom::swap
void swap(CameraSys &a, CameraSys &b)
Definition: CameraSys.h:157
lsst::afw::cameraGeom::CameraSysPrefix::hash_value
std::size_t hash_value() const noexcept
Hash function for this object.
Definition: CameraSys.cc:40
lsst::afw::cameraGeom::FIELD_ANGLE
CameraSys const FIELD_ANGLE
Field angle coordinates: Angle of a principal ray relative to the optical axis (x,...
Definition: CameraSys.cc:32
std::size_t
lsst::afw::cameraGeom::CameraSysPrefix::~CameraSysPrefix
~CameraSysPrefix() noexcept=default
lsst::afw::cameraGeom::CameraSysPrefix::getSysName
std::string getSysName() const
Get coordinate system name.
Definition: CameraSys.h:59
lsst::afw::cameraGeom::CameraSysPrefix::CameraSysPrefix
CameraSysPrefix(std::string const &sysName)
Definition: CameraSys.h:46
detectorName
table::Key< std::string > detectorName
Definition: TransformMap.cc:339
lsst::afw::cameraGeom::CameraSysPrefix
Camera coordinate system prefix.
Definition: CameraSys.h:44
lsst::afw::cameraGeom::CameraSys::hasDetectorName
bool hasDetectorName() const noexcept
Does this have a non-blank detector name?
Definition: CameraSys.h:125
lsst::afw::cameraGeom::PIXELS
CameraSysPrefix const PIXELS
Pixel coordinates: Nominal position on the entry surface of a given detector (x, y unbinned pixels).
Definition: CameraSys.cc:34
std::hash
lsst::afw::cameraGeom::CameraSys
Camera coordinate system; used as a key in in TransformMap.
Definition: CameraSys.h:83