Developer documentation
Version 3.0.3-105-gd3941f44
MR::Registration Namespace Reference

Namespaces

namespace  Metric
 
 
namespace  Transform
 
namespace  Warp
 

Classes

class  Linear
 
struct  MultiContrastSetting
 
class  NonLinear
 
struct  StageSetting
 

Enumerations

enum  LinearMetricType { Diff , NCC }
 
enum  LinearRobustMetricEstimatorType { L1 , L2 , LP , None }
 
enum  OptimiserAlgoType { bbgd , gd , none }
 

Functions

void set_init_translation_model_from_option (Registration::Linear &registration, const int &option)
 
void set_init_rotation_model_from_option (Registration::Linear &registration, const int &option)
 
void parse_general_options (Registration::Linear &registration)
 
FORCE_INLINE void check_image_output (const std::string &image_name, const Header &reference)
 
std::ostream & operator<< (std::ostream &o, const MultiContrastSetting &a)
 
void preload_data (vector< Header > &input, Image< default_type > &images, const vector< MultiContrastSetting > &mc_params)
 
template<class ImageType >
FORCE_INLINE ImageType multi_resolution_lmax (ImageType &input, const default_type scale_factor, const bool do_reorientation=false, const uint32_t lmax=0)
 
template<class ImageType >
FORCE_INLINE ImageType multi_resolution_lmax (ImageType &input, const default_type scale_factor, const bool do_reorientation, const vector< MultiContrastSetting > &contrast, vector< MultiContrastSetting > *contrast_updated=nullptr)
 

Variables

const App::OptionGroup adv_init_options
 
const App::OptionGroup lin_stage_options
 
const App::OptionGroup rigid_options
 
const App::OptionGroup affine_options
 
const App::OptionGroup fod_options
 
const char * optim_algo_names []
 
const App::OptionGroup nonlinear_options
 
const OptionGroup multiContrastOptions
 

Enumeration Type Documentation

◆ LinearMetricType

Enumerator
Diff 
NCC 

Definition at line 58 of file linear.h.

◆ LinearRobustMetricEstimatorType

Enumerator
L1 
L2 
LP 
None 

Definition at line 59 of file linear.h.

◆ OptimiserAlgoType

Enumerator
bbgd 
gd 
none 

Definition at line 60 of file linear.h.

Function Documentation

◆ check_image_output()

FORCE_INLINE void MR::Registration::check_image_output ( const std::string &  image_name,
const Header reference 
)

Definition at line 39 of file multi_contrast.h.

◆ multi_resolution_lmax() [1/2]

template<class ImageType >
FORCE_INLINE ImageType MR::Registration::multi_resolution_lmax ( ImageType &  input,
const default_type  scale_factor,
const bool  do_reorientation,
const vector< MultiContrastSetting > &  contrast,
vector< MultiContrastSetting > *  contrast_updated = nullptr 
)

Definition at line 60 of file multi_resolution_lmax.h.

◆ multi_resolution_lmax() [2/2]

template<class ImageType >
FORCE_INLINE ImageType MR::Registration::multi_resolution_lmax ( ImageType &  input,
const default_type  scale_factor,
const bool  do_reorientation = false,
const uint32_t  lmax = 0 
)

Definition at line 31 of file multi_resolution_lmax.h.

◆ operator<<()

std::ostream & MR::Registration::operator<< ( std::ostream &  o,
const MultiContrastSetting a 
)
inline

Definition at line 102 of file multi_contrast.h.

◆ parse_general_options()

void MR::Registration::parse_general_options ( Registration::Linear registration)

◆ preload_data()

void MR::Registration::preload_data ( vector< Header > &  input,
Image< default_type > &  images,
const vector< MultiContrastSetting > &  mc_params 
)

◆ set_init_rotation_model_from_option()

void MR::Registration::set_init_rotation_model_from_option ( Registration::Linear registration,
const int &  option 
)

◆ set_init_translation_model_from_option()

void MR::Registration::set_init_translation_model_from_option ( Registration::Linear registration,
const int &  option 
)

Variable Documentation

◆ adv_init_options

const App::OptionGroup MR::Registration::adv_init_options
extern

◆ affine_options

const App::OptionGroup MR::Registration::affine_options
extern

◆ fod_options

const OptionGroup MR::Registration::fod_options
Initial value:
=
OptionGroup ("FOD registration options")
+ Option ("directions", "the directions used for FOD reorienation using apodised point spread functions (Default: 60 directions)")
+ Argument ("file", "a list of directions [az el] generated using the gendir command.").type_file_in ()
+ Option ("noreorientation", "turn off FOD reorientation. Reorientation is on by default if the number "
"of volumes in the 4th dimension corresponds to the number of coefficients in an "
"antipodally symmetric spherical harmonic series (i.e. 6, 15, 28, 45, 66 etc")
A class to specify a command-line argument.
Argument & type_file_in()
specifies that the argument should be an input file
a class to hold a named list of Option's
A class to specify a command-line option.

Definition at line 35 of file shared.h.

◆ lin_stage_options

const App::OptionGroup MR::Registration::lin_stage_options
extern

◆ multiContrastOptions

const OptionGroup MR::Registration::multiContrastOptions
Initial value:
=
OptionGroup ("Multi-contrast options")
+ Option ("mc_weights", "relative weight of images used for multi-contrast registration. Default: 1.0 (equal weighting)")
+ Argument ("weights").type_sequence_float ()
Argument & type_sequence_float()
specifies that the argument should be a sequence of comma-separated floating-point values.

Definition at line 30 of file shared.h.

◆ nonlinear_options

const App::OptionGroup MR::Registration::nonlinear_options
extern

◆ optim_algo_names

const char* MR::Registration::optim_algo_names[]
extern

◆ rigid_options

const App::OptionGroup MR::Registration::rigid_options
extern