![]() |
Orfeo Toolbox
3.16
|
Represent a symmetric tensor of second rank. More...
#include <itkSymmetricSecondRankTensor.h>
Inheritance diagram for itk::SymmetricSecondRankTensor< TComponent, NDimension >:
Collaboration diagram for itk::SymmetricSecondRankTensor< TComponent, NDimension >:Public Types | |
| typedef NumericTraits < ValueType >::RealType | AccumulateValueType |
| typedef FixedArray< TComponent, itkGetStaticConstMacro(InternalDimension)> | BaseArray |
| typedef ValueType | CArray [VLength] |
| typedef ComponentType | ComponentArrayType [itkGetStaticConstMacro(InternalDimension)] |
| typedef TComponent | ComponentType |
| typedef const ValueType * | const_pointer |
| typedef const ValueType & | const_reference |
| typedef const ValueType * | ConstIterator |
| typedef FixedArray< TComponent, NDimension > | EigenValuesArrayType |
| typedef Matrix< TComponent, NDimension, NDimension > | EigenVectorsMatrixType |
| typedef ValueType * | Iterator |
| typedef Matrix< TComponent, NDimension, NDimension > | MatrixType |
| typedef ValueType * | pointer |
| typedef NumericTraits < ValueType >::RealType | RealValueType |
| typedef ValueType & | reference |
| typedef SymmetricSecondRankTensor | Self |
| typedef unsigned int | SizeType |
| typedef FixedArray< TComponent, NDimension *(NDimension+1)/2 > | Superclass |
| typedef SymmetricEigenAnalysis < MatrixType, EigenValuesArrayType, EigenVectorsMatrixType > | SymmetricEigenAnalysisType |
| typedef Superclass::ValueType | ValueType |
Public Member Functions | |
| SymmetricSecondRankTensor () | |
| SymmetricSecondRankTensor (const ComponentType &r) | |
| template<typename TCoordRepB > | |
| SymmetricSecondRankTensor (const SymmetricSecondRankTensor< TCoordRepB, NDimension > &pa) | |
| SymmetricSecondRankTensor (const ComponentArrayType r) | |
| Iterator | Begin () |
| ConstIterator | Begin () const |
| void | ComputeEigenAnalysis (EigenValuesArrayType &eigenValues, EigenVectorsMatrixType &eigenVectors) const |
| void | ComputeEigenValues (EigenValuesArrayType &eigenValues) const |
| Iterator | End () |
| ConstIterator | End () const |
| void | Fill (const ValueType &) |
| ValueType * | GetDataPointer () |
| const ValueType * | GetDataPointer () const |
| const_reference | GetElement (unsigned short index) const |
| ComponentType | GetNthComponent (int c) const |
| AccumulateValueType | GetTrace () const |
| bool | operator!= (const FixedArray &r) const |
| ValueType & | operator() (unsigned int row, unsigned int col) |
| const ValueType & | operator() (unsigned int row, unsigned int col) const |
| Self | operator* (const RealValueType &scalar) const |
| const Self & | operator*= (const RealValueType &scalar) |
| Self | operator+ (const Self &vec) const |
| const Self & | operator+= (const Self &vec) |
| Self | operator- (const Self &vec) const |
| const Self & | operator-= (const Self &vec) |
| Self | operator/ (const RealValueType &scalar) const |
| const Self & | operator/= (const RealValueType &scalar) |
| template<typename TCoordRepB > | |
| Self & | operator= (const SymmetricSecondRankTensor< TCoordRepB, NDimension > &pa) |
| Self & | operator= (const ComponentType &r) |
| Self & | operator= (const ComponentArrayType r) |
| bool | operator== (const FixedArray &r) const |
| reference | operator[] (short index) |
| const_reference | operator[] (short index) const |
| reference | operator[] (unsigned short index) |
| const_reference | operator[] (unsigned short index) const |
| reference | operator[] (int index) |
| const_reference | operator[] (int index) const |
| reference | operator[] (unsigned int index) |
| const_reference | operator[] (unsigned int index) const |
| reference | operator[] (long index) |
| const_reference | operator[] (long index) const |
| reference | operator[] (unsigned long index) |
| const_reference | operator[] (unsigned long index) const |
| Self | PostMultiply (const MatrixType &m) const |
| Self | PreMultiply (const MatrixType &m) const |
| ReverseIterator | rBegin () |
| ConstReverseIterator | rBegin () const |
| ReverseIterator | rEnd () |
| ConstReverseIterator | rEnd () const |
| void | SetElement (unsigned short index, const_reference value) |
| void | SetIdentity () |
| void | SetNthComponent (int c, const ComponentType &v) |
| SizeType | Size () const |
Static Public Member Functions | |
| static FixedArray | Filled (const ValueType &) |
| static unsigned int | GetNumberOfComponents () |
Static Public Attributes | |
| static const unsigned int | Dimension = NDimension |
| static const unsigned int | InternalDimension = NDimension*(NDimension+1)/2 |
| static const unsigned int | Length |
Represent a symmetric tensor of second rank.
This class implements a ND symmetric tensor of second rank.
Since SymmetricSecondRankTensor is a subclass of FixedArray, you can access its components as:
typedef itk::SymmetricSecondRankTensor< float > TensorPixelType; TensorPixelType tensor;
tensor[0] = 1.233; tensor[1] = 1.456;
for convenience the indexed access is also available as
tensor(0,0) = 1.233; tensor(2,0) = 1.233;
The Tensor in principle represents a NxN matrix, but given that it is always symmetric the representation can be compacted into a N*(N+1)/2 elements array that derives from the itk::FixedArray<T>
This class was mostly based on files that Jeffrey Duda, Torsten Rohlfing and Martin Styner contributed to the ITK users list during a discussion on support for DiffusionTensorImages. The funding for creating this class was largely provided by NAMIC (National Alliance for Medical Image Computing) (http://www.na-mic.org). A discussion on the design of this class can be found in the WIKI pages of NAMIC:
http://www.na-mic.org/Wiki/index.php/NAMIC_Wiki:DTI:ITK-DiffusionTensorPixelType
Definition at line 74 of file itkSymmetricSecondRankTensor.h.
| typedef NumericTraits<ValueType>::RealType itk::SymmetricSecondRankTensor< TComponent, NDimension >::AccumulateValueType |
Reimplemented in itk::DiffusionTensor3D< TComponent >.
Definition at line 100 of file itkSymmetricSecondRankTensor.h.
| typedef FixedArray<TComponent, itkGetStaticConstMacro(InternalDimension)> itk::SymmetricSecondRankTensor< TComponent, NDimension >::BaseArray |
Convenience typedefs.
Definition at line 88 of file itkSymmetricSecondRankTensor.h.
|
inherited |
A type representing the C-array version of this FixedArray.
Definition at line 77 of file itkFixedArray.h.
| typedef ComponentType itk::SymmetricSecondRankTensor< TComponent, NDimension >::ComponentArrayType[itkGetStaticConstMacro(InternalDimension)] |
Reimplemented in itk::DiffusionTensor3D< TComponent >.
Definition at line 116 of file itkSymmetricSecondRankTensor.h.
| typedef TComponent itk::SymmetricSecondRankTensor< TComponent, NDimension >::ComponentType |
Define the component type.
Reimplemented in itk::DiffusionTensor3D< TComponent >.
Definition at line 98 of file itkSymmetricSecondRankTensor.h.
|
inherited |
A const pointer to the ValueType.
Definition at line 129 of file itkFixedArray.h.
|
inherited |
A const reference to the ValueType.
Definition at line 135 of file itkFixedArray.h.
|
inherited |
A const iterator through the array.
Definition at line 83 of file itkFixedArray.h.
| typedef FixedArray<TComponent, NDimension> itk::SymmetricSecondRankTensor< TComponent, NDimension >::EigenValuesArrayType |
Array of eigen-values.
Reimplemented in itk::DiffusionTensor3D< TComponent >.
Definition at line 91 of file itkSymmetricSecondRankTensor.h.
| typedef Matrix<TComponent, NDimension, NDimension> itk::SymmetricSecondRankTensor< TComponent, NDimension >::EigenVectorsMatrixType |
Reimplemented in itk::DiffusionTensor3D< TComponent >.
Definition at line 95 of file itkSymmetricSecondRankTensor.h.
|
inherited |
An iterator through the array.
Definition at line 80 of file itkFixedArray.h.
| typedef Matrix<TComponent, NDimension, NDimension> itk::SymmetricSecondRankTensor< TComponent, NDimension >::MatrixType |
Matrix of eigen-vectors.
Definition at line 94 of file itkSymmetricSecondRankTensor.h.
|
inherited |
A pointer to the ValueType.
Definition at line 126 of file itkFixedArray.h.
| typedef NumericTraits<ValueType>::RealType itk::SymmetricSecondRankTensor< TComponent, NDimension >::RealValueType |
Reimplemented in itk::DiffusionTensor3D< TComponent >.
Definition at line 101 of file itkSymmetricSecondRankTensor.h.
|
inherited |
A reference to the ValueType.
Definition at line 132 of file itkFixedArray.h.
| typedef SymmetricSecondRankTensor itk::SymmetricSecondRankTensor< TComponent, NDimension >::Self |
Standard class typedefs.
Reimplemented in itk::DiffusionTensor3D< TComponent >.
Definition at line 79 of file itkSymmetricSecondRankTensor.h.
|
inherited |
Definition at line 137 of file itkFixedArray.h.
| typedef FixedArray<TComponent,NDimension*(NDimension+1)/2> itk::SymmetricSecondRankTensor< TComponent, NDimension >::Superclass |
Reimplemented in itk::DiffusionTensor3D< TComponent >.
Definition at line 80 of file itkSymmetricSecondRankTensor.h.
| typedef SymmetricEigenAnalysis< MatrixType, EigenValuesArrayType, EigenVectorsMatrixType > itk::SymmetricSecondRankTensor< TComponent, NDimension >::SymmetricEigenAnalysisType |
Definition at line 104 of file itkSymmetricSecondRankTensor.h.
| typedef Superclass::ValueType itk::SymmetricSecondRankTensor< TComponent, NDimension >::ValueType |
The element type stored at each location in the FixedArray.
Reimplemented from itk::FixedArray< TComponent, NDimension *(NDimension+1)/2 >.
Reimplemented in itk::DiffusionTensor3D< TComponent >.
Definition at line 99 of file itkSymmetricSecondRankTensor.h.
|
inline |
Default constructor has nothing to do.
Definition at line 107 of file itkSymmetricSecondRankTensor.h.
|
inline |
Definition at line 109 of file itkSymmetricSecondRankTensor.h.
|
inline |
Constructor to enable casting...
Definition at line 113 of file itkSymmetricSecondRankTensor.h.
|
inline |
Pass-through constructor for the Array base class.
Definition at line 119 of file itkSymmetricSecondRankTensor.h.
|
inherited |
Get various iterators to the array.
Get an Iterator for the beginning of the FixedArray.
Referenced by itk::DTITubeSpatialObjectPoint< TPointDimension >::SetTensorMatrix().
|
inherited |
Get a ConstIterator for the beginning of the FixedArray.
| void itk::SymmetricSecondRankTensor< T, NDimension >::ComputeEigenAnalysis | ( | EigenValuesArrayType & | eigenValues, |
| EigenVectorsMatrixType & | eigenVectors | ||
| ) | const |
Return an array containing EigenValues, and a matrix containing Eigen vectors.
Compute Eigen analysis, it returns an array with eigen values and a Matrix with eigen vectors
Definition at line 300 of file itkSymmetricSecondRankTensor.txx.
References itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ComputeEigenValuesAndVectors().
| void itk::SymmetricSecondRankTensor< T, NDimension >::ComputeEigenValues | ( | EigenValuesArrayType & | eigenValues | ) | const |
Return an array containing EigenValues.
Compute Eigen Values
Definition at line 275 of file itkSymmetricSecondRankTensor.txx.
References itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ComputeEigenValues().
|
inherited |
Get an Iterator for the end of the FixedArray.
Referenced by itk::DTITubeSpatialObjectPoint< TPointDimension >::SetTensorMatrix().
|
inherited |
Get a ConstIterator for the end of the FixedArray.
|
inherited |
Fill all elements of the array with the given value.
Referenced by itk::SymmetricSecondRankTensor< TComponent, 3 >::SymmetricSecondRankTensor().
|
staticinherited |
Return an FixedArray with all elements assigned to the given value.
|
inlineinherited |
Return a pointer to the data.
Definition at line 216 of file itkFixedArray.h.
|
inlineinherited |
Definition at line 217 of file itkFixedArray.h.
|
inlineinherited |
Definition at line 213 of file itkFixedArray.h.
|
inline |
Return the value for the Nth component.
Definition at line 152 of file itkSymmetricSecondRankTensor.h.
|
inlinestatic |
Return the number of components.
Definition at line 146 of file itkSymmetricSecondRankTensor.h.
Referenced by itk::operator>>().
| SymmetricSecondRankTensor< T, NDimension >::AccumulateValueType itk::SymmetricSecondRankTensor< T, NDimension >::GetTrace | ( | ) | const |
Get Trace value
Get the Trace
Reimplemented in itk::DiffusionTensor3D< TComponent >.
Definition at line 256 of file itkSymmetricSecondRankTensor.txx.
|
inlineinherited |
Definition at line 191 of file itkFixedArray.h.
| SymmetricSecondRankTensor< T, NDimension >::ValueType & itk::SymmetricSecondRankTensor< T, NDimension >::operator() | ( | unsigned int | row, |
| unsigned int | col | ||
| ) |
Matrix notation, in const and non-const forms.
Matrix notation access to elements
Definition at line 211 of file itkSymmetricSecondRankTensor.txx.
| const SymmetricSecondRankTensor< T, NDimension >::ValueType & itk::SymmetricSecondRankTensor< T, NDimension >::operator() | ( | unsigned int | row, |
| unsigned int | col | ||
| ) | const |
Matrix notation access to elements
Definition at line 182 of file itkSymmetricSecondRankTensor.txx.
| SymmetricSecondRankTensor< T, NDimension > itk::SymmetricSecondRankTensor< T, NDimension >::operator* | ( | const RealValueType & | r | ) | const |
Arithmetic operations between tensors and scalars
Performs multiplication with a scalar
Definition at line 150 of file itkSymmetricSecondRankTensor.txx.
| const SymmetricSecondRankTensor< T, NDimension > & itk::SymmetricSecondRankTensor< T, NDimension >::operator*= | ( | const RealValueType & | r | ) |
Performs multiplication by a scalar, in place
Definition at line 120 of file itkSymmetricSecondRankTensor.txx.
| SymmetricSecondRankTensor< T, NDimension > itk::SymmetricSecondRankTensor< T, NDimension >::operator+ | ( | const Self & | r | ) | const |
Aritmetic operations between pixels. Return a new SymmetricSecondRankTensor.
Returns a temporary copy of a vector
Definition at line 58 of file itkSymmetricSecondRankTensor.txx.
| const SymmetricSecondRankTensor< T, NDimension > & itk::SymmetricSecondRankTensor< T, NDimension >::operator+= | ( | const Self & | r | ) |
Performs addition in place
Definition at line 90 of file itkSymmetricSecondRankTensor.txx.
| SymmetricSecondRankTensor< T, NDimension > itk::SymmetricSecondRankTensor< T, NDimension >::operator- | ( | const Self & | r | ) | const |
Returns a temporary copy of a vector
Definition at line 74 of file itkSymmetricSecondRankTensor.txx.
| const SymmetricSecondRankTensor< T, NDimension > & itk::SymmetricSecondRankTensor< T, NDimension >::operator-= | ( | const Self & | r | ) |
Performs subtraction in place
Definition at line 105 of file itkSymmetricSecondRankTensor.txx.
| SymmetricSecondRankTensor< T, NDimension > itk::SymmetricSecondRankTensor< T, NDimension >::operator/ | ( | const RealValueType & | r | ) | const |
Performs division by a scalar
Definition at line 166 of file itkSymmetricSecondRankTensor.txx.
| const SymmetricSecondRankTensor< T, NDimension > & itk::SymmetricSecondRankTensor< T, NDimension >::operator/= | ( | const RealValueType & | r | ) |
Performs division by a scalar, in place
Definition at line 135 of file itkSymmetricSecondRankTensor.txx.
|
inline |
Templated Pass-through assignment for the Array base class.
Definition at line 123 of file itkSymmetricSecondRankTensor.h.
| SymmetricSecondRankTensor< T, NDimension > & itk::SymmetricSecondRankTensor< T, NDimension >::operator= | ( | const ComponentType & | r | ) |
Pass-through assignment operator for the Array base class.
Assignment Operator from a scalar constant
Reimplemented in itk::DiffusionTensor3D< TComponent >.
Definition at line 33 of file itkSymmetricSecondRankTensor.txx.
| SymmetricSecondRankTensor< T, NDimension > & itk::SymmetricSecondRankTensor< T, NDimension >::operator= | ( | const ComponentArrayType | r | ) |
Assigment from a plain array
Definition at line 46 of file itkSymmetricSecondRankTensor.txx.
|
inherited |
Operators == and != are used to compare whether two arrays are equal. Note that arrays are equal when the number of components (size) is the same, and each component value is equal.
Operator != compares different types of arrays.
|
inlineinherited |
Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.
Definition at line 197 of file itkFixedArray.h.
Referenced by itk::SymmetricSecondRankTensor< TComponent, 3 >::GetNthComponent(), and itk::SymmetricSecondRankTensor< TComponent, 3 >::SetNthComponent().
|
inlineinherited |
Definition at line 198 of file itkFixedArray.h.
|
inlineinherited |
Definition at line 199 of file itkFixedArray.h.
|
inlineinherited |
Definition at line 200 of file itkFixedArray.h.
|
inlineinherited |
Definition at line 201 of file itkFixedArray.h.
|
inlineinherited |
Definition at line 202 of file itkFixedArray.h.
|
inlineinherited |
Definition at line 203 of file itkFixedArray.h.
|
inlineinherited |
Definition at line 204 of file itkFixedArray.h.
|
inlineinherited |
Definition at line 205 of file itkFixedArray.h.
|
inlineinherited |
Definition at line 206 of file itkFixedArray.h.
|
inlineinherited |
Definition at line 207 of file itkFixedArray.h.
|
inlineinherited |
Definition at line 208 of file itkFixedArray.h.
| SymmetricSecondRankTensor< T, NDimension > itk::SymmetricSecondRankTensor< T, NDimension >::PostMultiply | ( | const MatrixType & | m | ) | const |
Post-Multiply by a Matrix as ResultingTensor = ThisTensor * Matrix.
Post-multiply the Tensor by a Matrix
Definition at line 350 of file itkSymmetricSecondRankTensor.txx.
| SymmetricSecondRankTensor< T, NDimension > itk::SymmetricSecondRankTensor< T, NDimension >::PreMultiply | ( | const MatrixType & | m | ) | const |
Pre-Multiply by a Matrix as ResultingTensor = Matrix * ThisTensor.
Pre-multiply the Tensor by a Matrix
Definition at line 325 of file itkSymmetricSecondRankTensor.txx.
|
inherited |
Get a begin ReverseIterator.
|
inherited |
Get a begin ConstReverseIterator.
|
inherited |
Get an end ReverseIterator.
|
inherited |
Get an end ConstReverseIterator.
|
inlineinherited |
Set/Get element methods are more convenient in wrapping languages
Definition at line 211 of file itkFixedArray.h.
| void itk::SymmetricSecondRankTensor< T, NDimension >::SetIdentity | ( | void | ) |
Set the tensor to an identity tensor. This has 1 in its diagonal elements zero elsewhere
Set the Tensor to an Identity. Set ones in the diagonal and zeroes every where else.
Definition at line 240 of file itkSymmetricSecondRankTensor.txx.
|
inline |
Set the Nth component to v.
Definition at line 156 of file itkSymmetricSecondRankTensor.h.
|
inherited |
Get the size of the FixedArray.
|
static |
Dimension of the vector space.
Reimplemented from itk::FixedArray< TComponent, NDimension *(NDimension+1)/2 >.
Definition at line 83 of file itkSymmetricSecondRankTensor.h.
|
static |
Definition at line 84 of file itkSymmetricSecondRankTensor.h.
Referenced by itk::SymmetricSecondRankTensor< TComponent, 3 >::GetNumberOfComponents().
|
staticinherited |
Length constant
Definition at line 68 of file itkFixedArray.h.