Detailed Description

Simple connectivity restraint.

Note:: SimpleConnectivity stores pointers to ConnectivityRestraint, HarmonicUpperBound, and SphereDistancePairScore.; It provides convenient methods to change mean, k, and standard deviation.

Public Member Functions
def	__init__
core::HarmonicUpperBound *	get_harmonic_upper_bound ()
core::ConnectivityRestraint *	get_restraint ()
core::SphereDistancePairScore *	get_sphere_distance_pair_score ()
VersionInfo	get_version_info () const
void	set_k (Float k)
	Set the spring constant for the HarmonicUpperBound.
void	set_mean (Float mean)
	Set the mean for the HarmonicUpperBound.
void	set_standard_deviation (Float sd)
	Set the standard deviation for the HarmonicUpperBound.
void	show (std::ostream &out=std::cout) const

Friends
SimpleConnectivity	create_simple_connectivity_on_molecules (atom::Hierarchies const &mhs)
SimpleConnectivity	create_simple_connectivity_on_rigid_bodies (const core::RigidBodies &rbs, Refiner *ref)

Related Functions
(Note that these are not member functions.)
SimpleConnectivity	create_simple_connectivity_on_molecules (const atom::Hierarchies &mhs)

Member Function Documentation

void IMP::restrainer::SimpleConnectivity::set_k ( Float k )

Set the spring constant for the HarmonicUpperBound.

The default k is 1.

void IMP::restrainer::SimpleConnectivity::set_mean ( Float mean )

Set the mean for the HarmonicUpperBound.

The default mean is 0.

void IMP::restrainer::SimpleConnectivity::set_standard_deviation ( Float sd )

Set the standard deviation for the HarmonicUpperBound.

SimpleConnectivity create_simple_connectivity_on_molecules ( const atom::Hierarchies & mhs )

See also:: LowestRefinedPairScore; SphereDistancePairScore; HarmonicUpperBound; LeavesRefiner

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