Class GenericEndpoint

Inheritance Relationships

Base Type

Class Documentation

class GenericEndpoint : public lsst::afw::geom::BaseEndpoint<std::vector<double>, ndarray::Array<double, 2, 2>>

A generic endpoint for data in the format used by ast::Mapping

Thus supports all ast frame classes and any number of axes, and thus can be used as an endpoint for any ast::Mapping.

Public Functions

GenericEndpoint(GenericEndpoint const&)
GenericEndpoint(GenericEndpoint&&)
GenericEndpoint &operator=(GenericEndpoint const&)
GenericEndpoint &operator=(GenericEndpoint&&)
GenericEndpoint(int nAxes)

Construct a GenericEndpoint with the specified number of axes

Parameters

  • [in] nAxes: The number of axes in a point; must be > 0

Exceptions

  • lsst.pex.exceptions.InvalidParameterError: if nAxes <= 0

~GenericEndpoint()
int getNPoints(Array const &arr) const

Return the number of points in an array

std::vector<double> dataFromPoint(Point const &point) const

Get raw data from a single point

Return

the values in the point as a vector of size NAxess

Parameters

  • [in] point: data for a single point

Exceptions

  • lsst::pex::exceptions::InvalidParameterError: if the point has the wrong number of axes

ndarray::Array<double, 2, 2> dataFromArray(Array const &arr) const

Get raw data from an array of points

Return

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, …

Parameters

  • [in] arr: Array of points

Exceptions

  • lsst::pex::exceptions::InvalidParameterError: if the array has the wrong nAxes dimension

Point pointFromData(std::vector<double> const &data) const

Get a single point from raw data

Return

the corresponding point

Parameters

  • [in] data: Data as a vector of length NAxes

Array arrayFromData(ndarray::Array<double, 2, 2> const &data) const

Get an array of points from raw data

Return

an array of points

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, …

Exceptions

  • lsst::pex::exceptions::InvalidParameterError: if the array has the wrong nAxes dimension

Public Static Functions

static std::string getClassPrefix()

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