LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Private Types | List of all members
lsst::afw::geom::Point< T, 3 > Class Template Reference

A coordinate class intended to represent absolute positions (3-d specialization). More...

#include <Point.h>

Inheritance diagram for lsst::afw::geom::Point< T, 3 >:
lsst::afw::geom::PointBase< T, 3 > lsst::afw::geom::CoordinateBase< Point< T, N >, T, N >

Public Types

typedef Super::EigenVector EigenVector
 
- Public Types inherited from lsst::afw::geom::CoordinateBase< Point< T, N >, T, N >
typedef T Element
 
typedef Eigen::Matrix< T, N,
1, Eigen::DontAlign > 
EigenVector
 

Public Member Functions

 Point (T val=static_cast< T >(0))
 Construct a Point with all elements set to the same scalar value. More...
 
template<typename U >
 Point (Point< U, 3 > const &other)
 Explicit converting constructor. More...
 
 Point (EigenVector const &vector)
 Construct a Point from an Eigen vector. More...
 
 Point (Extent< T, 3 > const &other)
 Explicit constructor from Extent. More...
 
 Point (T x, T y, T z)
 Explicit constructor from a sequence of doubles. More...
 
 Point (T const xyz[3])
 Construct from a two-element array. More...
 
 Point (boost::tuple< T, T, T > const &xyz)
 Construct from boost::tuple. More...
 
void swap (Point &other)
 
- Public Member Functions inherited from lsst::afw::geom::PointBase< T, 3 >
bool operator== (Point< T, N > const &other) const
 Standard equality comparison. More...
 
bool operator!= (Point< T, N > const &other) const
 Standard inequality comparison. More...
 
Extent< T, N > asExtent () const
 Cast this object to an Extent of the same numeric type and dimensionality. More...
 
void shift (Extent< T, N > const &offset)
 Shift the point by the given offset. More...
 
void scale (double factor)
 
double distanceSquared (PointBase< T, N > const &other) const
 
std::string toString () const
 
CoordinateExpr< N > eq (Point< T, N > const &other) const
 
CoordinateExpr< N > eq (T scalar) const
 
CoordinateExpr< N > ne (Point< T, N > const &other) const
 
CoordinateExpr< N > ne (T scalar) const
 
CoordinateExpr< N > lt (Point< T, N > const &other) const
 
CoordinateExpr< N > lt (T scalar) const
 
CoordinateExpr< N > le (Point< T, N > const &other) const
 
CoordinateExpr< N > le (T scalar) const
 
CoordinateExpr< N > gt (Point< T, N > const &other) const
 
CoordinateExpr< N > gt (T scalar) const
 
CoordinateExpr< N > ge (Point< T, N > const &other) const
 
CoordinateExpr< N > ge (T scalar) const
 
Extent< T, N > operator- (Point< T, N > const &other) const
 
Point< T, N > operator- (Extent< T, N > const &other) const
 
Point< T, N > operator+ (Extent< T, N > const &other) const
 
Point< T, N > & operator+= (Extent< T, N > const &other)
 
Point< T, N > & operator-= (Extent< T, N > const &other)
 
- Public Member Functions inherited from lsst::afw::geom::CoordinateBase< Point< T, N >, T, N >
T & operator[] (int n)
 
T const & operator[] (int n) const
 
T & coeffRef (int n)
 
T const & coeffRef (int n) const
 
EigenVector const & asEigen () const
 Return a fixed-size Eigen representation of the coordinate object. More...
 

Private Types

typedef PointBase< T, 3 > Super
 

Additional Inherited Members

- Static Public Attributes inherited from lsst::afw::geom::CoordinateBase< Point< T, N >, T, N >
static int const dimensions
 
- Protected Member Functions inherited from lsst::afw::geom::PointBase< T, 3 >
 PointBase (T val=static_cast< T >(0))
 
 PointBase (Eigen::MatrixBase< Vector > const &vector)
 
- Protected Member Functions inherited from lsst::afw::geom::CoordinateBase< Point< T, N >, T, N >
 CoordinateBase (T val=static_cast< T >(0))
 Initialize all elements to a scalar. More...
 
 CoordinateBase (Eigen::MatrixBase< Vector > const &vector)
 Initialize all elements from an N-d Eigen vector. More...
 
void _swap (CoordinateBase &other)
 
- Protected Attributes inherited from lsst::afw::geom::CoordinateBase< Point< T, N >, T, N >
EigenVector _vector
 

Detailed Description

template<typename T>
class lsst::afw::geom::Point< T, 3 >

A coordinate class intended to represent absolute positions (3-d specialization).

See Operators on Point and Extent for mathematical operators on Point.

Definition at line 236 of file Point.h.

Member Typedef Documentation

template<typename T >
typedef Super::EigenVector lsst::afw::geom::Point< T, 3 >::EigenVector

Definition at line 239 of file Point.h.

template<typename T >
typedef PointBase<T,3> lsst::afw::geom::Point< T, 3 >::Super
private

Definition at line 237 of file Point.h.

Constructor & Destructor Documentation

template<typename T >
lsst::afw::geom::Point< T, 3 >::Point ( val = static_cast<T>(0))
inlineexplicit

Construct a Point with all elements set to the same scalar value.

Definition at line 242 of file Point.h.

242 : Super(val) {}
PointBase< T, 3 > Super
Definition: Point.h:237
bool val
template<typename T >
template<typename U >
lsst::afw::geom::Point< T, 3 >::Point ( Point< U, 3 > const &  other)
explicit

Explicit converting constructor.

Converting from floating point to integer rounds to the nearest integer instead of truncating. This ensures that a floating-point pixel coordinate converts to the coordinate of the pixel it lies on (assuming the floating point origin is the center of the first pixel).

template<typename T >
lsst::afw::geom::Point< T, 3 >::Point ( EigenVector const &  vector)
inlineexplicit

Construct a Point from an Eigen vector.

Definition at line 255 of file Point.h.

255 : Super(vector) {}
PointBase< T, 3 > Super
Definition: Point.h:237
template<typename T >
lsst::afw::geom::Point< T, 3 >::Point ( Extent< T, 3 > const &  other)
inlineexplicit

Explicit constructor from Extent.

Definition at line 258 of file Point.h.

258 : Super(other.asEigen()) {}
PointBase< T, 3 > Super
Definition: Point.h:237
template<typename T >
lsst::afw::geom::Point< T, 3 >::Point ( x,
y,
z 
)
inlineexplicit

Explicit constructor from a sequence of doubles.

Definition at line 261 of file Point.h.

261 : Super(EigenVector(x,y,z)) {}
int y
Super::EigenVector EigenVector
Definition: Point.h:239
PointBase< T, 3 > Super
Definition: Point.h:237
double x
template<typename T >
lsst::afw::geom::Point< T, 3 >::Point ( T const  xyz[3])
inlineexplicit

Construct from a two-element array.

Definition at line 264 of file Point.h.

264 : Super(EigenVector(xyz[0], xyz[1], xyz[2])) {}
Super::EigenVector EigenVector
Definition: Point.h:239
PointBase< T, 3 > Super
Definition: Point.h:237
template<typename T >
lsst::afw::geom::Point< T, 3 >::Point ( boost::tuple< T, T, T > const &  xyz)
inlineexplicit

Construct from boost::tuple.

Definition at line 267 of file Point.h.

267  :
268  Super(EigenVector(xyz.template get<0>(), xyz.template get<1>(), xyz.template get<2>())) {}
Super::EigenVector EigenVector
Definition: Point.h:239
PointBase< T, 3 > Super
Definition: Point.h:237

Member Function Documentation

template<typename T >
void lsst::afw::geom::Point< T, 3 >::swap ( Point< T, 3 > &  other)
inline

Definition at line 279 of file Point.h.

279 { this->_swap(other); }

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