Skip to content

shapeworks::ShapeScalarJob

Inherits from shapeworks::Job, QObject

Public Types

Name
enum class JobType
enum class Direction

Public Functions

Name
ShapeScalarJob(QSharedPointer< Session > session, QString target_feature, Eigen::MatrixXd target_particles, JobType job_type)
virtual void run() override
run the job
virtual QString name() override
get the name of the job
QPixmap get_plot()
void set_number_of_components(int num_components)
void set_number_of_folds(int num_folds)
void set_max_number_of_components(int num)
Eigen::VectorXd get_prediction()
void set_direction(Direction direction)
Eigen::VectorXd predict_scalars(QSharedPointer< Session > session, QString target_feature, Eigen::MatrixXd target_particles)
Eigen::VectorXd predict_shape(QSharedPointer< Session > session, QString target_feature, Eigen::MatrixXd target_particles)
void clear_model()

Additional inherited members

Public Signals inherited from shapeworks::Job

Name
void progress(double , QString ="")
void finished()

Public Functions inherited from shapeworks::Job

Name
Job()
virtual ~Job()
virtual QString get_completion_message()
get a message to display when the job is complete
virtual QString get_abort_message()
get a message to display when the job is aborted
void start_timer()
start the timer
qint64 timer_elapsed()
how much time has elapsed since the timer was started
void set_complete(bool complete)
set the job as complete
bool is_complete() const
is the job complete?
void abort()
abort the job
bool is_aborted() const
was the job aborted?
void set_quiet_mode(bool quiet)
set to quiet mode (no progress messages)
bool get_quiet_mode()
get quiet mode

Public Types Documentation

enum JobType

Enumerator Value Description
Find_Components
MSE_Plot
Predict

enum Direction

Enumerator Value Description
To_Shape
To_Scalar

Public Functions Documentation

function ShapeScalarJob

ShapeScalarJob(
    QSharedPointer< Session > session,
    QString target_feature,
    Eigen::MatrixXd target_particles,
    JobType job_type
)

function run

virtual void run() override

run the job

Reimplements: shapeworks::Job::run

function name

virtual QString name() override

get the name of the job

Reimplements: shapeworks::Job::name

function get_plot

QPixmap get_plot()

function set_number_of_components

inline void set_number_of_components(
    int num_components
)

function set_number_of_folds

inline void set_number_of_folds(
    int num_folds
)

function set_max_number_of_components

inline void set_max_number_of_components(
    int num
)

function get_prediction

inline Eigen::VectorXd get_prediction()

function set_direction

inline void set_direction(
    Direction direction
)

function predict_scalars

static Eigen::VectorXd predict_scalars(
    QSharedPointer< Session > session,
    QString target_feature,
    Eigen::MatrixXd target_particles
)

function predict_shape

static Eigen::VectorXd predict_shape(
    QSharedPointer< Session > session,
    QString target_feature,
    Eigen::MatrixXd target_particles
)

function clear_model

static inline void clear_model()

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