Chemical Data Processing Library C++ API - Version 1.4.0
Public Member Functions | Friends | List of all members
CDPL::Shape::GaussianShapeFunctionAlignment::Result Class Reference

A single alignment result: rigid-body transformation plus shape and color overlap values. More...

#include <GaussianShapeFunctionAlignment.hpp>

Public Member Functions

 Result (const Math::Matrix4D &xform, double overlap, double col_overlap)
 Constructs a Result with the given values. More...
 
const Math::Matrix4DgetTransform () const
 Returns the rigid-body transformation that maps the aligned shape onto the reference shape. More...
 
double getOverlap () const
 Returns the shape overlap value of the alignment. More...
 
double getColorOverlap () const
 Returns the color overlap value of the alignment. More...
 

Friends

class GaussianShapeFunctionAlignment
 

Detailed Description

A single alignment result: rigid-body transformation plus shape and color overlap values.

Constructor & Destructor Documentation

◆ Result()

CDPL::Shape::GaussianShapeFunctionAlignment::Result::Result ( const Math::Matrix4D xform,
double  overlap,
double  col_overlap 
)
inline

Constructs a Result with the given values.

Parameters
xformThe rigid-body transformation.
overlapThe shape overlap value.
col_overlapThe color overlap value.

Member Function Documentation

◆ getTransform()

const Math::Matrix4D& CDPL::Shape::GaussianShapeFunctionAlignment::Result::getTransform ( ) const
inline

Returns the rigid-body transformation that maps the aligned shape onto the reference shape.

Returns
A const reference to the rigid-body transformation matrix.

◆ getOverlap()

double CDPL::Shape::GaussianShapeFunctionAlignment::Result::getOverlap ( ) const
inline

Returns the shape overlap value of the alignment.

Returns
The shape overlap value.

◆ getColorOverlap()

double CDPL::Shape::GaussianShapeFunctionAlignment::Result::getColorOverlap ( ) const
inline

Returns the color overlap value of the alignment.

Returns
The color overlap value.

Friends And Related Function Documentation

◆ GaussianShapeFunctionAlignment

friend class GaussianShapeFunctionAlignment
friend

The documentation for this class was generated from the following file: