SIRF  3.4.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
sirf::SPMRegistration< dataType > Class Template Reference

Wrapper around SPM's registration class. More...

#include "SPMRegistration.h"

Inheritance diagram for sirf::SPMRegistration< dataType >:
sirf::NiftiBasedRegistration< dataType > sirf::Registration< dataType >

Public Member Functions

virtual ~SPMRegistration ()
 Destructor.
 
void process ()
 Process.
 
void set_working_folder (const std::string &working_folder)
 Set working folder.
 
void set_working_folder_file_overwrite (const bool working_folder_overwrite)
 Set file overwrite in working folder.
 
void set_delete_temp_files (const bool delete_temp_files)
 Delete temporary files.
 
virtual const std::shared_ptr< const ImageDataget_output_sptr (const unsigned idx=0) const
 Get registered image.
 
virtual const std::shared_ptr< const AffineTransformation< float > > get_transformation_matrix_forward_sptr (const unsigned idx=0) const
 Get forwards transformation matrix.
 
virtual const std::shared_ptr< const AffineTransformation< float > > get_transformation_matrix_inverse_sptr (const unsigned idx=0) const
 Get inverse transformation matrix.
 
virtual const std::shared_ptr< const Transformation< dataType > > get_deformation_field_forward_sptr (const unsigned idx=0) const
 Get forward deformation field image.
 
virtual const std::shared_ptr< const Transformation< dataType > > get_deformation_field_inverse_sptr (const unsigned idx=0) const
 Get inverse deformation field image.
 
- Public Member Functions inherited from sirf::NiftiBasedRegistration< dataType >
 NiftiBasedRegistration ()
 Constructor.
 
virtual ~NiftiBasedRegistration ()
 Destructor.
 
virtual const std::shared_ptr< const Transformation< dataType > > get_displacement_field_forward_sptr (const unsigned idx=0) const
 Get forward displacement field image.
 
virtual const std::shared_ptr< const Transformation< dataType > > get_displacement_field_inverse_sptr (const unsigned idx=0) const
 Get inverse displacement field image.
 
- Public Member Functions inherited from sirf::Registration< dataType >
 Registration ()
 Constructor.
 
virtual ~Registration ()
 Destructor.
 
void set_reference_image (const std::shared_ptr< const ImageData > reference_image_sptr)
 Set reference image.
 
void set_floating_image (const std::shared_ptr< const ImageData > floating_image_sptr)
 Set floating image. Will clear any previous floating images.
 
void add_floating_image (const std::shared_ptr< const ImageData > floating_image_sptr)
 Add floating image.
 
void set_reference_image_filename (const std::string &filename)
 Set reference image filename. Will be read as NiftiImageData.
 
void set_floating_image_filename (const std::string &filename)
 Set floating image filename. Will be read as NiftiImageData.
 
void add_floating_image_filename (const std::string &filename)
 Add floating image filename. Will be read as NiftiImageData.
 
void clear_floating_images ()
 Clear floating images.
 

Protected Member Functions

virtual void parse_parameter_file ()
 Parse parameter file.
 
virtual void check_parameters () const
 Check parameters.
 
virtual void set_parameters ()
 Set any extra parameters.
 

Protected Attributes

std::string _working_folder = ""
 working folder
 
bool _working_folder_overwrite = false
 Overwrite files already in working folder.
 
bool _delete_temp_files = false
 Delete temp files.
 
std::vector< std::shared_ptr< AffineTransformation< float > > > _TMs_fwd
 Forwards transformation matrix.
 
std::vector< std::shared_ptr< AffineTransformation< float > > > _TMs_inv
 Inverse transformation matrix.
 
std::unique_ptr< matlab::engine::MATLABEngine > _matlab_uptr
 Matlab instance.
 
std::vector< std::string > _filenames_to_delete
 Filenames to potentially delete.
 
std::vector< std::string > _folders_to_delete
 Folders to potentially delete.
 
std::vector< std::string > _resliced_filenames
 Resliced images.
 
- Protected Attributes inherited from sirf::NiftiBasedRegistration< dataType >
std::shared_ptr< const NiftiImageData3D< dataType > > _reference_image_nifti_sptr
 Reference image (as NiftiImageData3D)
 
std::vector< std::shared_ptr< const NiftiImageData3D< dataType > > > _floating_images_nifti
 Floating image (as NiftiImageData3D)
 
std::vector< std::shared_ptr< NiftiImageData3D< dataType > > > _warped_images_nifti
 Output (as NiftiImageData3D)
 
- Protected Attributes inherited from sirf::Registration< dataType >
std::shared_ptr< const ImageData_reference_image_sptr
 Reference image.
 
std::vector< std::shared_ptr< const ImageData > > _floating_images
 Floating image.
 
std::vector< std::shared_ptr< ImageData > > _warped_images
 Warped image.
 
std::vector< std::shared_ptr< Transformation< dataType > > > _def_fwd_images
 Forward deformation field image.
 
std::string _reference_image_filename = ""
 Reference image filename.
 
std::vector< std::string > _floating_image_filenames
 Floating image filenames.
 

Additional Inherited Members

- Static Public Member Functions inherited from sirf::NiftiBasedRegistration< dataType >
static void convert_to_NiftiImageData_if_not_already (std::shared_ptr< const NiftiImageData3D< dataType > > &output_sptr, const std::shared_ptr< const ImageData > &input_sptr)
 Convert an ImageData to NiftiImageData. Try to dynamic pointer cast, else create new image.
 

Detailed Description

template<class dataType>
class sirf::SPMRegistration< dataType >

Wrapper around SPM's registration class.

Author
Richard Brown
SyneRBI

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