LSST Applications g04c3c9f7ca+2075667efa,g1e125bf412+5f448d5fcf,g2079a07aa2+3e9fd84d81,g2305ad1205+b635cf1488,g2bbee38e9b+6c6beb4891,g337abbeb29+6c6beb4891,g33d1c0ed96+6c6beb4891,g3a166c0a6a+6c6beb4891,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+42f171e1e6,g5c3423f6d4+d536b04327,g607f77f49a+d536b04327,g6f43f06aed+ca1339dc19,g858d7b2824+d536b04327,g8ee334c5b4+d7f9608c2f,g9963eaa53e+b3dc1655d3,g998f4353bf+d536b04327,g99cad8db69+8ef2408349,g9ddcbc5298+9a081db1e4,ga1e77700b3+2cbb763275,gadfd92a7e4+aec2f3b930,gae0086650b+585e252eca,gb0e22166c9+0e73c8378f,gb3b7280ab2+cb5fdb229e,gbb8dafda3b+a327199e22,gc120e1dc64+88074880ea,gc28159a63d+6c6beb4891,gcdd4ae20e8+bd241b2308,gcde1bda545+903e937d91,gcf0d15dbbd+bd241b2308,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+6c6beb4891,gfbcc870c63+b310236976,w.2024.23
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
31#include "lsst/geom/Angle.h"
32#include "lsst/geom/Point.h"
33
34namespace lsst {
35namespace geom {
36
57class SpherePoint final {
58public:
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
368private:
369 double _longitude; // radians
370 double _latitude; // radians
371
373 void _set(sphgeom::UnitVector3d const& unitVector);
374};
375
383SpherePoint averageSpherePoint(std::vector<SpherePoint> const& coords);
384
385/*
386 * Object-level display
387 */
388
409std::ostream& operator<<(std::ostream& os, SpherePoint const& point);
410
411} // namespace geom
412} // namespace lsst
413
414namespace std {
415template <>
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_ */
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:215
table::Key< lsst::geom::Angle > latitude
Definition VisitInfo.cc:214
A class representing an angle.
Definition Angle.h:128
A class used to convert scalar POD types such as double to Angle.
Definition Angle.h:71
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.
SpherePoint offset(Angle const &bearing, Angle const &amount) const
Return a point offset from this one along a great circle.
SpherePoint(SpherePoint const &other) noexcept
Create a copy of a SpherePoint.
bool isFinite() const noexcept
true if this point is a well-defined position.
Point2D getPosition(AngleUnit unit) const noexcept
Return longitude, latitude as a Point2D object.
Angle bearingTo(SpherePoint const &other) const
Orientation at this point of the great circle arc to another point.
bool atPole() const noexcept
true if this point is either coordinate pole.
Angle separation(SpherePoint const &other) const noexcept
Angular distance between two points.
SpherePoint(SpherePoint &&other) noexcept
Create a copy of a SpherePoint.
sphgeom::UnitVector3d getVector() const noexcept
A unit vector representation of this point.
SpherePoint() noexcept
Construct a SpherePoint with "nan" for longitude and latitude.
Angle getLatitude() const noexcept
The latitude of this point.
Angle getLongitude() const noexcept
The longitude of this point.
SpherePoint rotated(SpherePoint const &axis, Angle const &amount) const noexcept
Return a point rotated from this one around an axis.
Angle getDec() const noexcept
Synonym for getLatitude.
std::size_t hash_value() const noexcept
Return a hash of this object.
Angle getRa() const noexcept
Synonym for getLongitude.
LonLat represents a spherical coordinate (longitude/latitude angle) pair.
Definition LonLat.h:55
UnitVector3d is a unit vector in ℝ³ with components stored in double precision.
Vector3d is a vector in ℝ³ with components stored in double precision.
Definition Vector3d.h:51
double constexpr HALFPI
Definition Angle.h:42
AngleUnit constexpr radians
constant with units of radians
Definition Angle.h:109
STL namespace.
size_t operator()(argument_type const &x) const noexcept