lsst::afw::geom::BaseEndpoint< PointT, ArrayT > Class Template Reference

Virtual base class for endpoints, which are helper classes for Transform. More...

#include <Endpoint.h>

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

Public Types
using	Point = PointT
using	Array = ArrayT

Public Member Functions
	BaseEndpoint (BaseEndpoint const &)=default
	BaseEndpoint (BaseEndpoint &&)=default
BaseEndpoint &	operator= (BaseEndpoint const &)=delete
BaseEndpoint &	operator= (BaseEndpoint &&)=delete
virtual	~BaseEndpoint ()=default
int	getNAxes () const
virtual int	getNPoints (Array const &arr) const =0
	Return the number of points in an array. More...
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::vector< double >	dataFromPoint (Point const &point) const =0
	Get raw data from a single point. More...
virtual ndarray::Array< double, 2, 2 >	dataFromArray (Array const &arr) const =0
	Get raw data from an array of points. More...
virtual Point	pointFromData (std::vector< double > const &data) const =0
	Get a single point from raw data. More...
virtual Array	arrayFromData (ndarray::Array< double, 2, 2 > const &data) const =0
	Get an array of points from raw data. More...
virtual std::shared_ptr< ast::Frame >	makeFrame () const
	Create a Frame that can be used with this end point in a Transform. More...
virtual void	normalizeFrame (std::shared_ptr< ast::Frame > framePtr) const
	Adjust and check the frame as needed. More...

Protected Member Functions
	BaseEndpoint (int nAxes)
	Construct a BaseEndpoint. More...
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

template<typename PointT, typename ArrayT>
class lsst::afw::geom::BaseEndpoint< PointT, ArrayT >

Virtual base class for endpoints, which are helper classes for Transform.

Endpoints transform points and lists of points from LSST-specific data types, such as lsst::geom::Point2D and lsst::geom::SpherePoint, to a form accepted by ast::Mapping.tran. Each type of endpoint is used for a particular LSST data type, for example:

• Point2Endpoint is used for lsst::geom::Point2D data
• SpherePointEndpoint for lsst::geom::SpherePoint data
• GenericEndpoint is used when no other form will do; its LSST data type is identical to the type used for ast::Mapping.applyForward.

Endpoints use the following forms of data for raw data:

• std::vector<double> for a single point
• ndarray<double, 2, 2> with dimensions number of axes x number of points for an array of points

Endpoints are designed as helper classes for Transform. Each transform has a two endpoints: one for input data and one for output data.

Endpoint also provides two methods to work with ast::Frames:

• normalizeFrame verifies that a frame is the correct type, and adjusts its settings if necessary
• makeFrame creates a new frame with the correct type and settings

Template Parameters

PointT	LSST data type for one point
ArrayT	LSST data type for an array of points

Definition at line 67 of file Endpoint.h.

Member Typedef Documentation

Array

template<typename PointT , typename ArrayT >

using lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::Array = ArrayT

Definition at line 70 of file Endpoint.h.

Point

template<typename PointT , typename ArrayT >

using lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::Point = PointT

Definition at line 69 of file Endpoint.h.

Constructor & Destructor Documentation

BaseEndpoint() [1/3]

template<typename PointT , typename ArrayT >

lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::BaseEndpoint ( BaseEndpoint< PointT, ArrayT > const &  )

default

BaseEndpoint() [2/3]

template<typename PointT , typename ArrayT >

lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::BaseEndpoint ( BaseEndpoint< PointT, ArrayT > &&  )

default

~BaseEndpoint()

template<typename PointT , typename ArrayT >

virtual lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::~BaseEndpoint ( )

virtualdefault

BaseEndpoint() [3/3]

template<typename Point , typename Array >

lsst::afw::geom::BaseEndpoint< Point, Array >::BaseEndpoint ( int  nAxes )

explicitprotected

Construct a BaseEndpoint.

Parameters

[in]

nAxes

The number of axes in a point; must be > 0

Exceptions

lsst.pex.exceptions.InvalidParameterError

if nAxes <= 0

Definition at line 55 of file Endpoint.cc.

                                                  : _nAxes(nAxes) {
    if (nAxes <= 0) {
        throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                          "nAxes = " + std::to_string(nAxes) + "; must be > 0");
    }
}

Member Function Documentation

_assertNAxes()

template<typename Point , typename Array >

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

protected

Definition at line 73 of file Endpoint.cc.

                                                             {
    if (nAxes != this->getNAxes()) {
        std::ostringstream os;
        os << "number of axes provided " << nAxes << " != " << this->getNAxes() << " required";
        throw std::invalid_argument(os.str());
    }
}

_getNAxes() [1/3]

template<typename PointT , typename ArrayT >

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

inlineprotected

Definition at line 179 of file Endpoint.h.

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

_getNAxes() [2/3]

template<typename PointT , typename ArrayT >

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

inlineprotected

Definition at line 177 of file Endpoint.h.

{ 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

inlineprotected

Definition at line 181 of file Endpoint.h.

{ 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

inlineprotected

Definition at line 183 of file Endpoint.h.

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

arrayFromData()

template<typename PointT , typename ArrayT >

virtual Array lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::arrayFromData ( ndarray::Array< double, 2, 2 > const &  data ) const

pure virtual

Get an array of points from raw data.

Parameters

[in]

data

Raw 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::InvalidParameterError

if the array has the wrong nAxes dimension

Implemented in lsst::afw::geom::SpherePointEndpoint, lsst::afw::geom::Point2Endpoint, and lsst::afw::geom::GenericEndpoint.

dataFromArray()

template<typename PointT , typename ArrayT >

virtual ndarray::Array<double, 2, 2> lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::dataFromArray ( Array const &  arr ) const

pure virtual

Get raw data from an array of points.

Parameters

[in]

arr

Array 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::InvalidParameterError

if the array has the wrong nAxes dimension

Implemented in lsst::afw::geom::SpherePointEndpoint, and lsst::afw::geom::Point2Endpoint.

dataFromPoint()

template<typename PointT , typename ArrayT >

virtual std::vector<double> lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::dataFromPoint ( Point const &  point ) const

pure virtual

Get raw data from a single point.

Parameters

[in]

point

data for a single point

Returns

the values in the point as a vector of size NAxess

Exceptions

lsst::pex::exceptions::InvalidParameterError

if the point has the wrong number of axes

Implemented in lsst::afw::geom::SpherePointEndpoint, and lsst::afw::geom::Point2Endpoint.

getNAxes()

template<typename PointT , typename ArrayT >

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

inline

Definition at line 79 of file Endpoint.h.

{ return _nAxes; }

getNPoints()

template<typename PointT , typename ArrayT >

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

pure virtual

Return the number of points in an array.

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

makeFrame()

template<typename Point , typename Array >

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

virtual

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.

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

normalizeFrame()

template<typename PointT , typename ArrayT >

virtual void lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::normalizeFrame ( std::shared_ptr< ast::Frame >  framePtr ) const

inlinevirtual

Adjust and check the frame as needed.

Do not bother to check the number of axes because that is done elsewhere.

The base implementation does nothing.

Reimplemented in lsst::afw::geom::SpherePointEndpoint, and lsst::afw::geom::Point2Endpoint.

Definition at line 163 of file Endpoint.h.

{};

operator!=()

template<typename PointT , typename ArrayT >

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

inlinenoexcept

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.

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

operator=() [1/2]

template<typename PointT , typename ArrayT >

BaseEndpoint& lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::operator= ( BaseEndpoint< PointT, ArrayT > &&  )

delete

operator=() [2/2]

template<typename PointT , typename ArrayT >

BaseEndpoint& lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::operator= ( BaseEndpoint< PointT, ArrayT > const &  )

delete

operator==()

template<typename Point , typename Array >

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

virtualnoexcept

Determine whether two endpoints represent the same conversion.

Parameters

other

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

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

pointFromData()

template<typename PointT , typename ArrayT >

virtual Point lsst::afw::geom::BaseEndpoint< PointT, ArrayT >::pointFromData ( std::vector< double > const &  data ) const

pure virtual

Get a single point from raw data.

Parameters

[in]

data

Data as a vector of length NAxes

Returns

the corresponding point

Implemented in lsst::afw::geom::SpherePointEndpoint, lsst::afw::geom::Point2Endpoint, and lsst::afw::geom::GenericEndpoint.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/geom/Endpoint.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/geom/Endpoint.cc