IMP::helper::SimpleDiameter Class Reference

Detailed Description

Simple diameter restraint.

Note:: SimpleDiameter stores pointers to DiameterRestraint, and HarmonicUpperBound.
It provides convenient methods to change mean, k, and standard deviation.


Public Member Functions
core::HarmonicUpperBound *	get_harmonic_upper_bound ()
core::DiameterRestraint *	get_restraint ()
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_stddev (Float sd)
	Set the standard deviation for the HarmonicUpperBound.
void	show (std::ostream &out=std::cout) const
Friends
SimpleDiameter	create_simple_diameter (Particles *ps, Float diameter)

void IMP::helper::SimpleDiameter::set_k ( Float k )

Set the spring constant for the HarmonicUpperBound.

The default k is 1.

void IMP::helper::SimpleDiameter::set_mean ( Float mean )

Set the mean for the HarmonicUpperBound.

The default mean is 0.

SimpleDiameter create_simple_diameter	(	Particles *	ps,
		Float	diameter
	)			`[friend]`

Creates DiameterRestraint using HarmonicUpperBound scoring function as default.

Parameters:

`[in]`	ps	Pointer to particles in diameter restraint.
`[in]`	diameter	Diameter.

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