LSST Applications g063fba187b+fee0456c91,g0f08755f38+ea96e5a5a3,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g1a2382251a+90257ff92a,g20f6ffc8e0+ea96e5a5a3,g217e2c1bcf+937a289c59,g28da252d5a+daa7da44eb,g2bbee38e9b+253935c60e,g2bc492864f+253935c60e,g3156d2b45e+6e55a43351,g32e5bea42b+31359a2a7a,g347aa1857d+253935c60e,g35bb328faa+a8ce1bb630,g3a166c0a6a+253935c60e,g3b1af351f3+a8ce1bb630,g3e281a1b8c+c5dd892a6c,g414038480c+416496e02f,g41af890bb2+afe91b1188,g599934f4f4+0db33f7991,g7af13505b9+e36de7bce6,g80478fca09+da231ba887,g82479be7b0+a4516e59e3,g858d7b2824+ea96e5a5a3,g89c8672015+f4add4ffd5,g9125e01d80+a8ce1bb630,ga5288a1d22+bc6ab8dfbd,gb58c049af0+d64f4d3760,gc28159a63d+253935c60e,gcab2d0539d+3f2b72788c,gcf0d15dbbd+4ea9c45075,gda6a2b7d83+4ea9c45075,gdaeeff99f8+1711a396fd,ge79ae78c31+253935c60e,gef2f8181fd+3031e3cf99,gf0baf85859+c1f95f4921,gfa517265be+ea96e5a5a3,gfa999e8aa5+17cd334064,w.2024.50
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
lsst::afw::geom::SpherePointEndpoint Class Referenceabstract

An endpoint for lsst::geom::SpherePoint. More...

#include <Endpoint.h>

Inheritance diagram for lsst::afw::geom::SpherePointEndpoint:
lsst::afw::geom::BaseVectorEndpoint< lsst::geom::SpherePoint > lsst::afw::geom::BaseEndpoint< PointT, ArrayT >

Public Types

using Array
 
using Point
 

Public Member Functions

 SpherePointEndpoint (SpherePointEndpoint const &)=default
 
 SpherePointEndpoint (SpherePointEndpoint &&)=default
 
SpherePointEndpointoperator= (SpherePointEndpoint const &)=delete
 
SpherePointEndpointoperator= (SpherePointEndpoint &&)=delete
 
 SpherePointEndpoint ()
 Construct a SpherePointEndpoint.
 
 SpherePointEndpoint (int nAxes)
 Construct a SpherePointEndpoint with nAxes specified; nAxes must equal 2.
 
 ~SpherePointEndpoint () override=default
 
std::vector< doubledataFromPoint (Point const &point) const override
 Get raw data from a single point.
 
ndarray::Array< double, 2, 2 > dataFromArray (Array const &arr) const override
 Get raw data from an array of points.
 
Point pointFromData (std::vector< double > const &data) const override
 Get a single point from raw data.
 
Array arrayFromData (ndarray::Array< double, 2, 2 > const &data) const override
 Get an array of points from raw data.
 
std::shared_ptr< ast::FramemakeFrame () const override
 Create a Frame that can be used with this end point in a Transform.
 
void normalizeFrame (std::shared_ptr< ast::Frame > framePtr) const override
 Check that framePtr points to a SkyFrame and set longitude axis to 0, latitude to 1.
 
int getNPoints (Array const &arr) const override
 Return the number of points in an array.
 
virtual int getNPoints (Array const &arr) const =0
 Return the number of points in an array.
 
int getNAxes () const
 
virtual bool operator== (BaseEndpoint const &other) const noexcept
 Determine whether two endpoints represent the same conversion.
 
bool operator!= (BaseEndpoint const &other) const noexcept
 Determine whether two endpoints do not represent the same conversion.
 

Static Public Member Functions

static std::string getClassPrefix ()
 Get the class name prefix, e.g. "Point2" for "Point2Endpoint".
 

Protected Member Functions

void _assertNAxes (int nAxes) const
 
int _getNAxes (ndarray::Array< double, 2, 2 > const &data) const
 
int _getNAxes (ndarray::Array< double, 1, 1 > const &data) const
 
int _getNAxes (std::vector< double > const &data) const
 
int _getNPoints (ndarray::Array< double, 2, 2 > const &data) const
 

Detailed Description

An endpoint for lsst::geom::SpherePoint.

A SpherePointEndpoint always has 2 axes: longitude, latitude

Definition at line 315 of file Endpoint.h.

Member Typedef Documentation

◆ Array

Definition at line 197 of file Endpoint.h.

◆ Point

Definition at line 198 of file Endpoint.h.

Constructor & Destructor Documentation

◆ SpherePointEndpoint() [1/4]

lsst::afw::geom::SpherePointEndpoint::SpherePointEndpoint ( SpherePointEndpoint const & )
default

◆ SpherePointEndpoint() [2/4]

lsst::afw::geom::SpherePointEndpoint::SpherePointEndpoint ( SpherePointEndpoint && )
default

◆ SpherePointEndpoint() [3/4]

lsst::afw::geom::SpherePointEndpoint::SpherePointEndpoint ( )
inlineexplicit

Construct a SpherePointEndpoint.

Definition at line 325 of file Endpoint.h.

325: BaseVectorEndpoint(2) {}

◆ SpherePointEndpoint() [4/4]

lsst::afw::geom::SpherePointEndpoint::SpherePointEndpoint ( int nAxes)
explicit

Construct a SpherePointEndpoint with nAxes specified; nAxes must equal 2.

This constructor is primarily used by Transform; other users are encouraged to use the default constructor.

Parameters
[in]nAxesThe number of axes in a point; must equal 2
Exceptions
lsst.pex.exceptions.InvalidParameterErrorif nAxes != 2

Definition at line 169 of file Endpoint.cc.

169 : BaseVectorEndpoint(2) {
170 if (nAxes != 2) {
172 os << "nAxes = " << nAxes << " != 2";
174 }
175}
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition Exception.h:48
std::ostream * os
Definition Schema.cc:557
Reports invalid arguments.
Definition Runtime.h:66

◆ ~SpherePointEndpoint()

lsst::afw::geom::SpherePointEndpoint::~SpherePointEndpoint ( )
overridedefault

Member Function Documentation

◆ _assertNAxes()

template<typename Point , typename Array >
void lsst::afw::geom::BaseEndpoint< Point, Array >::_assertNAxes ( int nAxes) const
protectedinherited

Definition at line 73 of file Endpoint.cc.

73 {
74 if (nAxes != this->getNAxes()) {
76 os << "number of axes provided " << nAxes << " != " << this->getNAxes() << " required";
77 throw std::invalid_argument(os.str());
78 }
79}

◆ _getNAxes() [1/3]

template<typename PointT , typename ArrayT >
int lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::_getNAxes ( ndarray::Array< double, 1, 1 > const & data) const
inlineprotectedinherited

Definition at line 179 of file Endpoint.h.

179{ return data.getSize<0>(); }
char * data
Definition BaseRecord.cc:61

◆ _getNAxes() [2/3]

template<typename PointT , typename ArrayT >
int lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::_getNAxes ( ndarray::Array< double, 2, 2 > const & data) const
inlineprotectedinherited

Definition at line 177 of file Endpoint.h.

177{ return data.getSize<0>(); }

◆ _getNAxes() [3/3]

template<typename PointT , typename ArrayT >
int lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::_getNAxes ( std::vector< double > const & data) const
inlineprotectedinherited

Definition at line 181 of file Endpoint.h.

181{ return data.size(); }

◆ _getNPoints()

template<typename PointT , typename ArrayT >
int lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::_getNPoints ( ndarray::Array< double, 2, 2 > const & data) const
inlineprotectedinherited

Definition at line 183 of file Endpoint.h.

183{ return data.getSize<1>(); }

◆ arrayFromData()

std::vector< lsst::geom::SpherePoint > lsst::afw::geom::SpherePointEndpoint::arrayFromData ( ndarray::Array< double, 2, 2 > const & data) const
overridevirtual

Get an array of points from raw data.

Parameters
[in]dataRaw data for an array of points, as a 2-D ndarray array [nPoints, nAxes] in C order, so the in-memory view is, for example, x0, y0, x1, y1, x2, y2, ...
Returns
an array of points
Exceptions
lsst::pex::exceptions::InvalidParameterErrorif the array has the wrong nAxes dimension

Implements lsst::afw::geom::BaseEndpoint< PointT, ArrayT >.

Definition at line 205 of file Endpoint.cc.

206 {
207 this->_assertNAxes(this->_getNAxes(data));
208 int const nPoints = this->_getNPoints(data);
209 Array array;
210 array.reserve(nPoints);
211 for (auto const& dataCol : data.transpose()) {
212 array.emplace_back(lsst::geom::SpherePoint(dataCol[0], dataCol[1], lsst::geom::radians));
213 }
214 return array;
215}
int _getNPoints(ndarray::Array< double, 2, 2 > const &data) const
Definition Endpoint.h:183
void _assertNAxes(int nAxes) const
Definition Endpoint.cc:73
int _getNAxes(ndarray::Array< double, 2, 2 > const &data) const
Definition Endpoint.h:177
Point in an unspecified spherical coordinate system.
Definition SpherePoint.h:57
AngleUnit constexpr radians
constant with units of radians
Definition Angle.h:109

◆ dataFromArray()

ndarray::Array< double, 2, 2 > lsst::afw::geom::SpherePointEndpoint::dataFromArray ( Array const & arr) const
overridevirtual

Get raw data from an array of points.

Parameters
[in]arrArray of points
Returns
the data as a 2-D ndarray array [nAxes, nPoints] in C order, so the in-memory view is, for example, x0, x1, x2, ..., y0, y1, y2, ...
Exceptions
lsst::pex::exceptions::InvalidParameterErrorif the array has the wrong nAxes dimension

Implements lsst::afw::geom::BaseEndpoint< PointT, ArrayT >.

Definition at line 186 of file Endpoint.cc.

186 {
187 const int nAxes = this->getNAxes();
188 const int nPoints = this->getNPoints(arr);
189 ndarray::Array<double, 2, 2> data = ndarray::allocate(ndarray::makeVector(nAxes, nPoints));
190 auto dataColIter = data.transpose().begin();
191 for (auto const& point : arr) {
192 for (int axInd = 0; axInd < nAxes; ++axInd) {
193 (*dataColIter)[axInd] = point[axInd].asRadians();
194 }
195 ++dataColIter;
196 }
197 return data;
198}

◆ dataFromPoint()

std::vector< double > lsst::afw::geom::SpherePointEndpoint::dataFromPoint ( Point const & point) const
overridevirtual

Get raw data from a single point.

Parameters
[in]pointdata for a single point
Returns
the values in the point as a vector of size NAxess
Exceptions
lsst::pex::exceptions::InvalidParameterErrorif the point has the wrong number of axes

Implements lsst::afw::geom::BaseEndpoint< PointT, ArrayT >.

Definition at line 177 of file Endpoint.cc.

177 {
178 const int nAxes = this->getNAxes();
180 for (int axInd = 0; axInd < nAxes; ++axInd) {
181 result[axInd] = point[axInd].asRadians();
182 }
183 return result;
184}
py::object result
Definition _schema.cc:429

◆ getClassPrefix()

static std::string lsst::afw::geom::SpherePointEndpoint::getClassPrefix ( )
inlinestatic

Get the class name prefix, e.g. "Point2" for "Point2Endpoint".

Definition at line 356 of file Endpoint.h.

356{ return "SpherePoint"; };

◆ getNAxes()

template<typename PointT , typename ArrayT >
int lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::getNAxes ( ) const
inlineinherited

Definition at line 79 of file Endpoint.h.

79{ return _nAxes; }

◆ getNPoints() [1/2]

template<typename PointT , typename ArrayT >
virtual int lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::getNPoints ( Array const & arr) const
pure virtualinherited

Return the number of points in an array.

Implemented in lsst::afw::geom::BaseVectorEndpoint< PointT >, and lsst::afw::geom::GenericEndpoint.

◆ getNPoints() [2/2]

int lsst::afw::geom::BaseVectorEndpoint< Point >::getNPoints ( Array const & arr) const
overrideinherited

Return the number of points in an array.

Definition at line 207 of file Endpoint.cc.

◆ makeFrame()

std::shared_ptr< ast::Frame > lsst::afw::geom::SpherePointEndpoint::makeFrame ( ) const
overridevirtual

Create a Frame that can be used with this end point in a Transform.

Reimplemented from lsst::afw::geom::BaseEndpoint< PointT, ArrayT >.

Definition at line 217 of file Endpoint.cc.

217 {
218 return std::make_shared<ast::SkyFrame>();
219}

◆ normalizeFrame()

void lsst::afw::geom::SpherePointEndpoint::normalizeFrame ( std::shared_ptr< ast::Frame > framePtr) const
overridevirtual

Check that framePtr points to a SkyFrame and set longitude axis to 0, latitude to 1.

Reimplemented from lsst::afw::geom::BaseEndpoint< PointT, ArrayT >.

Definition at line 221 of file Endpoint.cc.

221 {
222 // use getCurrentFrame because if framePtr points to a FrameSet we want its current frame
224 auto skyFramePtr = std::dynamic_pointer_cast<ast::SkyFrame>(currentFramePtr);
225 if (!skyFramePtr) {
227 os << "frame is a " << currentFramePtr->getClassName() << ", not a SkyFrame";
229 }
230 if (skyFramePtr->getLonAxis() != 1) {
231 // axes are swapped to Lat, Lon; swap them back to the usual Lon, Lat
232 // warning: be sure to call permAxes on the original framePtr argument,
233 // as otherwise it will have no effect if framePtr points to a FrameSet
234 std::vector<int> perm = {2, 1};
235 framePtr->permAxes(perm);
236 }
237}

◆ operator!=()

template<typename PointT , typename ArrayT >
bool lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::operator!= ( BaseEndpoint< PointT, ArrayT > const & other) const
inlinenoexceptinherited

Determine whether two endpoints do not represent the same conversion.

Returns
the inverse of operator==. See that operator's documentation for important caveats.

Definition at line 109 of file Endpoint.h.

109{ return !(*this == other); }

◆ operator=() [1/2]

SpherePointEndpoint & lsst::afw::geom::SpherePointEndpoint::operator= ( SpherePointEndpoint && )
delete

◆ operator=() [2/2]

SpherePointEndpoint & lsst::afw::geom::SpherePointEndpoint::operator= ( SpherePointEndpoint const & )
delete

◆ operator==()

template<typename Point , typename Array >
bool lsst::afw::geom::BaseEndpoint< Point, Array >::operator== ( BaseEndpoint< PointT, ArrayT > const & other) const
virtualnoexceptinherited

Determine whether two endpoints represent the same conversion.

Parameters
otherthe endpoint to compare
Returns
true iff this object and other are of exactly the same class and all visible properties are identical. This implementation requires that the objects have the same number of axes.
Warning
Two endpoints with different implementation classes will never compare equal, even if one class is conceptually equivalent to the other (e.g., a decorator). This may cause unexpected behavior when mixing related concrete endpoint classes.

Definition at line 63 of file Endpoint.cc.

63 {
64 return this->getNAxes() == other.getNAxes() && typeid(*this) == typeid(other);
65}

◆ pointFromData()

lsst::geom::SpherePoint lsst::afw::geom::SpherePointEndpoint::pointFromData ( std::vector< double > const & data) const
overridevirtual

Get a single point from raw data.

Parameters
[in]dataData as a vector of length NAxes
Returns
the corresponding point

Implements lsst::afw::geom::BaseEndpoint< PointT, ArrayT >.

Definition at line 200 of file Endpoint.cc.

200 {
201 this->_assertNAxes(this->_getNAxes(data));
203}

The documentation for this class was generated from the following files: