Medical Imaging Interaction Toolkit  2018.4.99-3e3f1a6e
Medical Imaging Interaction Toolkit
mitk::TubeGraphProperty Class Reference

Property for tube graphs. More...

#include <mitkTubeGraphProperty.h>

Inheritance diagram for mitk::TubeGraphProperty:
Collaboration diagram for mitk::TubeGraphProperty:

Classes

struct  Annotation
 
struct  LabelGroup
 

Public Types

typedef TubeGraph::TubeDescriptorType TubeDescriptorType
 
typedef std::vector< TubeGraphProperty::LabelGroup * > LabelGroupSetType
 
typedef std::pair< TubeDescriptorType, std::string > TubeToLabelGroupType
 
- Public Types inherited from mitk::BaseProperty
typedef BaseProperty Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

 mitkClassMacro (TubeGraphProperty, BaseProperty)
 
bool IsTubeVisible (const TubeDescriptorType &tube)
 
void SetTubeActive (const TubeDescriptorType &tube, const bool &active)
 
void SetTubesActive (std::vector< TubeDescriptorType > &tubes)
 
bool IsTubeActive (const TubeDescriptorType &tube)
 
std::vector< TubeDescriptorTypeGetActiveTubes ()
 
Color GetColorOfTube (const TubeDescriptorType &tube)
 
void SetTubesToLabels (std::map< TubeToLabelGroupType, std::string > tubeToLabelMap)
 
std::map< TubeToLabelGroupType, std::string > GetTubesToLabels ()
 
void DeactivateAllTubes ()
 
void AddAnnotation (Annotation *annotation)
 
AnnotationGetAnnotationByName (std::string annotation)
 
std::vector< Annotation * > GetAnnotations ()
 
void RemoveAnnotation (Annotation *annotation)
 
void AddLabelGroup (LabelGroup *labelGroup, unsigned int position)
 
void RemoveLabelGroup (LabelGroup *labelGroup)
 
LabelGroupSetType GetLabelGroups ()
 
unsigned int GetNumberOfLabelGroups ()
 
unsigned int GetIndexOfLabelGroup (LabelGroup *labelGroup)
 
LabelGroupGetLabelGroupByName (std::string labelGroup)
 
void SetLabelVisibility (LabelGroup::Label *label, bool isVisible)
 
void SetLabelColor (LabelGroup::Label *label, Color color)
 
void RenameLabel (LabelGroup *labelGroup, LabelGroup::Label *label, std::string newName)
 
void SetLabelForActivatedTubes (LabelGroup *labelGroup, LabelGroup::Label *label)
 
LabelGroup::LabelGetLabelByName (LabelGroup *labelGroup, std::string labelName)
 
std::string GetValueAsString () const override
 
- Public Member Functions inherited from mitk::BaseProperty
virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
bool operator== (const BaseProperty &property) const
 Subclasses must implement IsEqual(const BaseProperty&) to support comparison. More...
 
BasePropertyoperator= (const BaseProperty &property)
 Assigns property to this BaseProperty instance. More...
 
bool AssignProperty (const BaseProperty &property)
 Assigns property to this BaseProperty instance. More...
 

Static Public Member Functions

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

Protected Member Functions

 TubeGraphProperty ()
 
 TubeGraphProperty (const TubeGraphProperty &other)
 
 ~TubeGraphProperty () override
 
- Protected Member Functions inherited from mitk::BaseProperty
 BaseProperty ()
 
 BaseProperty (const BaseProperty &other)
 
 ~BaseProperty () override
 

Additional Inherited Members

- Static Public Attributes inherited from mitk::BaseProperty
static const std::string VALUE_CANNOT_BE_CONVERTED_TO_STRING
 Default return value if a property which can not be returned as string. More...
 

Detailed Description

Property for tube graphs.

Definition at line 31 of file mitkTubeGraphProperty.h.

Member Typedef Documentation

◆ LabelGroupSetType

◆ TubeDescriptorType

◆ TubeToLabelGroupType

Definition at line 52 of file mitkTubeGraphProperty.h.

Constructor & Destructor Documentation

◆ TubeGraphProperty() [1/2]

mitk::TubeGraphProperty::TubeGraphProperty ( )
protected

Definition at line 17 of file mitkTubeGraphProperty.cpp.

◆ TubeGraphProperty() [2/2]

mitk::TubeGraphProperty::TubeGraphProperty ( const TubeGraphProperty other)
protected

Definition at line 22 of file mitkTubeGraphProperty.cpp.

◆ ~TubeGraphProperty()

mitk::TubeGraphProperty::~TubeGraphProperty ( )
overrideprotected

Definition at line 31 of file mitkTubeGraphProperty.cpp.

Member Function Documentation

◆ AddAnnotation()

void mitk::TubeGraphProperty::AddAnnotation ( Annotation annotation)

◆ AddLabelGroup()

void mitk::TubeGraphProperty::AddLabelGroup ( LabelGroup labelGroup,
unsigned int  position 
)

◆ DeactivateAllTubes()

void mitk::TubeGraphProperty::DeactivateAllTubes ( )

Deactivates all tubes

Definition at line 118 of file mitkTubeGraphProperty.cpp.

◆ GetActiveTubes()

std::vector< mitk::TubeGraphProperty::TubeDescriptorType > mitk::TubeGraphProperty::GetActiveTubes ( )

Definition at line 113 of file mitkTubeGraphProperty.cpp.

◆ GetAnnotationByName()

mitk::TubeGraphProperty::Annotation * mitk::TubeGraphProperty::GetAnnotationByName ( std::string  annotation)

Definition at line 137 of file mitkTubeGraphProperty.cpp.

◆ GetAnnotations()

std::vector< mitk::TubeGraphProperty::Annotation * > mitk::TubeGraphProperty::GetAnnotations ( )

Definition at line 146 of file mitkTubeGraphProperty.cpp.

◆ GetColorOfTube()

mitk::Color mitk::TubeGraphProperty::GetColorOfTube ( const TubeDescriptorType tube)

◆ GetIndexOfLabelGroup()

unsigned int mitk::TubeGraphProperty::GetIndexOfLabelGroup ( LabelGroup labelGroup)

Definition at line 361 of file mitkTubeGraphProperty.cpp.

References MITK_ERROR.

◆ GetLabelByName()

mitk::TubeGraphProperty::LabelGroup::Label * mitk::TubeGraphProperty::GetLabelByName ( LabelGroup labelGroup,
std::string  labelName 
)

◆ GetLabelGroupByName()

mitk::TubeGraphProperty::LabelGroup * mitk::TubeGraphProperty::GetLabelGroupByName ( std::string  labelGroup)

Definition at line 375 of file mitkTubeGraphProperty.cpp.

References MITK_ERROR.

Referenced by GetColorOfTube(), and IsTubeVisible().

◆ GetLabelGroups()

mitk::TubeGraphProperty::LabelGroupSetType mitk::TubeGraphProperty::GetLabelGroups ( )

Definition at line 351 of file mitkTubeGraphProperty.cpp.

◆ GetNumberOfLabelGroups()

unsigned int mitk::TubeGraphProperty::GetNumberOfLabelGroups ( )

Definition at line 356 of file mitkTubeGraphProperty.cpp.

◆ GetTubesToLabels()

std::map< mitk::TubeGraphProperty::TubeToLabelGroupType, std::string > mitk::TubeGraphProperty::GetTubesToLabels ( )

Definition at line 251 of file mitkTubeGraphProperty.cpp.

◆ GetValueAsString()

std::string mitk::TubeGraphProperty::GetValueAsString ( ) const
overridevirtual

Reimplemented from mitk::BaseProperty.

Definition at line 419 of file mitkTubeGraphProperty.cpp.

◆ IsTubeActive()

bool mitk::TubeGraphProperty::IsTubeActive ( const TubeDescriptorType tube)

Checks, if a given tube is activated

Parameters
idthe tube id of the tube to check
Returns
true, if the tube with id is active or false otherwise

Definition at line 103 of file mitkTubeGraphProperty.cpp.

◆ IsTubeVisible()

bool mitk::TubeGraphProperty::IsTubeVisible ( const TubeDescriptorType tube)

Checks, if a given tube is visible

Parameters
tubethe tube id of the tube to check
Returns
true, if the tube with id is visible or false otherwise

Definition at line 41 of file mitkTubeGraphProperty.cpp.

References GetLabelByName(), GetLabelGroupByName(), and mitk::TubeGraphProperty::LabelGroup::Label::isVisible.

◆ mitkClassMacro()

mitk::TubeGraphProperty::mitkClassMacro ( TubeGraphProperty  ,
BaseProperty   
)

◆ New()

static Pointer mitk::TubeGraphProperty::New ( )
static

Referenced by mitk::TubeGraphIO::Read().

◆ RemoveAnnotation()

void mitk::TubeGraphProperty::RemoveAnnotation ( Annotation annotation)

◆ RemoveLabelGroup()

void mitk::TubeGraphProperty::RemoveLabelGroup ( LabelGroup labelGroup)

◆ RenameLabel()

void mitk::TubeGraphProperty::RenameLabel ( LabelGroup labelGroup,
LabelGroup::Label label,
std::string  newName 
)

◆ SetLabelColor()

void mitk::TubeGraphProperty::SetLabelColor ( LabelGroup::Label label,
mitk::Color  color 
)

◆ SetLabelForActivatedTubes()

void mitk::TubeGraphProperty::SetLabelForActivatedTubes ( LabelGroup labelGroup,
LabelGroup::Label label 
)

◆ SetLabelVisibility()

void mitk::TubeGraphProperty::SetLabelVisibility ( LabelGroup::Label label,
bool  isVisible 
)

◆ SetTubeActive()

void mitk::TubeGraphProperty::SetTubeActive ( const TubeDescriptorType tube,
const bool &  active 
)

Sets a tube active.

Parameters
tubethe tube id of the tube, which has to be set active
activetrue, if the tube should be active or false if not.

Definition at line 64 of file mitkTubeGraphProperty.cpp.

Referenced by SetTubesActive().

◆ SetTubesActive()

void mitk::TubeGraphProperty::SetTubesActive ( std::vector< TubeDescriptorType > &  tubes)

Sets tubes active.

Definition at line 97 of file mitkTubeGraphProperty.cpp.

References SetTubeActive().

◆ SetTubesToLabels()

void mitk::TubeGraphProperty::SetTubesToLabels ( std::map< TubeToLabelGroupType, std::string >  tubeToLabelMap)

Definition at line 246 of file mitkTubeGraphProperty.cpp.


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