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

Main class for the rigid registration pipeline. More...

#include <mitkImageRegistrationMethod.h>

Inheritance diagram for mitk::ImageRegistrationMethod:
Collaboration diagram for mitk::ImageRegistrationMethod:

Public Types

typedef itk::SingleValuedNonLinearOptimizer OptimizerType
 
typedef itk::ImageMaskSpatialObject< 3 > MaskType
 
- 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
 

Public Member Functions

 mitkClassMacro (ImageRegistrationMethod, ImageToImageFilter)
 
Pointer Clone () const
 
void SetObserver (RigidRegistrationObserver::Pointer observer)
 
void SetInterpolator (int interpolator)
 
virtual void GenerateData () override
 A version of GenerateData() specific for image processing filters. More...
 
virtual void SetReferenceImage (Image::Pointer fixedImage)
 
virtual void SetFixedMask (Image::Pointer fixedMask)
 
virtual void SetMovingMask (Image::Pointer movingMask)
 
void SetOptimizerScales (itk::Array< double > scales)
 
void SetTransform (itk::Object::Pointer transform)
 
void SetMetric (itk::Object::Pointer metric)
 
void SetOptimizer (itk::Object::Pointer optimizer)
 
void SetNumberOfLevels (unsigned int levels)
 
- 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 ()
 
- 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 ()
 

Static Public Attributes

static const int LINEARINTERPOLATOR
 
static const int NEARESTNEIGHBORINTERPOLATOR
 

Protected Member Functions

 ImageRegistrationMethod ()
 
virtual ~ImageRegistrationMethod ()
 
virtual void GenerateOutputInformation () override
 
- 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

RigidRegistrationObserver::Pointer m_Observer
 
int m_Interpolator
 
Image::Pointer m_ReferenceImage
 
Image::Pointer m_FixedMask
 
Image::Pointer m_MovingMask
 

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

Main class for the rigid registration pipeline.

Author
Daniel Stein

Definition at line 41 of file mitkImageRegistrationMethod.h.

Member Typedef Documentation

typedef itk::ImageMaskSpatialObject<3> mitk::ImageRegistrationMethod::MaskType

Definition at line 45 of file mitkImageRegistrationMethod.h.

typedef itk::SingleValuedNonLinearOptimizer mitk::ImageRegistrationMethod::OptimizerType

Definition at line 44 of file mitkImageRegistrationMethod.h.

Constructor & Destructor Documentation

mitk::ImageRegistrationMethod::ImageRegistrationMethod ( )
protected

Definition at line 22 of file mitkImageRegistrationMethod.cpp.

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

mitk::ImageRegistrationMethod::~ImageRegistrationMethod ( )
protectedvirtual

Definition at line 28 of file mitkImageRegistrationMethod.cpp.

Member Function Documentation

Pointer mitk::ImageRegistrationMethod::Clone ( ) const
void mitk::ImageRegistrationMethod::GenerateData ( )
overridevirtual

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

This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also
ThreadedGenerateData()

Reimplemented from mitk::ImageSource.

Definition at line 29 of file mitkImageRegistrationMethod.cpp.

References mitk::ImageToImageFilter::GetInput(), and ImageRegistrationMethodAccessFunctor.

virtual void mitk::ImageRegistrationMethod::GenerateOutputInformation ( void  )
inlineoverrideprotectedvirtual

Definition at line 88 of file mitkImageRegistrationMethod.h.

mitk::ImageRegistrationMethod::mitkClassMacro ( ImageRegistrationMethod  ,
ImageToImageFilter   
)
static Pointer mitk::ImageRegistrationMethod::New ( )
static
void mitk::ImageRegistrationMethod::SetFixedMask ( Image::Pointer  fixedMask)
virtual

Definition at line 53 of file mitkImageRegistrationMethod.cpp.

References m_FixedMask.

void mitk::ImageRegistrationMethod::SetInterpolator ( int  interpolator)

Definition at line 38 of file mitkImageRegistrationMethod.cpp.

References m_Interpolator.

void mitk::ImageRegistrationMethod::SetMetric ( itk::Object::Pointer  metric)

Definition at line 67 of file mitkImageRegistrationMethod.cpp.

void mitk::ImageRegistrationMethod::SetMovingMask ( Image::Pointer  movingMask)
virtual

Definition at line 46 of file mitkImageRegistrationMethod.cpp.

References m_MovingMask.

void mitk::ImageRegistrationMethod::SetNumberOfLevels ( unsigned int  levels)

Definition at line 75 of file mitkImageRegistrationMethod.cpp.

void mitk::ImageRegistrationMethod::SetObserver ( RigidRegistrationObserver::Pointer  observer)

Definition at line 37 of file mitkImageRegistrationMethod.cpp.

References m_Observer.

void mitk::ImageRegistrationMethod::SetOptimizer ( itk::Object::Pointer  optimizer)

Definition at line 68 of file mitkImageRegistrationMethod.cpp.

void mitk::ImageRegistrationMethod::SetOptimizerScales ( itk::Array< double >  scales)

Definition at line 69 of file mitkImageRegistrationMethod.cpp.

void mitk::ImageRegistrationMethod::SetReferenceImage ( Image::Pointer  fixedImage)
virtual

Definition at line 39 of file mitkImageRegistrationMethod.cpp.

References m_ReferenceImage.

void mitk::ImageRegistrationMethod::SetTransform ( itk::Object::Pointer  transform)

Definition at line 60 of file mitkImageRegistrationMethod.cpp.

References MITK_INFO.

Member Data Documentation

const int mitk::ImageRegistrationMethod::LINEARINTERPOLATOR
static

Definition at line 51 of file mitkImageRegistrationMethod.h.

Image::Pointer mitk::ImageRegistrationMethod::m_FixedMask
protected

Definition at line 85 of file mitkImageRegistrationMethod.h.

Referenced by SetFixedMask().

int mitk::ImageRegistrationMethod::m_Interpolator
protected

Definition at line 83 of file mitkImageRegistrationMethod.h.

Referenced by SetInterpolator().

Image::Pointer mitk::ImageRegistrationMethod::m_MovingMask
protected

Definition at line 86 of file mitkImageRegistrationMethod.h.

Referenced by SetMovingMask().

RigidRegistrationObserver::Pointer mitk::ImageRegistrationMethod::m_Observer
protected

Definition at line 82 of file mitkImageRegistrationMethod.h.

Referenced by SetObserver().

Image::Pointer mitk::ImageRegistrationMethod::m_ReferenceImage
protected

Definition at line 84 of file mitkImageRegistrationMethod.h.

Referenced by ImageRegistrationMethod(), and SetReferenceImage().

const int mitk::ImageRegistrationMethod::NEARESTNEIGHBORINTERPOLATOR
static

Definition at line 52 of file mitkImageRegistrationMethod.h.


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