Detailed Description

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).

Exceptions

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)