#include <mitkCorrectorAlgorithm.h>

Inheritance diagram for mitk::CorrectorAlgorithm:

Collaboration diagram for mitk::CorrectorAlgorithm:

[legend]

Classes
struct	TSegData
	Calculated difference image. More...

Public Types
typedef mitk::Label::PixelType	DefaultSegmentationDataType

Public Types inherited from mitk::ImageToImageFilter
typedef ImageToImageFilter	Self

typedef ImageSource	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef mitk::Image	InputImageType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef SlicedData::RegionType	InputImageRegionType

Public Types inherited from mitk::ImageSource
typedef ImageSource	Self

typedef BaseDataSource	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef mitk::Image	OutputImageType
	Some convenient typedefs. More...

typedef OutputImageType	OutputType

typedef OutputImageType::Pointer	OutputImagePointer

typedef SlicedData::RegionType	OutputImageRegionType

Public Types inherited from mitk::BaseDataSource
typedef BaseDataSource	Self

typedef itk::ProcessObject	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef BaseData	OutputType

typedef itk::DataObject::DataObjectIdentifierType	DataObjectIdentifierType

Public Member Functions
	mitkClassMacro (CorrectorAlgorithm, ImageToImageFilter)

Pointer	Clone () const

void	SetContour (ContourModel *contour)
	User drawn contour. More...

virtual void	SetFillColor (int _arg)

virtual int	GetFillColor () const

virtual void	SetEraseColor (int _arg)

virtual int	GetEraseColor () const

Public Member Functions inherited from mitk::ImageToImageFilter
virtual std::vector< std::string >	GetClassHierarchy () const override

virtual const char *	GetClassName () const

Pointer	Clone () const

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const InputImageType *image)

InputImageType *	GetInput (void)

InputImageType *	GetInput (unsigned int idx)

const InputImageType *	GetInput (void) const

const InputImageType *	GetInput (unsigned int idx) const

Public Member Functions inherited from mitk::ImageSource
Pointer	Clone () const

OutputType *	GetOutput ()
	Get the output data of this image source object. More...

const OutputType *	GetOutput () const

OutputType *	GetOutput (DataObjectPointerArraySizeType idx)

const OutputType *	GetOutput (DataObjectPointerArraySizeType idx) const

itk::DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override
	Make a DataObject of the correct type to used as the specified output. More...

itk::DataObject::Pointer	MakeOutput (const DataObjectIdentifierType &name) override

virtual vtkImageData *	GetVtkImageData ()

virtual const vtkImageData *	GetVtkImageData () const

Public Member Functions inherited from mitk::BaseDataSource
OutputType *	GetOutput ()

const OutputType *	GetOutput () const

OutputType *	GetOutput (DataObjectPointerArraySizeType idx)

const OutputType *	GetOutput (DataObjectPointerArraySizeType idx) const

virtual void	GraftOutput (OutputType *output)
	Graft the specified BaseData onto this BaseDataSource's output. More...

virtual void	GraftOutput (const DataObjectIdentifierType &key, OutputType *output)

virtual void	GraftNthOutput (unsigned int idx, OutputType *output)
	Graft the specified base data object onto this BaseDataSource's idx'th output. More...

bool	Updating () const
	Access itk::ProcessObject::m_Updating. More...

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from mitk::ImageToImageFilter
static const char *	GetStaticNameOfClass ()

static Pointer	New ()

Static Public Member Functions inherited from mitk::ImageSource
static const char *	GetStaticNameOfClass ()

static Pointer	New ()
	Method for creation through the object factory. More...

Static Public Member Functions inherited from mitk::BaseDataSource
static const char *	GetStaticNameOfClass ()

Protected Member Functions
	CorrectorAlgorithm ()

	~CorrectorAlgorithm () override

void	GenerateData () override

bool	ImprovedHeimannCorrectionAlgorithm (itk::Image< DefaultSegmentationDataType, 2 >::Pointer pic)

bool	ModifySegment (const TSegData &segment, itk::Image< DefaultSegmentationDataType, 2 >::Pointer pic)

Protected Member Functions inherited from mitk::ImageToImageFilter
	ImageToImageFilter ()

	~ImageToImageFilter () override

void	PrintSelf (std::ostream &os, itk::Indent indent) const override

void	GenerateInputRequestedRegion () override

Protected Member Functions inherited from mitk::ImageSource
	ImageSource ()

	~ImageSource () override

void	GenerateData () override
	A version of GenerateData() specific for image processing filters. More...

virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
	If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). More...

void	PrepareOutputs () override
	This method is intentionally left blank. More...

virtual void	AllocateOutputs ()
	The GenerateData method normally allocates the buffers for all of the outputs of a filter. More...

virtual void	BeforeThreadedGenerateData ()
	If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). More...

virtual void	AfterThreadedGenerateData ()
	If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). More...

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
	Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". More...

Protected Member Functions inherited from mitk::BaseDataSource
	BaseDataSource ()

	~BaseDataSource () override

Protected Attributes
Image::Pointer	m_WorkingImage

ContourModel::Pointer	m_Contour

Image::Pointer	m_DifferenceImage

int	m_FillColor

int	m_EraseColor

Additional Inherited Members
Static Protected Member Functions inherited from mitk::ImageSource
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
	Static function used as a "callback" by the MultiThreader. More...

Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer	New ()

Detailed Description

This class encapsulates an algorithm, which takes a 2D binary image and a contour. The algorithm tests if the line begins and ends inside or outside a segmentation and whether areas should be added to or subtracted from the segmentation shape.

This class has two outputs:

the modified input image from GetOutput()

The output image is a combination of the original input with the generated difference image.

See also: CorrectorTool2D

Definition at line 39 of file mitkCorrectorAlgorithm.h.

Member Typedef Documentation

◆ DefaultSegmentationDataType

typedef mitk::Label::PixelType mitk::CorrectorAlgorithm::DefaultSegmentationDataType

Definition at line 44 of file mitkCorrectorAlgorithm.h.

Constructor & Destructor Documentation

◆ CorrectorAlgorithm()

mitk::CorrectorAlgorithm::CorrectorAlgorithm ( )

protected

Definition at line 26 of file mitkCorrectorAlgorithm.cpp.

◆ ~CorrectorAlgorithm()

mitk::CorrectorAlgorithm::~CorrectorAlgorithm ( )

overrideprotected

Definition at line 30 of file mitkCorrectorAlgorithm.cpp.

Member Function Documentation

◆ Clone()

Pointer mitk::CorrectorAlgorithm::Clone ( ) const

◆ GenerateData()

void mitk::CorrectorAlgorithm::GenerateData ( )

overrideprotected

Definition at line 52 of file mitkCorrectorAlgorithm.cpp.

References AccessByItk_n, mitk::CastToItkImage(), mitk::CastToMitkImage(), ConvertBackToCorrectPixelType(), mitk::ImageToImageFilter::GetInput(), mitk::ImageSource::GetOutput(), ImprovedHeimannCorrectionAlgorithm(), m_Contour, m_EraseColor, m_WorkingImage, max(), and min().

◆ GetEraseColor()

virtual int mitk::CorrectorAlgorithm::GetEraseColor ( ) const

virtual

◆ GetFillColor()

virtual int mitk::CorrectorAlgorithm::GetFillColor ( ) const

virtual

◆ ImprovedHeimannCorrectionAlgorithm()

bool mitk::CorrectorAlgorithm::ImprovedHeimannCorrectionAlgorithm ( itk::Image< DefaultSegmentationDataType, 2 >::Pointer pic )

protected

Some documentation (not by the original author)

TobiasHeimannCorrectionAlgorithm will be called, when the user has finished drawing a freehand line.

There should be different results, depending on the line's properties:

Without any prior segmentation, the start point and the end point of the drawn line will be connected to a contour and the area enclosed by the contour will be marked as segmentation.
When the whole line is inside a segmentation, start and end point will be connected to a contour and the area of this contour will be subtracted from the segmentation.
When the line starts inside a segmentation and ends outside with only a single transition from segmentation to no-segmentation, nothing will happen.
When there are multiple transitions between inside-segmentation and outside-segmentation, the line will be divided in so called segments. Each segment is either fully inside or fully outside a segmentation. When it is inside a segmentation, its enclosed area will be subtracted from the segmentation. When the segment is outside a segmentation, its enclosed area it will be added to the segmentation.

The algorithm is described in full length in Tobias Heimann's diploma thesis (MBI Technical Report 145, p. 37 - 40).

Definition at line 133 of file mitkCorrectorAlgorithm.cpp.

References m_Contour, m_EraseColor, m_FillColor, m_WorkingImage, mitkThrow, ModifySegment(), mitk::CorrectorAlgorithm::TSegData::points, mitk::ContourModelUtils::ProjectContourTo2DSlice(), and yOffset.

Referenced by GenerateData().

◆ mitkClassMacro()

mitk::CorrectorAlgorithm::mitkClassMacro	(	CorrectorAlgorithm	,
		ImageToImageFilter
	)

◆ ModifySegment()

bool mitk::CorrectorAlgorithm::ModifySegment	(	const TSegData &	segment,
		itk::Image< DefaultSegmentationDataType, 2 >::Pointer	pic
	)

protected

Definition at line 458 of file mitkCorrectorAlgorithm.cpp.

Referenced by ImprovedHeimannCorrectionAlgorithm().

◆ New()

static Pointer mitk::CorrectorAlgorithm::New ( )

static

Referenced by mitk::CorrectorTool2D::OnMouseReleased().

◆ SetContour()

void mitk::CorrectorAlgorithm::SetContour ( ContourModel * contour )

inline

User drawn contour.

Definition at line 51 of file mitkCorrectorAlgorithm.h.

◆ SetEraseColor()

virtual void mitk::CorrectorAlgorithm::SetEraseColor ( int _arg )

virtual

◆ SetFillColor()

virtual void mitk::CorrectorAlgorithm::SetFillColor ( int _arg )

virtual

Member Data Documentation

◆ m_Contour

ContourModel::Pointer mitk::CorrectorAlgorithm::m_Contour

protected

Definition at line 83 of file mitkCorrectorAlgorithm.h.

Referenced by GenerateData(), and ImprovedHeimannCorrectionAlgorithm().

◆ m_DifferenceImage

Image::Pointer mitk::CorrectorAlgorithm::m_DifferenceImage

protected

Definition at line 84 of file mitkCorrectorAlgorithm.h.

◆ m_EraseColor

int mitk::CorrectorAlgorithm::m_EraseColor

protected

Definition at line 87 of file mitkCorrectorAlgorithm.h.

Referenced by GenerateData(), and ImprovedHeimannCorrectionAlgorithm().

◆ m_FillColor

int mitk::CorrectorAlgorithm::m_FillColor

protected

Definition at line 86 of file mitkCorrectorAlgorithm.h.

Referenced by ImprovedHeimannCorrectionAlgorithm().

◆ m_WorkingImage

Image::Pointer mitk::CorrectorAlgorithm::m_WorkingImage

protected

Definition at line 82 of file mitkCorrectorAlgorithm.h.

Referenced by GenerateData(), and ImprovedHeimannCorrectionAlgorithm().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DefaultSegmentationDataType

Constructor & Destructor Documentation

◆ CorrectorAlgorithm()

◆ ~CorrectorAlgorithm()

Member Function Documentation

◆ Clone()

◆ GenerateData()

◆ GetEraseColor()

◆ GetFillColor()

◆ ImprovedHeimannCorrectionAlgorithm()

◆ mitkClassMacro()

◆ ModifySegment()

◆ New()

◆ SetContour()

◆ SetEraseColor()

◆ SetFillColor()

Member Data Documentation

◆ m_Contour

◆ m_DifferenceImage

◆ m_EraseColor

◆ m_FillColor

◆ m_WorkingImage