LabelSetImage class for handling labels and layers in a segmentation session. More...

#include <mitkLabelSetImage.h>

Inheritance diagram for mitk::LabelSetImage:

[legend]

Collaboration diagram for mitk::LabelSetImage:

[legend]

Public Types
typedef mitk::Label::PixelType	PixelType

Public Types inherited from mitk::Image
enum	ImportMemoryManagementType { CopyMemory, ManageMemory, ReferenceMemory, DontManageMemory }

typedef Image	Self

typedef SlicedData	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef itk::SmartPointer< ImageDataItem >	ImageDataItemPointer

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

typedef mitk::ImageStatisticsHolder *	StatisticsHolderPointer

typedef std::vector< ImageDataItemPointer >	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. More...

Public Types inherited from mitk::SlicedData
typedef SlicedData	Self

typedef BaseData	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

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< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Types inherited from mitk::Identifiable
using	UIDType = std::string

Public Member Functions
	mitkClassMacro (LabelSetImage, Image)

void	Initialize (const mitk::Image *image) override

void	ClearBuffer ()
	More...

void	MergeLabel (PixelType pixelValue, PixelType sourcePixelValue, unsigned int layer=0)
	Merges the mitk::Label with a given target value with the active label. More...

void	MergeLabels (PixelType pixelValue, std::vector< PixelType > &vectorOfSourcePixelValues, unsigned int layer=0)
	Merges a list of mitk::Labels with the mitk::Label that has a specific value. More...

void	UpdateCenterOfMass (PixelType pixelValue, unsigned int layer=0)
	More...

void	RemoveLabel (PixelType pixelValue, unsigned int layer=0)
	Removes the label with the given value. The label is removed from the labelset of the given layer and the pixel values of the image below the label are reset. More...

void	RemoveLabels (std::vector< PixelType > &VectorOfLabelPixelValues, unsigned int layer=0)
	Removes a list of labels with th given value. The labels are removed from the labelset of the given layer and the pixel values of the image below the label are reset. Calls mitk::LabelSetImage::EraseLabels(). More...

void	EraseLabel (PixelType pixelValue)
	Erases the label with the given value from the labelset image. The label itself will not be erased from the respective mitk::LabelSet. In order to remove the label itself use mitk::LabelSetImage::RemoveLabels() More...

void	EraseLabels (std::vector< PixelType > &VectorOfLabelPixelValues)
	Erases a list of labels with the given values from the labelset image. More...

bool	ExistLabel (PixelType pixelValue) const
	Returns true if the value exists in one of the labelsets. More...

bool	ExistLabel (PixelType pixelValue, unsigned int layer) const
	Checks if a label exists in a certain layer. More...

bool	ExistLabelSet (unsigned int layer) const
	Returns true if the labelset exists. More...

mitk::Label *	GetActiveLabel (unsigned int layer=0)
	Returns the active label of a specific layer. More...

const mitk::Label *	GetActiveLabel (unsigned int layer=0) const

mitk::Label *	GetLabel (PixelType pixelValue, unsigned int layer=0) const
	Returns the mitk::Label with the given pixelValue and for the given layer. More...

mitk::LabelSet *	GetActiveLabelSet ()
	Returns the currently active mitk::LabelSet. More...

const mitk::LabelSet *	GetActiveLabelSet () const

mitk::LabelSet *	GetLabelSet (unsigned int layer=0)
	Gets the mitk::LabelSet for the given layer. More...

const mitk::LabelSet *	GetLabelSet (unsigned int layer=0) const

unsigned int	GetActiveLayer () const
	Gets the ID of the currently active layer. More...

unsigned int	GetNumberOfLabels (unsigned int layer=0) const
	Get the number of all existing mitk::Labels for a given layer. More...

unsigned int	GetTotalNumberOfLabels () const
	Returns the number of all labels summed up across all layers. More...

mitk::Image::Pointer	CreateLabelMask (PixelType index, bool useActiveLayer=true, unsigned int layer=0)
	‍** More...

void	InitializeByLabeledImage (mitk::Image::Pointer image)
	Initialize a new mitk::LabelSetImage by an given image. For all distinct pixel values of the parameter image new labels will be created. If the number of distinct pixel values exceeds mitk::Label::MAX_LABEL_VALUE a new layer will be created. More...

void	MaskStamp (mitk::Image *mask, bool forceOverwrite)
	More...

void	SetActiveLayer (unsigned int layer)
	More...

unsigned int	GetNumberOfLayers () const
	More...

unsigned int	AddLayer (mitk::LabelSet::Pointer labelSet=nullptr)
	Adds a new layer to the LabelSetImage. The new layer will be set as the active one. More...

unsigned int	AddLayer (mitk::Image::Pointer layerImage, mitk::LabelSet::Pointer labelSet=nullptr)
	Adds a layer based on a provided mitk::Image. More...

void	AddLabelSetToLayer (const unsigned int layerIdx, const mitk::LabelSet::Pointer labelSet)
	Add a LabelSet to an existing layer. More...

void	RemoveLayer ()
	Removes the active layer and the respective mitk::LabelSet and image information. The new active layer is the one below, if exists. More...

mitk::Image *	GetLayerImage (unsigned int layer)
	More...

const mitk::Image *	GetLayerImage (unsigned int layer) const

void	OnLabelSetModified ()

void	SetExteriorLabel (mitk::Label *label)
	Sets the label which is used as default exterior label when creating a new layer. More...

mitk::Label *	GetExteriorLabel ()
	Gets the mitk::Label which is used as default exterior label. More...

const mitk::Label *	GetExteriorLabel () const

Public Member Functions inherited from mitk::Image
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 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 &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, unsigned int channels=1, int tDim=1)

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

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 RegionType &	GetLargestPossibleRegion () const

virtual const RegionType &	GetRequestedRegion () const

void	CopyInformation (const itk::DataObject *data) override

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

SlicedGeometry3D *	GetSlicedGeometry (unsigned int t=0) const
	Convenience access method for the geometry, which is of type SlicedGeometry3D (or a sub-class of it). More...

const SlicedGeometry3D *	GetUpdatedSlicedGeometry (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...

BaseProperty *	GetNonConstProperty (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::TimeGeometry *	GetTimeGeometry () const
	Return the TimeGeometry of the data as const pointer. More...

mitk::TimeGeometry *	GetTimeGeometry ()
	Return the TimeGeometry of the data as pointer. More...

const mitk::TimeGeometry *	GetUpdatedTimeGeometry ()
	Return the TimeGeometry of the data. More...

const mitk::BaseGeometry *	GetUpdatedGeometry (int t=0)
	Return the BaseGeometry of the data at time t. More...

mitk::BaseGeometry *	GetGeometry (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::BaseDataSource >	GetSource () 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...

itk::ModifiedTimeType	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 ()

Identifiable &	operator= (const Identifiable &)=delete

Identifiable &	operator= (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 Pointer	New ()

Static Public Member Functions inherited from mitk::Image
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 ()

Public Attributes
Message	BeforeChangeLayerEvent
	BeforeChangeLayerEvent (e.g. used for GUI integration) As soon as active labelset should be changed, the signal emits. Emitted by SetActiveLayer(int layer);. More...

Message	AfterChangeLayerEvent
	AfterchangeLayerEvent (e.g. used for GUI integration) As soon as active labelset was changed, the signal emits. Emitted by SetActiveLayer(int layer);. More...

Protected Member Functions
	mitkCloneMacro (Self)

	LabelSetImage ()

	LabelSetImage (const LabelSetImage &other)

	~LabelSetImage () override

template<typename TPixel , unsigned int VImageDimension>
void	LayerContainerToImageProcessing (itk::Image< TPixel, VImageDimension > *source, unsigned int layer)

template<typename TPixel , unsigned int VImageDimension>
void	ImageToLayerContainerProcessing (itk::Image< TPixel, VImageDimension > *source, unsigned int layer) const

template<typename ImageType >
void	CalculateCenterOfMassProcessing (ImageType *input, PixelType index, unsigned int layer)

template<typename ImageType >
void	ClearBufferProcessing (ImageType *input)

template<typename ImageType >
void	EraseLabelProcessing (ImageType *input, PixelType index)

template<typename ImageType >
void	MergeLabelProcessing (ImageType *input, PixelType pixelValue, PixelType index)

template<typename ImageType >
void	MaskStampProcessing (ImageType input, mitk::Image mask, bool forceOverwrite)

template<typename LabelSetImageType , typename ImageType >
void	InitializeByLabeledImageProcessing (LabelSetImageType input, ImageType other)

Protected Member Functions inherited from mitk::Image
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	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
std::vector< LabelSet::Pointer >	m_LabelSetContainer

std::vector< Image::Pointer >	m_LayerContainer

int	m_ActiveLayer

bool	m_activeLayerInvalid

mitk::Label::Pointer	m_ExteriorLabel

Protected Attributes inherited from mitk::Image
ImageDataItemPointerArray	m_Channels

ImageDataItemPointerArray	m_Volumes

ImageDataItemPointerArray	m_Slices

std::mutex	m_ImageDataArraysLock

unsigned int	m_Dimension

unsigned int *	m_Dimensions

ImageDescriptor::Pointer	m_ImageDescriptor

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

Additional Inherited Members
Protected Types inherited from mitk::Image
typedef std::lock_guard< std::mutex >	MutexHolder

Detailed Description

LabelSetImage class for handling labels and layers in a segmentation session.

Handles operations for adding, removing, erasing and editing labels and layers.

Definition at line 29 of file mitkLabelSetImage.h.

Member Typedef Documentation

◆ PixelType

typedef mitk::Label::PixelType mitk::LabelSetImage::PixelType

Definition at line 33 of file mitkLabelSetImage.h.

Constructor & Destructor Documentation

◆ LabelSetImage() [1/2]

mitk::LabelSetImage::LabelSetImage ( )

protected

◆ LabelSetImage() [2/2]

mitk::LabelSetImage::LabelSetImage ( const LabelSetImage & other )

protected

◆ ~LabelSetImage()

mitk::LabelSetImage::~LabelSetImage ( )

overrideprotected

Member Function Documentation

◆ AddLabelSetToLayer()

void mitk::LabelSetImage::AddLabelSetToLayer	(	const unsigned int	layerIdx,
		const mitk::LabelSet::Pointer	labelSet
	)

Add a LabelSet to an existing layer.

This will replace an existing labelSet if one exists. Throws an exceptions if you are trying to add a labelSet to a non-existing layer.

If there are no labelSets for layers with an id less than layerIdx default ones will be added for them.

Parameters

layerIdx	The index of the layer the LabelSet should be added to
labelSet	The LabelSet that should be added

◆ AddLayer() [1/2]

unsigned int mitk::LabelSetImage::AddLayer	(	mitk::Image::Pointer	layerImage,
		mitk::LabelSet::Pointer	labelSet = `nullptr`
	)

Adds a layer based on a provided mitk::Image.

Parameters

layerImage	is added to the vector of label images
labelSet	a labelset that will be added to the new layer if provided

Returns: the layer ID of the new layer

◆ AddLayer() [2/2]

unsigned int mitk::LabelSetImage::AddLayer ( mitk::LabelSet::Pointer labelSet = nullptr )

Adds a new layer to the LabelSetImage. The new layer will be set as the active one.

Parameters

labelSet a labelset that will be added to the new layer if provided

Returns: the layer ID of the new layer

◆ CalculateCenterOfMassProcessing()

template<typename ImageType >

void mitk::LabelSetImage::CalculateCenterOfMassProcessing	(	ImageType *	input,
		PixelType	index,
		unsigned int	layer
	)

protected

◆ ClearBuffer()

void mitk::LabelSetImage::ClearBuffer ( )

◆ ClearBufferProcessing()

template<typename ImageType >

void mitk::LabelSetImage::ClearBufferProcessing ( ImageType * input )

protected

◆ CreateLabelMask()

mitk::Image::Pointer mitk::LabelSetImage::CreateLabelMask	(	PixelType	index,
		bool	useActiveLayer = `true`,
		unsigned int	layer = `0`
	)

‍**

◆ EraseLabel()

void mitk::LabelSetImage::EraseLabel ( PixelType pixelValue )

Erases the label with the given value from the labelset image. The label itself will not be erased from the respective mitk::LabelSet. In order to remove the label itself use mitk::LabelSetImage::RemoveLabels()

Parameters

pixelValue the pixel value of the label that will be erased from the labelset image

◆ EraseLabelProcessing()

template<typename ImageType >

void mitk::LabelSetImage::EraseLabelProcessing	(	ImageType *	input,
		PixelType	index
	)

protected

◆ EraseLabels()

void mitk::LabelSetImage::EraseLabels ( std::vector< PixelType > & VectorOfLabelPixelValues )

Erases a list of labels with the given values from the labelset image.

Parameters

VectorOfLabelPixelValues the list of pixel values of the labels that will be erased from the labelset image

◆ ExistLabel() [1/2]

bool mitk::LabelSetImage::ExistLabel ( PixelType pixelValue ) const

Returns true if the value exists in one of the labelsets.

◆ ExistLabel() [2/2]

bool mitk::LabelSetImage::ExistLabel	(	PixelType	pixelValue,
		unsigned int	layer
	)		const

Checks if a label exists in a certain layer.

Parameters

pixelValue	the label value
layer	the layer in which should be searched for the label

Returns: true if the label exists otherwise false

◆ ExistLabelSet()

bool mitk::LabelSetImage::ExistLabelSet ( unsigned int layer ) const

Returns true if the labelset exists.

◆ GetActiveLabel() [1/2]

mitk::Label* mitk::LabelSetImage::GetActiveLabel ( unsigned int layer = 0 )

Returns the active label of a specific layer.

Parameters

layer the layer ID for which the active label should be returned

Returns: the active label of the specified layer

◆ GetActiveLabel() [2/2]

const mitk::Label* mitk::LabelSetImage::GetActiveLabel ( unsigned int layer = 0 ) const

◆ GetActiveLabelSet() [1/2]

mitk::LabelSet* mitk::LabelSetImage::GetActiveLabelSet ( )

Returns the currently active mitk::LabelSet.

Returns: the mitk::LabelSet of the active layer or nullptr if non is present

◆ GetActiveLabelSet() [2/2]

const mitk::LabelSet* mitk::LabelSetImage::GetActiveLabelSet ( ) const

◆ GetActiveLayer()

unsigned int mitk::LabelSetImage::GetActiveLayer ( ) const

Gets the ID of the currently active layer.

Returns: the ID of the active layer

◆ GetExteriorLabel() [1/2]

mitk::Label* mitk::LabelSetImage::GetExteriorLabel ( )

Gets the mitk::Label which is used as default exterior label.

Returns: the exterior mitk::Label

◆ GetExteriorLabel() [2/2]

const mitk::Label* mitk::LabelSetImage::GetExteriorLabel ( ) const

◆ GetLabel()

mitk::Label* mitk::LabelSetImage::GetLabel	(	PixelType	pixelValue,
		unsigned int	layer = `0`
	)		const

Returns the mitk::Label with the given pixelValue and for the given layer.

Parameters

pixelValue	the pixel value of the label
layer	the layer in which the labels should be located

Returns: the mitk::Label if available otherwise nullptr

◆ GetLabelSet() [1/2]

mitk::LabelSet* mitk::LabelSetImage::GetLabelSet ( unsigned int layer = 0 )

Gets the mitk::LabelSet for the given layer.

Parameters

layer the layer for which the mitk::LabelSet should be retrieved

Returns: the respective mitk::LabelSet or nullptr if non exists for the given layer

◆ GetLabelSet() [2/2]

const mitk::LabelSet* mitk::LabelSetImage::GetLabelSet ( unsigned int layer = 0 ) const

◆ GetLayerImage() [1/2]

mitk::Image* mitk::LabelSetImage::GetLayerImage ( unsigned int layer )

◆ GetLayerImage() [2/2]

const mitk::Image* mitk::LabelSetImage::GetLayerImage ( unsigned int layer ) const

◆ GetNumberOfLabels()

unsigned int mitk::LabelSetImage::GetNumberOfLabels ( unsigned int layer = 0 ) const

Get the number of all existing mitk::Labels for a given layer.

Parameters

layer the layer ID for which the active mitk::Labels should be retrieved

Returns: the number of all existing mitk::Labels for the given layer

◆ GetNumberOfLayers()

unsigned int mitk::LabelSetImage::GetNumberOfLayers ( ) const

◆ GetTotalNumberOfLabels()

unsigned int mitk::LabelSetImage::GetTotalNumberOfLabels ( ) const

Returns the number of all labels summed up across all layers.

Returns: the overall number of labels across all layers

◆ ImageToLayerContainerProcessing()

template<typename TPixel , unsigned int VImageDimension>

void mitk::LabelSetImage::ImageToLayerContainerProcessing	(	itk::Image< TPixel, VImageDimension > *	source,
		unsigned int	layer
	)		const

protected

◆ Initialize()

void mitk::LabelSetImage::Initialize ( const mitk::Image * image )

overridevirtual

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

Reimplemented from mitk::Image.

◆ InitializeByLabeledImage()

void mitk::LabelSetImage::InitializeByLabeledImage ( mitk::Image::Pointer image )

Initialize a new mitk::LabelSetImage by an given image. For all distinct pixel values of the parameter image new labels will be created. If the number of distinct pixel values exceeds mitk::Label::MAX_LABEL_VALUE a new layer will be created.

Parameters

image the image which is used for initialization

◆ InitializeByLabeledImageProcessing()

template<typename LabelSetImageType , typename ImageType >

void mitk::LabelSetImage::InitializeByLabeledImageProcessing	(	LabelSetImageType *	input,
		ImageType *	other
	)

protected

◆ LayerContainerToImageProcessing()

template<typename TPixel , unsigned int VImageDimension>

void mitk::LabelSetImage::LayerContainerToImageProcessing	(	itk::Image< TPixel, VImageDimension > *	source,
		unsigned int	layer
	)

protected

◆ MaskStamp()

void mitk::LabelSetImage::MaskStamp	(	mitk::Image *	mask,
		bool	forceOverwrite
	)

◆ MaskStampProcessing()

template<typename ImageType >

void mitk::LabelSetImage::MaskStampProcessing	(	ImageType *	input,
		mitk::Image *	mask,
		bool	forceOverwrite
	)

protected

◆ MergeLabel()

void mitk::LabelSetImage::MergeLabel	(	PixelType	pixelValue,
		PixelType	sourcePixelValue,
		unsigned int	layer = `0`
	)

Merges the mitk::Label with a given target value with the active label.

Parameters

pixelValue	the value of the label that should be the new merged label
sourcePixelValue	the value of the label that should be merged into the specified one
layer	the layer in which the merge should be performed

◆ MergeLabelProcessing()

template<typename ImageType >

void mitk::LabelSetImage::MergeLabelProcessing	(	ImageType *	input,
		PixelType	pixelValue,
		PixelType	index
	)

protected

◆ MergeLabels()

void mitk::LabelSetImage::MergeLabels	(	PixelType	pixelValue,
		std::vector< PixelType > &	vectorOfSourcePixelValues,
		unsigned int	layer = `0`
	)

Merges a list of mitk::Labels with the mitk::Label that has a specific value.

Parameters

pixelValue	the value of the label that should be the new merged label
vectorOfSourcePixelValues	the list of label values that should be merge into the specified one
layer	the layer in which the merge should be performed

◆ mitkClassMacro()

mitk::LabelSetImage::mitkClassMacro	(	LabelSetImage	,
		Image
	)

◆ mitkCloneMacro()

mitk::LabelSetImage::mitkCloneMacro ( Self )

protected

◆ New()

static Pointer mitk::LabelSetImage::New ( )

static

◆ OnLabelSetModified()

void mitk::LabelSetImage::OnLabelSetModified ( )

◆ RemoveLabel()

void mitk::LabelSetImage::RemoveLabel	(	PixelType	pixelValue,
		unsigned int	layer = `0`
	)

Removes the label with the given value. The label is removed from the labelset of the given layer and the pixel values of the image below the label are reset.

Parameters

pixelValue	the pixel value of the label to be removed
layer	the layer from which the label should be removed

◆ RemoveLabels()

void mitk::LabelSetImage::RemoveLabels	(	std::vector< PixelType > &	VectorOfLabelPixelValues,
		unsigned int	layer = `0`
	)

Removes a list of labels with th given value. The labels are removed from the labelset of the given layer and the pixel values of the image below the label are reset. Calls mitk::LabelSetImage::EraseLabels().

Parameters

VectorOfLabelPixelValues	a list of pixel values of labels to be removed
layer	the layer from which the labels should be removed

◆ RemoveLayer()

void mitk::LabelSetImage::RemoveLayer ( )

Removes the active layer and the respective mitk::LabelSet and image information. The new active layer is the one below, if exists.

◆ SetActiveLayer()

void mitk::LabelSetImage::SetActiveLayer ( unsigned int layer )

◆ SetExteriorLabel()

void mitk::LabelSetImage::SetExteriorLabel ( mitk::Label * label )

Sets the label which is used as default exterior label when creating a new layer.

Parameters

label the label which will be used as new exterior label

◆ UpdateCenterOfMass()

void mitk::LabelSetImage::UpdateCenterOfMass	(	PixelType	pixelValue,
		unsigned int	layer = `0`
	)

Member Data Documentation

◆ AfterChangeLayerEvent

Message mitk::LabelSetImage::AfterChangeLayerEvent

AfterchangeLayerEvent (e.g. used for GUI integration) As soon as active labelset was changed, the signal emits. Emitted by SetActiveLayer(int layer);.

Definition at line 49 of file mitkLabelSetImage.h.

◆ BeforeChangeLayerEvent

Message mitk::LabelSetImage::BeforeChangeLayerEvent

BeforeChangeLayerEvent (e.g. used for GUI integration) As soon as active labelset should be changed, the signal emits. Emitted by SetActiveLayer(int layer);.

Definition at line 42 of file mitkLabelSetImage.h.

◆ m_ActiveLayer

int mitk::LabelSetImage::m_ActiveLayer

protected

Definition at line 308 of file mitkLabelSetImage.h.

◆ m_activeLayerInvalid

bool mitk::LabelSetImage::m_activeLayerInvalid

protected

Definition at line 310 of file mitkLabelSetImage.h.

◆ m_ExteriorLabel

mitk::Label::Pointer mitk::LabelSetImage::m_ExteriorLabel

protected

Definition at line 312 of file mitkLabelSetImage.h.

◆ m_LabelSetContainer

std::vector<LabelSet::Pointer> mitk::LabelSetImage::m_LabelSetContainer

protected

Definition at line 305 of file mitkLabelSetImage.h.

◆ m_LayerContainer

std::vector<Image::Pointer> mitk::LabelSetImage::m_LayerContainer

protected

Definition at line 306 of file mitkLabelSetImage.h.

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

mitkLabelSetImage.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PixelType

Constructor & Destructor Documentation

◆ LabelSetImage() [1/2]

◆ LabelSetImage() [2/2]

◆ ~LabelSetImage()

Member Function Documentation

◆ AddLabelSetToLayer()

◆ AddLayer() [1/2]

◆ AddLayer() [2/2]

◆ CalculateCenterOfMassProcessing()

◆ ClearBuffer()

◆ ClearBufferProcessing()

◆ CreateLabelMask()

◆ EraseLabel()

◆ EraseLabelProcessing()

◆ EraseLabels()

◆ ExistLabel() [1/2]

◆ ExistLabel() [2/2]

◆ ExistLabelSet()

◆ GetActiveLabel() [1/2]

◆ GetActiveLabel() [2/2]

◆ GetActiveLabelSet() [1/2]

◆ GetActiveLabelSet() [2/2]

◆ GetActiveLayer()

◆ GetExteriorLabel() [1/2]

◆ GetExteriorLabel() [2/2]

◆ GetLabel()

◆ GetLabelSet() [1/2]

◆ GetLabelSet() [2/2]

◆ GetLayerImage() [1/2]

◆ GetLayerImage() [2/2]

◆ GetNumberOfLabels()

◆ GetNumberOfLayers()

◆ GetTotalNumberOfLabels()

◆ ImageToLayerContainerProcessing()

◆ Initialize()

◆ InitializeByLabeledImage()

◆ InitializeByLabeledImageProcessing()

◆ LayerContainerToImageProcessing()

◆ MaskStamp()

◆ MaskStampProcessing()

◆ MergeLabel()

◆ MergeLabelProcessing()

◆ MergeLabels()

◆ mitkClassMacro()

◆ mitkCloneMacro()

◆ New()

◆ OnLabelSetModified()

◆ RemoveLabel()

◆ RemoveLabels()

◆ RemoveLayer()

◆ SetActiveLayer()

◆ SetExteriorLabel()

◆ UpdateCenterOfMass()

Member Data Documentation

◆ AfterChangeLayerEvent

◆ BeforeChangeLayerEvent

◆ m_ActiveLayer

◆ m_activeLayerInvalid

◆ m_ExteriorLabel

◆ m_LabelSetContainer

◆ m_LayerContainer