IMP Reference Guide
2.14.0
The Integrative Modeling Platform
|
Track creation of a system fragment from sampling. More...
#include <IMP/core/provenance.h>
Track creation of a system fragment from sampling.
Part of the system (usually the top of a Hierarchy) tagged with this decorator is understood to be a single frame from an ensemble of multiple frames generated with some sampling method (e.g. Monte Carlo). Additionally, the number of iterations of the sampler used to generate each frame can be stored, if known and applicable. The rest of the frames are generally stored in a file (e.g. an RMF file).
UsageException | if invalid sampling method |
Definition at line 173 of file provenance.h.
Public Member Functions | |
SampleProvenance (::IMP::Model *m,::IMP::ParticleIndex id) | |
SampleProvenance (const IMP::ParticleAdaptor &d) | |
std::string | get_method () const |
int | get_number_of_frames () const |
int | get_number_of_iterations () const |
int | get_number_of_replicas () const |
void | set_method (std::string method) const |
void | set_number_of_frames (int frames) const |
Set the number of frames. More... | |
void | set_number_of_iterations (int iterations) const |
Set the number of iterations. More... | |
void | set_number_of_replicas (int replicas) const |
Set the number of replicas. 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 SampleProvenance | setup_particle (IMP::ParticleAdaptor decorator, std::string method, int frames, int iterations, int replicas) |
static SampleProvenance | setup_particle (Model *m, ParticleIndex pi, std::string method, int frames, int iterations, int replicas) |
static SampleProvenance | setup_particle (Model *m, ParticleIndex pi, std::string method, int frames, int iterations) |
static SampleProvenance | setup_particle (IMP::ParticleAdaptor decorator, std::string method, int frames, int iterations) |
static SampleProvenance | setup_particle (IMP::ParticleAdaptor decorator, SampleProvenance o) |
static SampleProvenance | setup_particle (Model *m, ParticleIndex pi, SampleProvenance 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::SampleProvenance::get_method | ( | ) | const |
Definition at line 225 of file provenance.h.
int IMP::core::SampleProvenance::get_number_of_frames | ( | ) | const |
Definition at line 236 of file provenance.h.
int IMP::core::SampleProvenance::get_number_of_iterations | ( | ) | const |
Definition at line 247 of file provenance.h.
int IMP::core::SampleProvenance::get_number_of_replicas | ( | ) | const |
Definition at line 259 of file provenance.h.
void IMP::core::SampleProvenance::set_method | ( | std::string | method | ) | const |
Set the sampling method
IMP::UsageException | invalid = not in get_allowed_methods(). |
Definition at line 218 of file provenance.h.
void IMP::core::SampleProvenance::set_number_of_frames | ( | int | frames | ) | const |
Set the number of frames.
Definition at line 230 of file provenance.h.
void IMP::core::SampleProvenance::set_number_of_iterations | ( | int | iterations | ) | const |
Set the number of iterations.
Definition at line 241 of file provenance.h.
void IMP::core::SampleProvenance::set_number_of_replicas | ( | int | replicas | ) | const |
Set the number of replicas.
Definition at line 253 of file provenance.h.
|
static |
Setup the particle so it can be used with this decorator.
Definition at line 266 of file provenance.h.
|
static |
Setup the particle so it can be used with this decorator.
Definition at line 268 of file provenance.h.
|
static |
Setup the particle so that it can be used with this decorator
Definition at line 269 of file provenance.h.
|
static |
Definition at line 269 of file provenance.h.