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
|
Namespaces | |
_Angle | |
_Box | |
_coordinates | |
_Interval | |
_SpherePoint | |
detail | |
polynomials | |
Low-level polynomials (including special polynomials) in C++. | |
testUtils | |
version | |
Classes | |
class | AffineTransform |
An affine coordinate transformation consisting of a linear transformation and an offset. More... | |
class | AngleUnit |
A class used to convert scalar POD types such as double to Angle. More... | |
class | Angle |
A class representing an angle. More... | |
class | Box2I |
An integer coordinate rectangle. More... | |
class | Box2D |
A floating-point coordinate rectangle geometry. More... | |
class | Point |
A coordinate class intended to represent absolute positions. More... | |
class | Extent |
A coordinate class intended to represent offsets and dimensions. More... | |
class | CoordinateBase |
A CRTP base class for coordinate objects. More... | |
class | CoordinateBase< Derived, T, 2 > |
Specialization of CoordinateBase for 2 dimensions. More... | |
class | CoordinateBase< Derived, T, 3 > |
Specialization of CoordinateBase for 3 dimensions. More... | |
class | CoordinateExpr |
A boolean coordinate. More... | |
class | ExtentBase |
class | Extent< T, 2 > |
A coordinate class intended to represent offsets and dimensions (2-d specialization). More... | |
class | Extent< T, 3 > |
A coordinate class intended to represent offsets and dimensions (3-d specialization). More... | |
class | IntervalI |
A 1-d integer coordinate range. More... | |
class | IntervalD |
A floating-point coordinate rectangle geometry. More... | |
class | SingularTransformException |
class | LinearTransform |
A 2D linear coordinate transformation. More... | |
class | PointBase |
class | Point< T, 2 > |
A coordinate class intended to represent absolute positions (2-d specialization). More... | |
class | Point< T, 3 > |
A coordinate class intended to represent absolute positions (3-d specialization). More... | |
class | SpherePoint |
Point in an unspecified spherical coordinate system. More... | |
Typedefs | |
typedef Box2D | BoxD |
typedef Box2I | BoxI |
typedef CoordinateExpr< 2 > | CoordinateExpr2 |
typedef CoordinateExpr< 3 > | CoordinateExpr3 |
typedef Extent< int, 2 > | ExtentI |
typedef Extent< int, 2 > | Extent2I |
typedef Extent< int, 3 > | Extent3I |
typedef Extent< double, 2 > | ExtentD |
typedef Extent< double, 2 > | Extent2D |
typedef Extent< double, 3 > | Extent3D |
typedef Point< int, 2 > | PointI |
typedef Point< int, 2 > | Point2I |
typedef Point< int, 3 > | Point3I |
typedef Point< double, 2 > | PointD |
typedef Point< double, 2 > | Point2D |
typedef Point< double, 3 > | Point3D |
using | PyAngle = py::class_< Angle > |
using | PyAngleUnit = py::class_< AngleUnit > |
using | PySpherePoint = py::class_< SpherePoint, std::shared_ptr< SpherePoint > > |
Functions | |
std::ostream & | operator<< (std::ostream &os, lsst::geom::AffineTransform const &transform) |
AffineTransform | makeAffineTransformFromTriple (Point2D const &p1, Point2D const &p2, Point2D const &p3, Point2D const &q1, Point2D const &q2, Point2D const &q3) |
constexpr double | degToRad (double x) noexcept |
constexpr double | radToDeg (double x) noexcept |
constexpr double | radToArcsec (double x) noexcept |
constexpr double | radToMas (double x) noexcept |
constexpr double | arcsecToRad (double x) noexcept |
constexpr double | masToRad (double x) noexcept |
constexpr Angle | operator+ (Angle a, Angle d) noexcept |
Sum of two angles. More... | |
constexpr Angle | operator- (Angle a, Angle d) noexcept |
Difference of two angles. More... | |
constexpr Angle | operator* (Angle a, Angle d) noexcept |
Product of two angles. More... | |
constexpr Angle | operator* (Angle a, double d) noexcept |
Product of an angle and a scalar. More... | |
constexpr Angle | operator* (double d, Angle a) noexcept |
constexpr Angle | operator* (Angle a, int d) noexcept |
constexpr Angle | operator* (int d, Angle a) noexcept |
constexpr Angle | operator- (Angle angle) |
An angle in the opposite sense. More... | |
constexpr Angle | operator/ (Angle a, int d) noexcept |
Ratio of an angle and a scalar. More... | |
constexpr Angle | operator/ (Angle a, double d) noexcept |
Ratio of an angle and a scalar. More... | |
template<typename T > | |
constexpr double | operator/ (T const lhs, Angle rhs) noexcept=delete |
std::ostream & | operator<< (std::ostream &s, Angle a) |
Print an Angle to a stream. More... | |
template<typename T > | |
constexpr bool | isAngle (T) noexcept |
Allow a user to check if they have an angle. More... | |
template<typename T > | |
constexpr Angle | operator* (T lhs, AngleUnit rhs) noexcept |
Use AngleUnit to convert a POD (e.g. int, double) to an Angle; e.g. 180*degrees. More... | |
std::ostream & | operator<< (std::ostream &os, Box2I const &box) |
std::ostream & | operator<< (std::ostream &os, Box2D const &box) |
template<typename Derived , typename T , int N> | |
bool | allclose (CoordinateBase< Derived, T, N > const &a, CoordinateBase< Derived, T, N > const &b, T rtol=static_cast< T >(1E-5), T atol=static_cast< T >(1E-8)) noexcept(std::is_nothrow_copy_constructible< T >::value &&std::is_nothrow_copy_assignable< T >::value) |
Floating-point comparison with tolerance. More... | |
template<typename Derived , typename T , int N> | |
std::ostream & | operator<< (std::ostream &os, CoordinateBase< Derived, T, N > const &coordinate) |
template<int N> | |
bool | all (CoordinateExpr< N > const &expr) noexcept |
Return true if all elements are true. More... | |
template<int N> | |
bool | any (CoordinateExpr< N > const &expr) noexcept |
Return true if any elements are true. More... | |
template<typename T , int N> | |
std::size_t | hash_value (Extent< T, N > const &extent) noexcept |
template<int N> | |
Extent< int, N > | truncate (Extent< double, N > const &input) noexcept |
Return the component-wise truncation (round towards zero). More... | |
template<int N> | |
Extent< int, N > | floor (Extent< double, N > const &input) noexcept |
Return the component-wise floor (round towards more negative). More... | |
template<int N> | |
Extent< int, N > | ceil (Extent< double, N > const &input) noexcept |
Return the component-wise ceil (round towards more positive). More... | |
template<typename T , int N> | |
Extent< T, N > | operator* (T scalar, ExtentBase< T, N > const &rhs) noexcept(ExtentBase< T, N >::IS_ELEMENT_NOTHROW_COPYABLE) |
template<int N> | |
Extent< double, N > | operator* (ExtentBase< int, N > const &lhs, double rhs) noexcept |
template<int N> | |
void | operator*= (ExtentBase< int, N > &lhs, double rhs) noexcept |
template<int N> | |
Extent< double, N > | operator/ (ExtentBase< int, N > const &lhs, double rhs) noexcept |
template<int N> | |
void | operator/= (ExtentBase< int, N > &lhs, double rhs) noexcept |
template<int N> | |
Extent< double, N > | operator* (double lhs, ExtentBase< int, N > const &rhs) noexcept |
template<int N> | |
Extent< double, N > | operator+ (Extent< double, N > const &lhs, Extent< int, N > const &rhs) noexcept |
template<int N> | |
Extent< double, N > & | operator+= (Extent< double, N > &lhs, Extent< int, N > const &rhs) noexcept |
template<int N> | |
Extent< double, N > | operator- (Extent< double, N > const &lhs, Extent< int, N > const &rhs) noexcept |
template<int N> | |
Extent< double, N > & | operator-= (Extent< double, N > &lhs, Extent< int, N > const &rhs) noexcept |
template<int N> | |
Extent< double, N > | operator+ (Extent< int, N > const &lhs, Extent< double, N > const &rhs) noexcept |
template<int N> | |
Extent< double, N > | operator- (Extent< int, N > const &lhs, Extent< double, N > const &rhs) noexcept |
std::ostream & | operator<< (std::ostream &os, IntervalI const &interval) |
std::ostream & | operator<< (std::ostream &os, IntervalD const &interval) |
void | swap (IntervalI &a, IntervalI &b) noexcept |
void | swap (IntervalD &a, IntervalD &b) noexcept |
std::ostream & | operator<< (std::ostream &os, lsst::geom::LinearTransform const &t) |
template<typename T , int N> | |
std::size_t | hash_value (Point< T, N > const &point) noexcept |
template<int N> | |
Point< double, N > | operator+ (Point< double, N > const &lhs, Extent< int, N > const &rhs) noexcept |
template<int N> | |
Point< double, N > | operator+ (Extent< int, N > const &rhs, Point< double, N > const &lhs) noexcept |
template<int N> | |
Point< double, N > & | operator+= (Point< double, N > &lhs, Extent< int, N > const &rhs) noexcept |
template<int N> | |
Point< double, N > | operator+ (Point< int, N > const &lhs, Extent< double, N > const &rhs) noexcept |
template<int N> | |
Point< double, N > | operator- (Point< double, N > const &lhs, Extent< int, N > const &rhs) noexcept |
template<int N> | |
Point< double, N > & | operator-= (Point< double, N > &lhs, Extent< int, N > const &rhs) noexcept |
template<int N> | |
Point< double, N > | operator- (Point< int, N > const &lhs, Extent< double, N > const &rhs) noexcept |
template<int N> | |
Extent< double, N > | operator- (Point< double, N > const &lhs, Point< int, N > const &rhs) noexcept |
template<int N> | |
Extent< double, N > | operator- (Point< int, N > const &lhs, Point< double, N > const &rhs) noexcept |
SpherePoint | averageSpherePoint (std::vector< SpherePoint > const &coords) |
Return the average of a list of coordinates. More... | |
std::ostream & | operator<< (std::ostream &os, SpherePoint const &point) |
Print the value of a point to a stream. More... | |
Eigen::Vector3d | asEigen (sphgeom::Vector3d const &vector) noexcept |
void | wrapAffineTransform (utils::python::WrapperCollection &wrappers) |
void | wrapAngle (utils::python::WrapperCollection &wrappers) |
void | wrapBox (utils::python::WrapperCollection &wrappers) |
void | wrapCoordinates (utils::python::WrapperCollection &wrappers) |
void | wrapAngle (WrapperCollection &wrappers) |
void | wrapCoordinates (WrapperCollection &wrappers) |
void | wrapSpherePoint (WrapperCollection &wrappers) |
void | wrapInterval (WrapperCollection &wrappers) |
void | wrapBox (WrapperCollection &wrappers) |
void | wrapLinearTransform (WrapperCollection &wrappers) |
void | wrapAffineTransform (WrapperCollection &wrappers) |
PYBIND11_MODULE (_geom, mod) | |
void | wrapInterval (utils::python::WrapperCollection &wrappers) |
void | wrapLinearTransform (utils::python::WrapperCollection &wrappers) |
void | wrapSpherePoint (utils::python::WrapperCollection &wrappers) |
template bool | allclose< Point2D, double, 2 > (CoordinateBase< Point2D, double, 2 > const &, CoordinateBase< Point2D, double, 2 > const &, double, double) |
template bool | allclose< Point3D, double, 3 > (CoordinateBase< Point3D, double, 3 > const &, CoordinateBase< Point3D, double, 3 > const &, double, double) |
template bool | allclose< Extent2D, double, 2 > (CoordinateBase< Extent2D, double, 2 > const &, CoordinateBase< Extent2D, double, 2 > const &, double, double) |
template bool | allclose< Extent3D, double, 3 > (CoordinateBase< Extent3D, double, 3 > const &, CoordinateBase< Extent3D, double, 3 > const &, double, double) |
Variables | |
constexpr double | PI = boost::math::constants::pi<double>() |
The ratio of a circle's circumference to diameter. More... | |
constexpr double | TWOPI = boost::math::constants::pi<double>() * 2.0 |
constexpr double | HALFPI = boost::math::constants::pi<double>() * 0.5 |
constexpr double | ONE_OVER_PI = 1.0 / boost::math::constants::pi<double>() |
double const | SQRTPI = sqrt(boost::math::constants::pi<double>()) |
double const | INVSQRTPI = 1.0 / sqrt(boost::math::constants::pi<double>()) |
constexpr double | ROOT2 = boost::math::constants::root_two<double>() |
constexpr AngleUnit | radians = AngleUnit(1.0) |
constant with units of radians More... | |
constexpr AngleUnit | degrees = AngleUnit(PI / 180.0) |
constant with units of degrees More... | |
constexpr AngleUnit | hours = AngleUnit(PI * 15.0 / 180.0) |
constant with units of hours More... | |
constexpr AngleUnit | arcminutes = AngleUnit(PI / 60 / 180.0) |
constant with units of arcminutes More... | |
constexpr AngleUnit | arcseconds = AngleUnit(PI / 180.0 / 3600.0) |
constant with units of arcseconds More... | |
constexpr AngleUnit | milliarcseconds |
constant with units of milliarcseconds More... | |
template<typename T , typename U > | |
constexpr bool | IS_NOTHROW_CONVERTIBLE |
Test that a type is nothrow-copy-convertible from U to T. More... | |
typedef Box2D lsst::geom::BoxD |
typedef Box2I lsst::geom::BoxI |
typedef CoordinateExpr<2> lsst::geom::CoordinateExpr2 |
Definition at line 95 of file CoordinateExpr.h.
typedef CoordinateExpr<3> lsst::geom::CoordinateExpr3 |
Definition at line 96 of file CoordinateExpr.h.
typedef Extent<double, 2> lsst::geom::Extent2D |
typedef Extent<int, 2> lsst::geom::Extent2I |
typedef Extent<double, 3> lsst::geom::Extent3D |
typedef Extent<int, 3> lsst::geom::Extent3I |
typedef Extent<double, 2> lsst::geom::ExtentD |
typedef Extent<int, 2> lsst::geom::ExtentI |
typedef Point<double, 2> lsst::geom::Point2D |
typedef Point<int, 2> lsst::geom::Point2I |
typedef Point<double, 3> lsst::geom::Point3D |
typedef Point<int, 3> lsst::geom::Point3I |
typedef Point<double, 2> lsst::geom::PointD |
typedef Point<int, 2> lsst::geom::PointI |
using lsst::geom::PyAngle = typedef py::class_<Angle> |
using lsst::geom::PyAngleUnit = typedef py::class_<AngleUnit> |
using lsst::geom::PySpherePoint = typedef py::class_<SpherePoint, std::shared_ptr<SpherePoint> > |
Definition at line 60 of file _SpherePoint.cc.
|
inlinenoexcept |
Return true if all elements are true.
Definition at line 81 of file CoordinateExpr.h.
|
noexcept |
Floating-point comparison with tolerance.
Interface, naming, and default tolerances matches Numpy.
Definition at line 30 of file CoordinateBase.cc.
template bool lsst::geom::allclose< Extent2D, double, 2 > | ( | CoordinateBase< Extent2D, double, 2 > const & | , |
CoordinateBase< Extent2D, double, 2 > const & | , | ||
double | , | ||
double | |||
) |
template bool lsst::geom::allclose< Extent3D, double, 3 > | ( | CoordinateBase< Extent3D, double, 3 > const & | , |
CoordinateBase< Extent3D, double, 3 > const & | , | ||
double | , | ||
double | |||
) |
template bool lsst::geom::allclose< Point2D, double, 2 > | ( | CoordinateBase< Point2D, double, 2 > const & | , |
CoordinateBase< Point2D, double, 2 > const & | , | ||
double | , | ||
double | |||
) |
template bool lsst::geom::allclose< Point3D, double, 3 > | ( | CoordinateBase< Point3D, double, 3 > const & | , |
CoordinateBase< Point3D, double, 3 > const & | , | ||
double | , | ||
double | |||
) |
|
inlinenoexcept |
Return true if any elements are true.
Definition at line 89 of file CoordinateExpr.h.
|
inlineconstexprnoexcept |
Definition at line 55 of file Angle.h.
|
noexcept |
Definition at line 36 of file sphgeomUtils.h.
SpherePoint lsst::geom::averageSpherePoint | ( | std::vector< SpherePoint > const & | coords | ) |
Return the average of a list of coordinates.
[in] | coords | list of coords to average |
lsst::pex::exceptions::LengthError | if coords is empty |
Definition at line 235 of file SpherePoint.cc.
Return the component-wise ceil (round towards more positive).
In Python, this is available as both a free function and a method on ExtentD.
|
inlineconstexprnoexcept |
|
noexcept |
Definition at line 127 of file Extent.cc.
|
noexcept |
|
inlineconstexprnoexcept |
Allow a user to check if they have an angle.
AffineTransform lsst::geom::makeAffineTransformFromTriple | ( | Point2D const & | p1, |
Point2D const & | p2, | ||
Point2D const & | p3, | ||
Point2D const & | q1, | ||
Point2D const & | q2, | ||
Point2D const & | q3 | ||
) |
Definition at line 88 of file AffineTransform.cc.
|
inlineconstexprnoexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
constexprdeletenoexcept |
|
noexcept |
std::ostream & lsst::geom::operator<< | ( | std::ostream & | os, |
Box2D const & | box | ||
) |
std::ostream & lsst::geom::operator<< | ( | std::ostream & | os, |
Box2I const & | box | ||
) |
std::ostream& lsst::geom::operator<< | ( | std::ostream & | os, |
CoordinateBase< Derived, T, N > const & | coordinate | ||
) |
Definition at line 258 of file CoordinateBase.h.
std::ostream & lsst::geom::operator<< | ( | std::ostream & | os, |
IntervalD const & | interval | ||
) |
Definition at line 375 of file Interval.cc.
std::ostream & lsst::geom::operator<< | ( | std::ostream & | os, |
IntervalI const & | interval | ||
) |
Definition at line 370 of file Interval.cc.
std::ostream & lsst::geom::operator<< | ( | std::ostream & | os, |
lsst::geom::AffineTransform const & | transform | ||
) |
Definition at line 72 of file AffineTransform.cc.
std::ostream & lsst::geom::operator<< | ( | std::ostream & | os, |
lsst::geom::LinearTransform const & | t | ||
) |
Definition at line 65 of file LinearTransform.cc.
ostream & lsst::geom::operator<< | ( | std::ostream & | os, |
SpherePoint const & | point | ||
) |
Print the value of a point to a stream.
The exact details of the string representation are unspecified and subject to change, but the following may be regarded as typical: "(10.543250, +32.830583)"
.
os | the stream to which to print point |
point | the point to print to the stream |
os
pex::exceptions::std::ostream::failure | Thrown if an I/O state flag was set that was registered with os.exceptions() . See the documentation of std::ostream for more details. |
Definition at line 253 of file SpherePoint.cc.
std::ostream & lsst::geom::operator<< | ( | std::ostream & | s, |
Angle | a | ||
) |
Print an Angle to a stream.
The exact details of the string representation are unspecified and subject to change, but the following may be regarded as typical: "0.567 rad"
.
s | The output stream. |
a | The angle. |
Definition at line 29 of file Angle.cc.
lsst::geom::PYBIND11_MODULE | ( | _geom | , |
mod | |||
) |
Definition at line 43 of file _geom.cc.
|
inlineconstexprnoexcept |
|
inlineconstexprnoexcept |
|
inlineconstexprnoexcept |
Definition at line 736 of file Interval.h.
Definition at line 734 of file Interval.h.
Return the component-wise truncation (round towards zero).
In Python, this is available as both a free function and a method on ExtentD.
void lsst::geom::wrapAffineTransform | ( | utils::python::WrapperCollection & | wrappers | ) |
Definition at line 37 of file _AffineTransform.cc.
void lsst::geom::wrapAffineTransform | ( | WrapperCollection & | wrappers | ) |
void lsst::geom::wrapAngle | ( | utils::python::WrapperCollection & | wrappers | ) |
Definition at line 54 of file _Angle.cc.
void lsst::geom::wrapAngle | ( | WrapperCollection & | wrappers | ) |
void lsst::geom::wrapBox | ( | utils::python::WrapperCollection & | wrappers | ) |
void lsst::geom::wrapBox | ( | WrapperCollection & | wrappers | ) |
void lsst::geom::wrapCoordinates | ( | utils::python::WrapperCollection & | wrappers | ) |
Definition at line 491 of file _coordinates.cc.
void lsst::geom::wrapCoordinates | ( | WrapperCollection & | wrappers | ) |
void lsst::geom::wrapInterval | ( | utils::python::WrapperCollection & | wrappers | ) |
Definition at line 105 of file _Interval.cc.
void lsst::geom::wrapInterval | ( | WrapperCollection & | wrappers | ) |
void lsst::geom::wrapLinearTransform | ( | utils::python::WrapperCollection & | wrappers | ) |
Definition at line 41 of file _LinearTransform.cc.
void lsst::geom::wrapLinearTransform | ( | WrapperCollection & | wrappers | ) |
void lsst::geom::wrapSpherePoint | ( | utils::python::WrapperCollection & | wrappers | ) |
Definition at line 62 of file _SpherePoint.cc.
void lsst::geom::wrapSpherePoint | ( | WrapperCollection & | wrappers | ) |
|
constexpr |
double const lsst::geom::INVSQRTPI = 1.0 / sqrt(boost::math::constants::pi<double>()) |
|
constexpr |
Test that a type is nothrow-copy-convertible from U to T.
Definition at line 45 of file CoordinateBase.h.
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
double const lsst::geom::SQRTPI = sqrt(boost::math::constants::pi<double>()) |