#include <itkNumericTraitsTensorPixel.h>

Detailed Description

template<typename T, unsigned int D>
class itk::NumericTraits< SymmetricSecondRankTensor< T, D > >

Define numeric traits for SymmetricSecondRankTensor.

Template Parameters

T	Component type of SymmetricSecondRankTensor
D	Dimension of the SymmetricSecondRankTensor

We provide here a generic implementation based on creating types of SymmetricSecondRankTensor whose components are the types of the NumericTraits from the original SymmetricSecondRankTensor components. This implementation require support for partial specializations, since it is based on the concept that: NumericTraits<SymmetricSecondRankTensor< T, D > > is defined piecewise by SymmetricSecondRankTensor< NumericTraits< T, D > >

See also: NumericTraits

Definition at line 44 of file itkNumericTraitsTensorPixel.h.

Inheritance diagram for itk::NumericTraits< SymmetricSecondRankTensor< T, D > >:

Collaboration diagram for itk::NumericTraits< SymmetricSecondRankTensor< T, D > >:

Public Types
using	AbsType

using	AbsType = SymmetricSecondRankTensor<ElementAbsType, D>

using	AccumulateType

using	AccumulateType = SymmetricSecondRankTensor<ElementAccumulateType, D>

using	FloatType

using	FloatType = SymmetricSecondRankTensor<ElementFloatType, D>

using	MeasurementVectorType

using	MeasurementVectorType = Self

using	PrintType

using	PrintType = SymmetricSecondRankTensor<ElementPrintType, D>

using	RealType

using	RealType = SymmetricSecondRankTensor<ElementRealType, D>

using	ScalarRealType

using	ScalarRealType = ElementRealType

using	Self = SymmetricSecondRankTensor<T, D>

using	TraitsType

using	ValueType

using	ValueType = T

Static Public Member Functions
static void	AssignToArray (const Self &v, MeasurementVectorType &mv)

template<typename TArray>
static void	AssignToArray (const Self &v, TArray &mv)

static void	AssignToArray (const T &v, TArray &mv)

static constexpr unsigned int	GetLength ()

static constexpr unsigned int	GetLength ()

static constexpr unsigned int	GetLength (const SymmetricSecondRankTensor< T, D > &)

static constexpr unsigned int	GetLength (const T &)

static bool	IsNegative (T val)

static bool	IsNonnegative (T val)

static bool	IsNonpositive (T val)

static bool	IsPositive (T val)

static Self	max ()

static Self	max (const Self &)

static constexpr T	max (const T &)

static Self	min ()

static Self	min (const Self &)

static constexpr T	min (const T &)

static constexpr T	NonpositiveMin ()

static Self	NonpositiveMin ()

static Self	NonpositiveMin (const Self &)

static T	NonpositiveMin (const T &)

static T	OneValue ()

static Self	OneValue ()

static Self	OneValue (const Self &)

static T	OneValue (const T &)

static void	SetLength (SymmetricSecondRankTensor< T, D > &m, const unsigned int s)

static void	SetLength (T &m, const unsigned int s)

static T	ZeroValue ()

static Self	ZeroValue ()

static Self	ZeroValue (const Self &)

static T	ZeroValue (const T &)

Static Public Attributes
static constexpr bool	IsComplex

static constexpr bool	IsComplex = NumericTraits<ValueType>::IsComplex

static constexpr bool	IsInteger

static constexpr bool	IsInteger = std::is_integral_v<ValueType>

static constexpr bool	IsSigned

static constexpr bool	IsSigned = std::is_signed_v<ValueType>

static const T ITKCommon_EXPORT	One

static const Self ITKCommon_EXPORT	One

static const T ITKCommon_EXPORT	Zero

static const Self ITKCommon_EXPORT	Zero

Private Types
using	ElementAbsType = typename NumericTraits<T>::AbsType

using	ElementAccumulateType = typename NumericTraits<T>::AccumulateType

using	ElementFloatType = typename NumericTraits<T>::FloatType

using	ElementPrintType = typename NumericTraits<T>::PrintType

using	ElementRealType = typename NumericTraits<T>::RealType

Member Typedef Documentation

◆ AbsType [1/2]

using itk::NumericTraits< T >::AbsType

Return value of itk::Math::Absolute().

Definition at line 73 of file itkNumericTraits.h.

◆ AbsType [2/2]

template<typename T, unsigned int D>

using itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::AbsType = SymmetricSecondRankTensor<ElementAbsType, D>

Unsigned component type

Definition at line 60 of file itkNumericTraitsTensorPixel.h.

◆ AccumulateType [1/2]

using itk::NumericTraits< T >::AccumulateType

Accumulation of addition and multiplication.

Definition at line 76 of file itkNumericTraits.h.

◆ AccumulateType [2/2]

template<typename T, unsigned int D>

using itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::AccumulateType = SymmetricSecondRankTensor<ElementAccumulateType, D>

Accumulation of addition and multiplication.

Definition at line 63 of file itkNumericTraitsTensorPixel.h.

◆ ElementAbsType

template<typename T, unsigned int D>

using itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::ElementAbsType = typename NumericTraits<T>::AbsType

private

Definition at line 47 of file itkNumericTraitsTensorPixel.h.

◆ ElementAccumulateType

template<typename T, unsigned int D>

using itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::ElementAccumulateType = typename NumericTraits<T>::AccumulateType

private

Definition at line 48 of file itkNumericTraitsTensorPixel.h.

◆ ElementFloatType

template<typename T, unsigned int D>

using itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::ElementFloatType = typename NumericTraits<T>::FloatType

private

Definition at line 49 of file itkNumericTraitsTensorPixel.h.

◆ ElementPrintType

template<typename T, unsigned int D>

using itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::ElementPrintType = typename NumericTraits<T>::PrintType

private

Definition at line 50 of file itkNumericTraitsTensorPixel.h.

◆ ElementRealType

template<typename T, unsigned int D>

using itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::ElementRealType = typename NumericTraits<T>::RealType

private

Definition at line 51 of file itkNumericTraitsTensorPixel.h.

◆ FloatType [1/2]

using itk::NumericTraits< T >::FloatType

Typedef for operations that use floating point instead of real precision to save memory

Definition at line 83 of file itkNumericTraits.h.

◆ FloatType [2/2]

template<typename T, unsigned int D>

using itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::FloatType = SymmetricSecondRankTensor<ElementFloatType, D>

Typedef for operations that use floating point instead of real precision

Definition at line 67 of file itkNumericTraitsTensorPixel.h.

◆ MeasurementVectorType [1/2]

using itk::NumericTraits< T >::MeasurementVectorType

Measurement vector type

Definition at line 79 of file itkNumericTraits.h.

◆ MeasurementVectorType [2/2]

template<typename T, unsigned int D>

using itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::MeasurementVectorType = Self

Measurement vector type

Definition at line 79 of file itkNumericTraitsTensorPixel.h.

◆ PrintType [1/2]

using itk::NumericTraits< T >::PrintType

Return the type that can be printed.

Definition at line 70 of file itkNumericTraits.h.

◆ PrintType [2/2]

template<typename T, unsigned int D>

using itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::PrintType = SymmetricSecondRankTensor<ElementPrintType, D>

Return the type that can be printed.

Definition at line 70 of file itkNumericTraitsTensorPixel.h.

◆ RealType [1/2]

using itk::NumericTraits< T >::RealType

Type for real-valued scalar operations.

Definition at line 86 of file itkNumericTraits.h.

◆ RealType [2/2]

template<typename T, unsigned int D>

using itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::RealType = SymmetricSecondRankTensor<ElementRealType, D>

Type for real-valued scalar operations.

Definition at line 73 of file itkNumericTraitsTensorPixel.h.

◆ ScalarRealType [1/2]

using itk::NumericTraits< T >::ScalarRealType

Type for real-valued scalar operations.

Definition at line 89 of file itkNumericTraits.h.

◆ ScalarRealType [2/2]

template<typename T, unsigned int D>

using itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::ScalarRealType = ElementRealType

Type for real-valued scalar operations.

Definition at line 76 of file itkNumericTraitsTensorPixel.h.

◆ Self

template<typename T, unsigned int D>

using itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::Self = SymmetricSecondRankTensor<T, D>

Definition at line 57 of file itkNumericTraitsTensorPixel.h.

◆ TraitsType

using itk::NumericTraits< T >::TraitsType

The type of this limits trait object.

Definition at line 64 of file itkNumericTraits.h.

◆ ValueType [1/2]

using itk::NumericTraits< T >::ValueType

Return the type of this native type.

Definition at line 67 of file itkNumericTraits.h.

◆ ValueType [2/2]

template<typename T, unsigned int D>

using itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::ValueType = T

Return the type of the native component type.

Definition at line 55 of file itkNumericTraitsTensorPixel.h.

Member Function Documentation

◆ AssignToArray() [1/3]

template<typename T, unsigned int D>

static void itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::AssignToArray	(	const Self &	v,
		MeasurementVectorType &	mv )

inlinestatic

Definition at line 180 of file itkNumericTraitsTensorPixel.h.

◆ AssignToArray() [2/3]

template<typename T, unsigned int D>

template<typename TArray>

static void itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::AssignToArray	(	const Self &	v,
		TArray &	mv )

inlinestatic

Definition at line 187 of file itkNumericTraitsTensorPixel.h.

References itk::NumericTraits< T >::GetLength().

◆ AssignToArray() [3/3]

static void itk::NumericTraits< T >::AssignToArray	(	const T &	v,
		TArray &	mv )

inlinestatic

assign the value to an array

Definition at line 244 of file itkNumericTraits.h.

◆ GetLength() [1/4]

static constexpr unsigned int itk::NumericTraits< T >::GetLength ( )

inlinestaticconstexpr

Return the length of the scalar: 1. Array types can return a different value

Definition at line 209 of file itkNumericTraits.h.

◆ GetLength() [2/4]

template<typename T, unsigned int D>

static constexpr unsigned int itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::GetLength ( )

inlinestaticconstexpr

Return the size of the underlying FixedArray.

Definition at line 174 of file itkNumericTraitsTensorPixel.h.

◆ GetLength() [3/4]

template<typename T, unsigned int D>

static constexpr unsigned int itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::GetLength ( const SymmetricSecondRankTensor< T, D > & )

inlinestaticconstexpr

Return the size of the underlying FixedArray.

Definition at line 167 of file itkNumericTraitsTensorPixel.h.

References itk::NumericTraits< T >::GetLength().

◆ GetLength() [4/4]

static constexpr unsigned int itk::NumericTraits< T >::GetLength ( const T & )

inlinestaticconstexpr

Return the length of the scalar. This API is needed for VariableLengthVector because its length is only known at run-time. Specializations of the VariableLengthVector will provide a different implementation where a vector of the correct size is built.

Definition at line 202 of file itkNumericTraits.h.

◆ IsNegative()

static bool itk::NumericTraits< T >::IsNegative ( T val )

inlinestatic

Is a given value negative?

Definition at line 120 of file itkNumericTraits.h.

◆ IsNonnegative()

static bool itk::NumericTraits< T >::IsNonnegative ( T val )

inlinestatic

Is a given value nonnegative?

Definition at line 127 of file itkNumericTraits.h.

◆ IsNonpositive()

static bool itk::NumericTraits< T >::IsNonpositive ( T val )

inlinestatic

Is a given value nonpositive?

Definition at line 113 of file itkNumericTraits.h.

◆ IsPositive()

static bool itk::NumericTraits< T >::IsPositive ( T val )

inlinestatic

Is a given value positive?

Definition at line 106 of file itkNumericTraits.h.

◆ max() [1/3]

template<typename T, unsigned int D>

static Self itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::max ( )

inlinestatic

Definition at line 99 of file itkNumericTraitsTensorPixel.h.

References itk::MakeFilled(), and itk::NumericTraits< T >::max().

◆ max() [2/3]

template<typename T, unsigned int D>

static Self itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::max ( const Self & )

inlinestatic

Component wise defined element

Note: minimum value for floating pointer types is defined as minimum positive normalize value.

Definition at line 87 of file itkNumericTraitsTensorPixel.h.

References itk::MakeFilled(), and itk::NumericTraits< T >::max().

◆ max() [3/3]

static constexpr T itk::NumericTraits< T >::max ( const T & )

inlinestaticconstexpr

Definition at line 169 of file itkNumericTraits.h.

◆ min() [1/3]

template<typename T, unsigned int D>

static Self itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::min ( )

inlinestatic

Definition at line 105 of file itkNumericTraitsTensorPixel.h.

References itk::MakeFilled(), and itk::NumericTraits< T >::min().

◆ min() [2/3]

template<typename T, unsigned int D>

static Self itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::min ( const Self & )

inlinestatic

Definition at line 93 of file itkNumericTraitsTensorPixel.h.

References itk::MakeFilled(), and itk::NumericTraits< T >::min().

◆ min() [3/3]

static constexpr T itk::NumericTraits< T >::min ( const T & )

inlinestaticconstexpr

Definition at line 174 of file itkNumericTraits.h.

◆ NonpositiveMin() [1/4]

static constexpr T itk::NumericTraits< T >::NonpositiveMin ( )

inlinestaticconstexpr

Smallest (most nonpositive) value

Definition at line 99 of file itkNumericTraits.h.

◆ NonpositiveMin() [2/4]

template<typename T, unsigned int D>

static Self itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::NonpositiveMin ( )

inlinestatic

Definition at line 111 of file itkNumericTraitsTensorPixel.h.

References itk::MakeFilled(), and itk::NumericTraits< T >::NonpositiveMin().

◆ NonpositiveMin() [3/4]

template<typename T, unsigned int D>

static Self itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::NonpositiveMin ( const Self & )

inlinestatic

Definition at line 129 of file itkNumericTraitsTensorPixel.h.

References itk::NumericTraits< T >::NonpositiveMin().

◆ NonpositiveMin() [4/4]

static T itk::NumericTraits< T >::NonpositiveMin ( const T & )

inlinestatic

Smallest (most nonpositive) value. This API is needed for VariableLengthVector because its length is only known at run-time.

Definition at line 218 of file itkNumericTraits.h.

◆ OneValue() [1/4]

static T itk::NumericTraits< T >::OneValue ( )

inlinestatic

Return one value. This function should be used to support RGBPixel type and standard types (not vectors)

Definition at line 158 of file itkNumericTraits.h.

◆ OneValue() [2/4]

template<typename T, unsigned int D>

static Self itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::OneValue ( )

inlinestatic

Definition at line 123 of file itkNumericTraitsTensorPixel.h.

References itk::MakeFilled(), and itk::NumericTraits< T >::OneValue().

◆ OneValue() [3/4]

template<typename T, unsigned int D>

static Self itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::OneValue ( const Self & )

inlinestatic

Definition at line 141 of file itkNumericTraitsTensorPixel.h.

References itk::NumericTraits< T >::OneValue().

◆ OneValue() [4/4]

static T itk::NumericTraits< T >::OneValue ( const T & )

inlinestatic

One value. This API is needed for VariableLengthVector because its length is only known at run-time.

Definition at line 236 of file itkNumericTraits.h.

◆ SetLength() [1/2]

template<typename T, unsigned int D>

static void itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::SetLength	(	SymmetricSecondRankTensor< T, D > &	m,
		const unsigned int	s )

inlinestatic

Fixed length vectors cannot be resized, so an exception will be thrown if the input size is not valid. Here, the size refers to the dimensionality of the underlying FixedArray, not the tensor dimensionality.

Definition at line 155 of file itkNumericTraitsTensorPixel.h.

References itk::FixedArray< TValue, VLength >::Fill().

◆ SetLength() [2/2]

static void itk::NumericTraits< T >::SetLength	(	T &	m,
		const unsigned int	s )

inlinestatic

Scalars cannot be resized, so an exception will be thrown if the input size is not 1. If the size is valid the will be zeros. This API is needed for VariableLengthVector because its length is only known at run-time. Specializations of the VariableLengthVector will provide a different implementation where a vector of the correct size is built.

Definition at line 187 of file itkNumericTraits.h.

◆ ZeroValue() [1/4]

static T itk::NumericTraits< T >::ZeroValue ( )

inlinestatic

Return zero value. This function should be used to support RGBPixel type and standard types (not vectors)

Definition at line 150 of file itkNumericTraits.h.

◆ ZeroValue() [2/4]

template<typename T, unsigned int D>

static Self itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::ZeroValue ( )

inlinestatic

Definition at line 117 of file itkNumericTraitsTensorPixel.h.

◆ ZeroValue() [3/4]

template<typename T, unsigned int D>

static Self itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::ZeroValue ( const Self & )

inlinestatic

Definition at line 135 of file itkNumericTraitsTensorPixel.h.

References itk::NumericTraits< T >::ZeroValue().

◆ ZeroValue() [4/4]

static T itk::NumericTraits< T >::ZeroValue ( const T & )

inlinestatic

Zero value. This API is needed for VariableLengthVector because its length is only known at run-time.

Definition at line 227 of file itkNumericTraits.h.

Member Data Documentation

◆ IsComplex [1/2]

bool itk::NumericTraits< T >::IsComplex

staticconstexpr

Is a given type complex? – default is no. For uniform array data types in ITK, the value of IsComplex is determined by the component elements of the array.

Definition at line 145 of file itkNumericTraits.h.

◆ IsComplex [2/2]

template<typename T, unsigned int D>

bool itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::IsComplex = NumericTraits<ValueType>::IsComplex

staticconstexpr

Definition at line 148 of file itkNumericTraitsTensorPixel.h.

◆ IsInteger [1/2]

bool itk::NumericTraits< T >::IsInteger

staticconstexpr

Is a given type an integer? – default is no. For uniform array data types in ITK, the value of IsInteger is determined by the component elements of the array.

Definition at line 140 of file itkNumericTraits.h.

◆ IsInteger [2/2]

template<typename T, unsigned int D>

bool itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::IsInteger = std::is_integral_v<ValueType>

staticconstexpr

Definition at line 147 of file itkNumericTraitsTensorPixel.h.

◆ IsSigned [1/2]

bool itk::NumericTraits< T >::IsSigned

staticconstexpr

Is a given type signed? – default is no. For uniform array data types in ITK, the value of IsSigned is determined by the component elements of the array.

Definition at line 135 of file itkNumericTraits.h.

◆ IsSigned [2/2]

template<typename T, unsigned int D>

bool itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::IsSigned = std::is_signed_v<ValueType>

staticconstexpr

Definition at line 146 of file itkNumericTraitsTensorPixel.h.

◆ One [1/2]

const T ITKCommon_EXPORT itk::NumericTraits< T >::One

static

Multiplicative identity.

Definition at line 95 of file itkNumericTraits.h.

◆ One [2/2]

template<typename T, unsigned int D>

const Self ITKCommon_EXPORT itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::One

static

Definition at line 199 of file itkNumericTraitsTensorPixel.h.

◆ Zero [1/2]

const T ITKCommon_EXPORT itk::NumericTraits< T >::Zero

static

Additive identity.

Definition at line 92 of file itkNumericTraits.h.

◆ Zero [2/2]

template<typename T, unsigned int D>

const Self ITKCommon_EXPORT itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::Zero

static

Note: : the functions are preferred over the member variables as they are defined for all partial specialization

Definition at line 198 of file itkNumericTraitsTensorPixel.h.

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

itkNumericTraitsTensorPixel.h

Detailed Description

Public Types

Static Public Member Functions

Static Public Attributes

Private Types

Member Typedef Documentation

◆ AbsType [1/2]

◆ AbsType [2/2]

◆ AccumulateType [1/2]

◆ AccumulateType [2/2]

◆ ElementAbsType

◆ ElementAccumulateType

◆ ElementFloatType

◆ ElementPrintType

◆ ElementRealType

◆ FloatType [1/2]

◆ FloatType [2/2]

◆ MeasurementVectorType [1/2]

◆ MeasurementVectorType [2/2]

◆ PrintType [1/2]

◆ PrintType [2/2]

◆ RealType [1/2]

◆ RealType [2/2]

◆ ScalarRealType [1/2]

◆ ScalarRealType [2/2]

◆ Self

◆ TraitsType

◆ ValueType [1/2]

◆ ValueType [2/2]

Member Function Documentation

◆ AssignToArray() [1/3]

◆ AssignToArray() [2/3]

◆ AssignToArray() [3/3]

◆ GetLength() [1/4]

◆ GetLength() [2/4]

◆ GetLength() [3/4]

◆ GetLength() [4/4]

◆ IsNegative()

◆ IsNonnegative()

◆ IsNonpositive()

◆ IsPositive()

◆ max() [1/3]

◆ max() [2/3]

◆ max() [3/3]

◆ min() [1/3]

◆ min() [2/3]

◆ min() [3/3]

◆ NonpositiveMin() [1/4]

◆ NonpositiveMin() [2/4]

◆ NonpositiveMin() [3/4]

◆ NonpositiveMin() [4/4]

◆ OneValue() [1/4]

◆ OneValue() [2/4]

◆ OneValue() [3/4]

◆ OneValue() [4/4]

◆ SetLength() [1/2]

◆ SetLength() [2/2]

◆ ZeroValue() [1/4]

◆ ZeroValue() [2/4]

◆ ZeroValue() [3/4]

◆ ZeroValue() [4/4]

Member Data Documentation

◆ IsComplex [1/2]

◆ IsComplex [2/2]

◆ IsInteger [1/2]

◆ IsInteger [2/2]

◆ IsSigned [1/2]

◆ IsSigned [2/2]

◆ One [1/2]

◆ One [2/2]

◆ Zero [1/2]

◆ Zero [2/2]