IMP::atom::SecondaryStructureResidue Class Reference

A decorator for a residue with probability of secondary structure. More...

#include <IMP/atom/SecondaryStructureResidue.h>

Inheritance diagram for IMP::atom::SecondaryStructureResidue:

Detailed Description

A decorator for a residue with probability of secondary structure.

Contains probabilities for each sse type (helix, strand, coil)

Definition at line 27 of file SecondaryStructureResidue.h.

Public Member Functions
	SecondaryStructureResidue (::IMP::Model *m,::IMP::ParticleIndex id)
	SecondaryStructureResidue (const IMP::ParticleAdaptor &d)
Floats	get_all_probabilities ()
	Return all probabilities in one vector. More...
Particle *	get_particle () const
Float	get_prob_coil () const
Float	get_prob_helix () const
Float	get_prob_strand () const
void	set_prob_coil (Float t)
void	set_prob_helix (Float t)
void	set_prob_strand (Float t)
void	show (std::ostream &out=std::cout) const
Public Member Functions inherited from IMP::Decorator
bool	get_is_valid () const
	Returns true if constructed with a non-default constructor. More...
Model *	get_model () const
	Returns the Model containing the particle. More...
Particle *	get_particle () const
	Returns the particle decorated by this decorator. More...
ParticleIndex	get_particle_index () const
	Returns the particle index decorated by this decorator. More...
	operator Particle * () const
	operator ParticleIndex () const
Particle *	operator-> () const

Static Public Member Functions
static bool	get_is_setup (const IMP::ParticleAdaptor &p)
static bool	get_is_setup (Model *m, ParticleIndex pi)
	Return true if the particle is a secondary structure residue. More...
static FloatKey	get_prob_coil_key ()
static FloatKey	get_prob_helix_key ()
static FloatKey	get_prob_strand_key ()
static SecondaryStructureResidue	setup_particle (Model *m, ParticleIndex pi, Float prob_helix, Float prob_strand, Float prob_coil)
static SecondaryStructureResidue	setup_particle (IMP::ParticleAdaptor pa, Float prob_helix, Float prob_strand, Float prob_coil)
static SecondaryStructureResidue	setup_particle (Particle *res_p)
	Set up SecondaryStructureResidue with default probabilities. More...

Additional Inherited Members
Protected Member Functions inherited from IMP::Decorator
	Decorator (Model *m, ParticleIndex pi)
	Decorator (ParticleAdaptor p)

Member Function Documentation

Floats IMP::atom::SecondaryStructureResidue::get_all_probabilities

(

)

Return all probabilities in one vector.

Definition at line 70 of file SecondaryStructureResidue.h.

static bool IMP::atom::SecondaryStructureResidue::get_is_setup ( Model *  m, ParticleIndex  pi  )

static

Return true if the particle is a secondary structure residue.

Definition at line 59 of file SecondaryStructureResidue.h.

Here is the call graph for this function:

Float IMP::atom::SecondaryStructureResidue::get_prob_coil

(

)

const

returns the value of the prob_coil attribute, or 0.333 if \ the prob_coil attribute is missing

Definition at line 83 of file SecondaryStructureResidue.h.

Float IMP::atom::SecondaryStructureResidue::get_prob_helix

(

)

const

returns the value of the prob_helix attribute, or 0.333 if \ the prob_helix attribute is missing

Definition at line 79 of file SecondaryStructureResidue.h.

Float IMP::atom::SecondaryStructureResidue::get_prob_strand

(

)

const

returns the value of the prob_strand attribute, or 0.333 if \ the prob_strand attribute is missing

Definition at line 81 of file SecondaryStructureResidue.h.

void IMP::atom::SecondaryStructureResidue::set_prob_coil

(

Float

t

)

sets the prob_coil attribute to t

Definition at line 83 of file SecondaryStructureResidue.h.

void IMP::atom::SecondaryStructureResidue::set_prob_helix

(

Float

t

)

sets the prob_helix attribute to t

Definition at line 79 of file SecondaryStructureResidue.h.

void IMP::atom::SecondaryStructureResidue::set_prob_strand

(

Float

t

)

sets the prob_strand attribute to t

Definition at line 81 of file SecondaryStructureResidue.h.

static SecondaryStructureResidue IMP::atom::SecondaryStructureResidue::setup_particle ( Model *  m, ParticleIndex  pi, Float  prob_helix, Float  prob_strand, Float  prob_coil  )

static

Returns

a SecondaryStructureResidue object that decorates particle pi

Definition at line 47 of file SecondaryStructureResidue.h.

static SecondaryStructureResidue IMP::atom::SecondaryStructureResidue::setup_particle ( IMP::ParticleAdaptor  pa, Float  prob_helix, Float  prob_strand, Float  prob_coil  )

static

Returns

a SecondaryStructureResidue object that decorates the particle specified by pa

See Also

setup_particle(m, pi, prob_helix , prob_strand , prob_coil )

Definition at line 47 of file SecondaryStructureResidue.h.

static SecondaryStructureResidue IMP::atom::SecondaryStructureResidue::setup_particle ( Particle *  res_p )

static

Set up SecondaryStructureResidue with default probabilities.

Definition at line 50 of file SecondaryStructureResidue.h.

---

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

• SecondaryStructureResidue.h