Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mitk::NonBlockingAlgorithm Class Reference

#include <mitkNonBlockingAlgorithm.h>

Inheritance diagram for mitk::NonBlockingAlgorithm:
Inheritance graph
[legend]
Collaboration diagram for mitk::NonBlockingAlgorithm:
Collaboration graph
[legend]

Classes

class  ThreadParameters
 

Public Member Functions

 mitkClassMacroItkParent (NonBlockingAlgorithm, itk::Object) void SetDataStorage(DataStorage &storage)
 
DataStorage * GetDataStorage ()
 
template<typename T >
void SetParameter (const char *parameter, const T &value)
 For any kind of normal types. More...
 
template<typename T >
void SetPointerParameter (const char *parameter, const itk::SmartPointer< T > &value)
 For any kind of smart pointers. More...
 
void SetPointerParameter (const char *parameter, BaseData *value)
 For any kind of BaseData, like Image, Surface, etc. Will be stored inside some SmartPointerProperty. More...
 
template<typename TPixel , unsigned int VImageDimension>
void SetItkImageAsMITKImagePointerParameter (const char *parameter, itk::Image< TPixel, VImageDimension > *itkImage)
 For any kind of ITK images (C pointers) More...
 
template<typename TPixel , unsigned int VImageDimension>
void SetItkImageAsMITKImagePointerParameter (const char *parameter, const itk::SmartPointer< itk::Image< TPixel, VImageDimension >> &itkImage)
 For any kind of ITK images (smartpointers) More...
 
template<typename T >
void GetParameter (const char *parameter, T &value) const
 
template<typename T >
void GetPointerParameter (const char *parameter, itk::SmartPointer< T > &value) const
 
virtual void Reset ()
 
void StartAlgorithm ()
 
void StartBlockingAlgorithm ()
 
void StopAlgorithm ()
 
void TriggerParameterModified (const itk::EventObject &)
 
void ThreadedUpdateSuccessful (const itk::EventObject &)
 
void ThreadedUpdateFailed (const itk::EventObject &)
 

Protected Member Functions

 NonBlockingAlgorithm ()
 
virtual ~NonBlockingAlgorithm ()
 
void DefineTriggerParameter (const char *)
 
void UnDefineTriggerParameter (const char *)
 
virtual void Initialize (const NonBlockingAlgorithm *other=nullptr)
 
virtual bool ReadyToRun ()
 
virtual bool ThreadedUpdateFunction ()
 
virtual void ThreadedUpdateSuccessful ()
 
virtual void ThreadedUpdateFailed ()
 

Protected Attributes

PropertyList::Pointer m_Parameters
 
WeakPointer< DataStorage > m_DataStorage
 

Detailed Description

Invokes ResultsAvailable with each new result

done centralize use of itk::MultiThreader in this class

Definition at line 83 of file mitkNonBlockingAlgorithm.h.

Constructor & Destructor Documentation

mitk::NonBlockingAlgorithm::NonBlockingAlgorithm ( )
protected

Definition at line 24 of file mitkNonBlockingAlgorithm.cpp.

References m_Parameters, mitk::New(), and mitk::PropertyList::New().

mitk::NonBlockingAlgorithm::~NonBlockingAlgorithm ( )
protectedvirtual

Definition at line 31 of file mitkNonBlockingAlgorithm.cpp.

Member Function Documentation

void mitk::NonBlockingAlgorithm::DefineTriggerParameter ( const char *  parameter)
protected

Definition at line 54 of file mitkNonBlockingAlgorithm.cpp.

References m_Parameters, mitk::New(), and TriggerParameterModified().

DataStorage * mitk::NonBlockingAlgorithm::GetDataStorage ( )

Definition at line 33 of file mitkNonBlockingAlgorithm.cpp.

References m_DataStorage.

template<typename T >
void mitk::NonBlockingAlgorithm::GetParameter ( const char *  parameter,
T &  value 
) const
inline

Definition at line 156 of file mitkNonBlockingAlgorithm.h.

References mitk::GenericProperty< T >::GetValue().

Referenced by mitk::ShowSegmentationAsSmoothedSurface::Initialize(), mitk::SegmentationSink::Initialize(), mitk::ShowSegmentationAsSurface::Initialize(), mitk::LabelSetImageToSurfaceThreadedFilter::ThreadedUpdateFunction(), mitk::ShowSegmentationAsSurface::ThreadedUpdateFunction(), and mitk::ShowSegmentationAsSurface::ThreadedUpdateSuccessful().

template<typename T >
void mitk::NonBlockingAlgorithm::GetPointerParameter ( const char *  parameter,
itk::SmartPointer< T > &  value 
) const
inline

Definition at line 177 of file mitkNonBlockingAlgorithm.h.

References mitk::SmartPointerProperty::GetSmartPointer().

Referenced by mitk::SegmentationSink::GetGroupNode(), mitk::SegmentationSink::Initialize(), mitk::SegmentationSink::LookForPointerTargetBelowGroupNode(), mitk::CalculateSegmentationVolume::ReadyToRun(), mitk::SegmentationSink::ReadyToRun(), mitk::ShowSegmentationAsSurface::ReadyToRun(), mitk::LabelSetImageToSurfaceThreadedFilter::ReadyToRun(), mitk::CalculateSegmentationVolume::ThreadedUpdateFunction(), mitk::ShowSegmentationAsSurface::ThreadedUpdateFunction(), mitk::LabelSetImageToSurfaceThreadedFilter::ThreadedUpdateFunction(), mitk::LabelSetImageToSurfaceThreadedFilter::ThreadedUpdateSuccessful(), and mitk::ShowSegmentationAsSurface::ThreadedUpdateSuccessful().

void mitk::NonBlockingAlgorithm::Initialize ( const NonBlockingAlgorithm *  other = nullptr)
protectedvirtual

Reimplemented in mitk::LabelSetImageToSurfaceThreadedFilter, mitk::ShowSegmentationAsSurface, mitk::SegmentationSink, and mitk::ShowSegmentationAsSmoothedSurface.

Definition at line 34 of file mitkNonBlockingAlgorithm.cpp.

References SetPointerParameter().

Referenced by Reset().

mitk::NonBlockingAlgorithm::mitkClassMacroItkParent ( NonBlockingAlgorithm  ,
itk::Object   
)
bool mitk::NonBlockingAlgorithm::ReadyToRun ( )
protectedvirtual

Reimplemented in mitk::LabelSetImageToSurfaceThreadedFilter, mitk::ShowSegmentationAsSurface, mitk::SegmentationSink, mitk::CalculateSegmentationVolume, and mitk::ShowSegmentationAsSmoothedSurface.

Definition at line 167 of file mitkNonBlockingAlgorithm.cpp.

Referenced by StartAlgorithm().

void mitk::NonBlockingAlgorithm::Reset ( )
virtual

Definition at line 83 of file mitkNonBlockingAlgorithm.cpp.

References Initialize().

template<typename TPixel , unsigned int VImageDimension>
void mitk::NonBlockingAlgorithm::SetItkImageAsMITKImagePointerParameter ( const char *  parameter,
itk::Image< TPixel, VImageDimension > *  itkImage 
)
inline

For any kind of ITK images (C pointers)

Definition at line 130 of file mitkNonBlockingAlgorithm.h.

References mitk::ImportItkImage(), and mitk::Image::New().

template<typename TPixel , unsigned int VImageDimension>
void mitk::NonBlockingAlgorithm::SetItkImageAsMITKImagePointerParameter ( const char *  parameter,
const itk::SmartPointer< itk::Image< TPixel, VImageDimension >> &  itkImage 
)
inline

For any kind of ITK images (smartpointers)

Definition at line 142 of file mitkNonBlockingAlgorithm.h.

References mitk::ImportItkImage(), and mitk::Image::New().

template<typename T >
void mitk::NonBlockingAlgorithm::SetParameter ( const char *  parameter,
const T &  value 
)
inline

For any kind of normal types.

Definition at line 102 of file mitkNonBlockingAlgorithm.h.

Referenced by mitk::SegmentationSink::Initialize(), and mitk::ShowSegmentationAsSurface::Initialize().

template<typename T >
void mitk::NonBlockingAlgorithm::SetPointerParameter ( const char *  parameter,
const itk::SmartPointer< T > &  value 
)
inline

For any kind of smart pointers.

Definition at line 112 of file mitkNonBlockingAlgorithm.h.

References mitk::SmartPointerProperty::New().

Referenced by mitk::SegmentationSink::Initialize(), and Initialize().

void mitk::NonBlockingAlgorithm::SetPointerParameter ( const char *  parameter,
BaseData *  value 
)

For any kind of BaseData, like Image, Surface, etc. Will be stored inside some SmartPointerProperty.

Definition at line 47 of file mitkNonBlockingAlgorithm.cpp.

References m_Parameters, and mitk::SmartPointerProperty::New().

void mitk::NonBlockingAlgorithm::StartAlgorithm ( )

Definition at line 90 of file mitkNonBlockingAlgorithm.cpp.

References mitk::NonBlockingAlgorithm::ThreadParameters::m_Algorithm, and ReadyToRun().

Referenced by StartBlockingAlgorithm(), and TriggerParameterModified().

void mitk::NonBlockingAlgorithm::StartBlockingAlgorithm ( )

Definition at line 84 of file mitkNonBlockingAlgorithm.cpp.

References StartAlgorithm(), and StopAlgorithm().

void mitk::NonBlockingAlgorithm::StopAlgorithm ( )

Definition at line 111 of file mitkNonBlockingAlgorithm.cpp.

Referenced by StartBlockingAlgorithm().

void mitk::NonBlockingAlgorithm::ThreadedUpdateFailed ( const itk::EventObject &  )

Definition at line 191 of file mitkNonBlockingAlgorithm.cpp.

References mitk::NonBlockingAlgorithm::ThreadParameters::m_Algorithm, and ThreadedUpdateFailed().

void mitk::NonBlockingAlgorithm::ThreadedUpdateFailed ( )
protectedvirtual

Definition at line 201 of file mitkNonBlockingAlgorithm.cpp.

Referenced by ThreadedUpdateFailed().

bool mitk::NonBlockingAlgorithm::ThreadedUpdateFunction ( )
protectedvirtual

Reimplemented in mitk::LabelSetImageToSurfaceThreadedFilter, mitk::ShowSegmentationAsSurface, mitk::SegmentationSink, mitk::CalculateSegmentationVolume, and mitk::ShowSegmentationAsSmoothedSurface.

Definition at line 172 of file mitkNonBlockingAlgorithm.cpp.

void mitk::NonBlockingAlgorithm::ThreadedUpdateSuccessful ( const itk::EventObject &  )

Definition at line 174 of file mitkNonBlockingAlgorithm.cpp.

References mitk::NonBlockingAlgorithm::ThreadParameters::m_Algorithm, and ThreadedUpdateSuccessful().

void mitk::NonBlockingAlgorithm::ThreadedUpdateSuccessful ( )
protectedvirtual

Reimplemented in mitk::LabelSetImageToSurfaceThreadedFilter, mitk::ShowSegmentationAsSurface, and mitk::ShowSegmentationAsSmoothedSurface.

Definition at line 184 of file mitkNonBlockingAlgorithm.cpp.

Referenced by ThreadedUpdateSuccessful().

void mitk::NonBlockingAlgorithm::TriggerParameterModified ( const itk::EventObject &  )

Definition at line 166 of file mitkNonBlockingAlgorithm.cpp.

References StartAlgorithm().

Referenced by DefineTriggerParameter().

void mitk::NonBlockingAlgorithm::UnDefineTriggerParameter ( const char *  parameter)
protected

Definition at line 67 of file mitkNonBlockingAlgorithm.cpp.

References m_Parameters, and MITK_ERROR.

Referenced by mitk::SegmentationSink::Initialize().

Member Data Documentation

WeakPointer<DataStorage> mitk::NonBlockingAlgorithm::m_DataStorage
protected

Definition at line 232 of file mitkNonBlockingAlgorithm.h.

Referenced by mitk::SegmentationSink::InsertBelowGroupNode(), and mitk::SegmentationSink::LookForPointerTargetBelowGroupNode().

PropertyList::Pointer mitk::NonBlockingAlgorithm::m_Parameters
protected

Definition at line 230 of file mitkNonBlockingAlgorithm.h.

Referenced by DefineTriggerParameter(), NonBlockingAlgorithm(), SetPointerParameter(), and UnDefineTriggerParameter().

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