shapeworks::GroomParameters

#include <GroomParameters.h>

Public Classes

	Name
struct	SharedBoundary

Public Types

	Name
enum class	MeshSmoothingOption
enum class	AlignmentOption

Public Functions

	Name
	GroomParameters(ProjectHandle project, std::string domain_name ="")
void	set_domain_name(std::string domain_name)
void	save_to_project()
std::string	get_groom_output_prefix()
void	set_groom_output_prefix(std::string prefix)
bool	get_groom_all_domains_the_same()
void	set_groom_all_domains_the_same(bool value)
bool	get_alignment_enabled()
void	set_alignment_enabled(bool value)
std::string	get_alignment_method()
void	set_alignment_method(std::string method)
int	get_alignment_reference()
void	set_alignment_reference(int reference)
int	get_alignment_reference_chosen()
void	set_alignment_reference_chosen(int reference)
int	get_alignment_subset_size()
void	set_alignment_subset_size(int size)
bool	get_isolate_tool()
void	set_isolate_tool(bool value)
bool	get_fill_holes_tool()
void	set_fill_holes_tool(bool value)
bool	get_fill_mesh_holes_tool()
void	set_fill_mesh_holes_tool(bool value)
bool	get_auto_pad_tool()
void	set_auto_pad_tool(bool value)
int	get_padding_amount()
void	set_padding_amount(int padding_amount)
bool	get_antialias_tool()
void	set_antialias_tool(bool value)
int	get_antialias_iterations()
void	set_antialias_iterations(int iterations)
bool	get_blur_tool()
void	set_blur_tool(bool value)
double	get_blur_amount()
void	set_blur_amount(double blur_amount)
bool	get_fast_marching()
void	set_fast_marching(bool value)
bool	get_mesh_smooth()
void	set_mesh_smooth(bool value)
std::string	get_mesh_smoothing_method()
void	set_mesh_smoothing_method(std::string method)
int	get_mesh_vtk_laplacian_iterations()
void	set_mesh_vtk_laplacian_iterations(int iterations)
double	get_mesh_vtk_laplacian_relaxation()
void	set_mesh_vtk_laplacian_relaxation(double relaxation)
int	get_mesh_vtk_windowed_sinc_iterations()
void	set_mesh_vtk_windowed_sinc_iterations(int iterations)
double	get_mesh_vtk_windowed_sinc_passband()
void	set_mesh_vtk_windowed_sinc_passband(double passband)
bool	get_use_icp()
bool	get_use_center()
bool	get_use_landmarks()
bool	get_crop()
void	set_crop(bool crop)
bool	get_convert_to_mesh()
void	set_convert_to_mesh(bool value)
bool	get_reflect()
void	set_reflect(bool reflect)
std::string	get_reflect_column()
void	set_reflect_column(std::string column)
std::string	get_reflect_choice()
void	set_reflect_choice(std::string choice)
std::string	get_reflect_axis()
void	set_reflect_axis(std::string axies)
bool	get_resample()
void	set_resample(bool resample)
bool	get_isotropic()
void	set_isotropic(bool isotropic)
double	get_iso_spacing()
void	set_iso_spacing(double spacing)
std::vector< double >	get_spacing()
void	set_spacing(std::vector< double > spacing)
bool	get_remesh()
void	set_remesh(bool remesh)
bool	get_remesh_percent_mode()
void	set_remesh_percent_mode(bool mode)
double	get_remesh_percent()
void	set_remesh_percent(double percent)
int	get_remesh_num_vertices()
void	set_remesh_num_vertices(int num_vertices)
double	get_remesh_gradation()
void	set_remesh_gradation(double gradation)
bool	get_skip_grooming()
void	set_skip_grooming(bool skip)
bool	get_shared_boundaries_enabled()
void	set_shared_boundaries_enabled(bool enabled)
std::vector< SharedBoundary >	get_shared_boundaries()
void	set_shared_boundaries(const std::vector< SharedBoundary > & boundaries)
void	add_shared_boundary(const std::string & first_domain, const std::string & second_domain, double tolerance)
void	remove_shared_boundary(size_t index)
void	clear_shared_boundaries()
void	restore_defaults()
Parameters	get_parameters() const

Public Attributes

	Name
const std::string	GROOM_SMOOTH_VTK_LAPLACIAN_C
const std::string	GROOM_SMOOTH_VTK_WINDOWED_SINC_C
const std::string	GROOM_ALIGNMENT_CENTER_C
const std::string	GROOM_ALIGNMENT_ICP_C
const std::string	GROOM_ALIGNMENT_LANDMARK_C

Detailed Description

class shapeworks::GroomParameters;

This class encapsulated processing of Groom parameters

Public Types Documentation

enum MeshSmoothingOption

Enumerator	Value	Description
laplacian
sinc

enum AlignmentOption

Enumerator	Value	Description
none
center
icp

Public Functions Documentation

function GroomParameters

explicit GroomParameters(
    ProjectHandle project,
    std::string domain_name =""
)

function set_domain_name

void set_domain_name(
    std::string domain_name
)

function save_to_project

void save_to_project()

function get_groom_output_prefix

std::string get_groom_output_prefix()

function set_groom_output_prefix

void set_groom_output_prefix(
    std::string prefix
)

function get_groom_all_domains_the_same

bool get_groom_all_domains_the_same()

function set_groom_all_domains_the_same

void set_groom_all_domains_the_same(
    bool value
)

function get_alignment_enabled

bool get_alignment_enabled()

function set_alignment_enabled

void set_alignment_enabled(
    bool value
)

function get_alignment_method

std::string get_alignment_method()

function set_alignment_method

void set_alignment_method(
    std::string method
)

function get_alignment_reference

int get_alignment_reference()

function set_alignment_reference

void set_alignment_reference(
    int reference
)

function get_alignment_reference_chosen

int get_alignment_reference_chosen()

function set_alignment_reference_chosen

void set_alignment_reference_chosen(
    int reference
)

function get_alignment_subset_size

int get_alignment_subset_size()

function set_alignment_subset_size

void set_alignment_subset_size(
    int size
)

function get_isolate_tool

bool get_isolate_tool()

function set_isolate_tool

void set_isolate_tool(
    bool value
)

function get_fill_holes_tool

bool get_fill_holes_tool()

function set_fill_holes_tool

void set_fill_holes_tool(
    bool value
)

function get_fill_mesh_holes_tool

bool get_fill_mesh_holes_tool()

function set_fill_mesh_holes_tool

void set_fill_mesh_holes_tool(
    bool value
)

function get_auto_pad_tool

bool get_auto_pad_tool()

function set_auto_pad_tool

void set_auto_pad_tool(
    bool value
)

function get_padding_amount

int get_padding_amount()

function set_padding_amount

void set_padding_amount(
    int padding_amount
)

function get_antialias_tool

bool get_antialias_tool()

function set_antialias_tool

void set_antialias_tool(
    bool value
)

function get_antialias_iterations

int get_antialias_iterations()

function set_antialias_iterations

void set_antialias_iterations(
    int iterations
)

function get_blur_tool

bool get_blur_tool()

function set_blur_tool

void set_blur_tool(
    bool value
)

function get_blur_amount

double get_blur_amount()

function set_blur_amount

void set_blur_amount(
    double blur_amount
)

function get_fast_marching

bool get_fast_marching()

function set_fast_marching

void set_fast_marching(
    bool value
)

function get_mesh_smooth

bool get_mesh_smooth()

function set_mesh_smooth

void set_mesh_smooth(
    bool value
)

function get_mesh_smoothing_method

std::string get_mesh_smoothing_method()

function set_mesh_smoothing_method

void set_mesh_smoothing_method(
    std::string method
)

function get_mesh_vtk_laplacian_iterations

int get_mesh_vtk_laplacian_iterations()

function set_mesh_vtk_laplacian_iterations

void set_mesh_vtk_laplacian_iterations(
    int iterations
)

function get_mesh_vtk_laplacian_relaxation

double get_mesh_vtk_laplacian_relaxation()

function set_mesh_vtk_laplacian_relaxation

void set_mesh_vtk_laplacian_relaxation(
    double relaxation
)

function get_mesh_vtk_windowed_sinc_iterations

int get_mesh_vtk_windowed_sinc_iterations()

function set_mesh_vtk_windowed_sinc_iterations

void set_mesh_vtk_windowed_sinc_iterations(
    int iterations
)

function get_mesh_vtk_windowed_sinc_passband

double get_mesh_vtk_windowed_sinc_passband()

function set_mesh_vtk_windowed_sinc_passband

void set_mesh_vtk_windowed_sinc_passband(
    double passband
)

function get_use_icp

bool get_use_icp()

function get_use_center

bool get_use_center()

function get_use_landmarks

bool get_use_landmarks()

function get_crop

bool get_crop()

function set_crop

void set_crop(
    bool crop
)

function get_convert_to_mesh

bool get_convert_to_mesh()

function set_convert_to_mesh

void set_convert_to_mesh(
    bool value
)

function get_reflect

bool get_reflect()

function set_reflect

void set_reflect(
    bool reflect
)

function get_reflect_column

std::string get_reflect_column()

function set_reflect_column

void set_reflect_column(
    std::string column
)

function get_reflect_choice

std::string get_reflect_choice()

function set_reflect_choice

void set_reflect_choice(
    std::string choice
)

function get_reflect_axis

std::string get_reflect_axis()

function set_reflect_axis

void set_reflect_axis(
    std::string axies
)

function get_resample

bool get_resample()

function set_resample

void set_resample(
    bool resample
)

function get_isotropic

bool get_isotropic()

function set_isotropic

void set_isotropic(
    bool isotropic
)

function get_iso_spacing

double get_iso_spacing()

function set_iso_spacing

void set_iso_spacing(
    double spacing
)

function get_spacing

std::vector< double > get_spacing()

function set_spacing

void set_spacing(
    std::vector< double > spacing
)

function get_remesh

bool get_remesh()

function set_remesh

void set_remesh(
    bool remesh
)

function get_remesh_percent_mode

bool get_remesh_percent_mode()

function set_remesh_percent_mode

void set_remesh_percent_mode(
    bool mode
)

function get_remesh_percent

double get_remesh_percent()

function set_remesh_percent

void set_remesh_percent(
    double percent
)

function get_remesh_num_vertices

int get_remesh_num_vertices()

function set_remesh_num_vertices

void set_remesh_num_vertices(
    int num_vertices
)

function get_remesh_gradation

double get_remesh_gradation()

function set_remesh_gradation

void set_remesh_gradation(
    double gradation
)

function get_skip_grooming

bool get_skip_grooming()

function set_skip_grooming

void set_skip_grooming(
    bool skip
)

function get_shared_boundaries_enabled

bool get_shared_boundaries_enabled()

function set_shared_boundaries_enabled

void set_shared_boundaries_enabled(
    bool enabled
)

function get_shared_boundaries

std::vector< SharedBoundary > get_shared_boundaries()

function set_shared_boundaries

void set_shared_boundaries(
    const std::vector< SharedBoundary > & boundaries
)

function add_shared_boundary

void add_shared_boundary(
    const std::string & first_domain,
    const std::string & second_domain,
    double tolerance
)

function remove_shared_boundary

void remove_shared_boundary(
    size_t index
)

function clear_shared_boundaries

void clear_shared_boundaries()

function restore_defaults

void restore_defaults()

function get_parameters

inline Parameters get_parameters() const

Public Attributes Documentation

variable GROOM_SMOOTH_VTK_LAPLACIAN_C

static const std::string GROOM_SMOOTH_VTK_LAPLACIAN_C;

variable GROOM_SMOOTH_VTK_WINDOWED_SINC_C

static const std::string GROOM_SMOOTH_VTK_WINDOWED_SINC_C;

variable GROOM_ALIGNMENT_CENTER_C

static const std::string GROOM_ALIGNMENT_CENTER_C;

variable GROOM_ALIGNMENT_ICP_C

static const std::string GROOM_ALIGNMENT_ICP_C;

variable GROOM_ALIGNMENT_LANDMARK_C

static const std::string GROOM_ALIGNMENT_LANDMARK_C;

Updated on 2025-09-04 at 08:01:25 +0000