ITK
6.0.0
Insight Toolkit
|
#include <itkCovariantVector.h>
A templated class holding a n-Dimensional covariant vector.
CovariantVector is a templated class that holds a single vector (i.e., an array of values). CovariantVector 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 VVectorDimension defines the number of components in the vector array.
CovariantVector is not a dynamically extendible array like std::vector. It is intended to be used like a mathematical vector.
If you wish a simpler pixel types, you can use Scalar, which represents a single data value at a pixel. There is also the more complex type ScalarCovariantVector, which supports (for a given pixel) a single scalar value plus an array of vector values. (The scalar and vectors can be of different data type.)
CovariantVector is the type that should be used for representing normals to surfaces and gradients of functions. AffineTransform transform covariant vectors different than vectors.
Definition at line 70 of file itkCovariantVector.h.
Public Types | |
using | BaseArray = FixedArray< T, VVectorDimension > |
using | ComponentType = T |
using | CovariantVectorType = Self |
using | RealValueType = typename NumericTraits< ValueType >::RealType |
using | Self = CovariantVector |
using | Superclass = FixedArray< T, VVectorDimension > |
using | ValueType = T |
Public Types inherited from itk::FixedArray< T, 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 = T |
Public Member Functions | |
CovariantVector ()=default | |
CovariantVector (const ValueType &r) | |
RealValueType | GetNorm () const |
RealValueType | GetSquaredNorm () const |
vnl_vector_ref< T > | GetVnlVector () |
vnl_vector< T > | GetVnlVector () const |
RealValueType | Normalize () |
ValueType | operator* (const Self &other) const |
Self | operator* (const ValueType &val) const |
ValueType | operator* (const Vector< T, VVectorDimension > &other) const |
Self | operator+ (const Self &vec) const |
const Self & | operator+= (const Self &vec) |
Self | operator- () const |
Self | operator- (const Self &vec) const |
const Self & | operator-= (const Self &vec) |
template<typename Tt > | |
Self | operator/ (const Tt &val) const |
CovariantVector & | operator= (const ValueType r[VVectorDimension]) |
void | SetVnlVector (const vnl_vector< T > &) |
template<typename TVectorValueType > | |
CovariantVector (const CovariantVector< TVectorValueType, VVectorDimension > &r) | |
CovariantVector (const ValueType r[Dimension]) | |
template<typename TCovariantVectorValueType > | |
Self & | operator= (const CovariantVector< TCovariantVectorValueType, VVectorDimension > &r) |
template<typename Tt > | |
const Self & | operator*= (const Tt &value) |
template<typename Tt > | |
const Self & | operator/= (const Tt &value) |
template<typename TCoordRepB > | |
void | CastFrom (const CovariantVector< TCoordRepB, VVectorDimension > &pa) |
Public Member Functions inherited from itk::FixedArray< T, 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 | GetCovariantVectorDimension () |
static unsigned int | GetNumberOfComponents () |
Static Public Member Functions inherited from itk::FixedArray< T, 3 > | |
static constexpr FixedArray | Filled (const ValueType &value) |
Static Public Attributes | |
static constexpr unsigned int | Dimension = VVectorDimension |
Static Public Attributes inherited from itk::FixedArray< T, 3 > | |
static constexpr unsigned int | Dimension |
static constexpr unsigned int | Length |
using itk::CovariantVector< T, VVectorDimension >::BaseArray = FixedArray<T, VVectorDimension> |
The Array type from which this CovariantVector is derived.
Definition at line 92 of file itkCovariantVector.h.
using itk::CovariantVector< T, VVectorDimension >::ComponentType = T |
Component value type
Definition at line 83 of file itkCovariantVector.h.
using itk::CovariantVector< T, VVectorDimension >::CovariantVectorType = Self |
I am a covariant vector.
Definition at line 89 of file itkCovariantVector.h.
using itk::CovariantVector< T, VVectorDimension >::RealValueType = typename NumericTraits<ValueType>::RealType |
Definition at line 80 of file itkCovariantVector.h.
using itk::CovariantVector< T, VVectorDimension >::Self = CovariantVector |
Standard class type aliases.
Definition at line 74 of file itkCovariantVector.h.
using itk::CovariantVector< T, VVectorDimension >::Superclass = FixedArray<T, VVectorDimension> |
Definition at line 75 of file itkCovariantVector.h.
using itk::CovariantVector< T, VVectorDimension >::ValueType = T |
ValueType can be used to declare a variable that is the same type as a data element held in an CovariantVector.
Definition at line 79 of file itkCovariantVector.h.
|
default |
Default-constructor.
|
explicit |
Constructor to initialize entire vector to one value.
|
inline |
Pass-through constructor for the Array base class. Implicit casting is performed to initialize constructor from any another one of datatype.
Definition at line 125 of file itkCovariantVector.h.
|
inline |
Pass-through constructor for the Array base class. Implicit casting is performed to initialize constructor from any another one of datatype.
Definition at line 128 of file itkCovariantVector.h.
|
inline |
Copy from another CovariantVector with a different representation type. Casting is done with C-Like rules
Definition at line 255 of file itkCovariantVector.h.
|
inlinestatic |
Get the dimension (size) of the vector.
Definition at line 96 of file itkCovariantVector.h.
RealValueType itk::CovariantVector< T, VVectorDimension >::GetNorm | ( | ) | const |
Returns the Euclidean Norm of the vector
|
inlinestatic |
Returns the number of components in this vector type
Definition at line 238 of file itkCovariantVector.h.
RealValueType itk::CovariantVector< T, VVectorDimension >::GetSquaredNorm | ( | ) | const |
Returns vector's Squared Euclidean Norm
vnl_vector_ref< T > itk::CovariantVector< T, VVectorDimension >::GetVnlVector | ( | ) |
Get a vnl_vector_ref referencing the same memory block.
vnl_vector< T > itk::CovariantVector< T, VVectorDimension >::GetVnlVector | ( | ) | const |
Get a vnl_vector with a copy of the internal memory block.
RealValueType itk::CovariantVector< T, VVectorDimension >::Normalize | ( | ) |
Divides the covariant vector components by the norm and return the norm
ValueType itk::CovariantVector< T, VVectorDimension >::operator* | ( | const Self & | other | ) | const |
CovariantVector operator*. Performs the inner product of two covariant vectors.
|
inline |
Scalar operator*. Scale the elements of a vector by a scalar. Return a new vector.
Definition at line 206 of file itkCovariantVector.h.
ValueType itk::CovariantVector< T, VVectorDimension >::operator* | ( | const Vector< T, VVectorDimension > & | other | ) | const |
operator*. Performs the scalar product with a vector (contravariant). This scalar product is invariant under affine transformations
|
inline |
Scalar operator*=. Scales elements by a scalar.
Definition at line 150 of file itkCovariantVector.h.
Self itk::CovariantVector< T, VVectorDimension >::operator+ | ( | const Self & | vec | ) | const |
CovariantVector addition. Add two vectors. Return a new vector.
const Self & itk::CovariantVector< T, VVectorDimension >::operator+= | ( | const Self & | vec | ) |
CovariantVector operator+=. Adds a vectors to the current vector.
Self itk::CovariantVector< T, VVectorDimension >::operator- | ( | ) | const |
CovariantVector negation. Negate all the elements of a vector. Return a new vector
Self itk::CovariantVector< T, VVectorDimension >::operator- | ( | const Self & | vec | ) | const |
CovariantVector subtraction. Subtract two vectors. Return a new vector.
const Self & itk::CovariantVector< T, VVectorDimension >::operator-= | ( | const Self & | vec | ) |
CovariantVector operator-=. Subtracts a vector from a current vector.
|
inline |
Scalar operator/. Scale (divide) the elements of a vector by a scalar. Return a new vector.
Definition at line 221 of file itkCovariantVector.h.
|
inline |
Scalar operator/=. Scales (divides) elements by a scalar.
Definition at line 163 of file itkCovariantVector.h.
|
inline |
Assignment operator with implicit casting from another data type
Definition at line 136 of file itkCovariantVector.h.
CovariantVector & itk::CovariantVector< T, VVectorDimension >::operator= | ( | const ValueType | r[VVectorDimension] | ) |
Pass-through assignment operator for the Array base class.
void itk::CovariantVector< T, VVectorDimension >::SetVnlVector | ( | const vnl_vector< T > & | ) |
Set a vnl_vector_ref referencing the same memory block.
|
staticconstexpr |
Dimension of the Space
Definition at line 86 of file itkCovariantVector.h.