IMP logo
IMP Reference Guide  2.13.0
The Integrative Modeling Platform
IMP::atom::Representation Class Reference

A decorator for a representation. More...

#include <IMP/atom/Representation.h>

+ Inheritance diagram for IMP::atom::Representation:

Detailed Description

A decorator for a representation.

It stores a number of copies of its sub hierarchy each with an associated resolution. You can use it to get the representation at a given resolution.

Note
The particle returned for a given representation should be thought of as replacing this particle (not as a child of it).
Only one Representation node is allowed in any path up the tree as nesting them does not have a clear meaning.

Definition at line 39 of file Representation.h.

Public Member Functions

 Representation (::IMP::Model *m,::IMP::ParticleIndex id)
 
 Representation (const IMP::ParticleAdaptor &d)
 
void add_representation (ParticleIndexAdaptor rep, RepresentationType type=BALLS, double resolution=-1)
 Add the representation for the given resolution. More...
 
Hierarchy get_representation (double resolution, RepresentationType type=BALLS)
 Get children at the resolution closest to resolution of the passed type. More...
 
Hierarchies get_representations (RepresentationType type=BALLS)
 Return all children at all resolutions. More...
 
Floats get_resolutions (RepresentationType type=BALLS) const
 Get all resolutions that are available for a specific RepresentationType. More...
 
void show (std::ostream &out=std::cout) const
 
void update_parents ()
 If you've changed the parent, update all the resolutions. More...
 
- Public Member Functions inherited from IMP::atom::Hierarchy
 Hierarchy (Model *m, ParticleIndex pi)
 
 Hierarchy (ParticleAdaptor pi)
 
 Hierarchy ()
 Null constructor. More...
 
 Hierarchy (IMP::core::Hierarchy h)
 The traits must match. More...
 
void add_child (Hierarchy o)
 Add a child and check that the types are appropriate. More...
 
Hierarchy get_child (unsigned int i) const
 Get the ith child based on the order they were added. More...
 
Hierarchies get_children () const
 Return the children in the order they were added. More...
 
template<class C >
get_children () const
 Get the children in a container of your choosing, eg ParticlesTemp. More...
 
bool get_is_valid (bool print_info=false) const
 Return true if the hierarchy is valid. More...
 
Hierarchy get_parent () const
 Get the parent particle. More...
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::core::Hierarchy
 Hierarchy (const IMP::ParticleAdaptor &d, const HierarchyTraits &tr=get_default_traits())
 
 Hierarchy (::IMP::Model *m,::IMP::ParticleIndex id, const HierarchyTraits &tr=get_default_traits())
 
void add_child (Hierarchy h) const
 
void add_child_at (Hierarchy h, unsigned int pos)
 
void clear_children ()
 
Hierarchy get_child (unsigned int i) const
 
ParticleIndex get_child_index (unsigned int i) const
 
int get_child_index () const
 Return i such that get_parent().get_child(i) == this More...
 
GenericHierarchies get_children () const
 
ParticleIndexes get_children_indexes () const
 
const DecoratorTraitsget_decorator_traits () const
 
unsigned int get_number_of_children () const
 
Hierarchy get_parent () const
 
HierarchyTraits get_traits ()
 
void remove_child (unsigned int i)
 
void remove_child (Hierarchy h)
 
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...
 
Modelget_model () const
 Returns the Model containing the particle. More...
 
Particleget_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
 
Particleoperator-> () const
 

Static Public Member Functions

static bool get_is_setup (const IMP::ParticleAdaptor &p)
 
static bool get_is_setup (Model *m, ParticleIndex pi)
 
static Representation setup_particle (IMP::ParticleAdaptor decorator)
 
static Representation setup_particle (Model *m, ParticleIndex pi)
 
static Representation setup_particle (Model *m, ParticleIndex pi, double resolution)
 
static Representation setup_particle (IMP::ParticleAdaptor decorator, double resolution)
 
static Representation setup_particle (IMP::ParticleAdaptor decorator, Representation other)
 
static Representation setup_particle (Model *m, ParticleIndex pi, Representation other)
 
- Static Public Member Functions inherited from IMP::atom::Hierarchy
static bool get_is_setup (Model *m, ParticleIndex p)
 Check if the particle has the needed attributes for a cast to succeed. More...
 
static const
IMP::core::HierarchyTraits
get_traits ()
 Get the molecular hierarchy HierarchyTraits. More...
 
static Hierarchy setup_particle (Model *m, ParticleIndex pi, ParticleIndexesAdaptor children=ParticleIndexesAdaptor())
 Create a Hierarchy of level t by adding the needed attributes. More...
 
- Static Public Member Functions inherited from IMP::core::Hierarchy
static const DecoratorTraitsget_default_decorator_traits ()
 
static const HierarchyTraitsget_default_traits ()
 Get the default hierarchy traits. More...
 
static bool get_is_setup (const IMP::ParticleAdaptor &p, const HierarchyTraits &tr=get_default_traits())
 
static bool get_is_setup (Model *, ParticleIndex, HierarchyTraits=Hierarchy::get_default_traits())
 
static Hierarchy setup_particle (IMP::ParticleAdaptor d, DecoratorTraits tr=get_default_decorator_traits())
 
static Hierarchy setup_particle (Model *m, ParticleIndex pi, DecoratorTraits tr=get_default_decorator_traits())
 
static Hierarchy setup_particle (Model *m, ParticleIndex pi, ParticleIndexes children, DecoratorTraits tr=get_default_decorator_traits())
 
static Hierarchy setup_particle (IMP::ParticleAdaptor d, ParticleIndexes children, DecoratorTraits tr=get_default_decorator_traits())
 
static Hierarchy setup_particle (IMP::ParticleAdaptor d, ParticlesTemp children, DecoratorTraits tr=get_default_decorator_traits())
 
static Hierarchy setup_particle (Model *m, ParticleIndex pi, ParticlesTemp children, DecoratorTraits tr=get_default_decorator_traits())
 

Additional Inherited Members

- Public Types inherited from IMP::core::Hierarchy
typedef HierarchyTraits DecoratorTraits
 
- Protected Member Functions inherited from IMP::Decorator
 Decorator (Model *m, ParticleIndex pi)
 
 Decorator (ParticleAdaptor p)
 

Member Function Documentation

void IMP::atom::Representation::add_representation ( ParticleIndexAdaptor  rep,
RepresentationType  type = BALLS,
double  resolution = -1 
)

Add the representation for the given resolution.

If the resolution is not given it is computed using get_resolution(). Currently only 'BALLS' and 'DENSITIES' are supported; eventually, other types of representation may be supported.

Hierarchy IMP::atom::Representation::get_representation ( double  resolution,
RepresentationType  type = BALLS 
)

Get children at the resolution closest to resolution of the passed type.

Hierarchies IMP::atom::Representation::get_representations ( RepresentationType  type = BALLS)

Return all children at all resolutions.

Floats IMP::atom::Representation::get_resolutions ( RepresentationType  type = BALLS) const

Get all resolutions that are available for a specific RepresentationType.

static Representation IMP::atom::Representation::setup_particle ( Model m,
ParticleIndex  pi 
)
static

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

Definition at line 55 of file Representation.h.

static Representation IMP::atom::Representation::setup_particle ( IMP::ParticleAdaptor  decorator,
double  resolution 
)
static
See Also
setup_particle(m, pi, resolution )

Definition at line 56 of file Representation.h.

static Representation IMP::atom::Representation::setup_particle ( Model m,
ParticleIndex  pi,
double  resolution 
)
static

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

Definition at line 56 of file Representation.h.

static Representation IMP::atom::Representation::setup_particle ( IMP::ParticleAdaptor  decorator,
Representation  other 
)
static
See Also
setup_particle(m, pi, other )

Definition at line 57 of file Representation.h.

static Representation IMP::atom::Representation::setup_particle ( Model m,
ParticleIndex  pi,
Representation  other 
)
static

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

Definition at line 57 of file Representation.h.

void IMP::atom::Representation::update_parents ( )

If you've changed the parent, update all the resolutions.


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