Medical Imaging Interaction Toolkit  2018.4.99-f51274ea
Medical Imaging Interaction Toolkit
mitk::LabelSet Class Reference

#include <mitkLabelSet.h>

Inheritance diagram for mitk::LabelSet:
Collaboration diagram for mitk::LabelSet:

Public Types

typedef mitk::Label::PixelType PixelType
 
typedef std::map< PixelType, Label::PointerLabelContainerType
 
typedef LabelContainerType::const_iterator LabelContainerConstIteratorType
 
typedef LabelContainerType::iterator LabelContainerIteratorType
 

Public Member Functions

 mitkClassMacroItkParent (LabelSet, itk::Object)
 
LabelContainerConstIteratorType IteratorConstBegin () const
 Returns a const iterator poiting to the begining of the container. More...
 
LabelContainerConstIteratorType IteratorConstEnd () const
 Returns a const iterator pointing to the end of the container. More...
 
LabelContainerIteratorType IteratorBegin ()
 Returns a iterator poiting to the begining of the container. More...
 
LabelContainerIteratorType IteratorEnd ()
 Returns a iterator pointing to the end of the container. More...
 
void OnLabelModified ()
 Recall itk::Object::Modified event from a label and send a ModifyLabelEvent. More...
 
void SetLayer (unsigned int)
 
void SetActiveLabel (PixelType)
 
void RemoveLabel (PixelType)
 
bool ExistLabel (PixelType)
 
void AddLabel (mitk::Label *label)
 
void AddLabel (const std::string &name, const Color &color)
 
void RenameLabel (PixelType, const std::string &, const Color &)
 
unsigned int GetNumberOfLabels () const
 
void SetAllLabelsVisible (bool)
 
void SetAllLabelsLocked (bool)
 
void RemoveAllLabels ()
 
void SetNextActiveLabel ()
 
LabelGetActiveLabel ()
 
const LabelGetActiveLabel () const
 
LabelGetLabel (PixelType pixelValue)
 
const LabelGetLabel (PixelType pixelValue) const
 
virtual int GetLayer ()
 
virtual int GetLayer () const
 
 itkGetModifiableObjectMacro (LookupTable, mitk::LookupTable)
 
void SetLookupTable (LookupTable *lut)
 
void UpdateLookupTable (PixelType pixelValue)
 

Static Public Member Functions

static Pointer New ()
 

Public Attributes

Message AddLabelEvent
 AddLabelEvent is emitted whenever a new label has been added to the LabelSet. More...
 
Message RemoveLabelEvent
 RemoveLabelEvent is emitted whenever a new label has been removed from the LabelSet. More...
 
Message ModifyLabelEvent
 ModifyLabelEvent is emitted whenever a label has been modified from the LabelSet. More...
 
Message1< PixelTypeActiveLabelEvent
 ActiveLabelEvent is emitted whenever a label has been set as active in the LabelSet. More...
 
Message AllLabelsModifiedEvent
 AllLabelsModifiedEvent is emitted whenever a new label has been removed from the LabelSet. More...
 

Protected Member Functions

 LabelSet ()
 
 LabelSet (const LabelSet &)
 
 mitkCloneMacro (Self)
 
 ~LabelSet () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 

Protected Attributes

LabelContainerType m_LabelContainer
 
LookupTable::Pointer m_LookupTable
 
PixelType m_ActiveLabelValue
 
unsigned int m_Layer
 

Detailed Description

Definition at line 33 of file mitkLabelSet.h.

Member Typedef Documentation

◆ LabelContainerConstIteratorType

typedef LabelContainerType::const_iterator mitk::LabelSet::LabelContainerConstIteratorType

Definition at line 42 of file mitkLabelSet.h.

◆ LabelContainerIteratorType

typedef LabelContainerType::iterator mitk::LabelSet::LabelContainerIteratorType

Definition at line 43 of file mitkLabelSet.h.

◆ LabelContainerType

Definition at line 41 of file mitkLabelSet.h.

◆ PixelType

Constructor & Destructor Documentation

◆ LabelSet() [1/2]

mitk::LabelSet::LabelSet ( )
protected

◆ LabelSet() [2/2]

mitk::LabelSet::LabelSet ( const LabelSet other)
protected

◆ ~LabelSet()

mitk::LabelSet::~LabelSet ( )
overrideprotected

Definition at line 24 of file mitkLabelSet.cpp.

References m_LabelContainer.

Member Function Documentation

◆ AddLabel() [1/2]

◆ AddLabel() [2/2]

void mitk::LabelSet::AddLabel ( const std::string &  name,
const Color color 
)

Definition at line 145 of file mitkLabelSet.cpp.

References AddLabel(), m_LabelContainer, and mitk::Label::New().

◆ ExistLabel()

bool mitk::LabelSet::ExistLabel ( PixelType  pixelValue)

Definition at line 91 of file mitkLabelSet.cpp.

References m_LabelContainer.

Referenced by RemoveLabel().

◆ GetActiveLabel() [1/2]

Label* mitk::LabelSet::GetActiveLabel ( )
inline

Definition at line 172 of file mitkLabelSet.h.

Referenced by mitk::Equal().

◆ GetActiveLabel() [2/2]

const Label* mitk::LabelSet::GetActiveLabel ( ) const
inline

Definition at line 175 of file mitkLabelSet.h.

References mitkCloneMacro.

◆ GetLabel() [1/2]

mitk::Label * mitk::LabelSet::GetLabel ( PixelType  pixelValue)

◆ GetLabel() [2/2]

const mitk::Label * mitk::LabelSet::GetLabel ( PixelType  pixelValue) const

Definition at line 284 of file mitkLabelSet.cpp.

References m_LabelContainer.

◆ GetLayer() [1/2]

virtual int mitk::LabelSet::GetLayer ( )
virtual

Referenced by mitk::Equal().

◆ GetLayer() [2/2]

virtual int mitk::LabelSet::GetLayer ( ) const
virtual

◆ GetNumberOfLabels()

unsigned int mitk::LabelSet::GetNumberOfLabels ( ) const

Definition at line 73 of file mitkLabelSet.cpp.

References m_LabelContainer.

Referenced by mitk::Equal().

◆ IteratorBegin()

mitk::LabelSet::LabelContainerIteratorType mitk::LabelSet::IteratorBegin ( )

Returns a iterator poiting to the begining of the container.

Definition at line 68 of file mitkLabelSet.cpp.

References m_LabelContainer.

Referenced by RemoveAllLabels().

◆ IteratorConstBegin()

◆ IteratorConstEnd()

◆ IteratorEnd()

mitk::LabelSet::LabelContainerIteratorType mitk::LabelSet::IteratorEnd ( )

Returns a iterator pointing to the end of the container.

Definition at line 63 of file mitkLabelSet.cpp.

References m_LabelContainer.

◆ itkGetModifiableObjectMacro()

mitk::LabelSet::itkGetModifiableObjectMacro ( LookupTable  ,
mitk::LookupTable   
)

◆ mitkClassMacroItkParent()

mitk::LabelSet::mitkClassMacroItkParent ( LabelSet  ,
itk::Object   
)

◆ mitkCloneMacro()

mitk::LabelSet::mitkCloneMacro ( Self  )
protected

◆ New()

static Pointer mitk::LabelSet::New ( )
static

◆ OnLabelModified()

void mitk::LabelSet::OnLabelModified ( )

Recall itk::Object::Modified event from a label and send a ModifyLabelEvent.

Definition at line 47 of file mitkLabelSet.cpp.

References ModifyLabelEvent, and mitk::Message< A >::Send().

Referenced by AddLabel(), and LabelSet().

◆ PrintSelf()

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

Definition at line 172 of file mitkLabelSet.cpp.

◆ RemoveAllLabels()

void mitk::LabelSet::RemoveAllLabels ( )

◆ RemoveLabel()

◆ RenameLabel()

void mitk::LabelSet::RenameLabel ( PixelType  pixelValue,
const std::string &  name,
const Color color 
)

◆ SetActiveLabel()

◆ SetAllLabelsLocked()

void mitk::LabelSet::SetAllLabelsLocked ( bool  value)

◆ SetAllLabelsVisible()

void mitk::LabelSet::SetAllLabelsVisible ( bool  value)

◆ SetLayer()

void mitk::LabelSet::SetLayer ( unsigned int  layer)

Definition at line 78 of file mitkLabelSet.cpp.

References m_Layer.

◆ SetLookupTable()

void mitk::LabelSet::SetLookupTable ( mitk::LookupTable lut)

Definition at line 166 of file mitkLabelSet.cpp.

References m_LookupTable.

◆ SetNextActiveLabel()

void mitk::LabelSet::SetNextActiveLabel ( )

Definition at line 216 of file mitkLabelSet.cpp.

References m_ActiveLabelValue, m_LabelContainer, and SetActiveLabel().

◆ UpdateLookupTable()

Member Data Documentation

◆ ActiveLabelEvent

Message1<PixelType> mitk::LabelSet::ActiveLabelEvent

ActiveLabelEvent is emitted whenever a label has been set as active in the LabelSet.

Definition at line 87 of file mitkLabelSet.h.

Referenced by SetActiveLabel().

◆ AddLabelEvent

Message mitk::LabelSet::AddLabelEvent

AddLabelEvent is emitted whenever a new label has been added to the LabelSet.

Observers should register to this event by calling myLabelSet->AddLabelEvent.AddListener(myObject, MyObject::MyMethod). After registering, myObject->MyMethod() will be called every time a new label has been added to the LabelSet. Observers should unregister by calling myLabelSet->AddLabelEvent.RemoveListener(myObject, MyObject::MyMethod).

member variable is not needed to be locked in multi-threaded scenarios since the LabelSetEvent is a typedef for a Message1 object which is thread safe

Definition at line 56 of file mitkLabelSet.h.

Referenced by AddLabel().

◆ AllLabelsModifiedEvent

Message mitk::LabelSet::AllLabelsModifiedEvent

AllLabelsModifiedEvent is emitted whenever a new label has been removed from the LabelSet.

Observers should register to this event by calling myLabelSet->AllLabelsModifiedEvent.AddListener(myObject, MyObject::MyMethod). After registering, myObject->MyMethod() will be called every time a new label has been removed from the LabelSet. Observers should unregister by calling myLabelSet->AllLabelsModifiedEvent.RemoveListener(myObject, MyObject::MyMethod).

member variable is not needed to be locked in multi-threaded scenarios since the LabelSetEvent is a typedef for a Message object which is thread safe

Definition at line 101 of file mitkLabelSet.h.

Referenced by RemoveAllLabels(), SetAllLabelsLocked(), and SetAllLabelsVisible().

◆ m_ActiveLabelValue

PixelType mitk::LabelSet::m_ActiveLabelValue
protected

Definition at line 212 of file mitkLabelSet.h.

Referenced by RemoveLabel(), SetActiveLabel(), and SetNextActiveLabel().

◆ m_LabelContainer

◆ m_Layer

unsigned int mitk::LabelSet::m_Layer
protected

Definition at line 214 of file mitkLabelSet.h.

Referenced by AddLabel(), and SetLayer().

◆ m_LookupTable

LookupTable::Pointer mitk::LabelSet::m_LookupTable
protected

Definition at line 210 of file mitkLabelSet.h.

Referenced by LabelSet(), SetLookupTable(), and UpdateLookupTable().

◆ ModifyLabelEvent

Message mitk::LabelSet::ModifyLabelEvent

ModifyLabelEvent is emitted whenever a label has been modified from the LabelSet.

Observers should register to this event by calling myLabelSet->ModifyLabelEvent.AddListener(myObject, MyObject::MyMethod). After registering, myObject->MyMethod() will be called every time a new label has been removed from the LabelSet. Observers should unregister by calling myLabelSet->ModifyLabelEvent.RemoveListener(myObject, MyObject::MyMethod).

member variable is not needed to be locked in multi-threaded scenarios since the LabelSetEvent is a typedef for a Message object which is thread safe

Definition at line 82 of file mitkLabelSet.h.

Referenced by OnLabelModified().

◆ RemoveLabelEvent

Message mitk::LabelSet::RemoveLabelEvent

RemoveLabelEvent is emitted whenever a new label has been removed from the LabelSet.

Observers should register to this event by calling myLabelSet->RemoveLabelEvent.AddListener(myObject, MyObject::MyMethod). After registering, myObject->MyMethod() will be called every time a new label has been removed from the LabelSet. Observers should unregister by calling myLabelSet->RemoveLabelEvent.RemoveListener(myObject, MyObject::MyMethod).

member variable is not needed to be locked in multi-threaded scenarios since the LabelSetEvent is a typedef for a Message object which is thread safe

Definition at line 69 of file mitkLabelSet.h.

Referenced by RemoveAllLabels(), and RemoveLabel().


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