IMP Reference Guide
develop.63b38c487d,2024/12/21
The Integrative Modeling Platform
|
A lookup based particle refiner. More...
#include <IMP/core/TableRefiner.h>
A lookup based particle refiner.
Each particle is refined by returning the list of particles stored for it in a table.
Definition at line 21 of file TableRefiner.h.
Public Member Functions | |
TableRefiner () | |
Initialize it with an empty table. More... | |
void | add_particle (Particle *p, const ParticlesTemp &ps) |
Add a mapping to the table. More... | |
virtual ModelObjectsTemp | do_get_inputs (Model *m, const ParticleIndexes &pis) const override |
Overload this method to specify the inputs. More... | |
virtual bool | get_can_refine (Particle *) const override |
Return true if this refiner can refine that particle. More... | |
virtual const ParticlesTemp | get_refined (Particle *) const override |
Refine the passed particle into a set of particles. More... | |
virtual std::string | get_type_name () const override |
virtual ::IMP::VersionInfo | get_version_info () const override |
Get information about the module and version of the object. More... | |
void | remove_particle (Particle *p) |
Remove a mapping from the table. More... | |
void | set_particle (Particle *p, const ParticlesTemp &ps) |
Set the mapping for a particular particle. More... | |
Public Member Functions inherited from IMP::Refiner | |
Refiner (std::string name="Refiner %1%", bool is_by_ref=false) | |
Constructs the refiner. More... | |
bool | get_is_by_ref_supported () |
virtual unsigned int | get_number_of_refined (Particle *a) const |
virtual Particle * | get_refined (Particle *a, unsigned int i) const |
Get the ith refined particle. More... | |
virtual ParticleIndexes | get_refined_indexes (Model *m, ParticleIndex pi) const |
Return the indexes of the particles returned by get_refined() More... | |
virtual ParticleIndexes const & | get_refined_indexes_by_ref (Model *m, ParticleIndex pi) const |
Return the indexes of the particles returned by get_refined() More... | |
RefinedIterator | refined_begin (Particle *a) const |
RefinedIterator | refined_end (Particle *a) const |
Public Member Functions inherited from IMP::ParticleInputs | |
ModelObjectsTemp | get_inputs (Model *m, const ParticleIndexes &pis) const |
Get the ModelObjects read when the given list of particles is used. More... | |
Public Member Functions inherited from IMP::Object | |
virtual void | clear_caches () |
CheckLevel | get_check_level () const |
LogLevel | get_log_level () const |
void | set_check_level (CheckLevel l) |
void | set_log_level (LogLevel l) |
Set the logging level used in this object. More... | |
void | set_was_used (bool tf) const |
void | show (std::ostream &out=std::cout) const |
const std::string & | get_name () const |
void | set_name (std::string name) |
Additional Inherited Members | |
Public Types inherited from IMP::Refiner | |
typedef internal::IndexingIterator < Accessor > | RefinedIterator |
Protected Member Functions inherited from IMP::Object | |
Object (std::string name) | |
Construct an object with the given name. More... | |
virtual void | do_destroy () |
IMP::core::TableRefiner::TableRefiner | ( | ) |
Initialize it with an empty table.
void IMP::core::TableRefiner::add_particle | ( | Particle * | p, |
const ParticlesTemp & | ps | ||
) |
Add a mapping to the table.
|
overridevirtual |
Overload this method to specify the inputs.
Implements IMP::ParticleInputs.
|
overridevirtual |
Return true if this refiner can refine that particle.
This should not throw, so be careful what fields are touched.
Reimplemented from IMP::Refiner.
|
overridevirtual |
Refine the passed particle into a set of particles.
As a precondition can_refine_particle(a) should be true.
a | coarse particle to be refined |
Implements IMP::Refiner.
|
overridevirtual |
Get information about the module and version of the object.
Reimplemented from IMP::Object.
Definition at line 45 of file TableRefiner.h.
void IMP::core::TableRefiner::remove_particle | ( | Particle * | p | ) |
Remove a mapping from the table.
void IMP::core::TableRefiner::set_particle | ( | Particle * | p, |
const ParticlesTemp & | ps | ||
) |
Set the mapping for a particular particle.