IMP Reference Guide
2.14.0
The Integrative Modeling Platform
|
Track creation of a system fragment from clustering. More...
#include <IMP/core/provenance.h>
Track creation of a system fragment from clustering.
Part of the system (usually the top of a Hierarchy) tagged with this decorator is understood to be a single frame inside a cluster of specified size. The rest of the cluster members are generally stored in a file (e.g. an RMF file).
Definition at line 426 of file provenance.h.
Public Member Functions | |
ClusterProvenance (::IMP::Model *m,::IMP::ParticleIndex id) | |
ClusterProvenance (const IMP::ParticleAdaptor &d) | |
std::string | get_density () const |
int | get_number_of_members () const |
double | get_precision () const |
void | set_density (std::string density) const |
Set the path to the localization probability density for this cluster. More... | |
void | set_number_of_members (int members) const |
Set the number of cluster members. More... | |
void | set_precision (double precision) const |
Set the cluster precision. More... | |
void | show (std::ostream &out=std::cout) const |
Public Member Functions inherited from IMP::core::Provenance | |
Provenance (::IMP::Model *m,::IMP::ParticleIndex id) | |
Provenance (const IMP::ParticleAdaptor &d) | |
Provenance | get_previous () const |
void | set_previous (Provenance p) |
Set the previous provenance. More... | |
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 (Model *m, ParticleIndex pi) |
static bool | get_is_setup (const IMP::ParticleAdaptor &p) |
static ClusterProvenance | setup_particle (IMP::ParticleAdaptor decorator, int members) |
static ClusterProvenance | setup_particle (Model *m, ParticleIndex pi, int members) |
static ClusterProvenance | setup_particle (Model *m, ParticleIndex pi, int members, double precision) |
static ClusterProvenance | setup_particle (IMP::ParticleAdaptor decorator, int members, double precision) |
static ClusterProvenance | setup_particle (Model *m, ParticleIndex pi, int members, double precision, std::string density) |
static ClusterProvenance | setup_particle (IMP::ParticleAdaptor decorator, int members, double precision, std::string density) |
static ClusterProvenance | setup_particle (IMP::ParticleAdaptor decorator, ClusterProvenance o) |
static ClusterProvenance | setup_particle (Model *m, ParticleIndex pi, ClusterProvenance o) |
Static Public Member Functions inherited from IMP::core::Provenance | |
static bool | get_is_setup (Model *m, ParticleIndex pi) |
static bool | get_is_setup (const IMP::ParticleAdaptor &p) |
static Provenance | setup_particle (Model *m, ParticleIndex pi) |
static Provenance | setup_particle (IMP::ParticleAdaptor decorator) |
Additional Inherited Members | |
Protected Member Functions inherited from IMP::Decorator | |
Decorator (Model *m, ParticleIndex pi) | |
Decorator (ParticleAdaptor p) | |
std::string IMP::core::ClusterProvenance::get_density | ( | ) | const |
Definition at line 494 of file provenance.h.
int IMP::core::ClusterProvenance::get_number_of_members | ( | ) | const |
Definition at line 463 of file provenance.h.
double IMP::core::ClusterProvenance::get_precision | ( | ) | const |
Definition at line 474 of file provenance.h.
void IMP::core::ClusterProvenance::set_density | ( | std::string | density | ) | const |
Set the path to the localization probability density for this cluster.
Typically, this is used to point to an MRC file, but can be empty if no such density is available. The path can be relative or absolute. Internally, an absolute path will be stored (although generally it will be converted to a relative path when storing in a file, such as RMF).
Definition at line 485 of file provenance.h.
void IMP::core::ClusterProvenance::set_number_of_members | ( | int | members | ) | const |
Set the number of cluster members.
Definition at line 457 of file provenance.h.
void IMP::core::ClusterProvenance::set_precision | ( | double | precision | ) | const |
Set the cluster precision.
Definition at line 468 of file provenance.h.
|
static |
Definition at line 499 of file provenance.h.
|
static |
Setup the particle so that it can be used with this decorator
Definition at line 499 of file provenance.h.
|
static |
Setup the particle so it can be used with this decorator.
Definition at line 500 of file provenance.h.
|
static |
Setup the particle so it can be used with this decorator.
Definition at line 502 of file provenance.h.
|
static |
Setup the particle so that it can be used with this decorator
Definition at line 503 of file provenance.h.
|
static |
Definition at line 503 of file provenance.h.