IMP::restrainer::SimpleDiameter Class Reference

Simple diameter restraint. More...

#include <IMP/restrainer/simplify_restraint.h>

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

Friends
SimpleDiameter	create_simple_diameter (const kernel::Particles &ps, Float diameter)

Detailed Description

Note

SimpleDiameter stores pointers to DiameterRestraint, and HarmonicUpperBound.

It provides convenient methods to change mean, k, and standard deviation.

See Also

DiameterRestraint

Definition at line 307 of file simplify_restraint.h.

Member Function Documentation

void IMP::restrainer::SimpleDiameter::set_k

(

Float

k

)

The default k is 1.

Definition at line 342 of file simplify_restraint.h.

void IMP::restrainer::SimpleDiameter::set_mean

(

Float

mean

)

The default mean is 0.

Definition at line 327 of file simplify_restraint.h.

Friends And Related Function Documentation

SimpleDiameter create_simple_diameter ( const kernel::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.

See Also

ListSingletonContainer See SimpleDiameter

---

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

• simplify_restraint.h