shapeworks::OptimizeParameters

#include <OptimizeParameters.h>

Public Functions

	Name
	OptimizeParameters(ProjectHandle project)
void	save_to_project()
std::string	get_optimize_output_prefix()
void	set_optimize_output_prefix(std::string prefix)
std::vector< int >	get_number_of_particles()
void	set_number_of_particles(std::vector< int > number_of_particles)
double	get_initial_relative_weighting()
void	set_initial_relative_weighting(double value)
double	get_relative_weighting()
void	set_relative_weighting(double value)
double	get_starting_regularization()
void	set_starting_regularization(double value)
double	get_ending_regularization()
void	set_ending_regularization(double value)
int	get_iterations_per_split()
void	set_iterations_per_split(int value)
int	get_optimization_iterations()
void	set_optimization_iterations(int value)
bool	get_use_geodesic_distance()
void	set_use_geodesic_distance(bool value)
int	get_geodesic_cache_multiplier()
void	set_geodesic_cache_multiplier(int value)
std::vector< bool >	get_use_normals()
void	set_use_normals(std::vector< bool > use_normals)
double	get_normals_strength()
void	set_normals_strength(double value)
bool	get_use_disentangled_ssm()
void	set_use_disentangled_ssm(bool value)
bool	get_use_procrustes()
void	set_use_procrustes(bool value)
bool	get_use_procrustes_scaling()
void	set_use_procrustes_scaling(bool value)
bool	get_use_procrustes_rotation_translation()
void	set_use_procrustes_rotation_translation(bool value)
int	get_procrustes_interval()
void	set_procrustes_interval(int value)
bool	get_use_multiscale()
void	set_use_multiscale(bool value)
int	get_multiscale_particles()
void	set_multiscale_particles(int value)
double	get_narrow_band()
void	set_narrow_band(double value)
int	get_verbosity()
void	set_verbosity(int value)
bool	get_mesh_ffc_mode()
void	set_mesh_ffc_mode(bool value)
bool	get_use_landmarks()
void	set_use_landmarks(bool value)
bool	get_use_fixed_subjects()
void	set_use_fixed_subjects(bool value)
std::string	get_fixed_subjects_column()
void	set_fixed_subject_column(std::string column)
std::string	get_fixed_subjects_choice()
void	set_fixed_subjects_choice(std::string choice)
void	set_abort_load(bool value)
void	set_load_callback(const std::function< void(int)> & f)
bool	set_up_optimize(Optimize * optimize)
bool	is_subject_fixed(std::shared_ptr< Subject > subject)
int	get_checkpoint_interval()
void	set_checkpoint_interval(int iterations)
bool	get_save_init_splits()
void	set_save_init_splits(bool enabled)
bool	get_keep_checkpoints()
void	set_keep_checkpoints(bool enabled)
std::vector< std::string >	get_field_attributes()
void	set_field_attributes(std::vector< std::string > attributes)
std::vector< double >	get_field_attribute_weights()
void	set_field_attribute_weights(std::vector< double > weights)
bool	get_use_geodesics_to_landmarks()
void	set_use_geodesics_to_landmarks(bool value)
double	get_geodesic_to_landmarks_weight()
void	set_geodesic_to_landmarks_weight(double value)
std::string	get_particle_format()
void	set_particle_format(std::string format)
double	get_geodesic_remesh_percent()
void	set_geodesic_remesh_percent(double value)

Detailed Description

class shapeworks::OptimizeParameters;

This class encapsulated processing of Optimization parameters

Public Functions Documentation

function OptimizeParameters

explicit OptimizeParameters(
    ProjectHandle project
)

function save_to_project

void save_to_project()

function get_optimize_output_prefix

std::string get_optimize_output_prefix()

function set_optimize_output_prefix

void set_optimize_output_prefix(
    std::string prefix
)

function get_number_of_particles

std::vector< int > get_number_of_particles()

function set_number_of_particles

void set_number_of_particles(
    std::vector< int > number_of_particles
)

function get_initial_relative_weighting

double get_initial_relative_weighting()

function set_initial_relative_weighting

void set_initial_relative_weighting(
    double value
)

function get_relative_weighting

double get_relative_weighting()

function set_relative_weighting

void set_relative_weighting(
    double value
)

function get_starting_regularization

double get_starting_regularization()

function set_starting_regularization

void set_starting_regularization(
    double value
)

function get_ending_regularization

double get_ending_regularization()

function set_ending_regularization

void set_ending_regularization(
    double value
)

function get_iterations_per_split

int get_iterations_per_split()

function set_iterations_per_split

void set_iterations_per_split(
    int value
)

function get_optimization_iterations

int get_optimization_iterations()

function set_optimization_iterations

void set_optimization_iterations(
    int value
)

function get_use_geodesic_distance

bool get_use_geodesic_distance()

function set_use_geodesic_distance

void set_use_geodesic_distance(
    bool value
)

function get_geodesic_cache_multiplier

int get_geodesic_cache_multiplier()

function set_geodesic_cache_multiplier

void set_geodesic_cache_multiplier(
    int value
)

function get_use_normals

std::vector< bool > get_use_normals()

function set_use_normals

void set_use_normals(
    std::vector< bool > use_normals
)

function get_normals_strength

double get_normals_strength()

function set_normals_strength

void set_normals_strength(
    double value
)

function get_use_disentangled_ssm

bool get_use_disentangled_ssm()

function set_use_disentangled_ssm

void set_use_disentangled_ssm(
    bool value
)

function get_use_procrustes

bool get_use_procrustes()

function set_use_procrustes

void set_use_procrustes(
    bool value
)

function get_use_procrustes_scaling

bool get_use_procrustes_scaling()

function set_use_procrustes_scaling

void set_use_procrustes_scaling(
    bool value
)

function get_use_procrustes_rotation_translation

bool get_use_procrustes_rotation_translation()

function set_use_procrustes_rotation_translation

void set_use_procrustes_rotation_translation(
    bool value
)

function get_procrustes_interval

int get_procrustes_interval()

function set_procrustes_interval

void set_procrustes_interval(
    int value
)

function get_use_multiscale

bool get_use_multiscale()

function set_use_multiscale

void set_use_multiscale(
    bool value
)

function get_multiscale_particles

int get_multiscale_particles()

function set_multiscale_particles

void set_multiscale_particles(
    int value
)

function get_narrow_band

double get_narrow_band()

function set_narrow_band

void set_narrow_band(
    double value
)

function get_verbosity

int get_verbosity()

function set_verbosity

void set_verbosity(
    int value
)

function get_mesh_ffc_mode

bool get_mesh_ffc_mode()

function set_mesh_ffc_mode

void set_mesh_ffc_mode(
    bool value
)

function get_use_landmarks

bool get_use_landmarks()

function set_use_landmarks

void set_use_landmarks(
    bool value
)

function get_use_fixed_subjects

bool get_use_fixed_subjects()

function set_use_fixed_subjects

void set_use_fixed_subjects(
    bool value
)

function get_fixed_subjects_column

std::string get_fixed_subjects_column()

function set_fixed_subject_column

void set_fixed_subject_column(
    std::string column
)

function get_fixed_subjects_choice

std::string get_fixed_subjects_choice()

function set_fixed_subjects_choice

void set_fixed_subjects_choice(
    std::string choice
)

function set_abort_load

void set_abort_load(
    bool value
)

function set_load_callback

void set_load_callback(
    const std::function< void(int)> & f
)

function set_up_optimize

bool set_up_optimize(
    Optimize * optimize
)

function is_subject_fixed

bool is_subject_fixed(
    std::shared_ptr< Subject > subject
)

function get_checkpoint_interval

int get_checkpoint_interval()

function set_checkpoint_interval

void set_checkpoint_interval(
    int iterations
)

function get_save_init_splits

bool get_save_init_splits()

function set_save_init_splits

void set_save_init_splits(
    bool enabled
)

function get_keep_checkpoints

bool get_keep_checkpoints()

function set_keep_checkpoints

void set_keep_checkpoints(
    bool enabled
)

function get_field_attributes

std::vector< std::string > get_field_attributes()

function set_field_attributes

void set_field_attributes(
    std::vector< std::string > attributes
)

function get_field_attribute_weights

std::vector< double > get_field_attribute_weights()

function set_field_attribute_weights

void set_field_attribute_weights(
    std::vector< double > weights
)

function get_use_geodesics_to_landmarks

bool get_use_geodesics_to_landmarks()

function set_use_geodesics_to_landmarks

void set_use_geodesics_to_landmarks(
    bool value
)

function get_geodesic_to_landmarks_weight

double get_geodesic_to_landmarks_weight()

function set_geodesic_to_landmarks_weight

void set_geodesic_to_landmarks_weight(
    double value
)

function get_particle_format

std::string get_particle_format()

function set_particle_format

void set_particle_format(
    std::string format
)

function get_geodesic_remesh_percent

double get_geodesic_remesh_percent()

function set_geodesic_remesh_percent

void set_geodesic_remesh_percent(
    double value
)

Updated on 2024-03-17 at 12:58:44 -0600