Medical Imaging Interaction Toolkit  2018.04.99-74b4982f
Medical Imaging Interaction Toolkit
mitk::CalculateGrayValueStatisticsTool Class Reference

Calculates some gray value statistics for segmentations. More...

#include <mitkCalculateGrayValueStatisticsTool.h>

Inheritance diagram for mitk::CalculateGrayValueStatisticsTool:
Collaboration diagram for mitk::CalculateGrayValueStatisticsTool:

Public Types

typedef itk::Statistics::Histogram< double > HistogramType
 
typedef HistogramType::MeasurementType HistogramMeasurementType
 
- Public Types inherited from mitk::Tool
typedef mitk::Label::PixelType DefaultSegmentationDataType
 
- Public Types inherited from mitk::EventStateMachine
typedef EventStateMachine Self
 
typedef InteractionEventHandler Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef std::map< std::string, TActionFunctor * > ActionFunctionsMapType
 
typedef itk::SmartPointer< StateMachineStateStateMachineStateType
 
- Public Types inherited from mitk::InteractionEventHandler
typedef InteractionEventHandler Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

 mitkClassMacro (CalculateGrayValueStatisticsTool, SegmentationsProcessingTool)
 
Pointer Clone () const
 
const char ** GetXPM () const override
 Returns an icon in the XPM format. More...
 
const char * GetName () const override
 Returns the name of this tool. Make it short! More...
 
virtual std::string GetReport () const
 
HistogramType::ConstPointer GetHistogram ()
 
- Public Member Functions inherited from mitk::SegmentationsProcessingTool
 mitkClassMacro (SegmentationsProcessingTool, Tool)
 
- Public Member Functions inherited from mitk::Tool
 mitkClassMacro (Tool, EventStateMachine)
 
virtual std::string GetIconPath () const
 Returns the path of an icon. More...
 
virtual us::ModuleResource GetCursorIconResource () const
 Returns the path of a cursor icon. More...
 
virtual us::ModuleResource GetIconResource () const
 Returns the tool button icon of the tool wrapped by a usModuleResource. More...
 
virtual void InitializeStateMachine ()
 
virtual itk::Object::Pointer GetGUI (const std::string &toolkitPrefix, const std::string &toolkitPostfix)
 Interface for GUI creation. More...
 
virtual NodePredicateBase::ConstPointer GetReferenceDataPreference () const
 
virtual NodePredicateBase::ConstPointer GetWorkingDataPreference () const
 
DataNode::Pointer CreateEmptySegmentationNode (const Image *original, const std::string &organName, const mitk::Color &color)
 
DataNode::Pointer CreateSegmentationNode (Image *image, const std::string &organName, const mitk::Color &color)
 
virtual bool CanHandle (const BaseData *referenceData, const BaseData *workingData) const
 
- Public Member Functions inherited from mitk::EventStateMachine
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
bool LoadStateMachine (const std::string &filename, const us::Module *module=nullptr)
 Loads XML resource. More...
 
bool HandleEvent (InteractionEvent *event, DataNode *dataNode)
 
void EnableUndo (bool enable)
 Enables or disabled Undo. More...
 
void EnableInteraction (bool enable)
 Enables/disables the state machine. In un-enabled state it won't react to any events. More...
 
- Public Member Functions inherited from mitk::InteractionEventHandler
bool SetEventConfig (const std::string &filename, const us::Module *module=nullptr)
 Loads a configuration from an XML resource. More...
 
bool SetEventConfig (const EventConfig &config)
 Loads a configuration from an EventConfig object. More...
 
EventConfig GetEventConfig () const
 Returns the current configuration. More...
 
bool AddEventConfig (const std::string &filename, const us::Module *module=nullptr)
 This method extends the configuration. More...
 
bool AddEventConfig (const EventConfig &config)
 This method extends the configuration. The configuration from the EventConfig object is loaded and only the ones conflicting are replaced by the new one. This way several configurations can be combined. More...
 
- Public Member Functions inherited from mitk::InteractionEventObserver
 InteractionEventObserver ()
 
virtual ~InteractionEventObserver ()
 
void Disable ()
 
void Enable ()
 
bool IsEnabled () const
 

Static Public Member Functions

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

Public Attributes

Message StatisticsCompleted
 
HistogramType::Pointer m_ITKHistogram
 
- Public Attributes inherited from mitk::Tool
Message GUIProcessEventsMessage
 To let GUI process new events (e.g. qApp->processEvents() ) More...
 
Message1< std::string > ErrorMessage
 To send error messages (to be shown by some GUI) More...
 
Message1< bool > CurrentlyBusy
 To send whether the tool is busy (to be shown by some GUI) More...
 
Message1< std::string > GeneralMessage
 To send general messages (to be shown by some GUI) More...
 

Protected Member Functions

 CalculateGrayValueStatisticsTool ()
 
 ~CalculateGrayValueStatisticsTool () override
 
void StartProcessingAllData () override
 Subclasses should override this method. More...
 
bool ProcessOneWorkingData (DataNode *node) override
 Subclasses should override this method. More...
 
void FinishProcessingAllData () override
 Subclasses should override this method. More...
 
std::string GetErrorMessage () override
 Describes the error (if one occurred during processing). More...
 
template<typename TPixel , unsigned int VImageDimension>
void CalculateMinMax (itk::Image< TPixel, VImageDimension > *referenceImage, Image *segmentation, TPixel &minimum, TPixel &maximum)
 
template<typename TPixel , unsigned int VImageDimension>
void ITKHistogramming (itk::Image< TPixel, VImageDimension > *referenceImage, Image *segmentation, std::stringstream &report)
 
- Protected Member Functions inherited from mitk::SegmentationsProcessingTool
 SegmentationsProcessingTool ()
 
 ~SegmentationsProcessingTool () override
 
const char * GetGroup () const override
 Name of a group. More...
 
void Activated () override
 Called when the tool gets activated. More...
 
void Deactivated () override
 Called when the tool gets deactivated. More...
 
virtual void ProcessAllObjects ()
 Loop over all working data items. More...
 
virtual void SendErrorMessageIfAny ()
 Sends an error message if there was an error during processing. More...
 
- Protected Member Functions inherited from mitk::Tool
virtual void SetToolManager (ToolManager *)
 
void ConnectActionsAndFunctions () override
 
 Tool ()
 
 Tool (const char *, const us::Module *interactorModule=nullptr)
 
 ~Tool () override
 
void Notify (InteractionEvent *interactionEvent, bool isHandled) override
 
bool FilterEvents (InteractionEvent *, DataNode *) override
 
- Protected Member Functions inherited from mitk::EventStateMachine
 EventStateMachine ()
 
 ~EventStateMachine () override
 
void AddActionFunction (const std::string &action, TActionFunctor *functor)
 
void AddActionFunction (const std::string &action, const ActionFunctionDelegate &delegate)
 
void AddConditionFunction (const std::string &condition, const ConditionFunctionDelegate &delegate)
 
StateMachineStateGetCurrentState () const
 
void ResetToStartState ()
 ResetToStartState Reset state machine to it initial starting state. More...
 
virtual bool CheckCondition (const StateMachineCondition &condition, const InteractionEvent *interactionEvent)
 
virtual void ExecuteAction (StateMachineAction *action, InteractionEvent *interactionEvent)
 
void SetMouseCursor (const char *xpm[], int hotspotX, int hotspotY)
 Sets the specified mouse cursor. More...
 
void ResetMouseCursor ()
 Resets the mouse cursor (if modified by the SlicesCoordinator) to its original state. More...
 
StateMachineTransitionGetExecutableTransition (InteractionEvent *event)
 Returns the executable transition for the given event. More...
 
- Protected Member Functions inherited from mitk::InteractionEventHandler
 InteractionEventHandler ()
 
 ~InteractionEventHandler () override
 
PropertyList::Pointer GetAttributes () const
 
std::string MapToEventVariant (InteractionEvent *interactionEvent)
 
virtual void ConfigurationChanged ()
 

Protected Attributes

std::stringstream m_CompleteReport
 
- Protected Attributes inherited from mitk::SegmentationsProcessingTool
std::string m_FailedNodes
 
- Protected Attributes inherited from mitk::Tool
std::string m_EventConfig
 Let subclasses change their event configuration. More...
 
ToolManagerm_ToolManager
 
- Protected Attributes inherited from mitk::EventStateMachine
bool m_IsActive
 
UndoControllerm_UndoController
 
bool m_UndoEnabled
 

Additional Inherited Members

- Protected Types inherited from mitk::EventStateMachine
typedef MessageAbstractDelegate2< StateMachineAction *, InteractionEvent *, void > ActionFunctionDelegate
 
typedef MessageAbstractDelegate1< const InteractionEvent *, bool > ConditionFunctionDelegate
 

Detailed Description

Calculates some gray value statistics for segmentations.

See also
mitk::Tool
QmitkInteractiveSegmentation

Last contributor: $Author$

Definition at line 38 of file mitkCalculateGrayValueStatisticsTool.h.

Member Typedef Documentation

◆ HistogramMeasurementType

Definition at line 61 of file mitkCalculateGrayValueStatisticsTool.h.

◆ HistogramType

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

Definition at line 56 of file mitkCalculateGrayValueStatisticsTool.h.

Constructor & Destructor Documentation

◆ CalculateGrayValueStatisticsTool()

mitk::CalculateGrayValueStatisticsTool::CalculateGrayValueStatisticsTool ( )
protected

◆ ~CalculateGrayValueStatisticsTool()

mitk::CalculateGrayValueStatisticsTool::~CalculateGrayValueStatisticsTool ( )
overrideprotected

Member Function Documentation

◆ CalculateMinMax()

template<typename TPixel , unsigned int VImageDimension>
void mitk::CalculateGrayValueStatisticsTool::CalculateMinMax ( itk::Image< TPixel, VImageDimension > *  referenceImage,
Image segmentation,
TPixel &  minimum,
TPixel &  maximum 
)
protected

Calculates the minimum and maximum of the pixelvalues. They have to be known to initialize the histogram.

◆ Clone()

Pointer mitk::CalculateGrayValueStatisticsTool::Clone ( ) const

◆ FinishProcessingAllData()

void mitk::CalculateGrayValueStatisticsTool::FinishProcessingAllData ( )
overrideprotectedvirtual

Subclasses should override this method.

See also
ProcessAllObjects

Reimplemented from mitk::SegmentationsProcessingTool.

◆ GetErrorMessage()

std::string mitk::CalculateGrayValueStatisticsTool::GetErrorMessage ( )
overrideprotectedvirtual

Describes the error (if one occurred during processing).

Reimplemented from mitk::SegmentationsProcessingTool.

◆ GetHistogram()

HistogramType::ConstPointer mitk::CalculateGrayValueStatisticsTool::GetHistogram ( )

◆ GetName()

const char* mitk::CalculateGrayValueStatisticsTool::GetName ( ) const
overridevirtual

Returns the name of this tool. Make it short!

This name has to fit into some kind of button in most applications, so take some time to think of a good name!

Implements mitk::Tool.

◆ GetReport()

virtual std::string mitk::CalculateGrayValueStatisticsTool::GetReport ( ) const
virtual

◆ GetXPM()

const char** mitk::CalculateGrayValueStatisticsTool::GetXPM ( ) const
overridevirtual

Returns an icon in the XPM format.

This icon has to fit into some kind of button in most applications, so make it smaller than 25x25 pixels.

XPM is e.g. supported by The Gimp. But if you open any XPM file in your text editor, you will see that you could also "draw" it with an editor.

Implements mitk::Tool.

◆ ITKHistogramming()

template<typename TPixel , unsigned int VImageDimension>
void mitk::CalculateGrayValueStatisticsTool::ITKHistogramming ( itk::Image< TPixel, VImageDimension > *  referenceImage,
Image segmentation,
std::stringstream &  report 
)
protected
  • initializes and fills the histogram
  • calculates mean, sd and quantiles

◆ mitkClassMacro()

mitk::CalculateGrayValueStatisticsTool::mitkClassMacro ( CalculateGrayValueStatisticsTool  ,
SegmentationsProcessingTool   
)

◆ New()

static Pointer mitk::CalculateGrayValueStatisticsTool::New ( )
static

◆ ProcessOneWorkingData()

bool mitk::CalculateGrayValueStatisticsTool::ProcessOneWorkingData ( DataNode node)
overrideprotectedvirtual

Subclasses should override this method.

See also
ProcessAllObjects

Reimplemented from mitk::SegmentationsProcessingTool.

◆ StartProcessingAllData()

void mitk::CalculateGrayValueStatisticsTool::StartProcessingAllData ( )
overrideprotectedvirtual

Subclasses should override this method.

See also
ProcessAllObjects

Reimplemented from mitk::SegmentationsProcessingTool.

Member Data Documentation

◆ m_CompleteReport

std::stringstream mitk::CalculateGrayValueStatisticsTool::m_CompleteReport
protected

Definition at line 91 of file mitkCalculateGrayValueStatisticsTool.h.

◆ m_ITKHistogram

HistogramType::Pointer mitk::CalculateGrayValueStatisticsTool::m_ITKHistogram

Definition at line 57 of file mitkCalculateGrayValueStatisticsTool.h.

◆ StatisticsCompleted

Message mitk::CalculateGrayValueStatisticsTool::StatisticsCompleted

Definition at line 41 of file mitkCalculateGrayValueStatisticsTool.h.


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