SIRF  3.6.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
sirf::NiftyF3dSym< dataType > Class Template Reference

NiftyReg's f3d class for non-rigid registrations. More...

#include "NiftyF3dSym.h"

Inheritance diagram for sirf::NiftyF3dSym< dataType >:
sirf::NiftyRegistration< dataType > sirf::NiftiBasedRegistration< dataType > sirf::Registration< dataType >

Public Member Functions

 NiftyF3dSym ()
 Constructor.
 
void process ()
 Process.
 
void set_floating_time_point (const int floating_time_point)
 Set floating time point.
 
void set_reference_time_point (const int reference_time_point)
 Set reference time point.
 
void set_use_symmetric (const bool use_symmetric)
 
void set_initial_affine_transformation (const std::shared_ptr< const AffineTransformation< float > > mat)
 Set initial affine transformation.
 
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::NiftyRegistration< dataType >
 NiftyRegistration ()
 Constructor.
 
virtual ~NiftyRegistration ()
 Destructor.
 
void set_parameter_file (const std::string &parameter_filename)
 Set parameter file.
 
void set_parameter (const std::string &par, const std::string &arg1="", const std::string &arg2="")
 
void set_reference_mask (const std::shared_ptr< const ImageData > reference_mask_sptr)
 Set reference mask.
 
void set_floating_mask (const std::shared_ptr< const ImageData > floating_mask_sptr)
 Set floating mask.
 
- 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.
 
virtual const std::shared_ptr< const ImageDataget_output_sptr (const unsigned idx=0) const
 Get registered image.
 
virtual const std::shared_ptr< const Transformation< dataType > > get_deformation_field_forward_sptr (const unsigned idx=0) const
 Get forward deformation field image.
 

Static Public Member Functions

static void print_all_wrapped_methods ()
 Print all wrapped methods.
 
- 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.
 

Protected Member Functions

virtual void check_parameters () const
 Check parameters.
 
virtual void parse_parameter_file ()
 Parse parameter file.
 
void set_parameters ()
 Set extra parameters.
 
- Protected Member Functions inherited from sirf::NiftyRegistration< dataType >
void set_up_inputs ()
 Set up inputs.
 

Protected Attributes

std::shared_ptr< reg_f3d< dataType > > _registration_sptr
 Registration object.
 
int _floating_time_point
 Floating time point.
 
int _reference_time_point
 Reference time point.
 
bool _use_symmetric = false
 Use symmetric bool.
 
std::shared_ptr< const AffineTransformation< float > > _initial_transformation_sptr
 Transformation matrix.
 
- Protected Attributes inherited from sirf::NiftyRegistration< dataType >
std::vector< std::string > _extra_params
 Store extra parameters. Only apply them after parsing.
 
std::string _parameter_filename
 Parameter filename.
 
std::shared_ptr< const ImageData_floating_mask_sptr
 Floating mask.
 
std::shared_ptr< const ImageData_reference_mask_sptr
 Reference mask.
 
std::shared_ptr< const NiftiImageData3D< dataType > > _floating_mask_nifti_sptr
 Floating mask (as NiftiImageData3D)
 
std::shared_ptr< const NiftiImageData3D< dataType > > _reference_mask_nifti_sptr
 Reference mask (as NiftiImageData3D)
 
- 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.
 

Detailed Description

template<class dataType>
class sirf::NiftyF3dSym< dataType >

NiftyReg's f3d class for non-rigid registrations.

User can set an initial affine transformation if desired.

In theory, multiple time points can be used, but thus far has only been tested for t == 1 for both reference and floating images.

Author
Richard Brown
SyneRBI

Member Function Documentation

◆ set_use_symmetric()

template<class dataType >
void sirf::NiftyF3dSym< dataType >::set_use_symmetric ( const bool  use_symmetric)
inline

Set use symmetric. Default is false. No need to expose to python/matlab until https://github.com/KCL-BMEIS/niftyreg/issues/71 is closed.


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