IMP  2.1.1
The Integrative Modeling Platform
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:

Public Member Functions

 SecondaryStructureResidue (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)
 
 SecondaryStructureResidue (const IMP::kernel::ParticleAdaptor &d)
 
Floats get_all_probabilities ()
 Return all probabilities in one vector.
 
kernel::Particleget_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::kernel::Decorator
ParticleIndex get_particle_index () const
 
Particleget_particle () const
 
Modelget_model () const
 Returns the Model containing the particle.
 
 Decorator (Particle *p)
 
 Decorator ()
 

Static Public Member Functions

static SecondaryStructureResidue decorate_particle (::IMP::kernel::Particle *p)
 
static bool get_is_setup (const IMP::kernel::ParticleAdaptor &p)
 
static bool get_is_setup (kernel::Model *m, kernel::ParticleIndex pi)
 Return true if the particle is a secondary structure residue.
 
static FloatKey get_prob_coil_key ()
 
static FloatKey get_prob_helix_key ()
 
static FloatKey get_prob_strand_key ()
 
static bool particle_is_instance (::IMP::kernel::Particle *p)
 
static bool particle_is_instance (IMP::kernel::Model *m, IMP::kernel::ParticleIndex pi)
 
static SecondaryStructureResidue setup_particle (IMP::kernel::ParticleAdaptor decorator, Float prob_helix, Float prob_strand, Float prob_coil)
 
static SecondaryStructureResidue setup_particle (kernel::Model *m, ParticleIndex pi, Float prob_helix, Float prob_strand, Float prob_coil)
 
static SecondaryStructureResidue setup_particle (kernel::Particle *res_p)
 Set up SecondaryStructureResidue with default probabilities.
 
- Static Public Member Functions inherited from IMP::kernel::Decorator
static bool get_is_setup (Particle *p)
 Return true if the particle can be cast to the decorator. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::kernel::Decorator
 Decorator (kernel::Model *m, ParticleIndex pi)
 
 Decorator (ParticleAdaptor p)
 

Detailed Description

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

Definition at line 26 of file SecondaryStructureResidue.h.

Member Function Documentation

static SecondaryStructureResidue IMP::atom::SecondaryStructureResidue::decorate_particle ( ::IMP::kernel::Particle p)
static
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Check explicitly instead.

Definition at line 44 of file SecondaryStructureResidue.h.

static bool IMP::atom::SecondaryStructureResidue::particle_is_instance ( ::IMP::kernel::Particle p)
static
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_is_setup() instead.

Definition at line 44 of file SecondaryStructureResidue.h.

static bool IMP::atom::SecondaryStructureResidue::particle_is_instance ( IMP::kernel::Model m,
IMP::kernel::ParticleIndex  pi 
)
static
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_is_setup() instead.

Definition at line 44 of file SecondaryStructureResidue.h.

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

Setup the particle so it can be used with this decorator.

Definition at line 46 of file SecondaryStructureResidue.h.


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