ITK
6.0.0
Insight Toolkit
|
#include <itkPoint.h>
A templated class holding a geometric point in n-Dimensional space.
Point is a templated class that holds a set of coordinates (components). Point can be used as the data type held at each pixel in an Image or at each vertex of an Mesh. The template parameter T can be any data type that behaves like a primitive (or atomic) data type (int, short, float, complex). The VPointDimension defines the number of components in the point array.
Definition at line 53 of file itkPoint.h.
Public Types | |
using | BaseArray = FixedArray< TCoordRep, VPointDimension > |
using | ConstIterator = typename BaseArray::ConstIterator |
using | CoordRepType = TCoordRep |
using | Iterator = typename BaseArray::Iterator |
using | RealType = typename NumericTraits< ValueType >::RealType |
using | Self = Point |
using | Superclass = FixedArray< TCoordRep, VPointDimension > |
using | ValueType = TCoordRep |
using | VectorType = Vector< ValueType, VPointDimension > |
Public Types inherited from itk::FixedArray< TCoordRep, 3 > | |
using | CArray = ValueType[VLength] |
using | const_iterator = const ValueType * |
using | const_pointer = const ValueType * |
using | const_reference = const ValueType & |
using | const_reverse_iterator = std::reverse_iterator< const_iterator > |
using | ConstIterator = const ValueType * |
using | Iterator = ValueType * |
using | iterator = ValueType * |
using | pointer = ValueType * |
using | reference = ValueType & |
using | reverse_iterator = std::reverse_iterator< iterator > |
using | SizeType = unsigned int |
using | ValueType = TCoordRep |
Public Member Functions | |
template<typename TCoordRepB > | |
RealType | EuclideanDistanceTo (const Point< TCoordRepB, VPointDimension > &pa) const |
VectorType | GetVectorFromOrigin () const |
vnl_vector_ref< TCoordRep > | GetVnlVector () |
vnl_vector< TCoordRep > | GetVnlVector () const |
ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self) | |
Self | operator+ (const VectorType &vec) const |
const Self & | operator+= (const VectorType &vec) |
VectorType | operator- (const Self &pnt) const |
Self | operator- (const VectorType &vec) const |
const Self & | operator-= (const VectorType &vec) |
Point & | operator= (const ValueType r[VPointDimension]) |
bool | operator== (const Self &pt) const |
Point ()=default | |
template<typename TPointValueType > | |
Point (const Point< TPointValueType, VPointDimension > &r) | |
Point (const std::array< ValueType, VPointDimension > &stdArray) | |
template<typename TPointValueType > | |
Point (const TPointValueType &v) | |
Point (const ValueType &v) | |
Point (std::nullptr_t)=delete | |
void | SetToMidPoint (const Self &, const Self &) |
template<typename TCoordRepB > | |
RealType | SquaredEuclideanDistanceTo (const Point< TCoordRepB, VPointDimension > &pa) const |
template<typename TPointValueType > | |
Point (const TPointValueType r[VPointDimension]) | |
Point (const ValueType r[VPointDimension]) | |
void | SetToBarycentricCombination (const Self &A, const Self &B, double alpha) |
void | SetToBarycentricCombination (const Self &A, const Self &B, const Self &C, double weightForA, double weightForB) |
void | SetToBarycentricCombination (const Self *P, const double *weights, unsigned int N) |
template<typename TCoordRepB > | |
void | CastFrom (const Point< TCoordRepB, VPointDimension > &pa) |
Public Member Functions inherited from itk::FixedArray< TCoordRep, 3 > | |
Iterator | Begin () |
ConstIterator | Begin () const |
constexpr const_iterator | begin () const noexcept |
constexpr iterator | begin () noexcept |
constexpr const_iterator | cbegin () const noexcept |
constexpr const_iterator | cend () const noexcept |
const_reverse_iterator | crbegin () const |
const_reverse_iterator | crend () const |
ValueType * | data () |
const ValueType * | data () const |
Iterator | End () |
ConstIterator | End () const |
constexpr const_iterator | end () const noexcept |
constexpr iterator | end () noexcept |
void | Fill (const ValueType &) |
FixedArray ()=default | |
FixedArray (const FixedArray< TFixedArrayValueType, VLength > &r) | |
FixedArray (const std::array< ValueType, VLength > &stdArray) | |
FixedArray (const TScalarValue *r) | |
ValueType * | GetDataPointer () |
const ValueType * | GetDataPointer () const |
ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (FixedArray) | |
itkLegacyMacro (ReverseIterator rBegin();) itkLegacyMacro(ConstReverseIterator rBegin() const | |
itkLegacyMacro (ReverseIterator rEnd();) itkLegacyMacro(ConstReverseIterator rEnd() const | |
FixedArray & | operator= (const FixedArray< TFixedArrayValueType, VLength > &r) |
FixedArray & | operator= (const ValueType r[VLength]) |
bool | operator== (const FixedArray &r) const |
reverse_iterator | rbegin () |
const_reverse_iterator | rbegin () const |
reverse_iterator | rend () |
const_reverse_iterator | rend () const |
SizeType | Size () const |
constexpr SizeType | size () const |
void | swap (FixedArray &other) |
FixedArray (const ValueType r[VLength]) | |
FixedArray (const ValueType &) | |
ITK_GCC_PRAGMA_PUSH ITK_GCC_SUPPRESS_Warray_bounds constexpr reference | operator[] (unsigned int index) |
constexpr const_reference | operator[] (unsigned int index) const |
ITK_GCC_PRAGMA_POP void | SetElement (unsigned int index, const_reference value) |
const_reference | GetElement (unsigned int index) const |
Static Public Member Functions | |
static unsigned int | GetPointDimension () |
Static Public Member Functions inherited from itk::FixedArray< TCoordRep, 3 > | |
static constexpr FixedArray | Filled (const ValueType &value) |
Static Public Attributes | |
static constexpr unsigned int | PointDimension = VPointDimension |
Static Public Attributes inherited from itk::FixedArray< TCoordRep, 3 > | |
static constexpr unsigned int | Dimension |
static constexpr unsigned int | Length |
using itk::Point< TCoordRep, VPointDimension >::BaseArray = FixedArray<TCoordRep, VPointDimension> |
The Array type from which this Vector is derived.
Definition at line 72 of file itkPoint.h.
using itk::Point< TCoordRep, VPointDimension >::ConstIterator = typename BaseArray::ConstIterator |
Definition at line 74 of file itkPoint.h.
using itk::Point< TCoordRep, VPointDimension >::CoordRepType = TCoordRep |
Definition at line 64 of file itkPoint.h.
using itk::Point< TCoordRep, VPointDimension >::Iterator = typename BaseArray::Iterator |
Definition at line 73 of file itkPoint.h.
using itk::Point< TCoordRep, VPointDimension >::RealType = typename NumericTraits<ValueType>::RealType |
Definition at line 66 of file itkPoint.h.
using itk::Point< TCoordRep, VPointDimension >::Self = Point |
Standard class type aliases.
Definition at line 58 of file itkPoint.h.
using itk::Point< TCoordRep, VPointDimension >::Superclass = FixedArray<TCoordRep, VPointDimension> |
Definition at line 59 of file itkPoint.h.
using itk::Point< TCoordRep, VPointDimension >::ValueType = TCoordRep |
ValueType can be used to declare a variable that is the same type as a data element held in an Point.
Definition at line 63 of file itkPoint.h.
using itk::Point< TCoordRep, VPointDimension >::VectorType = Vector<ValueType, VPointDimension> |
VectorType define the difference between two Points
Definition at line 84 of file itkPoint.h.
|
default |
Default-constructor.
|
inline |
Pass-through constructors for different type points.
Definition at line 92 of file itkPoint.h.
|
inline |
Pass-through constructors for plain arrays.
Definition at line 98 of file itkPoint.h.
|
inline |
Pass-through constructors for plain arrays.
Definition at line 101 of file itkPoint.h.
|
delete |
Prevents copy-initialization from nullptr
, as well as from 0
(NULL).
|
inlineexplicit |
Explicit constructors for single values
Definition at line 112 of file itkPoint.h.
|
inlineexplicit |
Definition at line 115 of file itkPoint.h.
|
inlineexplicit |
Explicit constructor for std::array.
Definition at line 133 of file itkPoint.h.
|
inline |
Copy from another Point with a different representation type. Casting is done with C-Like rules
Definition at line 265 of file itkPoint.h.
|
inline |
Compute the Euclidean Distance from this point to another point with a different representation type. Casting is done with C-Like rules
Definition at line 298 of file itkPoint.h.
|
inlinestatic |
Get the dimension (size) of the point.
Definition at line 78 of file itkPoint.h.
VectorType itk::Point< TCoordRep, VPointDimension >::GetVectorFromOrigin | ( | ) | const |
Access an element of a point.
vnl_vector_ref< TCoordRep > itk::Point< TCoordRep, VPointDimension >::GetVnlVector | ( | ) |
Get a vnl_vector_ref referencing the same memory block
vnl_vector< TCoordRep > itk::Point< TCoordRep, VPointDimension >::GetVnlVector | ( | ) | const |
Get a vnl_vector with a copy of the internal memory block.
itk::Point< TCoordRep, VPointDimension >::ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION | ( | Self | ) |
Self itk::Point< TCoordRep, VPointDimension >::operator+ | ( | const VectorType & | vec | ) | const |
Add a vector to a point. Return a new point.
const Self & itk::Point< TCoordRep, VPointDimension >::operator+= | ( | const VectorType & | vec | ) |
Point operator+=. Adds a vector to the current point.
VectorType itk::Point< TCoordRep, VPointDimension >::operator- | ( | const Self & | pnt | ) | const |
Computes the Vector difference between two points
Self itk::Point< TCoordRep, VPointDimension >::operator- | ( | const VectorType & | vec | ) | const |
Subtract a vector from a point. Return a new point.
const Self & itk::Point< TCoordRep, VPointDimension >::operator-= | ( | const VectorType & | vec | ) |
Point operator-=. Subtracts a vector from a current point.
Point & itk::Point< TCoordRep, VPointDimension >::operator= | ( | const ValueType | r[VPointDimension] | ) |
Pass-through assignment operator for a plain array.
|
inline |
Compare two points for equality.
Definition at line 143 of file itkPoint.h.
References itk::operator==().
void itk::Point< TCoordRep, VPointDimension >::SetToBarycentricCombination | ( | const Self & | A, |
const Self & | B, | ||
const Self & | C, | ||
double | weightForA, | ||
double | weightForB | ||
) |
Set the current point to a barycentric combination of three points Two values are expected to weight the contribution of the first two points, the weight of for the third point is computed to ensure that the three weights sum 1.
This method computes:
\[ \overrightarrow{P}= w_1 * \overrightarrow{P}_1 + w_2 * \overrightarrow{P}_2 + (1-w_1-w_2 ) * \overrightarrow{P}_3 \]
If the two weight are \( \in [0,1] \) , The resulting point will always be placed inside the triangle formed by the three points given as arguments.
void itk::Point< TCoordRep, VPointDimension >::SetToBarycentricCombination | ( | const Self & | A, |
const Self & | B, | ||
double | alpha | ||
) |
Set the current point to a barycentric combination of the two points given as arguments.
A | First point |
B | Second point |
alpha | Weight for the first point |
The first point is multiplied by \( \alpha \), the second is multiplied by * \( (1-\alpha) \), and the sum is stored in the Point on which the method is invoked.
\[ \overrightarrow{P}=\alpha * \overrightarrow{A}+ (1-\alpha)*\overrightarrow{B} \]
If the value of \( \alpha \in [0,1] \), the resulting point will be placed in the line segment \( \overline{AB} \) joining \( \overrightarrow{A} \) and \( \overrightarrow{A} \)
If the value of \( \alpha < 0 \) the resulting point will be placed outside the line segment \( \overline{AB} \) on the side of \( \overrightarrow{A} \).
If the value of \( \alpha > 1 \) the resulting point will be placed outside the line segment \( \overline{AB} \) on the side of \( \overrightarrow{B} \).
void itk::Point< TCoordRep, VPointDimension >::SetToBarycentricCombination | ( | const Self * | P, |
const double * | weights, | ||
unsigned int | N | ||
) |
Set the current point to a barycentric combination of an array of N points An array of (N-1) values is expected to weight the contribution of the first (N-1) points, the weight of the Nth point is computed to ensure that the N weights sum 1.
This method computes:
\[ \overrightarrow{P}= \sum_{i=1}^{N-1} w_i * \overrightarrow{P}_i + \left(1- \sum_{i=1}^{N-1} w_i\right) * \overrightarrow{P}_N \]
void itk::Point< TCoordRep, VPointDimension >::SetToMidPoint | ( | const Self & | , |
const Self & | |||
) |
Set to median point between the two points given as arguments
This method computes:
\[ \overrightarrow{P}=\frac{(\overrightarrow{A}+\overrightarrow{B})}{2} \]
using the two Points given as arguments, and store the result in the Point on which the method is invoked.
|
inline |
Compute the Squared Euclidean Distance from this point to another point with a different representation type. Casting is done with C-Like rules
Definition at line 280 of file itkPoint.h.
|
staticconstexpr |
Dimension of the Space
Definition at line 69 of file itkPoint.h.