lsst::afw::geom::Point2Endpoint Class Reference

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

#include <Endpoint.h>

Inheritance diagram for lsst::afw::geom::Point2Endpoint:

Public Types
using	Array
using	Point

Public Member Functions
	Point2Endpoint (Point2Endpoint const &)=default
	Point2Endpoint (Point2Endpoint &&)=default
Point2Endpoint &	operator= (Point2Endpoint const &)=delete
Point2Endpoint &	operator= (Point2Endpoint &&)=delete
	Point2Endpoint ()
	Construct a Point2Endpoint.
	Point2Endpoint (int nAxes)
	Construct a Point2Endpoint with nAxes specified; nAxes must equal template parameter N.
	~Point2Endpoint () override=default
std::vector< double >	dataFromPoint (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.
void	normalizeFrame (std::shared_ptr< ast::Frame > framePtr) const override
	Check that framePtr points to a Frame, not a subclass.
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.
virtual std::shared_ptr< ast::Frame >	makeFrame () const
	Create a Frame that can be used with this end point in a Transform.

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

Definition at line 261 of file Endpoint.h.

Member Typedef Documentation

Array

using lsst::afw::geom::BaseVectorEndpoint< lsst::geom::Point2D >::Array

inherited

Definition at line 197 of file Endpoint.h.

Point

using lsst::afw::geom::BaseVectorEndpoint< lsst::geom::Point2D >::Point

inherited

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.

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

nAxes

The number of axes in a point; must equal template parameter N

Exceptions

lsst.pex.exceptions.InvalidParameterError

if nAxes != N

Definition at line 106 of file Endpoint.cc.

                                        : BaseVectorEndpoint<lsst::geom::Point2D>(2) {
    if (nAxes != 2) {
        std::ostringstream os;
        os << "nAxes = " << nAxes << " != 2";
        throw LSST_EXCEPT(pexExcept::InvalidParameterError, os.str());
    }
}

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

                                                             {
    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

inlineprotectedinherited

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

inlineprotectedinherited

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

inlineprotectedinherited

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

inlineprotectedinherited

Definition at line 183 of file Endpoint.h.

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

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

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

Definition at line 147 of file Endpoint.cc.

                                                      {
    this->_assertNAxes(this->_getNAxes(data));
    int const nPoints = this->_getNPoints(data);
    Array array;
    array.reserve(nPoints);
    for (auto const& dataCol : data.transpose()) {
        array.emplace_back(dataCol[0], dataCol[1]);
    }
    return array;
}

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]

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

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

Definition at line 123 of file Endpoint.cc.

                                                                               {
    const int nAxes = this->getNAxes();
    const int nPoints = this->getNPoints(arr);
    ndarray::Array<double, 2, 2> data = ndarray::allocate(ndarray::makeVector(nAxes, nPoints));
    auto dataColIter = data.transpose().begin();
    for (auto const& point : arr) {
        for (int axInd = 0; axInd < nAxes; ++axInd) {
            (*dataColIter)[axInd] = point[axInd];
        }
        ++dataColIter;
    }
    return data;
}

dataFromPoint()

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

overridevirtual

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

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

Definition at line 114 of file Endpoint.cc.

                                                                        {
    const int nAxes = this->getNAxes();
    std::vector<double> result(nAxes);
    for (int axInd = 0; axInd < nAxes; ++axInd) {
        result[axInd] = point[axInd];
    }
    return result;
}

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.

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

{ 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()

template<typename Point , typename Array >

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

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.

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

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.

                                                                          {
    // use getCurrentFrame because if framePtr points to a FrameSet we want the name of its current frame
    std::string className = getCurrentFrame(framePtr)->getClassName();
    if (className != "Frame") {
        std::ostringstream os;
        os << "frame is a " << className << ", not a Frame";
        throw LSST_EXCEPT(pexExcept::InvalidParameterError, os.str());
    }
}

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.

{ 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

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()

lsst::geom::Point2D lsst::afw::geom::Point2Endpoint::pointFromData ( std::vector< double > const & data ) const

overridevirtual

Get a single point from raw data.

Parameters

[in]

data

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

                                                                                 {
    const int nAxes = this->getNAxes();
    this->_assertNAxes(this->_getNAxes(data));
    Point result;
    for (int axInd = 0; axInd < nAxes; ++axInd) {
        result[axInd] = data[axInd];
    }
    return result;
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/include/lsst/afw/geom/Endpoint.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/src/geom/Endpoint.cc