ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Static Public Member Functions | Static Public Attributes | Private Types | List of all members
itk::NumericTraits< RGBPixel< T > > Class Template Reference
Data Representation Objects | Module ITKCommon

#include <itkNumericTraitsRGBPixel.h>

+ Collaboration diagram for itk::NumericTraits< RGBPixel< T > >:

Detailed Description

template<typename T>
class itk::NumericTraits< RGBPixel< T > >

Define numeric traits for RGBPixel.

Template Parameters
TComponent type of RGBPixel

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

See Also
NumericTraits

Definition at line 43 of file itkNumericTraitsRGBPixel.h.

Public Types

using AbsType = RGBPixel< ElementAbsType >
 
using AccumulateType = RGBPixel< ElementAccumulateType >
 
using FloatType = RGBPixel< ElementFloatType >
 
using MeasurementVectorType = Self
 
using PrintType = RGBPixel< ElementPrintType >
 
using RealType = RGBPixel< ElementRealType >
 
using ScalarRealType = ElementRealType
 
using Self = RGBPixel< T >
 
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 unsigned int GetLength (const RGBPixel< T > &)
 
static unsigned int GetLength ()
 
static const Self max (const Self &)
 
static const Self max ()
 
static const Self min (const Self &)
 
static const Self min ()
 
static const Self NonpositiveMin ()
 
static const Self NonpositiveMin (const Self &)
 
static const Self OneValue ()
 
static const Self OneValue (const Self &)
 
static const Self ZeroValue ()
 
static const Self ZeroValue (const Self &)
 
static void SetLength (RGBPixel< T > &m, const unsigned int s)
 

Static Public Attributes

static constexpr bool IsComplex = NumericTraits< ValueType >::IsComplex
 
static constexpr bool IsInteger = NumericTraits< ValueType >::IsInteger
 
static constexpr bool IsSigned = NumericTraits< ValueType >::IsSigned
 
static const Self ITKCommon_EXPORT One
 
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

template<typename T >
using itk::NumericTraits< RGBPixel< T > >::AbsType = RGBPixel< ElementAbsType >

Unsigned component type

Definition at line 61 of file itkNumericTraitsRGBPixel.h.

template<typename T >
using itk::NumericTraits< RGBPixel< T > >::AccumulateType = RGBPixel< ElementAccumulateType >

Accumulation of addition and multiplication.

Definition at line 64 of file itkNumericTraitsRGBPixel.h.

template<typename T >
using itk::NumericTraits< RGBPixel< T > >::ElementAbsType = typename NumericTraits< T >::AbsType
private

Definition at line 47 of file itkNumericTraitsRGBPixel.h.

template<typename T >
using itk::NumericTraits< RGBPixel< T > >::ElementAccumulateType = typename NumericTraits< T >::AccumulateType
private

Definition at line 48 of file itkNumericTraitsRGBPixel.h.

template<typename T >
using itk::NumericTraits< RGBPixel< T > >::ElementFloatType = typename NumericTraits< T >::FloatType
private

Definition at line 49 of file itkNumericTraitsRGBPixel.h.

template<typename T >
using itk::NumericTraits< RGBPixel< T > >::ElementPrintType = typename NumericTraits< T >::PrintType
private

Definition at line 50 of file itkNumericTraitsRGBPixel.h.

template<typename T >
using itk::NumericTraits< RGBPixel< T > >::ElementRealType = typename NumericTraits< T >::RealType
private

Definition at line 51 of file itkNumericTraitsRGBPixel.h.

template<typename T >
using itk::NumericTraits< RGBPixel< T > >::FloatType = RGBPixel< ElementFloatType >

Typedef for operations that use floating point instead of real precision

Definition at line 68 of file itkNumericTraitsRGBPixel.h.

template<typename T >
using itk::NumericTraits< RGBPixel< T > >::MeasurementVectorType = Self

Measurement vector type

Definition at line 80 of file itkNumericTraitsRGBPixel.h.

template<typename T >
using itk::NumericTraits< RGBPixel< T > >::PrintType = RGBPixel< ElementPrintType >

Return the type that can be printed.

Definition at line 71 of file itkNumericTraitsRGBPixel.h.

template<typename T >
using itk::NumericTraits< RGBPixel< T > >::RealType = RGBPixel< ElementRealType >

Type for real-valued scalar operations.

Definition at line 74 of file itkNumericTraitsRGBPixel.h.

template<typename T >
using itk::NumericTraits< RGBPixel< T > >::ScalarRealType = ElementRealType

Type for real-valued scalar operations.

Definition at line 77 of file itkNumericTraitsRGBPixel.h.

template<typename T >
using itk::NumericTraits< RGBPixel< T > >::Self = RGBPixel< T >

Definition at line 58 of file itkNumericTraitsRGBPixel.h.

template<typename T >
using itk::NumericTraits< RGBPixel< T > >::ValueType = T

Return the type of the native component type.

Definition at line 56 of file itkNumericTraitsRGBPixel.h.

Member Function Documentation

template<typename T >
static void itk::NumericTraits< RGBPixel< T > >::AssignToArray ( const Self &  v,
MeasurementVectorType &  mv 
)
inlinestatic

Definition at line 167 of file itkNumericTraitsRGBPixel.h.

template<typename T >
template<typename TArray >
static void itk::NumericTraits< RGBPixel< T > >::AssignToArray ( const Self &  v,
TArray &  mv 
)
inlinestatic

Definition at line 173 of file itkNumericTraitsRGBPixel.h.

template<typename T >
static unsigned int itk::NumericTraits< RGBPixel< T > >::GetLength ( const RGBPixel< T > &  )
inlinestatic

Return the dimensionality of the pixel. Always returns 3.

Definition at line 156 of file itkNumericTraitsRGBPixel.h.

template<typename T >
static unsigned int itk::NumericTraits< RGBPixel< T > >::GetLength ( )
inlinestatic

Return the dimensionality of the pixel. Always returns 3.

Definition at line 162 of file itkNumericTraitsRGBPixel.h.

template<typename T >
static const Self itk::NumericTraits< RGBPixel< T > >::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 itkNumericTraitsRGBPixel.h.

template<typename T >
static const Self itk::NumericTraits< RGBPixel< T > >::max ( )
inlinestatic

Definition at line 97 of file itkNumericTraitsRGBPixel.h.

template<typename T >
static const Self itk::NumericTraits< RGBPixel< T > >::min ( const Self &  )
inlinestatic

Definition at line 92 of file itkNumericTraitsRGBPixel.h.

template<typename T >
static const Self itk::NumericTraits< RGBPixel< T > >::min ( )
inlinestatic

Definition at line 102 of file itkNumericTraitsRGBPixel.h.

template<typename T >
static const Self itk::NumericTraits< RGBPixel< T > >::NonpositiveMin ( )
inlinestatic

Definition at line 107 of file itkNumericTraitsRGBPixel.h.

template<typename T >
static const Self itk::NumericTraits< RGBPixel< T > >::NonpositiveMin ( const Self &  )
inlinestatic

Definition at line 122 of file itkNumericTraitsRGBPixel.h.

template<typename T >
static const Self itk::NumericTraits< RGBPixel< T > >::OneValue ( )
inlinestatic

Definition at line 117 of file itkNumericTraitsRGBPixel.h.

template<typename T >
static const Self itk::NumericTraits< RGBPixel< T > >::OneValue ( const Self &  )
inlinestatic

Definition at line 132 of file itkNumericTraitsRGBPixel.h.

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

RGB pixels must have 3 components, so the size cannot be set to anything besides 3. If called with size of 3, this function will fill the pixel with zeros.

Definition at line 144 of file itkNumericTraitsRGBPixel.h.

References itk::FixedArray< TComponent, 3 >::Fill().

template<typename T >
static const Self itk::NumericTraits< RGBPixel< T > >::ZeroValue ( )
inlinestatic

Definition at line 112 of file itkNumericTraitsRGBPixel.h.

template<typename T >
static const Self itk::NumericTraits< RGBPixel< T > >::ZeroValue ( const Self &  )
inlinestatic

Definition at line 127 of file itkNumericTraitsRGBPixel.h.

Member Data Documentation

template<typename T >
constexpr bool itk::NumericTraits< RGBPixel< T > >::IsComplex = NumericTraits< ValueType >::IsComplex
static

Definition at line 139 of file itkNumericTraitsRGBPixel.h.

template<typename T >
constexpr bool itk::NumericTraits< RGBPixel< T > >::IsInteger = NumericTraits< ValueType >::IsInteger
static

Definition at line 138 of file itkNumericTraitsRGBPixel.h.

template<typename T >
constexpr bool itk::NumericTraits< RGBPixel< T > >::IsSigned = NumericTraits< ValueType >::IsSigned
static

Definition at line 137 of file itkNumericTraitsRGBPixel.h.

template<typename T >
const Self ITKCommon_EXPORT itk::NumericTraits< RGBPixel< T > >::One
static

Definition at line 185 of file itkNumericTraitsRGBPixel.h.

template<typename T >
const Self ITKCommon_EXPORT itk::NumericTraits< RGBPixel< T > >::Zero
static
Note
: the functions are preferred over the member variables as they are defined for all partial specialization

Definition at line 184 of file itkNumericTraitsRGBPixel.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Sun Mar 24 2019 04:00:58 for ITK by   doxygen 1.8.5