Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::SymmetricForcesDemonsRegistration Class Reference

This class performes a symmetric forces demons registration between two images with the same modality. More...

#include <mitkSymmetricForcesDemonsRegistration.h>

Inheritance diagram for mitk::SymmetricForcesDemonsRegistration:
Collaboration diagram for mitk::SymmetricForcesDemonsRegistration:

Public Member Functions

 mitkClassMacro (SymmetricForcesDemonsRegistration, RegistrationBase)
 
Pointer Clone () const
 
void SetNumberOfIterations (int iterations)
 Sets the number of iterations which will be performed during the registration process. More...
 
void SetStandardDeviation (float deviation)
 Sets the standard deviation used by the symmetric forces demons registration. More...
 
void SetSaveDeformationField (bool saveField)
 Sets whether the resulting deformation field should be saved or not. More...
 
void SetDeformationFieldFileName (const char *fieldName)
 Sets the filename for the resulting deformation field. More...
 
void SetSaveResult (bool saveResult)
 Sets whether the result should be saved or not. More...
 
void SetResultFileName (const char *resultName)
 Sets the filename for the resulting deformed image. More...
 
itk::Image< class itk::Vector< float, 3 >, 3 >::Pointer GetDeformationField ()
 Returns the deformation field, which results by the registration. More...
 
virtual void GenerateData () override
 Starts the symmetric forces demons registration. More...
 
- Public Member Functions inherited from mitk::RegistrationBase
 mitkClassMacro (RegistrationBase, ImageToImageFilter)
 
Pointer Clone () const
 
virtual void SetReferenceImage (Image::Pointer fixedImage)
 Sets the reference image (fixed image) for the registration. More...
 
- 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)
 
InputImageTypeGetInput (void)
 
InputImageTypeGetInput (unsigned int idx)
 
const InputImageTypeGetInput (void) const
 
const InputImageTypeGetInput (unsigned int idx) const
 
- Public Member Functions inherited from mitk::ImageSource
Pointer Clone () const
 
OutputTypeGetOutput ()
 Get the output data of this image source object. More...
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 Make a DataObject of the correct type to used as the specified output. More...
 
virtual itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
virtual vtkImageData * GetVtkImageData ()
 
virtual const vtkImageData * GetVtkImageData () const
 
- Public Member Functions inherited from mitk::BaseDataSource
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (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 ()
 Method for creation through the object factory. More...
 
- Static Public Member Functions inherited from mitk::RegistrationBase
static Pointer New ()
 Method for creation through the object factory. More...
 
- 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

 SymmetricForcesDemonsRegistration ()
 Default constructor. More...
 
virtual ~SymmetricForcesDemonsRegistration ()
 Default destructor. More...
 
template<typename TPixel , unsigned int VImageDimension>
void GenerateData2 (const itk::Image< TPixel, VImageDimension > *itkImage1)
 Template class to perform the symmetric forces demons registration with any kind of image. Called by GenerateData(). More...
 
- Protected Member Functions inherited from mitk::RegistrationBase
 RegistrationBase ()
 Default constructor. More...
 
virtual ~RegistrationBase ()
 Default destructor. More...
 
virtual void AddStepsToDo (int steps)
 Adds steps to the progress bar, which will be done with AddStepsToDo(int steps) and SetRemainingProgress(int steps) More...
 
virtual void SetProgress (const itk::EventObject &)
 Sets one step of progress to the progress bar. More...
 
virtual void SetRemainingProgress (int steps)
 Sets the remaining progress to the progress bar. More...
 
- Protected Member Functions inherited from mitk::ImageToImageFilter
 ImageToImageFilter ()
 
virtual ~ImageToImageFilter ()
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
virtual void GenerateInputRequestedRegion () override
 
- Protected Member Functions inherited from mitk::ImageSource
 ImageSource ()
 
virtual ~ImageSource ()
 
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...
 
virtual 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 ()
 
virtual ~BaseDataSource ()
 

Protected Attributes

int m_Iterations
 
float m_StandardDeviation
 
const char * m_FieldName
 
const char * m_ResultName
 
bool m_SaveField
 
bool m_SaveResult
 
itk::Image< class itk::Vector< float, 3 >, 3 >::Pointer m_DeformationField
 
- Protected Attributes inherited from mitk::RegistrationBase
Image::Pointer m_ReferenceImage
 

Additional Inherited Members

- Public Types inherited from mitk::ImageToImageFilter
typedef ImageToImageFilter Self
 
typedef ImageSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef BaseData OutputType
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 
- 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 performes a symmetric forces demons registration between two images with the same modality.

Author
Daniel Stein

Definition at line 36 of file mitkSymmetricForcesDemonsRegistration.h.

Constructor & Destructor Documentation

mitk::SymmetricForcesDemonsRegistration::SymmetricForcesDemonsRegistration ( )
protected

Default constructor.

Definition at line 28 of file mitkSymmetricForcesDemonsRegistration.cpp.

mitk::SymmetricForcesDemonsRegistration::~SymmetricForcesDemonsRegistration ( )
protectedvirtual

Default destructor.

Definition at line 39 of file mitkSymmetricForcesDemonsRegistration.cpp.

Member Function Documentation

Pointer mitk::SymmetricForcesDemonsRegistration::Clone ( ) const
virtual void mitk::SymmetricForcesDemonsRegistration::GenerateData ( )
inlineoverridevirtual

Starts the symmetric forces demons registration.

Reimplemented from mitk::ImageSource.

Definition at line 84 of file mitkSymmetricForcesDemonsRegistration.h.

References AccessByItk.

template<typename TPixel , unsigned int VImageDimension>
void mitk::SymmetricForcesDemonsRegistration::GenerateData2 ( const itk::Image< TPixel, VImageDimension > *  itkImage1)
protected
itk::Image< class itk::Vector< float, 3 >, 3 >::Pointer mitk::SymmetricForcesDemonsRegistration::GetDeformationField ( )

Returns the deformation field, which results by the registration.

Definition at line 50 of file mitkSymmetricForcesDemonsRegistration.cpp.

References m_DeformationField.

mitk::SymmetricForcesDemonsRegistration::mitkClassMacro ( SymmetricForcesDemonsRegistration  ,
RegistrationBase   
)
static Pointer mitk::SymmetricForcesDemonsRegistration::New ( )
static

Method for creation through the object factory.

Referenced by QmitkDemonsRegistrationView::CalculateTransformation().

void mitk::SymmetricForcesDemonsRegistration::SetDeformationFieldFileName ( const char *  fieldName)

Sets the filename for the resulting deformation field.

Definition at line 43 of file mitkSymmetricForcesDemonsRegistration.cpp.

References m_FieldName.

void mitk::SymmetricForcesDemonsRegistration::SetNumberOfIterations ( int  iterations)

Sets the number of iterations which will be performed during the registration process.

Definition at line 40 of file mitkSymmetricForcesDemonsRegistration.cpp.

References m_Iterations.

void mitk::SymmetricForcesDemonsRegistration::SetResultFileName ( const char *  resultName)

Sets the filename for the resulting deformed image.

Definition at line 49 of file mitkSymmetricForcesDemonsRegistration.cpp.

References m_ResultName.

void mitk::SymmetricForcesDemonsRegistration::SetSaveDeformationField ( bool  saveField)

Sets whether the resulting deformation field should be saved or not.

Definition at line 42 of file mitkSymmetricForcesDemonsRegistration.cpp.

References m_SaveField.

void mitk::SymmetricForcesDemonsRegistration::SetSaveResult ( bool  saveResult)

Sets whether the result should be saved or not.

Definition at line 48 of file mitkSymmetricForcesDemonsRegistration.cpp.

References m_SaveResult.

void mitk::SymmetricForcesDemonsRegistration::SetStandardDeviation ( float  deviation)

Sets the standard deviation used by the symmetric forces demons registration.

Definition at line 41 of file mitkSymmetricForcesDemonsRegistration.cpp.

References m_StandardDeviation.

Member Data Documentation

itk::Image<class itk::Vector<float, 3>, 3>::Pointer mitk::SymmetricForcesDemonsRegistration::m_DeformationField
protected

Definition at line 116 of file mitkSymmetricForcesDemonsRegistration.h.

Referenced by GenerateData2(), and GetDeformationField().

const char* mitk::SymmetricForcesDemonsRegistration::m_FieldName
protected
int mitk::SymmetricForcesDemonsRegistration::m_Iterations
protected
const char* mitk::SymmetricForcesDemonsRegistration::m_ResultName
protected

Definition at line 113 of file mitkSymmetricForcesDemonsRegistration.h.

Referenced by GenerateData2(), and SetResultFileName().

bool mitk::SymmetricForcesDemonsRegistration::m_SaveField
protected
bool mitk::SymmetricForcesDemonsRegistration::m_SaveResult
protected

Definition at line 115 of file mitkSymmetricForcesDemonsRegistration.h.

Referenced by GenerateData2(), and SetSaveResult().

float mitk::SymmetricForcesDemonsRegistration::m_StandardDeviation
protected

Definition at line 111 of file mitkSymmetricForcesDemonsRegistration.h.

Referenced by GenerateData2(), and SetStandardDeviation().


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