IMP logo
IMP Reference Guide  2.20.2
The Integrative Modeling Platform
IMP::core::ClusterProvenance Class Reference

Track creation of a system fragment from clustering. More...

#include <IMP/core/provenance.h>

+ Inheritance diagram for IMP::core::ClusterProvenance:

Detailed Description

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...
 
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 (Model *m, ParticleIndex pi)
 
static bool get_is_setup (const IMP::ParticleAdaptor &p)
 
static ClusterProvenance setup_particle (IMP::ParticleAdaptor pa, 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 pa, 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 pa, int members, double precision, std::string density)
 
static ClusterProvenance setup_particle (IMP::ParticleAdaptor pa, 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 pa)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::Decorator
 Decorator (Model *m, ParticleIndex pi)
 
 Decorator (ParticleAdaptor p)
 

Member Function Documentation

std::string IMP::core::ClusterProvenance::get_density ( ) const
Returns
the localization probability density filename, as an absolute path

Definition at line 494 of file provenance.h.

+ Here is the call graph for this function:

int IMP::core::ClusterProvenance::get_number_of_members ( ) const
Returns
the number of cluster members

Definition at line 463 of file provenance.h.

+ Here is the call graph for this function:

double IMP::core::ClusterProvenance::get_precision ( ) const
Returns
the cluster precision

Definition at line 474 of file provenance.h.

+ Here is the call graph for this function:

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.

+ Here is the call graph for this function:

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.

+ Here is the call graph for this function:

void IMP::core::ClusterProvenance::set_precision ( double  precision) const

Set the cluster precision.

Definition at line 468 of file provenance.h.

+ Here is the call graph for this function:

static ClusterProvenance IMP::core::ClusterProvenance::setup_particle ( IMP::ParticleAdaptor  pa,
int  members 
)
static
Returns
a ClusterProvenance object that decorates the particle specified by pa
See Also
setup_particle(m, pi, members )

Definition at line 499 of file provenance.h.

static ClusterProvenance IMP::core::ClusterProvenance::setup_particle ( Model m,
ParticleIndex  pi,
int  members 
)
static
Returns
a ClusterProvenance object that decorates particle pi

Definition at line 499 of file provenance.h.

static ClusterProvenance IMP::core::ClusterProvenance::setup_particle ( IMP::ParticleAdaptor  pa,
int  members,
double  precision 
)
static
Returns
a ClusterProvenance object that decorates the particle specified by pa
See Also
setup_particle(m, p, members , precision )

Definition at line 500 of file provenance.h.

static ClusterProvenance IMP::core::ClusterProvenance::setup_particle ( Model m,
ParticleIndex  pi,
int  members,
double  precision 
)
static
Returns
a ClusterProvenance object that decorates particle pi

Definition at line 500 of file provenance.h.

static ClusterProvenance IMP::core::ClusterProvenance::setup_particle ( IMP::ParticleAdaptor  pa,
int  members,
double  precision,
std::string  density 
)
static
Returns
a ClusterProvenance object that decorates the particle specified by pa
See Also
setup_particle(m, pi, members , precision , density )

Definition at line 502 of file provenance.h.

static ClusterProvenance IMP::core::ClusterProvenance::setup_particle ( Model m,
ParticleIndex  pi,
int  members,
double  precision,
std::string  density 
)
static
Returns
a ClusterProvenance object that decorates particle pi

Definition at line 502 of file provenance.h.

static ClusterProvenance IMP::core::ClusterProvenance::setup_particle ( Model m,
ParticleIndex  pi,
ClusterProvenance  o 
)
static
Returns
a ClusterProvenance object that decorates particle pi

Definition at line 503 of file provenance.h.

static ClusterProvenance IMP::core::ClusterProvenance::setup_particle ( IMP::ParticleAdaptor  pa,
ClusterProvenance  o 
)
static
Returns
a ClusterProvenance object that decorates the particle specified by pa
See Also
setup_particle(m, pi, o )

Definition at line 503 of file provenance.h.


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