LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
SpherePoint.h
Go to the documentation of this file.
1 /*
2  * Developed for the LSST Data Management System.
3  * This product includes software developed by the LSST Project
4  * (https://www.lsst.org).
5  * See the COPYRIGHT file at the top-level directory of this distribution
6  * for details of code ownership.
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 GNU General Public License
19  * along with this program. If not, see <https://www.gnu.org/licenses/>.
20  */
21 
22 #ifndef LSST_GEOM_SPHEREPOINT_H_
23 #define LSST_GEOM_SPHEREPOINT_H_
24 
25 #include <cmath>
26 #include <ostream>
27 #include <utility>
28 
30 #include "lsst/sphgeom/Vector3d.h"
31 #include "lsst/geom/Angle.h"
32 #include "lsst/geom/Point.h"
33 
34 namespace lsst {
35 namespace geom {
36 
58 public:
72  SpherePoint(Angle const& longitude, Angle const& latitude);
73 
88  SpherePoint(double longitude, double latitude, AngleUnit units);
89 
105  explicit SpherePoint(sphgeom::Vector3d const& vector);
106 
114  SpherePoint(sphgeom::LonLat const& lonLat) noexcept;
115 
117  SpherePoint() noexcept;
118 
126  SpherePoint(SpherePoint const& other) noexcept;
127 
134  SpherePoint(SpherePoint&& other) noexcept;
135 
136  ~SpherePoint() noexcept;
137 
150  SpherePoint& operator=(SpherePoint const& other) noexcept;
151 
158  SpherePoint& operator=(SpherePoint&& other) noexcept;
159 
165  operator sphgeom::LonLat() const noexcept;
166 
167  /*
168  * Accessors
169  */
170 
178  Angle getLongitude() const noexcept { return _longitude * radians; };
179 
181  Angle getRa() const noexcept { return _longitude * radians; };
182 
190  Angle getLatitude() const noexcept { return _latitude * radians; };
191 
193  Angle getDec() const noexcept { return _latitude * radians; };
194 
202  Point2D getPosition(AngleUnit unit) const noexcept;
203 
211  sphgeom::UnitVector3d getVector() const noexcept;
212 
227  Angle operator[](size_t index) const;
228 
237  bool atPole() const noexcept {
238  // Unit tests indicate we don't need to worry about epsilon-errors, in that
239  // Objects constructed from lat=90*degrees, <0,0,1>, etc. all have atPole() = true.
240  return fabs(_latitude) >= HALFPI;
241  }
242 
252  bool isFinite() const noexcept;
253 
254  /*
255  * Comparisons between points
256  */
257 
278  bool operator==(SpherePoint const& other) const noexcept;
279 
286  bool operator!=(SpherePoint const& other) const noexcept;
287 
289  std::size_t hash_value() const noexcept;
290 
310  Angle bearingTo(SpherePoint const& other) const;
311 
321  Angle separation(SpherePoint const& other) const noexcept;
322 
323  /*
324  * Transformations of points
325  */
326 
338  SpherePoint rotated(SpherePoint const& axis, Angle const& amount) const noexcept;
339 
356  SpherePoint offset(Angle const& bearing, Angle const& amount) const;
357 
366  std::pair<Angle, Angle> getTangentPlaneOffset(SpherePoint const& other) const;
367 
368 private:
369  double _longitude; // radians
370  double _latitude; // radians
371 
373  void _set(sphgeom::UnitVector3d const& unitVector);
374 };
375 
383 SpherePoint averageSpherePoint(std::vector<SpherePoint> const& coords);
384 
385 /*
386  * Object-level display
387  */
388 
409 std::ostream& operator<<(std::ostream& os, SpherePoint const& point);
410 
411 } // namespace geom
412 } // namespace lsst
413 
414 namespace std {
415 template <>
419  size_t operator()(argument_type const& x) const noexcept { return x.hash_value(); }
420 };
421 } // namespace std
422 
423 #endif /* LSST_GEOM_SPHEREPOINT_H_ */
double x
std::ostream * os
Definition: Schema.cc:557
This file declares a class for representing unit vectors in ℝ³.
This file declares a class for representing vectors in ℝ³.
table::Key< lsst::geom::Angle > longitude
Definition: VisitInfo.cc:213
table::Key< lsst::geom::Angle > latitude
Definition: VisitInfo.cc:212
A class representing an angle.
Definition: Angle.h:127
A class used to convert scalar POD types such as double to Angle.
Definition: Angle.h:70
Point in an unspecified spherical coordinate system.
Definition: SpherePoint.h:57
std::pair< Angle, Angle > getTangentPlaneOffset(SpherePoint const &other) const
Get the offset from a tangent plane centered at this point to another point.
Definition: SpherePoint.cc:214
SpherePoint offset(Angle const &bearing, Angle const &amount) const
Return a point offset from this one along a great circle.
Definition: SpherePoint.cc:185
SpherePoint(SpherePoint const &other) noexcept
Create a copy of a SpherePoint.
bool isFinite() const noexcept
true if this point is a well-defined position.
Definition: SpherePoint.cc:144
Point2D getPosition(AngleUnit unit) const noexcept
Return longitude, latitude as a Point2D object.
Definition: SpherePoint.cc:129
Angle bearingTo(SpherePoint const &other) const
Orientation at this point of the great circle arc to another point.
Definition: SpherePoint.cc:159
bool atPole() const noexcept
true if this point is either coordinate pole.
Definition: SpherePoint.h:237
Angle separation(SpherePoint const &other) const noexcept
Angular distance between two points.
Definition: SpherePoint.cc:173
SpherePoint(SpherePoint &&other) noexcept
Create a copy of a SpherePoint.
sphgeom::UnitVector3d getVector() const noexcept
A unit vector representation of this point.
Definition: SpherePoint.cc:124
SpherePoint() noexcept
Construct a SpherePoint with "nan" for longitude and latitude.
Definition: SpherePoint.cc:108
Angle getLatitude() const noexcept
The latitude of this point.
Definition: SpherePoint.h:190
Angle getLongitude() const noexcept
The longitude of this point.
Definition: SpherePoint.h:178
SpherePoint rotated(SpherePoint const &axis, Angle const &amount) const noexcept
Return a point rotated from this one around an axis.
Definition: SpherePoint.cc:178
Angle getDec() const noexcept
Synonym for getLatitude.
Definition: SpherePoint.h:193
std::size_t hash_value() const noexcept
Return a hash of this object.
Definition: SpherePoint.cc:154
Angle getRa() const noexcept
Synonym for getLongitude.
Definition: SpherePoint.h:181
LonLat represents a spherical coordinate (longitude/latitude angle) pair.
Definition: LonLat.h:48
UnitVector3d is a unit vector in ℝ³ with components stored in double precision.
Definition: UnitVector3d.h:55
Vector3d is a vector in ℝ³ with components stored in double precision.
Definition: Vector3d.h:44
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
lsst::geom::SpherePoint SpherePoint
Definition: misc.h:34
SpherePoint averageSpherePoint(std::vector< SpherePoint > const &coords)
Return the average of a list of coordinates.
Definition: SpherePoint.cc:235
constexpr double HALFPI
Definition: Angle.h:41
constexpr AngleUnit radians
constant with units of radians
Definition: Angle.h:108
A base class for image defects.
STL namespace.
size_t operator()(argument_type const &x) const noexcept
Definition: SpherePoint.h:419