Medical Imaging Interaction Toolkit  2016.11.0
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 ()
 
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) virtual ~LabelSet()
 
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 37 of file mitkLabelSet.h.

Member Typedef Documentation

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

Definition at line 46 of file mitkLabelSet.h.

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

Definition at line 47 of file mitkLabelSet.h.

Definition at line 45 of file mitkLabelSet.h.

Constructor & Destructor Documentation

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

Member Function Documentation

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

Definition at line 144 of file mitkLabelSet.cpp.

References mitk::Label::New().

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

Definition at line 93 of file mitkLabelSet.cpp.

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

Definition at line 174 of file mitkLabelSet.h.

Referenced by mitk::Equal().

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

Definition at line 177 of file mitkLabelSet.h.

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

Definition at line 251 of file mitkLabelSet.cpp.

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

Definition at line 258 of file mitkLabelSet.cpp.

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

Referenced by mitk::Equal().

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

Definition at line 75 of file mitkLabelSet.cpp.

Referenced by mitk::Equal().

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

Returns a iterator poiting to the begining of the container.

Definition at line 70 of file mitkLabelSet.cpp.

mitk::LabelSet::LabelContainerConstIteratorType mitk::LabelSet::IteratorConstBegin ( ) const

Returns a const iterator poiting to the begining of the container.

Definition at line 60 of file mitkLabelSet.cpp.

Referenced by mitk::LabelSetImage::Concatenate(), mitk::Equal(), LabelSet(), and QmitkLabelSetWidget::ResetAllTableWidgetItems().

mitk::LabelSet::LabelContainerConstIteratorType mitk::LabelSet::IteratorConstEnd ( ) const

Returns a const iterator pointing to the end of the container.

Definition at line 55 of file mitkLabelSet.cpp.

Referenced by mitk::LabelSetImage::Concatenate(), mitk::Equal(), LabelSet(), and QmitkLabelSetWidget::ResetAllTableWidgetItems().

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

Returns a iterator pointing to the end of the container.

Definition at line 65 of file mitkLabelSet.cpp.

mitk::LabelSet::itkGetModifiableObjectMacro ( LookupTable  ,
mitk::LookupTable   
)
mitk::LabelSet::mitkClassMacroItkParent ( LabelSet  ,
itk::Object   
)
mitk::LabelSet::mitkCloneMacro ( Self  )
protected
void mitk::LabelSet::OnLabelModified ( )

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

Definition at line 49 of file mitkLabelSet.cpp.

Referenced by AddLabel(), and LabelSet().

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

Definition at line 168 of file mitkLabelSet.cpp.

void mitk::LabelSet::RemoveAllLabels ( )

Definition at line 201 of file mitkLabelSet.cpp.

void mitk::LabelSet::RemoveLabel ( PixelType  pixelValue)

Definition at line 172 of file mitkLabelSet.cpp.

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

Definition at line 155 of file mitkLabelSet.cpp.

References mitk::Label::SetColor(), and mitk::Label::SetName().

void mitk::LabelSet::SetActiveLabel ( PixelType  pixelValue)

Definition at line 86 of file mitkLabelSet.cpp.

Referenced by mitk::SegmentationInteractor::ChangeActiveLabel().

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

Definition at line 212 of file mitkLabelSet.cpp.

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

Definition at line 222 of file mitkLabelSet.cpp.

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

Definition at line 80 of file mitkLabelSet.cpp.

void mitk::LabelSet::UpdateLookupTable ( PixelType  pixelValue)

Definition at line 235 of file mitkLabelSet.cpp.

Member Data Documentation

Message1<PixelType> mitk::LabelSet::ActiveLabelEvent

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

Definition at line 91 of file mitkLabelSet.h.

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 60 of file mitkLabelSet.h.

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 105 of file mitkLabelSet.h.

PixelType mitk::LabelSet::m_ActiveLabelValue
protected

Definition at line 210 of file mitkLabelSet.h.

LabelContainerType mitk::LabelSet::m_LabelContainer
protected

Definition at line 206 of file mitkLabelSet.h.

Referenced by LabelSet().

unsigned int mitk::LabelSet::m_Layer
protected

Definition at line 212 of file mitkLabelSet.h.

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

Definition at line 208 of file mitkLabelSet.h.

Referenced by LabelSet().

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 86 of file mitkLabelSet.h.

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 73 of file mitkLabelSet.h.


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