An object to hold all essential information about an Image object. More...

#include <mitkImageDescriptor.h>

Inheritance diagram for mitk::ImageDescriptor:

Collaboration diagram for mitk::ImageDescriptor:

Public Types
typedef ImageDescriptor	Self

typedef itk::Object	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Member Functions
virtual std::vector< std::string >	GetClassHierarchy () const

virtual const char *	GetClassName () const

Pointer	Clone () const

void	AddNewChannel (mitk::PixelType ptype, const char *name=nullptr)

void	Initialize (const unsigned int *dims, const unsigned int dim)
	Initialize the image descriptor by the dimensions. More...

void	Initialize (const ImageDescriptor::Pointer refDescriptor, unsigned int channel=0)
	Initialize the descriptor by an referenced Descriptor. More...

const unsigned int *	GetDimensions () const
	Get the C-array of unsigned int holding the size for each dimension of the image. More...

unsigned int	GetNumberOfDimensions () const
	Get the number dimensions used (e.g. non-zero size) More...

const std::string	GetChannelName (unsigned int id) const
	Get the name of selected channel. More...

PixelType	GetChannelTypeByName (const char *name) const
	Get the pixel type of a channel specified by its name. More...

PixelType	GetChannelTypeById (unsigned int id) const
	Get the pixel type of a channel specified by its id. More...

ChannelDescriptor	GetChannelDescriptor (unsigned int id=0) const
	Get the ChannelDescriptor for a channel specified by its id. More...

unsigned int	GetNumberOfChannels () const
	Get the count of channels used. More...

Static Public Member Functions
static const char *	GetStaticNameOfClass ()

static Pointer	New ()

Protected Member Functions
	ImageDescriptor ()

	~ImageDescriptor ()

Detailed Description

An object to hold all essential information about an Image object.

The ImageDescriptor holds an std::vector of pointers to ChannelDescriptor together with the information about the image's dimensions. The general assumption ist, that each channel of an image has to have the same geometry.

See also: Image, ChannelDescriptor

Definition at line 41 of file mitkImageDescriptor.h.

Member Typedef Documentation

typedef itk::SmartPointer<const Self> mitk::ImageDescriptor::ConstPointer

Definition at line 44 of file mitkImageDescriptor.h.

typedef itk::SmartPointer<Self> mitk::ImageDescriptor::Pointer

Definition at line 44 of file mitkImageDescriptor.h.

typedef ImageDescriptor mitk::ImageDescriptor::Self

Definition at line 44 of file mitkImageDescriptor.h.

typedef itk::Object mitk::ImageDescriptor::Superclass

Definition at line 44 of file mitkImageDescriptor.h.

Constructor & Destructor Documentation

mitk::ImageDescriptor::ImageDescriptor ( )

protected

Protected constructor

Definition at line 18 of file mitkImageDescriptor.cpp.

mitk::ImageDescriptor::~ImageDescriptor ( )

inlineprotected

Protected desctructor

Definition at line 101 of file mitkImageDescriptor.h.

Member Function Documentation

void mitk::ImageDescriptor::AddNewChannel	(	mitk::PixelType	ptype,
		const char *	name = `nullptr`
	)

Insert new channel

Parameters

ptype	Pixel Type
name	channel's name

Definition at line 30 of file mitkImageDescriptor.cpp.

References mitk::PixelType::GetPixelTypeAsString().

Pointer mitk::ImageDescriptor::Clone ( ) const

mitk::ChannelDescriptor mitk::ImageDescriptor::GetChannelDescriptor ( unsigned int id = 0 ) const

Get the ChannelDescriptor for a channel specified by its id.

Definition at line 81 of file mitkImageDescriptor.cpp.

const std::string mitk::ImageDescriptor::GetChannelName ( unsigned int id ) const

Get the name of selected channel.

If the name of the channel wasn't initialized, the string returned is set to "Unnamed [ <PixelTypeName> ]"

See also: PixelType, ChannelDescriptor

Definition at line 113 of file mitkImageDescriptor.cpp.

mitk::PixelType mitk::ImageDescriptor::GetChannelTypeById ( unsigned int id ) const

Get the pixel type of a channel specified by its id.

Returns an uninitialized PixelType object if no channel with given id was found

Definition at line 100 of file mitkImageDescriptor.cpp.

References mitk::ChannelDescriptor::GetPixelType().

mitk::PixelType mitk::ImageDescriptor::GetChannelTypeByName ( const char * name ) const

Get the pixel type of a channel specified by its name.

Returns an uninitialized PixelType object if no channel with given name was found

Definition at line 86 of file mitkImageDescriptor.cpp.

virtual std::vector<std::string> mitk::ImageDescriptor::GetClassHierarchy ( ) const

inlinevirtual

Definition at line 44 of file mitkImageDescriptor.h.

virtual const char* mitk::ImageDescriptor::GetClassName ( ) const

virtual

const unsigned int* mitk::ImageDescriptor::GetDimensions ( ) const

inline

Get the C-array of unsigned int holding the size for each dimension of the image.

The C-array has allways lenght of MAX_IMAGE_DIMENSIONS

Definition at line 65 of file mitkImageDescriptor.h.

unsigned int mitk::ImageDescriptor::GetNumberOfChannels ( ) const

inline

Get the count of channels used.

Definition at line 95 of file mitkImageDescriptor.h.

unsigned int mitk::ImageDescriptor::GetNumberOfDimensions ( ) const

inline

Get the number dimensions used (e.g. non-zero size)

The return value does not exceed MAX_IMAGE_DIMENSIONS

Definition at line 70 of file mitkImageDescriptor.h.

static const char* mitk::ImageDescriptor::GetStaticNameOfClass ( )

inlinestatic

Definition at line 44 of file mitkImageDescriptor.h.

void mitk::ImageDescriptor::Initialize	(	const unsigned int *	dims,
		const unsigned int	dim
	)

Initialize the image descriptor by the dimensions.

Definition at line 70 of file mitkImageDescriptor.cpp.

void mitk::ImageDescriptor::Initialize	(	const ImageDescriptor::Pointer	refDescriptor,
		unsigned int	channel = `0`
	)

Initialize the descriptor by an referenced Descriptor.

Definition at line 51 of file mitkImageDescriptor.cpp.

static Pointer mitk::ImageDescriptor::New ( )

static

Referenced by mitk::CastToImageDescriptor(), and mitk::Image::Initialize().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation