Medical Imaging Interaction Toolkit
2024.06.99-c70462f2
Medical Imaging Interaction Toolkit
|
An object to hold all essential information about an Image object. More...
#include <mitkImageDescriptor.h>
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 () override | |
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 is that each channel of an image has to have the same geometry.
Definition at line 37 of file mitkImageDescriptor.h.
typedef itk::SmartPointer<const Self> mitk::ImageDescriptor::ConstPointer |
Definition at line 40 of file mitkImageDescriptor.h.
Definition at line 40 of file mitkImageDescriptor.h.
Definition at line 40 of file mitkImageDescriptor.h.
typedef itk::Object mitk::ImageDescriptor::Superclass |
Definition at line 40 of file mitkImageDescriptor.h.
|
protected |
Protected constructor
|
inlineoverrideprotected |
Protected destructor
Definition at line 99 of file mitkImageDescriptor.h.
void mitk::ImageDescriptor::AddNewChannel | ( | mitk::PixelType | ptype, |
const char * | name = nullptr |
||
) |
Insert new channel
ptype | Pixel Type |
name | channel's name |
Pointer mitk::ImageDescriptor::Clone | ( | ) | const |
ChannelDescriptor mitk::ImageDescriptor::GetChannelDescriptor | ( | unsigned int | id = 0 | ) | const |
Get the ChannelDescriptor for a channel specified by its id
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> ]"
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
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
|
inlinevirtual |
Definition at line 40 of file mitkImageDescriptor.h.
|
virtual |
|
inline |
Get the C-array of unsigned int holding the size for each dimension of the image.
The C-array has always length of MAX_IMAGE_DIMENSIONS
Definition at line 63 of file mitkImageDescriptor.h.
|
inline |
Get the count of channels used.
Definition at line 93 of file mitkImageDescriptor.h.
|
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.
|
inlinestatic |
Definition at line 40 of file mitkImageDescriptor.h.
void mitk::ImageDescriptor::Initialize | ( | const ImageDescriptor::Pointer | refDescriptor, |
unsigned int | channel = 0 |
||
) |
Initialize the descriptor by an referenced Descriptor.
void mitk::ImageDescriptor::Initialize | ( | const unsigned int * | dims, |
const unsigned int | dim | ||
) |
Initialize the image descriptor by the dimensions.
|
static |