mitk::PixelType Class Reference

Class for defining the data type of pixels. More...

#include <mitkPixelType.h>

Public Types
typedef itk::ImageIOBase::IOPixelType	ItkIOPixelType
typedef itk::ImageIOBase::IOComponentType	ItkIOComponentType

Public Member Functions
	PixelType (const mitk::PixelType &aPixelType)
PixelType &	operator= (const PixelType &other)
itk::ImageIOBase::IOPixelType	GetPixelType () const
int	GetComponentType () const
	Get the component type (the scalar (!) type). Each element may contain m_NumberOfComponents (more than one) of these scalars. More...
std::string	GetPixelTypeAsString () const
	Returns a string containing the ITK pixel type name. More...
std::string	GetComponentTypeAsString () const
	Returns a string containing the name of the component. More...
std::string	GetTypeAsString () const
	Returns a string representing the pixel type and pixel components. More...
vcl_size_t	GetSize () const
	Get size of the PixelType in bytes. More...
vcl_size_t	GetBpe () const
	Get the number of bits per element (of an element) More...
vcl_size_t	GetNumberOfComponents () const
	Get the number of components of which each element consists. More...
vcl_size_t	GetBitsPerComponent () const
	Get the number of bits per components. More...
bool	operator== (const PixelType &rhs) const
bool	operator!= (const PixelType &rhs) const
	~PixelType ()

Friends
PixelType	MakePixelType (const itk::ImageIOBase *imageIO)
	Create a MITK pixel type based on a itk::ImageIOBase object. More...
template<typename ComponentT , typename PixelT >
PixelType	MakePixelType (std::vcl_size_t numOfComponents)
	A template method for creating a pixel type. More...
template<typename ItkImageType >
PixelType	MakePixelType ()
	A template method for creating a pixel type. More...
template<typename ItkImageType >
PixelType	MakePixelType (vcl_size_t)

Detailed Description

Class for defining the data type of pixels.

To obtain additional type information not provided by this class itk::ImageIOBase can be used by passing the return value of PixelType::GetItkTypeId() to itk::ImageIOBase::SetPixelTypeInfo and using the itk::ImageIOBase methods GetComponentType, GetComponentTypeAsString, GetPixelType, GetPixelTypeAsString.

Definition at line 51 of file mitkPixelType.h.

Member Typedef Documentation

ItkIOComponentType

typedef itk::ImageIOBase::IOComponentType mitk::PixelType::ItkIOComponentType

Definition at line 55 of file mitkPixelType.h.

ItkIOPixelType

typedef itk::ImageIOBase::IOPixelType mitk::PixelType::ItkIOPixelType

Definition at line 54 of file mitkPixelType.h.

Constructor & Destructor Documentation

PixelType()

mitk::PixelType::PixelType

(

const mitk::PixelType &

aPixelType

)

~PixelType()

mitk::PixelType::~PixelType

(

)

Member Function Documentation

GetBitsPerComponent()

vcl_size_t mitk::PixelType::GetBitsPerComponent

(

)

const

Get the number of bits per components.

See also

GetBitsPerComponent

GetBpe()

vcl_size_t mitk::PixelType::GetBpe

(

)

const

Get the number of bits per element (of an element)

A vector of double with three components will return 8*sizeof(double)*3.

See also

GetBitsPerComponent

GetItkTypeId

GetTypeId

GetComponentType()

int mitk::PixelType::GetComponentType

(

)

const

Get the component type (the scalar (!) type). Each element may contain m_NumberOfComponents (more than one) of these scalars.

Referenced by mitk::ImageGenerator::GenerateRandomImage().

GetComponentTypeAsString()

std::string mitk::PixelType::GetComponentTypeAsString

(

)

const

Returns a string containing the name of the component.

GetNumberOfComponents()

vcl_size_t mitk::PixelType::GetNumberOfComponents

(

)

const

Get the number of components of which each element consists.

Each pixel can consist of multiple components, e.g. RGB.

Referenced by mitk::ImagePixelAccessor< TPixel, VDimension >::CheckData(), and mitk::ImagePixelReadAccessor< TPixel, VDimension >::GetConsecutivePixelsAsVector().

GetPixelType()

itk::ImageIOBase::IOPixelType mitk::PixelType::GetPixelType

(

)

const

GetPixelTypeAsString()

std::string mitk::PixelType::GetPixelTypeAsString

(

)

const

Returns a string containing the ITK pixel type name.

GetSize()

vcl_size_t mitk::PixelType::GetSize

(

)

const

Get size of the PixelType in bytes.

A RGBA PixelType of floats will return 4 * sizeof(float)

GetTypeAsString()

std::string mitk::PixelType::GetTypeAsString

(

)

const

Returns a string representing the pixel type and pixel components.

operator!=()

bool mitk::PixelType::operator!=

(

const PixelType &

rhs

)

const

operator=()

PixelType& mitk::PixelType::operator=

(

const PixelType &

other

)

operator==()

bool mitk::PixelType::operator==

(

const PixelType &

rhs

)

const

Friends And Related Function Documentation

MakePixelType [1/4]

PixelType MakePixelType ( const itk::ImageIOBase *  imageIO )

friend

Create a MITK pixel type based on a itk::ImageIOBase object.

Definition at line 277 of file mitkPixelType.h.

MakePixelType [2/4]

template<typename ComponentT , typename PixelT >

PixelType MakePixelType ( std::vcl_size_t  numOfComponents )

friend

A template method for creating a pixel type.

A template method for creating a MITK pixel type from an ITK image pixel type and dimension.

Parameters

numOfComponents	The number of components for the pixel type TPixelType
numOfComponents	The number of components for the pixel type of the ITK image

Definition at line 171 of file mitkPixelType.h.

MakePixelType [3/4]

template<typename ItkImageType >

PixelType MakePixelType ( )

friend

A template method for creating a pixel type.

Deprecated:

, use version with one numOfComponents as function argument instead.

For images where the number of components of the pixel type is determined at runtime (e.g. pixel types like itk::VariableLengthVector<short>) the MakePixelType(std::size_t) function must be used.

Definition at line 187 of file mitkPixelType.h.

MakePixelType [4/4]

template<typename ItkImageType >

PixelType MakePixelType ( vcl_size_t  )

friend

---

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

• mitkPixelType.h