Skip to content

shapeworks::Groom

High level groom API. More...

#include <Groom.h>

Public Functions

Name
Groom(ProjectHandle project)
bool run()
Run the grooming.
void abort()
Set abort as soon as possible.
bool get_aborted()
Return if grooming was aborted.
double compute_landmark_distance(vtkSmartPointer< vtkPoints > one, vtkSmartPointer< vtkPoints > two)
Util to compute square distance between paired landmarks.
vtkSmartPointer< vtkMatrix4x4 > compute_landmark_transform(vtkSmartPointer< vtkPoints > source, vtkSmartPointer< vtkPoints > target)
Util to compute landmark transform.

Protected Attributes

Name
std::atomic< float > progress_
std::atomic< int > total_ops_
std::atomic< int > progress_counter_

Detailed Description

class shapeworks::Groom;

High level groom API.

The Groom class operates on a Project. It is used by Studio and other tools to perform Grooming operations.

Public Functions Documentation

function Groom

Groom(
    ProjectHandle project
)

function run

bool run()

Run the grooming.

function abort

void abort()

Set abort as soon as possible.

function get_aborted

bool get_aborted()

Return if grooming was aborted.

function compute_landmark_distance

static double compute_landmark_distance(
    vtkSmartPointer< vtkPoints > one,
    vtkSmartPointer< vtkPoints > two
)

Util to compute square distance between paired landmarks.

function compute_landmark_transform

static vtkSmartPointer< vtkMatrix4x4 > compute_landmark_transform(
    vtkSmartPointer< vtkPoints > source,
    vtkSmartPointer< vtkPoints > target
)

Util to compute landmark transform.

Protected Attributes Documentation

variable progress_

std::atomic< float > progress_ = 0;

variable total_ops_

std::atomic< int > total_ops_ = 0;

variable progress_counter_

std::atomic< int > progress_counter_ = 0;

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