OpenStructure
Public Member Functions | Static Public Member Functions
InteractionStatistics Class Reference

#include <interaction_statistics.hh>

Inherits EntityVisitor.

Public Member Functions

 InteractionStatistics (Real lower_cutoff, Real upper_cutoff, Real bucket_size, int sequence_sep)
void Extract (mol::EntityView a, mol::EntityView b)
void SaveToFile (const String &file_name) const
Real GetDistanceBucketSize () const
int GetSequenceSeparation () const
Real GetUpperCutoff () const
Real GetLowerCutoff () const
uint64_t GetCount (Real distance) const
uint64_t GetCount (atom::ChemType a, atom::ChemType b, Real distance) const
uint64_t GetCount (atom::ChemType a, atom::ChemType b, int distance_bin) const
uint64_t GetCount (atom::ChemType a, atom::ChemType b) const
void Set (atom::ChemType a, atom::ChemType b, int distance_bin, int counts)
template<typename DS >
void Serialize (DS &ds)
virtual bool VisitResidue (const mol::ResidueHandle &r)
virtual bool VisitAtom (const mol::AtomHandle &a)
- Public Member Functions inherited from EntityVisitor
virtual ~EntityVisitor ()
virtual void OnEntry ()
virtual void OnExit ()
virtual bool VisitChain (const ChainHandle &c)
virtual bool VisitBond (const BondHandle &b)
virtual bool VisitTorsion (const TorsionHandle &t)

Static Public Member Functions

static InteractionStatisticsPtr LoadFromFile (const String &file_name)

Detailed Description

Definition at line 43 of file interaction_statistics.hh.


Constructor & Destructor Documentation

InteractionStatistics ( Real  lower_cutoff,
Real  upper_cutoff,
Real  bucket_size,
int  sequence_sep 
)

construct new interaction statistics.

Parameters:
lower_cutoffonly interaction parters that are further apart than this cutoff are taken into account.
upper_cutoffonly interaction partners below the cutoff are taken into account
bucket_sizesize of distance bins in Angstroem.
sequence_sepresidues that are closer than sequence_sep in sequence are not considered.

Member Function Documentation

void Extract ( mol::EntityView  a,
mol::EntityView  b 
)

Extract the interaction potential from the given entity view.

uint64_t GetCount ( Real  distance) const

Get number of atoms at the given distance regardless of their atom type.

uint64_t GetCount ( atom::ChemType  a,
atom::ChemType  b,
Real  distance 
) const

get number of atoms at given distance by taking their type into account.

uint64_t GetCount ( atom::ChemType  a,
atom::ChemType  b,
int  distance_bin 
) const

get number of atoms in given distance-bin by taking their type into account.

uint64_t GetCount ( atom::ChemType  a,
atom::ChemType  b 
) const

get number of atoms at given distance by taking their type into account.

Real GetDistanceBucketSize ( ) const

Get distance bucket size.

Real GetLowerCutoff ( ) const
int GetSequenceSeparation ( ) const
Real GetUpperCutoff ( ) const
static InteractionStatisticsPtr LoadFromFile ( const String file_name)
static

load interaction statistics from file

void SaveToFile ( const String file_name) const
void Serialize ( DS &  ds)
void Set ( atom::ChemType  a,
atom::ChemType  b,
int  distance_bin,
int  counts 
)

get number of atoms at given distance by taking their type into account.

virtual bool VisitAtom ( const mol::AtomHandle a)
virtual

Atom callback.

Reimplemented from EntityVisitor.

virtual bool VisitResidue ( const mol::ResidueHandle r)
virtual

Residue callback.

Reimplemented from EntityVisitor.


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