lsst::afw::geom::SpherePointEndpoint Class Reference

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

#include <Endpoint.h>

Inheritance diagram for lsst::afw::geom::SpherePointEndpoint:

Public Types
using	Array
using	Point

Public Member Functions
	SpherePointEndpoint (SpherePointEndpoint const &)=default
	SpherePointEndpoint (SpherePointEndpoint &&)=default
SpherePointEndpoint &	operator= (SpherePointEndpoint const &)=delete
SpherePointEndpoint &	operator= (SpherePointEndpoint &&)=delete
	SpherePointEndpoint ()
	Construct a SpherePointEndpoint.
	SpherePointEndpoint (int nAxes)
	Construct a SpherePointEndpoint with nAxes specified; nAxes must equal 2.
	~SpherePointEndpoint () 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.
std::shared_ptr< ast::Frame >	makeFrame () 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

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

inherited

Definition at line 197 of file Endpoint.h.

Point

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

inherited

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.

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

nAxes

The number of axes in a point; must equal 2

Exceptions

lsst.pex.exceptions.InvalidParameterError

if nAxes != 2

Definition at line 169 of file Endpoint.cc.

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

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

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

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 205 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(lsst::geom::SpherePoint(dataCol[0], dataCol[1], lsst::geom::radians));
    }
    return array;
}

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]

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 186 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].asRadians();
        }
        ++dataColIter;
    }
    return data;
}

dataFromPoint()

std::vector< double > lsst::afw::geom::SpherePointEndpoint::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 177 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].asRadians();
    }
    return result;
}

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.

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

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

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

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.

                                                                               {
    // use getCurrentFrame because if framePtr points to a FrameSet we want its current frame
    auto currentFramePtr = getCurrentFrame(framePtr);
    auto skyFramePtr = std::dynamic_pointer_cast<ast::SkyFrame>(currentFramePtr);
    if (!skyFramePtr) {
        std::ostringstream os;
        os << "frame is a " << currentFramePtr->getClassName() << ", not a SkyFrame";
        throw LSST_EXCEPT(pexExcept::InvalidParameterError, os.str());
    }
    if (skyFramePtr->getLonAxis() != 1) {
        // axes are swapped to Lat, Lon; swap them back to the usual Lon, Lat
        // warning: be sure to call permAxes on the original framePtr argument,
        // as otherwise it will have no effect if framePtr points to a FrameSet
        std::vector<int> perm = {2, 1};
        framePtr->permAxes(perm);
    }
}

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]

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

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::SpherePoint lsst::afw::geom::SpherePointEndpoint::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 200 of file Endpoint.cc.

                                                                                          {
    this->_assertNAxes(this->_getNAxes(data));
    return lsst::geom::SpherePoint(data[0], data[1], lsst::geom::radians);
}

---

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