Detailed Description

Track creation of a system fragment by filtering.

Part of the system (usually the top of a Hierarchy) tagged with this decorator is understood to be a single frame within an ensemble that resulted from filtering a larger ensemble (the 'previous' provenance) in some fashion, such as

by discarding models with scores above the threshold;
by ranking the models and keeping the best scoring subset;
by keeping a fraction of models from the ensemble.

Exceptions

UsageException if method not in get_allowed_methods()

Definition at line 340 of file provenance.h.

Public Member Functions
	FilterProvenance (::IMP::Model *m,::IMP::ParticleIndex id)

	FilterProvenance (const IMP::ParticleAdaptor &d)

std::string	get_method () const

int	get_number_of_frames () const

double	get_threshold () const

void	set_method (std::string method) const

void	set_number_of_frames (int frames) const
	Set the number of frames. More...

void	set_threshold (double threshold) const
	Set the score threshold. 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 FilterProvenance	setup_particle (IMP::ParticleAdaptor pa, std::string method, double threshold, int frames)

static FilterProvenance	setup_particle (Model *m, ParticleIndex pi, std::string method, double threshold, int frames)

static FilterProvenance	setup_particle (IMP::ParticleAdaptor pa, FilterProvenance o)

static FilterProvenance	setup_particle (Model *m, ParticleIndex pi, FilterProvenance 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 pa)

Additional Inherited Members
Protected Member Functions inherited from IMP::Decorator
	Decorator (Model *m, ParticleIndex pi)

	Decorator (ParticleAdaptor p)