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
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
lsst::afw::geom::Point2Endpoint Class Referenceabstract

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

#include <Endpoint.h>

Inheritance diagram for lsst::afw::geom::Point2Endpoint:
lsst::afw::geom::BaseVectorEndpoint< lsst::geom::Point2D > lsst::afw::geom::BaseEndpoint< PointT, ArrayT >

Public Types

using Array = std::vector< lsst::geom::Point2D >
 
using Point = lsst::geom::Point2D
 

Public Member Functions

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

Static Public Member Functions

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

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::Point2D.

Definition at line 261 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

◆ Point2Endpoint() [1/4]

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

◆ Point2Endpoint() [2/4]

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

◆ Point2Endpoint() [3/4]

lsst::afw::geom::Point2Endpoint::Point2Endpoint ( )
inlineexplicit

Construct a Point2Endpoint.

Definition at line 271 of file Endpoint.h.

271 : BaseVectorEndpoint<lsst::geom::Point2D>(2) {}

◆ Point2Endpoint() [4/4]

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

Construct a Point2Endpoint with nAxes specified; nAxes must equal template parameter N.

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 template parameter N
Exceptions
lsst.pex.exceptions.InvalidParameterErrorif nAxes != N

Definition at line 106 of file Endpoint.cc.

106  : BaseVectorEndpoint<lsst::geom::Point2D>(2) {
107  if (nAxes != 2) {
109  os << "nAxes = " << nAxes << " != 2";
111  }
112 }
#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

◆ ~Point2Endpoint()

lsst::afw::geom::Point2Endpoint::~Point2Endpoint ( )
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::Point2D > lsst::afw::geom::Point2Endpoint::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 147 of file Endpoint.cc.

148  {
149  this->_assertNAxes(this->_getNAxes(data));
150  int const nPoints = this->_getNPoints(data);
151  Array array;
152  array.reserve(nPoints);
153  for (auto const& dataCol : data.transpose()) {
154  array.emplace_back(dataCol[0], dataCol[1]);
155  }
156  return array;
157 }
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

◆ dataFromArray()

ndarray::Array< double, 2, 2 > lsst::afw::geom::Point2Endpoint::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 123 of file Endpoint.cc.

123  {
124  const int nAxes = this->getNAxes();
125  const int nPoints = this->getNPoints(arr);
126  ndarray::Array<double, 2, 2> data = ndarray::allocate(ndarray::makeVector(nAxes, nPoints));
127  auto dataColIter = data.transpose().begin();
128  for (auto const& point : arr) {
129  for (int axInd = 0; axInd < nAxes; ++axInd) {
130  (*dataColIter)[axInd] = point[axInd];
131  }
132  ++dataColIter;
133  }
134  return data;
135 }
int getNPoints(Array const &arr) const override
Definition: Endpoint.cc:82

◆ dataFromPoint()

std::vector< double > lsst::afw::geom::Point2Endpoint::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 114 of file Endpoint.cc.

114  {
115  const int nAxes = this->getNAxes();
117  for (int axInd = 0; axInd < nAxes; ++axInd) {
118  result[axInd] = point[axInd];
119  }
120  return result;
121 }
py::object result
Definition: _schema.cc:429

◆ getClassPrefix()

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

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

Definition at line 307 of file Endpoint.h.

307 { return "Point2"; };

◆ 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::GenericEndpoint, and lsst::afw::geom::BaseVectorEndpoint< PointT >.

◆ 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.

82  {
83  return arr.size();
84 }

◆ makeFrame()

template<typename Point , typename Array >
std::shared_ptr< ast::Frame > lsst::afw::geom::BaseEndpoint< Point, Array >::makeFrame
virtualinherited

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

Reimplemented in lsst::afw::geom::SpherePointEndpoint.

Definition at line 68 of file Endpoint.cc.

68  {
69  return std::make_shared<ast::Frame>(getNAxes());
70 }

◆ normalizeFrame()

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

Check that framePtr points to a Frame, not a subclass.

Subclasses are forbidden because lsst::geom::Point2D is assumed to be cartesian and subclasses of Frame are not (e.g. SkyFrame, SpecFrame and TimeFrame). Note that SpecFrame and TimeFrame are 1-dimensional so they cannot be used in any case. A CmpFrame could be cartesian, but we play it safe and reject these (however, a cartesian CmpFrame ought to simplify to a Frame).

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

Definition at line 159 of file Endpoint.cc.

159  {
160  // use getCurrentFrame because if framePtr points to a FrameSet we want the name of its current frame
161  std::string className = getCurrentFrame(framePtr)->getClassName();
162  if (className != "Frame") {
164  os << "frame is a " << className << ", not a Frame";
166  }
167 }

◆ 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]

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

◆ operator=() [2/2]

Point2Endpoint& lsst::afw::geom::Point2Endpoint::operator= ( Point2Endpoint 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::Point2D lsst::afw::geom::Point2Endpoint::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 137 of file Endpoint.cc.

137  {
138  const int nAxes = this->getNAxes();
139  this->_assertNAxes(this->_getNAxes(data));
140  Point result;
141  for (int axInd = 0; axInd < nAxes; ++axInd) {
142  result[axInd] = data[axInd];
143  }
144  return result;
145 }

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