BALL 1.5.0
Loading...
Searching...
No Matches
BALL::BurialDepth Class Reference

#include <BALL/SCORING/COMPONENTS/burialDepth.h>

Inheritance diagram for BALL::BurialDepth:
BALL::ScoringComponent

Public Member Functions

 BurialDepth (ScoringFunction &sf)
 ~BurialDepth ()
void update (const vector< std::pair< Atom *, Atom * > > &pair_vector)
double updateScore ()
Public Member Functions inherited from BALL::ScoringComponent
 ScoringComponent ()
 ScoringComponent (const ScoringComponent &sc)
 ScoringComponent (ScoringFunction &sf)
void selectBaseFunction (String function)
virtual ~ScoringComponent ()
virtual void clear ()
virtual bool setup ()
virtual void setupLigand ()
ScoringFunctiongetScoringFunction () const
void setScoringFunction (ScoringFunction &sf)
String getName () const
void setName (const String &name)
const StringgetTypeName ()
double getRawScore () const
double getScaledScore () const
virtual void setLigandIntraMolecular (bool b)
bool isLigandIntraMolecular ()
bool isGridable ()
bool isAtomPairwise ()
void setCoefficient (const double &coeff)
const doublegetCoefficient ()
void setNormalizationParameters (double stddev, double mean)
void getNormalizationParameters (double &stddev, double &mean)
bool isEnabled ()
void enable ()
void disable ()

Additional Inherited Members

Protected Member Functions inherited from BALL::ScoringComponent
double scaleScore (double score) const
Protected Attributes inherited from BALL::ScoringComponent
bool ligand_intra_molecular_
bool gridable_
bool atom_pairwise_
ScoringFunctionscoring_function_
ScoringBaseFunctionbase_function_
double score_
double coefficient_
double stddev_
double mean_
bool enabled_
String type_name_

Detailed Description

Definition at line 15 of file burialDepth.h.

Constructor & Destructor Documentation

◆ BurialDepth()

BALL::BurialDepth::BurialDepth ( ScoringFunction & sf)

◆ ~BurialDepth()

BALL::BurialDepth::~BurialDepth ( )

Member Function Documentation

◆ update()

void BALL::BurialDepth::update ( const vector< std::pair< Atom *, Atom * > > & pair_vector)
virtual

Update this ScoringComponent using the given atom-pairs.
This function should be overloaded by all ScoringComponents

Reimplemented from BALL::ScoringComponent.

◆ updateScore()

double BALL::BurialDepth::updateScore ( )
virtual

Calculate the score for this component (for all interactions that have been set by the last call of update()) and return the score.
The coefficient assigned by the user to this component should be taken into account for the calculation, so that the weighted score is returned.

Reimplemented from BALL::ScoringComponent.