Skip to content

shapeworks::OptimizeParameters

More...

#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)
bool get_shared_boundary()
void set_shared_boundary(bool value)
double get_shared_boundary_weight()
void set_shared_boundary_weight(double value)
bool get_sampling_scale()
void set_sampling_scale(bool value)
bool get_sampling_auto_scale()
void set_sampling_auto_scale(bool value)
double get_sampling_scale_value()
void set_sampling_scale_value(double value)
EarlyStoppingConfig get_early_stopping_config()
Parameters get_parameters() const

Detailed Description

cpp class shapeworks::OptimizeParameters;

This class encapsulated processing of Optimization parameters

Public Functions Documentation

function OptimizeParameters

cpp explicit OptimizeParameters( ProjectHandle project )

function save_to_project

cpp void save_to_project()

function get_optimize_output_prefix

cpp std::string get_optimize_output_prefix()

function set_optimize_output_prefix

cpp void set_optimize_output_prefix( std::string prefix )

function get_number_of_particles

cpp std::vector< int > get_number_of_particles()

function set_number_of_particles

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

function get_initial_relative_weighting

cpp double get_initial_relative_weighting()

function set_initial_relative_weighting

cpp void set_initial_relative_weighting( double value )

function get_relative_weighting

cpp double get_relative_weighting()

function set_relative_weighting

cpp void set_relative_weighting( double value )

function get_starting_regularization

cpp double get_starting_regularization()

function set_starting_regularization

cpp void set_starting_regularization( double value )

function get_ending_regularization

cpp double get_ending_regularization()

function set_ending_regularization

cpp void set_ending_regularization( double value )

function get_iterations_per_split

cpp int get_iterations_per_split()

function set_iterations_per_split

cpp void set_iterations_per_split( int value )

function get_optimization_iterations

cpp int get_optimization_iterations()

function set_optimization_iterations

cpp void set_optimization_iterations( int value )

function get_use_geodesic_distance

cpp bool get_use_geodesic_distance()

function set_use_geodesic_distance

cpp void set_use_geodesic_distance( bool value )

function get_geodesic_cache_multiplier

cpp int get_geodesic_cache_multiplier()

function set_geodesic_cache_multiplier

cpp void set_geodesic_cache_multiplier( int value )

function get_use_normals

cpp std::vector< bool > get_use_normals()

function set_use_normals

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

function get_normals_strength

cpp double get_normals_strength()

function set_normals_strength

cpp void set_normals_strength( double value )

function get_use_disentangled_ssm

cpp bool get_use_disentangled_ssm()

function set_use_disentangled_ssm

cpp void set_use_disentangled_ssm( bool value )

function get_use_procrustes

cpp bool get_use_procrustes()

function set_use_procrustes

cpp void set_use_procrustes( bool value )

function get_use_procrustes_scaling

cpp bool get_use_procrustes_scaling()

function set_use_procrustes_scaling

cpp void set_use_procrustes_scaling( bool value )

function get_use_procrustes_rotation_translation

cpp bool get_use_procrustes_rotation_translation()

function set_use_procrustes_rotation_translation

cpp void set_use_procrustes_rotation_translation( bool value )

function get_procrustes_interval

cpp int get_procrustes_interval()

function set_procrustes_interval

cpp void set_procrustes_interval( int value )

function get_use_multiscale

cpp bool get_use_multiscale()

function set_use_multiscale

cpp void set_use_multiscale( bool value )

function get_multiscale_particles

cpp int get_multiscale_particles()

function set_multiscale_particles

cpp void set_multiscale_particles( int value )

function get_narrow_band

cpp double get_narrow_band()

function set_narrow_band

cpp void set_narrow_band( double value )

function get_verbosity

cpp int get_verbosity()

function set_verbosity

cpp void set_verbosity( int value )

function get_mesh_ffc_mode

cpp bool get_mesh_ffc_mode()

function set_mesh_ffc_mode

cpp void set_mesh_ffc_mode( bool value )

function get_use_landmarks

cpp bool get_use_landmarks()

function set_use_landmarks

cpp void set_use_landmarks( bool value )

function get_use_fixed_subjects

cpp bool get_use_fixed_subjects()

function set_use_fixed_subjects

cpp void set_use_fixed_subjects( bool value )

function get_fixed_subjects_column

cpp std::string get_fixed_subjects_column()

function set_fixed_subject_column

cpp void set_fixed_subject_column( std::string column )

function get_fixed_subjects_choice

cpp std::string get_fixed_subjects_choice()

function set_fixed_subjects_choice

cpp void set_fixed_subjects_choice( std::string choice )

function set_abort_load

cpp void set_abort_load( bool value )

function set_load_callback

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

function set_up_optimize

cpp bool set_up_optimize( Optimize * optimize )

function is_subject_fixed

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

function get_checkpoint_interval

cpp int get_checkpoint_interval()

function set_checkpoint_interval

cpp void set_checkpoint_interval( int iterations )

function get_save_init_splits

cpp bool get_save_init_splits()

function set_save_init_splits

cpp void set_save_init_splits( bool enabled )

function get_keep_checkpoints

cpp bool get_keep_checkpoints()

function set_keep_checkpoints

cpp void set_keep_checkpoints( bool enabled )

function get_field_attributes

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

function set_field_attributes

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

function get_field_attribute_weights

cpp std::vector< double > get_field_attribute_weights()

function set_field_attribute_weights

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

function get_use_geodesics_to_landmarks

cpp bool get_use_geodesics_to_landmarks()

function set_use_geodesics_to_landmarks

cpp void set_use_geodesics_to_landmarks( bool value )

function get_geodesic_to_landmarks_weight

cpp double get_geodesic_to_landmarks_weight()

function set_geodesic_to_landmarks_weight

cpp void set_geodesic_to_landmarks_weight( double value )

function get_particle_format

cpp std::string get_particle_format()

function set_particle_format

cpp void set_particle_format( std::string format )

function get_geodesic_remesh_percent

cpp double get_geodesic_remesh_percent()

function set_geodesic_remesh_percent

cpp void set_geodesic_remesh_percent( double value )

function get_shared_boundary

cpp bool get_shared_boundary()

function set_shared_boundary

cpp void set_shared_boundary( bool value )

function get_shared_boundary_weight

cpp double get_shared_boundary_weight()

function set_shared_boundary_weight

cpp void set_shared_boundary_weight( double value )

function get_sampling_scale

cpp bool get_sampling_scale()

function set_sampling_scale

cpp void set_sampling_scale( bool value )

function get_sampling_auto_scale

cpp bool get_sampling_auto_scale()

function set_sampling_auto_scale

cpp void set_sampling_auto_scale( bool value )

function get_sampling_scale_value

cpp double get_sampling_scale_value()

function set_sampling_scale_value

cpp void set_sampling_scale_value( double value )

function get_early_stopping_config

cpp EarlyStoppingConfig get_early_stopping_config()

function get_parameters

cpp Parameters get_parameters() const


Updated on 2026-03-31 at 16:02:10 +0000