Medical Imaging Interaction Toolkit  2018.4.99-bd7b41ba
Medical Imaging Interaction Toolkit
mitk::ImageDescriptor Class Reference

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< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

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 () override
 

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 37 of file mitkImageDescriptor.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

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

Definition at line 40 of file mitkImageDescriptor.h.

Constructor & Destructor Documentation

◆ ImageDescriptor()

mitk::ImageDescriptor::ImageDescriptor ( )
protected

Protected constructor

Definition at line 14 of file mitkImageDescriptor.cpp.

◆ ~ImageDescriptor()

mitk::ImageDescriptor::~ImageDescriptor ( )
inlineoverrideprotected

Protected desctructor

Definition at line 99 of file mitkImageDescriptor.h.

References MAX_IMAGE_DIMENSIONS.

Member Function Documentation

◆ AddNewChannel()

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

Insert new channel

Parameters
ptypePixel Type
namechannel's name

Definition at line 26 of file mitkImageDescriptor.cpp.

References mitk::PixelType::GetPixelTypeAsString().

◆ Clone()

Pointer mitk::ImageDescriptor::Clone ( ) const

◆ GetChannelDescriptor()

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

Get the ChannelDescriptor for a channel specified by its id.

Definition at line 77 of file mitkImageDescriptor.cpp.

◆ GetChannelName()

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 109 of file mitkImageDescriptor.cpp.

◆ GetChannelTypeById()

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 96 of file mitkImageDescriptor.cpp.

References mitk::ChannelDescriptor::GetPixelType().

◆ GetChannelTypeByName()

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 82 of file mitkImageDescriptor.cpp.

◆ GetClassHierarchy()

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

Definition at line 40 of file mitkImageDescriptor.h.

◆ GetClassName()

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

◆ GetDimensions()

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 63 of file mitkImageDescriptor.h.

◆ GetNumberOfChannels()

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

Get the count of channels used.

Definition at line 93 of file mitkImageDescriptor.h.

◆ GetNumberOfDimensions()

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 68 of file mitkImageDescriptor.h.

◆ GetStaticNameOfClass()

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

Definition at line 40 of file mitkImageDescriptor.h.

◆ Initialize() [1/2]

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

Initialize the image descriptor by the dimensions.

Definition at line 66 of file mitkImageDescriptor.cpp.

◆ Initialize() [2/2]

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

Initialize the descriptor by an referenced Descriptor.

Definition at line 47 of file mitkImageDescriptor.cpp.

◆ New()

static Pointer mitk::ImageDescriptor::New ( )
static

Referenced by mitk::Image::Initialize().


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