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

Result of a Gaussian-shape alignment between a reference and an aligned shape. More...

#include <AlignmentResult.hpp>

Public Member Functions

 AlignmentResult ()
 Constructs the AlignmentResult instance. More...
 
const Math::Matrix4DgetTransform () const
 Returns the rigid-body transformation matrix that maps the aligned shape onto the reference shape. More...
 
void setTransform (const Math::Matrix4D &xform)
 Sets the rigid-body transformation matrix. More...
 
double getScore () const
 Returns the score of the alignment. More...
 
void setScore (double score)
 Sets the score of the alignment. More...
 
std::size_t getReferenceShapeSetIndex () const
 Returns the index of the reference shape set the aligned shape was matched against. More...
 
void setReferenceShapeSetIndex (std::size_t idx)
 Sets the index of the reference shape set. More...
 
std::size_t getReferenceShapeIndex () const
 Returns the index of the reference shape within its shape set. More...
 
void setReferenceShapeIndex (std::size_t idx)
 Sets the index of the reference shape within its shape set. More...
 
std::size_t getAlignedShapeIndex () const
 Returns the index of the aligned shape. More...
 
void setAlignedShapeIndex (std::size_t idx)
 Sets the index of the aligned shape. More...
 
double getReferenceSelfOverlap () const
 Returns the self-overlap of the reference shape (shape-only contribution). More...
 
void setReferenceSelfOverlap (double overlap)
 Sets the self-overlap of the reference shape (shape-only contribution). More...
 
double getReferenceColorSelfOverlap () const
 Returns the self-overlap of the reference shape (color/pharmacophore contribution). More...
 
void setReferenceColorSelfOverlap (double overlap)
 Sets the self-overlap of the reference shape (color/pharmacophore contribution). More...
 
double getAlignedSelfOverlap () const
 Returns the self-overlap of the aligned shape (shape-only contribution). More...
 
void setAlignedSelfOverlap (double overlap)
 Sets the self-overlap of the aligned shape (shape-only contribution). More...
 
double getAlignedColorSelfOverlap () const
 Returns the self-overlap of the aligned shape (color/pharmacophore contribution). More...
 
void setAlignedColorSelfOverlap (double overlap)
 Sets the self-overlap of the aligned shape (color/pharmacophore contribution). More...
 
double getOverlap () const
 Returns the calculated overlap between the reference and the aligned shape (shape-only contribution). More...
 
void setOverlap (double overlap)
 Sets the overlap between the reference and the aligned shape (shape-only contribution). More...
 
double getColorOverlap () const
 Returns the calculated overlap between the reference and the aligned shape (color/pharmacophore contribution). More...
 
void setColorOverlap (double overlap)
 Sets the overlap between the reference and the aligned shape (color/pharmacophore contribution). More...
 

Detailed Description

Result of a Gaussian-shape alignment between a reference and an aligned shape.

Bundles the rigid-body transformation that brings the aligned shape onto the reference shape together with the resulting overlap-based score values, source/destination shape indices, and the self-overlap values used for normalization.

Constructor & Destructor Documentation

◆ AlignmentResult()

CDPL::Shape::AlignmentResult::AlignmentResult ( )

Constructs the AlignmentResult instance.

Member Function Documentation

◆ getTransform()

const Math::Matrix4D& CDPL::Shape::AlignmentResult::getTransform ( ) const

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

Returns
The transformation matrix.

◆ setTransform()

void CDPL::Shape::AlignmentResult::setTransform ( const Math::Matrix4D xform)

Sets the rigid-body transformation matrix.

Parameters
xformThe transformation matrix.

◆ getScore()

double CDPL::Shape::AlignmentResult::getScore ( ) const

Returns the score of the alignment.

Returns
The alignment score.

◆ setScore()

void CDPL::Shape::AlignmentResult::setScore ( double  score)

Sets the score of the alignment.

Parameters
scoreThe alignment score.

◆ getReferenceShapeSetIndex()

std::size_t CDPL::Shape::AlignmentResult::getReferenceShapeSetIndex ( ) const

Returns the index of the reference shape set the aligned shape was matched against.

Returns
The reference shape set index.

◆ setReferenceShapeSetIndex()

void CDPL::Shape::AlignmentResult::setReferenceShapeSetIndex ( std::size_t  idx)

Sets the index of the reference shape set.

Parameters
idxThe reference shape set index.

◆ getReferenceShapeIndex()

std::size_t CDPL::Shape::AlignmentResult::getReferenceShapeIndex ( ) const

Returns the index of the reference shape within its shape set.

Returns
The reference shape index.

◆ setReferenceShapeIndex()

void CDPL::Shape::AlignmentResult::setReferenceShapeIndex ( std::size_t  idx)

Sets the index of the reference shape within its shape set.

Parameters
idxThe reference shape index.

◆ getAlignedShapeIndex()

std::size_t CDPL::Shape::AlignmentResult::getAlignedShapeIndex ( ) const

Returns the index of the aligned shape.

Returns
The aligned shape index.

◆ setAlignedShapeIndex()

void CDPL::Shape::AlignmentResult::setAlignedShapeIndex ( std::size_t  idx)

Sets the index of the aligned shape.

Parameters
idxThe aligned shape index.

◆ getReferenceSelfOverlap()

double CDPL::Shape::AlignmentResult::getReferenceSelfOverlap ( ) const

Returns the self-overlap of the reference shape (shape-only contribution).

Returns
The reference shape self-overlap value.

◆ setReferenceSelfOverlap()

void CDPL::Shape::AlignmentResult::setReferenceSelfOverlap ( double  overlap)

Sets the self-overlap of the reference shape (shape-only contribution).

Parameters
overlapThe reference shape self-overlap value.

◆ getReferenceColorSelfOverlap()

double CDPL::Shape::AlignmentResult::getReferenceColorSelfOverlap ( ) const

Returns the self-overlap of the reference shape (color/pharmacophore contribution).

Returns
The reference shape color self-overlap value.

◆ setReferenceColorSelfOverlap()

void CDPL::Shape::AlignmentResult::setReferenceColorSelfOverlap ( double  overlap)

Sets the self-overlap of the reference shape (color/pharmacophore contribution).

Parameters
overlapThe reference shape color self-overlap value.

◆ getAlignedSelfOverlap()

double CDPL::Shape::AlignmentResult::getAlignedSelfOverlap ( ) const

Returns the self-overlap of the aligned shape (shape-only contribution).

Returns
The aligned shape self-overlap value.

◆ setAlignedSelfOverlap()

void CDPL::Shape::AlignmentResult::setAlignedSelfOverlap ( double  overlap)

Sets the self-overlap of the aligned shape (shape-only contribution).

Parameters
overlapThe aligned shape self-overlap value.

◆ getAlignedColorSelfOverlap()

double CDPL::Shape::AlignmentResult::getAlignedColorSelfOverlap ( ) const

Returns the self-overlap of the aligned shape (color/pharmacophore contribution).

Returns
The aligned shape color self-overlap value.

◆ setAlignedColorSelfOverlap()

void CDPL::Shape::AlignmentResult::setAlignedColorSelfOverlap ( double  overlap)

Sets the self-overlap of the aligned shape (color/pharmacophore contribution).

Parameters
overlapThe aligned shape color self-overlap value.

◆ getOverlap()

double CDPL::Shape::AlignmentResult::getOverlap ( ) const

Returns the calculated overlap between the reference and the aligned shape (shape-only contribution).

Returns
The shape overlap value.

◆ setOverlap()

void CDPL::Shape::AlignmentResult::setOverlap ( double  overlap)

Sets the overlap between the reference and the aligned shape (shape-only contribution).

Parameters
overlapThe shape overlap value.

◆ getColorOverlap()

double CDPL::Shape::AlignmentResult::getColorOverlap ( ) const

Returns the calculated overlap between the reference and the aligned shape (color/pharmacophore contribution).

Returns
The color overlap value.

◆ setColorOverlap()

void CDPL::Shape::AlignmentResult::setColorOverlap ( double  overlap)

Sets the overlap between the reference and the aligned shape (color/pharmacophore contribution).

Parameters
overlapThe color overlap value.

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