Medical Imaging Interaction Toolkit  2018.04.99-c3229764
Medical Imaging Interaction Toolkit
mitk::Image Class Reference

Image class for storing images. More...

#include <mitkImage.h>

Inheritance diagram for mitk::Image:
Collaboration diagram for mitk::Image:

Public Types

enum  ImportMemoryManagementType { CopyMemory, ManageMemory, ReferenceMemory, DontManageMemory }
 
typedef Image Self
 
typedef SlicedData Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::SmartPointer< ImageDataItemImageDataItemPointer
 
typedef itk::Statistics::Histogram< double > HistogramType
 
typedef mitk::ImageStatisticsHolderStatisticsHolderPointer
 
typedef std::vector< ImageDataItemPointerImageDataItemPointerArray
 Vector container of SmartPointers to ImageDataItems; Class is only for internal usage to allow convenient access to all slices over iterators; See documentation of ImageDataItem for details. More...
 
- Public Types inherited from mitk::SlicedData
typedef SlicedData Self
 
typedef BaseData Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::ImageRegion< RegionDimension > RegionType
 
typedef itk::Index< RegionDimension > IndexType
 
typedef IndexType::IndexValueType IndexValueType
 
typedef itk::Offset< RegionDimension > OffsetType
 
typedef OffsetType::OffsetValueType OffsetValueType
 
typedef itk::Size< RegionDimension > SizeType
 
typedef SizeType::SizeValueType SizeValueType
 
- Public Types inherited from mitk::BaseData
typedef BaseData Self
 
typedef itk::DataObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::Identifiable
using UIDType = std::string
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
const mitk::PixelType GetPixelType (int n=0) const
 Returns the PixelType of channel n. More...
 
unsigned int GetDimension () const
 Get dimension of the image. More...
 
unsigned int GetDimension (int i) const
 Get the size of dimension i (e.g., i=0 results in the number of pixels in x-direction). More...
 
virtual void * GetData ()
 Get the data vector of the complete image, i.e., of all channels linked together. More...
 
double GetPixelValueByIndex (const itk::Index< 3 > &position, unsigned int timestep=0, unsigned int component=0)
 Get the pixel value at one specific index position. More...
 
double GetPixelValueByWorldCoordinate (const mitk::Point3D &position, unsigned int timestep=0, unsigned int component=0)
 Get the pixel value at one specific world position. More...
 
virtual vtkImageData * GetVtkImageData (int t=0, int n=0)
 Get a volume at a specific time t of channel n as a vtkImageData. More...
 
virtual const vtkImageData * GetVtkImageData (int t=0, int n=0) const
 
bool IsSliceSet (int s=0, int t=0, int n=0) const override
 Check whether slice s at time t in channel n is set. More...
 
bool IsVolumeSet (int t=0, int n=0) const override
 Check whether volume at time t in channel n is set. More...
 
bool IsChannelSet (int n=0) const override
 Check whether the channel n is set. More...
 
virtual bool SetSlice (const void *data, int s=0, int t=0, int n=0)
 Set data as slice s at time t in channel n. It is in the responsibility of the caller to ensure that the data vector data is really a slice (at least is not smaller than a slice), since there is no chance to check this. More...
 
virtual bool SetVolume (const void *data, int t=0, int n=0)
 Set data as volume at time t in channel n. It is in the responsibility of the caller to ensure that the data vector data is really a volume (at least is not smaller than a volume), since there is no chance to check this. More...
 
virtual bool SetChannel (const void *data, int n=0)
 Set data in channel n. It is in the responsibility of the caller to ensure that the data vector data is really a channel (at least is not smaller than a channel), since there is no chance to check this. More...
 
virtual bool SetImportSlice (void *data, int s=0, int t=0, int n=0, ImportMemoryManagementType importMemoryManagement=CopyMemory)
 Set data as slice s at time t in channel n. It is in the responsibility of the caller to ensure that the data vector data is really a slice (at least is not smaller than a slice), since there is no chance to check this. More...
 
virtual bool SetImportVolume (void *data, int t=0, int n=0, ImportMemoryManagementType importMemoryManagement=CopyMemory)
 Set data as volume at time t in channel n. It is in the responsibility of the caller to ensure that the data vector data is really a volume (at least is not smaller than a volume), since there is no chance to check this. More...
 
virtual bool SetImportVolume (const void *const_data, int t=0, int n=0)
 
virtual bool SetImportChannel (void *data, int n=0, ImportMemoryManagementType importMemoryManagement=CopyMemory)
 Set data in channel n. It is in the responsibility of the caller to ensure that the data vector data is really a channel (at least is not smaller than a channel), since there is no chance to check this. More...
 
virtual void Initialize (const mitk::PixelType &type, unsigned int dimension, const unsigned int *dimensions, unsigned int channels=1)
 
virtual void Initialize (const mitk::PixelType &type, const mitk::BaseGeometry &geometry, unsigned int channels=1, int tDim=1)
 
virtual void Initialize (const mitk::PixelType &, const mitk::TimeSlicedGeometry *, unsigned int, int)
 
virtual void Initialize (const mitk::PixelType &type, const mitk::TimeGeometry &geometry, unsigned int channels=1, int tDim=-1)
 Initialize new (or re-initialize) image information by a TimeGeometry. More...
 
virtual void Initialize (const mitk::PixelType &type, int sDim, const mitk::PlaneGeometry &geometry2d, bool flipped, unsigned int channels=1, int tDim=1)
 
virtual void Initialize (const mitk::PixelType &type, int sDim, const mitk::PlaneGeometry &geometry2d, unsigned int channels=1, int tDim=1)
 
virtual void Initialize (const mitk::Image *image)
 
virtual void Initialize (const mitk::ImageDescriptor::Pointer inDesc)
 
virtual void Initialize (vtkImageData *vtkimagedata, int channels=1, int tDim=-1, int sDim=-1, int pDim=-1)
 
template<typename itkImageType >
void InitializeByItk (const itkImageType *itkimage, int channels=1, int tDim=-1, int sDim=-1)
 
virtual bool IsValidSlice (int s=0, int t=0, int n=0) const
 Check whether slice s at time t in channel n is valid, i.e., is (or can be) inside of the image. More...
 
virtual bool IsValidVolume (int t=0, int n=0) const
 Check whether volume at time t in channel n is valid, i.e., is (or can be) inside of the image. More...
 
virtual bool IsValidChannel (int n=0) const
 Check whether the channel n is valid, i.e., is (or can be) inside of the image. More...
 
bool IsRotated () const
 Returns true if an image is rotated, i.e. its geometry's transformation matrix has nonzero elements besides the diagonal. Non-diagonal elements are checked if larger then 1/1000 of the matrix' trace. More...
 
unsigned int * GetDimensions () const
 Get the sizes of all dimensions as an integer-array. More...
 
ImageDescriptor::Pointer GetImageDescriptor () const
 
ChannelDescriptor GetChannelDescriptor (int id=0) const
 
void SetGeometry (BaseGeometry *aGeometry3D) override
 Sets a geometry to an image. More...
 
virtual ImageDataItemPointer GetSliceData (int s=0, int t=0, int n=0, void *data=nullptr, ImportMemoryManagementType importMemoryManagement=CopyMemory) const
 
virtual ImageDataItemPointer GetVolumeData (int t=0, int n=0, void *data=nullptr, ImportMemoryManagementType importMemoryManagement=CopyMemory) const
 
virtual ImageDataItemPointer GetChannelData (int n=0, void *data=nullptr, ImportMemoryManagementType importMemoryManagement=CopyMemory) const
 
ScalarType GetScalarValueMin (int t=0) const
 (DEPRECATED) Get the minimum for scalar images More...
 
ScalarType GetScalarValueMax (int t=0) const
 (DEPRECATED) Get the maximum for scalar images More...
 
ScalarType GetScalarValue2ndMin (int t=0) const
 (DEPRECATED) Get the second smallest value for scalar images More...
 
ScalarType GetScalarValueMinNoRecompute (unsigned int t=0) const
 (DEPRECATED) Get the smallest value for scalar images, but do not recompute it first More...
 
ScalarType GetScalarValue2ndMinNoRecompute (unsigned int t=0) const
 (DEPRECATED) Get the second smallest value for scalar images, but do not recompute it first More...
 
ScalarType GetScalarValue2ndMax (int t=0) const
 (DEPRECATED) Get the second largest value for scalar images More...
 
ScalarType GetScalarValueMaxNoRecompute (unsigned int t=0) const
 (DEPRECATED) Get the largest value for scalar images, but do not recompute it first More...
 
ScalarType GetScalarValue2ndMaxNoRecompute (unsigned int t=0) const
 (DEPRECATED) Get the second largest value for scalar images, but do not recompute it first More...
 
ScalarType GetCountOfMinValuedVoxels (int t=0) const
 (DEPRECATED) Get the count of voxels with the smallest scalar value in the dataset More...
 
ScalarType GetCountOfMaxValuedVoxels (int t=0) const
 (DEPRECATED) Get the count of voxels with the largest scalar value in the dataset More...
 
unsigned int GetCountOfMaxValuedVoxelsNoRecompute (unsigned int t=0) const
 (DEPRECATED) Get the count of voxels with the largest scalar value in the dataset More...
 
unsigned int GetCountOfMinValuedVoxelsNoRecompute (unsigned int t=0) const
 (DEPRECATED) Get the count of voxels with the smallest scalar value in the dataset More...
 
StatisticsHolderPointer GetStatistics () const
 Returns a pointer to the ImageStatisticsHolder object that holds all statistics information for the image. More...
 
- Public Member Functions inherited from mitk::SlicedData
 itkStaticConstMacro (RegionDimension, unsigned int, 5)
 
void UpdateOutputInformation () override
 
void PrepareForNewData () override
 
void SetRequestedRegionToLargestPossibleRegion () override
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
bool VerifyRequestedRegion () override
 Verify that the RequestedRegion is within the LargestPossibleRegion. More...
 
void SetRequestedRegion (const itk::DataObject *data) override
 
virtual void SetRequestedRegion (SlicedData::RegionType *region)
 
void SetLargestPossibleRegion (SlicedData::RegionType *region)
 Sets the largest possible region. The largest possible region is the entire region occupied by the data object. Note that the largest possible region should always be bigger then the requested region of a certain operation. More...
 
const RegionTypeGetLargestPossibleRegion () const
 
virtual const RegionTypeGetRequestedRegion () const
 
void CopyInformation (const itk::DataObject *data) override
 
unsigned int GetNumberOfChannels () const
 Get the number of channels. More...
 
SlicedGeometry3DGetSlicedGeometry (unsigned int t=0) const
 Convenience access method for the geometry, which is of type SlicedGeometry3D (or a sub-class of it). More...
 
const SlicedGeometry3DGetUpdatedSlicedGeometry (unsigned int t=0)
 Convenience access method for the geometry, which is of type SlicedGeometry3D (or a sub-class of it). More...
 
void SetGeometry (BaseGeometry *aGeometry3D) override
 Set the BaseGeometry of the data, which will be referenced (not copied!). It has to be a sub-class of SlicedGeometry3D. More...
 
void SetOrigin (const Point3D &origin) override
 Convenience method for setting the origin of the SlicedGeometry3D instances of all time steps. More...
 
virtual void SetSpacing (const ScalarType aSpacing[])
 Convenience method for setting the spacing of the SlicedGeometry3D instances of all time steps. More...
 
virtual void SetSpacing (mitk::Vector3D aSpacing)
 Convenience method for setting the spacing of the SlicedGeometry3D instances of all time steps. More...
 
- Public Member Functions inherited from mitk::BaseData
BaseProperty::ConstPointer GetConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const override
 Get property by its key. More...
 
std::vector< std::string > GetPropertyKeys (const std::string &contextName="", bool includeDefaultContext=false) const override
 Query keys of existing properties. More...
 
std::vector< std::string > GetPropertyContextNames () const override
 Query names of existing contexts. More...
 
BasePropertyGetNonConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) override
 Get property by its key. More...
 
void SetProperty (const std::string &propertyKey, BaseProperty *property, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Add new or change existent property. More...
 
void RemoveProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Removes a property. If the property does not exist, nothing will be done. More...
 
const mitk::TimeGeometryGetTimeGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
const mitk::TimeGeometryGetTimeSlicedGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
mitk::TimeGeometryGetTimeGeometry ()
 Return the TimeGeometry of the data as pointer. More...
 
const mitk::TimeGeometryGetUpdatedTimeGeometry ()
 Return the TimeGeometry of the data. More...
 
const mitk::TimeGeometryGetUpdatedTimeSliceGeometry ()
 Return the TimeGeometry of the data. More...
 
const mitk::BaseGeometryGetUpdatedGeometry (int t=0)
 Return the BaseGeometry of the data at time t. More...
 
mitk::BaseGeometryGetGeometry (int t=0) const
 Return the geometry, which is a TimeGeometry, of the data as non-const pointer. More...
 
void UpdateOutputInformation () override
 Update the information for this BaseData (the geometry in particular) so that it can be used as an output of a BaseProcess. More...
 
void CopyInformation (const itk::DataObject *data) override
 Copy information from the specified data set. More...
 
virtual bool IsInitialized () const
 Check whether the data has been initialized, i.e., at least the Geometry and other header data has been set. More...
 
virtual bool IsEmptyTimeStep (unsigned int t) const
 Check whether object contains data (at a specified time), e.g., a set of points may be empty. More...
 
virtual bool IsEmpty () const
 Check whether object contains data (at least at one point in time), e.g., a set of points may be empty. More...
 
void ExecuteOperation (Operation *operation) override
 overwrite if the Data can be called by an Interactor (StateMachine). More...
 
virtual void SetTimeGeometry (TimeGeometry *geometry)
 Set the TimeGeometry of the data, which will be referenced (not copied!). More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D)
 Set a clone of the provided Geometry as Geometry of the data. Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...
 
virtual void SetClonedTimeGeometry (const TimeGeometry *geometry)
 Set a clone of the provided TimeGeometry as TimeGeometry of the data. More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D, unsigned int time)
 Set a clone of the provided geometry as BaseGeometry of a given time step. More...
 
mitk::PropertyList::Pointer GetPropertyList () const
 Get the data's property list. More...
 
void SetPropertyList (PropertyList *propertyList)
 Set the data's property list. More...
 
mitk::BaseProperty::Pointer GetProperty (const char *propertyKey) const
 Get the property (instance of BaseProperty) with key propertyKey from the PropertyList, and set it to this, respectively;. More...
 
void SetProperty (const char *propertyKey, BaseProperty *property)
 
itk::SmartPointer< mitk::BaseDataSourceGetSource () const
 Get the process object that generated this data object. More...
 
unsigned int GetTimeSteps () const
 Get the number of time steps from the TimeGeometry As the base data has not a data vector given by itself, the number of time steps is defined over the time sliced geometry. In sub classes, a better implementation could be over the length of the data vector. More...
 
unsigned long GetMTime () const override
 Get the modified time of the last change of the contents this data object or its geometry. More...
 
void Graft (const DataObject *) override
 
- Public Member Functions inherited from mitk::OperationActor
 itkTypeMacroNoParent (OperationActor) virtual ~OperationActor()
 
- Public Member Functions inherited from mitk::Identifiable
 Identifiable ()
 
 Identifiable (const UIDType &uid)
 
 Identifiable (const Identifiable &)=delete
 
 Identifiable (Identifiable &&) noexcept
 
virtual ~Identifiable ()
 
Identifiableoperator= (const Identifiable &)=delete
 
Identifiableoperator= (Identifiable &&other) noexcept
 
virtual UIDType GetUID () const
 Get unique ID of an object. More...
 
- Public Member Functions inherited from mitk::IPropertyOwner
 ~IPropertyOwner () override
 
- Public Member Functions inherited from mitk::IPropertyProvider
virtual ~IPropertyProvider ()
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::SlicedData
static const char * GetStaticNameOfClass ()
 
- Static Public Member Functions inherited from mitk::BaseData
static const char * GetStaticNameOfClass ()
 

Protected Types

typedef itk::MutexLockHolder< itk::SimpleFastMutexLock > MutexHolder
 

Protected Member Functions

virtual itk::LightObject::Pointer InternalClone () const override
 
int GetSliceIndex (int s=0, int t=0, int n=0) const
 
int GetVolumeIndex (int t=0, int n=0) const
 
void ComputeOffsetTable ()
 
virtual bool IsValidTimeStep (int t) const
 
void Expand (unsigned int timeSteps) override
 Expands the TimeGeometry to a number of TimeSteps. More...
 
virtual ImageDataItemPointer AllocateSliceData (int s=0, int t=0, int n=0, void *data=nullptr, ImportMemoryManagementType importMemoryManagement=CopyMemory) const
 
virtual ImageDataItemPointer AllocateVolumeData (int t=0, int n=0, void *data=nullptr, ImportMemoryManagementType importMemoryManagement=CopyMemory) const
 
virtual ImageDataItemPointer AllocateChannelData (int n=0, void *data=nullptr, ImportMemoryManagementType importMemoryManagement=CopyMemory) const
 
 Image ()
 
 Image (const Image &other)
 
 ~Image () override
 
void Clear () override
 Calls ClearData() and InitializeEmpty();. More...
 
void Initialize () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from mitk::SlicedData
 SlicedData ()
 
 SlicedData (const SlicedData &other)
 
 ~SlicedData () override
 
- Protected Member Functions inherited from mitk::BaseData
 BaseData ()
 
 BaseData (const BaseData &other)
 
 ~BaseData () override
 
virtual void InitializeTimeGeometry (unsigned int timeSteps=1)
 Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...
 
virtual void InitializeTimeSlicedGeometry (unsigned int timeSteps=1)
 Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...
 
virtual void ClearData ()
 reset to non-initialized state, release memory More...
 
virtual void InitializeEmpty ()
 Pure virtual; Must be used in subclasses to get a data object to a valid state. Should at least create one empty object and call Superclass::InitializeTimeGeometry() to ensure an existing valid geometry. More...
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from mitk::Identifiable
virtual void SetUID (const UIDType &uid)
 

Protected Attributes

ImageDataItemPointerArray m_Channels
 
ImageDataItemPointerArray m_Volumes
 
ImageDataItemPointerArray m_Slices
 
itk::SimpleFastMutexLock m_ImageDataArraysLock
 
unsigned int m_Dimension
 
unsigned int * m_Dimensions
 
ImageDescriptor::Pointer m_ImageDescriptor
 
vcl_size_t * m_OffsetTable
 
ImageDataItemPointer m_CompleteData
 
StatisticsHolderPointer m_ImageStatistics
 
- Protected Attributes inherited from mitk::SlicedData
RegionType m_LargestPossibleRegion
 
RegionType m_RequestedRegion
 
bool m_RequestedRegionInitialized
 
RegionType m_BufferedRegion
 
bool m_UseLargestPossibleRegion
 
- Protected Attributes inherited from mitk::BaseData
bool m_LastRequestedRegionWasOutsideOfTheBufferedRegion
 
unsigned int m_SourceOutputIndexDuplicate
 
bool m_Initialized
 

Detailed Description

Image class for storing images.

Can be asked for header information, the data vector, the mitkIpPicDescriptor struct or vtkImageData objects. If not the complete data is required, the appropriate SubImageSelector class should be used for access. Image organizes sets of slices (s x 2D), volumes (t x 3D) and channels (n x ND). Channels are for different kind of data, e.g., morphology in channel 0, velocities in channel 1. All channels must have the same Geometry! In particular, the dimensions of all channels are the same, only the pixel-type may differ between channels.

For importing ITK images use of mitk::ITKImageImport is recommended, see Adaptor Classes.

For ITK v3.8 and older: Converting coordinates from the ITK physical coordinate system (which does not support rotated images) to the MITK world coordinate system should be performed via the BaseGeometry of the Image, see BaseGeometry::WorldToItkPhysicalPoint.

For more information, see MITK Image .

Definition at line 73 of file mitkImage.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 85 of file mitkImage.h.

◆ HistogramType

typedef itk::Statistics::Histogram<double> mitk::Image::HistogramType

Definition at line 93 of file mitkImage.h.

◆ ImageDataItemPointer

Smart Pointer type to a ImageDataItem.

Definition at line 89 of file mitkImage.h.

◆ ImageDataItemPointerArray

Vector container of SmartPointers to ImageDataItems; Class is only for internal usage to allow convenient access to all slices over iterators; See documentation of ImageDataItem for details.

Definition at line 111 of file mitkImage.h.

◆ MutexHolder

typedef itk::MutexLockHolder<itk::SimpleFastMutexLock> mitk::Image::MutexHolder
protected

Definition at line 655 of file mitkImage.h.

◆ Pointer

Definition at line 85 of file mitkImage.h.

◆ Self

Definition at line 85 of file mitkImage.h.

◆ StatisticsHolderPointer

◆ Superclass

Definition at line 85 of file mitkImage.h.

Member Enumeration Documentation

◆ ImportMemoryManagementType

This enum is evaluated when setting new data to an image.

Enumerator
CopyMemory 

Data to be set is copied and assigned to a new memory block. Data memory block will be freed on deletion of mitk::Image.

ManageMemory 

Data to be set will be referenced, and Data memory block will be freed on deletion of mitk::Image.

ReferenceMemory 

Data to be set will be referenced, but Data memory block will not be freed on deletion of mitk::Image.

DontManageMemory 

Definition at line 98 of file mitkImage.h.

Constructor & Destructor Documentation

◆ Image() [1/2]

mitk::Image::Image ( )
protected

◆ Image() [2/2]

mitk::Image::Image ( const Image other)
protected

◆ ~Image()

mitk::Image::~Image ( )
overrideprotected

Member Function Documentation

◆ AllocateChannelData()

virtual ImageDataItemPointer mitk::Image::AllocateChannelData ( int  n = 0,
void *  data = nullptr,
ImportMemoryManagementType  importMemoryManagement = CopyMemory 
) const
protectedvirtual

◆ AllocateSliceData()

virtual ImageDataItemPointer mitk::Image::AllocateSliceData ( int  s = 0,
int  t = 0,
int  n = 0,
void *  data = nullptr,
ImportMemoryManagementType  importMemoryManagement = CopyMemory 
) const
protectedvirtual

◆ AllocateVolumeData()

virtual ImageDataItemPointer mitk::Image::AllocateVolumeData ( int  t = 0,
int  n = 0,
void *  data = nullptr,
ImportMemoryManagementType  importMemoryManagement = CopyMemory 
) const
protectedvirtual

◆ Clear()

void mitk::Image::Clear ( )
overrideprotectedvirtual

Calls ClearData() and InitializeEmpty();.

Warning
Only use in subclasses that reimplemented these methods. Just calling Clear from BaseData will reset an object to a not initialized, invalid state.

Reimplemented from mitk::BaseData.

◆ Clone()

Pointer mitk::Image::Clone ( ) const

◆ ComputeOffsetTable()

void mitk::Image::ComputeOffsetTable ( )
protected

◆ Expand()

void mitk::Image::Expand ( unsigned int  timeSteps)
overrideprotectedvirtual

Expands the TimeGeometry to a number of TimeSteps.

The method expands the TimeGeometry to the given number of TimeSteps, filling newly created elements with empty geometries. Sub-classes should override this method to handle the elongation of their data vectors, too. Note that a shrinking is neither possible nor intended.

Reimplemented from mitk::BaseData.

◆ GetChannelData()

virtual ImageDataItemPointer mitk::Image::GetChannelData ( int  n = 0,
void *  data = nullptr,
ImportMemoryManagementType  importMemoryManagement = CopyMemory 
) const
virtual
Warning
for internal use only

◆ GetChannelDescriptor()

ChannelDescriptor mitk::Image::GetChannelDescriptor ( int  id = 0) const
inline

Definition at line 536 of file mitkImage.h.

References DEPRECATED.

◆ GetClassHierarchy()

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

Reimplemented from mitk::SlicedData.

Definition at line 85 of file mitkImage.h.

◆ GetClassName()

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

Reimplemented from mitk::SlicedData.

◆ GetCountOfMaxValuedVoxels()

ScalarType mitk::Image::GetCountOfMaxValuedVoxels ( int  t = 0) const

(DEPRECATED) Get the count of voxels with the largest scalar value in the dataset

Warning
This method is deprecated and will not be available in the future. Use the GetStatistics instead

◆ GetCountOfMaxValuedVoxelsNoRecompute()

unsigned int mitk::Image::GetCountOfMaxValuedVoxelsNoRecompute ( unsigned int  t = 0) const

(DEPRECATED) Get the count of voxels with the largest scalar value in the dataset

Warning
This method is deprecated and will not be available in the future. Use the GetStatistics instead

◆ GetCountOfMinValuedVoxels()

ScalarType mitk::Image::GetCountOfMinValuedVoxels ( int  t = 0) const

(DEPRECATED) Get the count of voxels with the smallest scalar value in the dataset

Warning
This method is deprecated and will not be available in the future. Use the GetStatistics instead

◆ GetCountOfMinValuedVoxelsNoRecompute()

unsigned int mitk::Image::GetCountOfMinValuedVoxelsNoRecompute ( unsigned int  t = 0) const

(DEPRECATED) Get the count of voxels with the smallest scalar value in the dataset

Warning
This method is deprecated and will not be available in the future. Use the GetStatistics instead

◆ GetData()

virtual void* mitk::Image::GetData ( )
virtual

Get the data vector of the complete image, i.e., of all channels linked together.

If you only want to access a slice, volume at a specific time or single channel use one of the SubImageSelector classes.

Deprecated:
(as of 2012_09) Please use image accessors instead: See Doxygen/Related-Pages/Concepts/Image. This method can be replaced by ImageWriteAccessor::GetData() or ImageReadAccessor::GetData()

◆ GetDimension() [1/2]

unsigned int mitk::Image::GetDimension ( ) const

◆ GetDimension() [2/2]

unsigned int mitk::Image::GetDimension ( int  i) const

Get the size of dimension i (e.g., i=0 results in the number of pixels in x-direction).

See also
GetDimensions()

◆ GetDimensions()

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

Get the sizes of all dimensions as an integer-array.

See also
GetDimension(int i);

◆ GetImageDescriptor()

ImageDescriptor::Pointer mitk::Image::GetImageDescriptor ( ) const
inline

Definition at line 535 of file mitkImage.h.

◆ GetPixelType()

◆ GetPixelValueByIndex()

double mitk::Image::GetPixelValueByIndex ( const itk::Index< 3 > &  position,
unsigned int  timestep = 0,
unsigned int  component = 0 
)

Get the pixel value at one specific index position.

The pixel type is always being converted to double.

Deprecated:
(as of 2012_09) Please use image accessors instead: See Doxygen/Related-Pages/Concepts/Image. This method can be replaced by a method from ImagePixelWriteAccessor or ImagePixelReadAccessor

◆ GetPixelValueByWorldCoordinate()

double mitk::Image::GetPixelValueByWorldCoordinate ( const mitk::Point3D position,
unsigned int  timestep = 0,
unsigned int  component = 0 
)

Get the pixel value at one specific world position.

The pixel type is always being converted to double. Please consider using image accessors instead: See Doxygen/Related-Pages/Concepts/Image. This method can be replaced by a templated method from ImagePixelWriteAccessor or ImagePixelReadAccessor

◆ GetScalarValue2ndMax()

ScalarType mitk::Image::GetScalarValue2ndMax ( int  t = 0) const

(DEPRECATED) Get the second largest value for scalar images

Warning
This method is deprecated and will not be available in the future. Use the GetStatistics instead

◆ GetScalarValue2ndMaxNoRecompute()

ScalarType mitk::Image::GetScalarValue2ndMaxNoRecompute ( unsigned int  t = 0) const

(DEPRECATED) Get the second largest value for scalar images, but do not recompute it first

Warning
This method is deprecated and will not be available in the future. Use the GetStatistics instead

◆ GetScalarValue2ndMin()

ScalarType mitk::Image::GetScalarValue2ndMin ( int  t = 0) const

(DEPRECATED) Get the second smallest value for scalar images

Warning
This method is deprecated and will not be available in the future. Use the GetStatistics instead

◆ GetScalarValue2ndMinNoRecompute()

ScalarType mitk::Image::GetScalarValue2ndMinNoRecompute ( unsigned int  t = 0) const

(DEPRECATED) Get the second smallest value for scalar images, but do not recompute it first

Warning
This method is deprecated and will not be available in the future. Use the GetStatistics instead

◆ GetScalarValueMax()

ScalarType mitk::Image::GetScalarValueMax ( int  t = 0) const

(DEPRECATED) Get the maximum for scalar images

Warning
This method is deprecated and will not be available in the future. Use the GetStatistics instead

◆ GetScalarValueMaxNoRecompute()

ScalarType mitk::Image::GetScalarValueMaxNoRecompute ( unsigned int  t = 0) const

(DEPRECATED) Get the largest value for scalar images, but do not recompute it first

Warning
This method is deprecated and will not be available in the future. Use the GetStatistics instead

◆ GetScalarValueMin()

ScalarType mitk::Image::GetScalarValueMin ( int  t = 0) const

(DEPRECATED) Get the minimum for scalar images

◆ GetScalarValueMinNoRecompute()

ScalarType mitk::Image::GetScalarValueMinNoRecompute ( unsigned int  t = 0) const

(DEPRECATED) Get the smallest value for scalar images, but do not recompute it first

Warning
This method is deprecated and will not be available in the future. Use the GetStatistics instead

◆ GetSliceData()

virtual ImageDataItemPointer mitk::Image::GetSliceData ( int  s = 0,
int  t = 0,
int  n = 0,
void *  data = nullptr,
ImportMemoryManagementType  importMemoryManagement = CopyMemory 
) const
virtual
Warning
for internal use only

◆ GetSliceIndex()

int mitk::Image::GetSliceIndex ( int  s = 0,
int  t = 0,
int  n = 0 
) const
protected

◆ GetStaticNameOfClass()

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

Definition at line 85 of file mitkImage.h.

◆ GetStatistics()

StatisticsHolderPointer mitk::Image::GetStatistics ( ) const
inline

Returns a pointer to the ImageStatisticsHolder object that holds all statistics information for the image.

All Get-methods for statistics properties formerly accessible directly from an Image object are now moved to the new ImageStatisticsHolder object.

Definition at line 653 of file mitkImage.h.

◆ GetVolumeData()

virtual ImageDataItemPointer mitk::Image::GetVolumeData ( int  t = 0,
int  n = 0,
void *  data = nullptr,
ImportMemoryManagementType  importMemoryManagement = CopyMemory 
) const
virtual
Warning
for internal use only

◆ GetVolumeIndex()

int mitk::Image::GetVolumeIndex ( int  t = 0,
int  n = 0 
) const
protected

◆ GetVtkImageData() [1/2]

virtual vtkImageData* mitk::Image::GetVtkImageData ( int  t = 0,
int  n = 0 
)
virtual

Get a volume at a specific time t of channel n as a vtkImageData.

◆ GetVtkImageData() [2/2]

virtual const vtkImageData* mitk::Image::GetVtkImageData ( int  t = 0,
int  n = 0 
) const
virtual

◆ Initialize() [1/10]

virtual void mitk::Image::Initialize ( const mitk::PixelType type,
unsigned int  dimension,
const unsigned int *  dimensions,
unsigned int  channels = 1 
)
virtual

initialize new (or re-initialize) image information

Warning
Initialize() by pic assumes a plane, evenly spaced geometry starting at (0,0,0).

◆ Initialize() [2/10]

virtual void mitk::Image::Initialize ( const mitk::PixelType type,
const mitk::BaseGeometry geometry,
unsigned int  channels = 1,
int  tDim = 1 
)
virtual

initialize new (or re-initialize) image information by a BaseGeometry

Parameters
type
geometry
channels
tDimdefines the number of time steps for which the Image should be initialized

◆ Initialize() [3/10]

virtual void mitk::Image::Initialize ( const mitk::PixelType ,
const mitk::TimeSlicedGeometry ,
unsigned  int,
int   
)
inlinevirtual

initialize new (or re-initialize) image information by a TimeGeometry

Deprecated:
(as of 2013_09) Please use TimeGeometry instead of TimeSlicedGeometry. For more information see http://www.mitk.org/Development/Refactoring%20of%20the%20Geometry%20Classes%20-%20Part%201

Definition at line 293 of file mitkImage.h.

References DEPRECATED.

◆ Initialize() [4/10]

virtual void mitk::Image::Initialize ( const mitk::PixelType type,
const mitk::TimeGeometry geometry,
unsigned int  channels = 1,
int  tDim = -1 
)
virtual

Initialize new (or re-initialize) image information by a TimeGeometry.

Parameters
type
geometry
channels
tDimoverride time dimension if the value is bigger than 0 (Default -1)

◆ Initialize() [5/10]

virtual void mitk::Image::Initialize ( const mitk::PixelType type,
int  sDim,
const mitk::PlaneGeometry geometry2d,
bool  flipped,
unsigned int  channels = 1,
int  tDim = 1 
)
virtual

initialize new (or re-initialize) image information by a PlaneGeometry and number of slices

Initializes the bounding box according to the width/height of the PlaneGeometry and sDim via SlicedGeometry3D::InitializeEvenlySpaced. The spacing is calculated from the PlaneGeometry.

See also
SlicedGeometry3D::InitializeEvenlySpaced
Deprecated:
(as of 2016_11) Use a left-handed or right-handed PlaneGeometry to define the direction of the image stack instead of the flipped parameter

◆ Initialize() [6/10]

virtual void mitk::Image::Initialize ( const mitk::PixelType type,
int  sDim,
const mitk::PlaneGeometry geometry2d,
unsigned int  channels = 1,
int  tDim = 1 
)
virtual

◆ Initialize() [7/10]

virtual void mitk::Image::Initialize ( const mitk::Image image)
virtual

initialize new (or re-initialize) image information by another mitk-image. Only the header is used, not the data vector!

Reimplemented in mitk::LabelSetImage.

◆ Initialize() [8/10]

virtual void mitk::Image::Initialize ( const mitk::ImageDescriptor::Pointer  inDesc)
virtual

◆ Initialize() [9/10]

virtual void mitk::Image::Initialize ( vtkImageData *  vtkimagedata,
int  channels = 1,
int  tDim = -1,
int  sDim = -1,
int  pDim = -1 
)
virtual

initialize new (or re-initialize) image information by vtkimagedata, a vtk-image. Only the header is used, not the data vector! Use SetVolume(vtkimage->GetScalarPointer()) to set the data vector.

Parameters
vtkimagedata
channels
tDimoverride time dimension in vtkimagedata (if >0 and <)
sDimoverride z-space dimension in vtkimagedata (if >0 and <)
pDimoverride y-space dimension in vtkimagedata (if >0 and <)

◆ Initialize() [10/10]

void mitk::Image::Initialize ( )
overrideprotected
Warning
Has to be called by every Initialize method!

◆ InitializeByItk()

template<typename itkImageType >
void mitk::Image::InitializeByItk ( const itkImageType *  itkimage,
int  channels = 1,
int  tDim = -1,
int  sDim = -1 
)
inline

initialize new (or re-initialize) image information by itkimage, a templated itk-image. Only the header is used, not the data vector! Use SetVolume(itkimage->GetBufferPointer()) to set the data vector.

Parameters
itkimage
channels
tDimoverride time dimension in itkimage (if >0 and <)
sDimoverride z-space dimension in itkimage (if >0 and <)

Definition at line 368 of file mitkImage.h.

References mitk::eps, mitk::FillVector3D(), mitk::BaseGeometry::GetIndexToWorldTransform(), mitk::SlicedGeometry3D::InitializeEvenlySpaced(), MITK_DEBUG, MITK_ERROR, MITK_WARN, mitk::BaseGeometry::SetOrigin(), and mitk::BaseGeometry::SetSpacing().

◆ InternalClone()

virtual itk::LightObject::Pointer mitk::Image::InternalClone ( ) const
inlineoverrideprotectedvirtual

Definition at line 655 of file mitkImage.h.

◆ IsChannelSet()

bool mitk::Image::IsChannelSet ( int  n = 0) const
overridevirtual

Check whether the channel n is set.

Implements mitk::SlicedData.

◆ IsRotated()

bool mitk::Image::IsRotated ( ) const

Returns true if an image is rotated, i.e. its geometry's transformation matrix has nonzero elements besides the diagonal. Non-diagonal elements are checked if larger then 1/1000 of the matrix' trace.

◆ IsSliceSet()

bool mitk::Image::IsSliceSet ( int  s = 0,
int  t = 0,
int  n = 0 
) const
overridevirtual

Check whether slice s at time t in channel n is set.

Implements mitk::SlicedData.

◆ IsValidChannel()

virtual bool mitk::Image::IsValidChannel ( int  n = 0) const
virtual

Check whether the channel n is valid, i.e., is (or can be) inside of the image.

◆ IsValidSlice()

virtual bool mitk::Image::IsValidSlice ( int  s = 0,
int  t = 0,
int  n = 0 
) const
virtual

Check whether slice s at time t in channel n is valid, i.e., is (or can be) inside of the image.

◆ IsValidTimeStep()

virtual bool mitk::Image::IsValidTimeStep ( int  t) const
protectedvirtual

◆ IsValidVolume()

virtual bool mitk::Image::IsValidVolume ( int  t = 0,
int  n = 0 
) const
virtual

Check whether volume at time t in channel n is valid, i.e., is (or can be) inside of the image.

◆ IsVolumeSet()

bool mitk::Image::IsVolumeSet ( int  t = 0,
int  n = 0 
) const
overridevirtual

Check whether volume at time t in channel n is set.

Implements mitk::SlicedData.

◆ New()

◆ PrintSelf()

void mitk::Image::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

◆ SetChannel()

virtual bool mitk::Image::SetChannel ( const void *  data,
int  n = 0 
)
virtual

Set data in channel n. It is in the responsibility of the caller to ensure that the data vector data is really a channel (at least is not smaller than a channel), since there is no chance to check this.

The data is copied to an array managed by the image. If the image shall reference the data, use SetImportChannel with ImportMemoryManagementType set to ReferenceMemory. For importing ITK images use of mitk:: ITKImageImport is recommended.

See also
SetPicChannel, SetImportChannel

◆ SetGeometry()

void mitk::Image::SetGeometry ( BaseGeometry aGeometry3D)
overridevirtual

Sets a geometry to an image.

Reimplemented from mitk::BaseData.

◆ SetImportChannel()

virtual bool mitk::Image::SetImportChannel ( void *  data,
int  n = 0,
ImportMemoryManagementType  importMemoryManagement = CopyMemory 
)
virtual

Set data in channel n. It is in the responsibility of the caller to ensure that the data vector data is really a channel (at least is not smaller than a channel), since there is no chance to check this.

The data is managed according to the parameter importMemoryManagement.

See also
SetPicChannel

◆ SetImportSlice()

virtual bool mitk::Image::SetImportSlice ( void *  data,
int  s = 0,
int  t = 0,
int  n = 0,
ImportMemoryManagementType  importMemoryManagement = CopyMemory 
)
virtual

Set data as slice s at time t in channel n. It is in the responsibility of the caller to ensure that the data vector data is really a slice (at least is not smaller than a slice), since there is no chance to check this.

The data is managed according to the parameter importMemoryManagement.

See also
SetPicSlice

◆ SetImportVolume() [1/2]

virtual bool mitk::Image::SetImportVolume ( void *  data,
int  t = 0,
int  n = 0,
ImportMemoryManagementType  importMemoryManagement = CopyMemory 
)
virtual

Set data as volume at time t in channel n. It is in the responsibility of the caller to ensure that the data vector data is really a volume (at least is not smaller than a volume), since there is no chance to check this.

The data is managed according to the parameter importMemoryManagement.

See also
SetPicVolume

◆ SetImportVolume() [2/2]

virtual bool mitk::Image::SetImportVolume ( const void *  const_data,
int  t = 0,
int  n = 0 
)
virtual

◆ SetSlice()

virtual bool mitk::Image::SetSlice ( const void *  data,
int  s = 0,
int  t = 0,
int  n = 0 
)
virtual

Set data as slice s at time t in channel n. It is in the responsibility of the caller to ensure that the data vector data is really a slice (at least is not smaller than a slice), since there is no chance to check this.

The data is copied to an array managed by the image. If the image shall reference the data, use SetImportSlice with ImportMemoryManagementType set to ReferenceMemory. For importing ITK images use of mitk:: ITKImageImport is recommended.

See also
SetPicSlice, SetImportSlice, SetImportVolume

◆ SetVolume()

virtual bool mitk::Image::SetVolume ( const void *  data,
int  t = 0,
int  n = 0 
)
virtual

Set data as volume at time t in channel n. It is in the responsibility of the caller to ensure that the data vector data is really a volume (at least is not smaller than a volume), since there is no chance to check this.

The data is copied to an array managed by the image. If the image shall reference the data, use SetImportVolume with ImportMemoryManagementType set to ReferenceMemory. For importing ITK images use of mitk:: ITKImageImport is recommended.

See also
SetPicVolume, SetImportVolume

Member Data Documentation

◆ m_Channels

ImageDataItemPointerArray mitk::Image::m_Channels
mutableprotected

Definition at line 695 of file mitkImage.h.

◆ m_CompleteData

ImageDataItemPointer mitk::Image::m_CompleteData
protected

Definition at line 707 of file mitkImage.h.

◆ m_Dimension

unsigned int mitk::Image::m_Dimension
protected

Definition at line 700 of file mitkImage.h.

◆ m_Dimensions

unsigned int* mitk::Image::m_Dimensions
protected

Definition at line 702 of file mitkImage.h.

◆ m_ImageDataArraysLock

itk::SimpleFastMutexLock mitk::Image::m_ImageDataArraysLock
mutableprotected

Definition at line 698 of file mitkImage.h.

◆ m_ImageDescriptor

ImageDescriptor::Pointer mitk::Image::m_ImageDescriptor
protected

Definition at line 704 of file mitkImage.h.

◆ m_ImageStatistics

StatisticsHolderPointer mitk::Image::m_ImageStatistics
protected

Definition at line 711 of file mitkImage.h.

◆ m_OffsetTable

vcl_size_t* mitk::Image::m_OffsetTable
protected

Definition at line 706 of file mitkImage.h.

◆ m_Slices

ImageDataItemPointerArray mitk::Image::m_Slices
mutableprotected

Definition at line 697 of file mitkImage.h.

◆ m_Volumes

ImageDataItemPointerArray mitk::Image::m_Volumes
mutableprotected

Definition at line 696 of file mitkImage.h.


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