IMP  2.1.1
The Integrative Modeling Platform
IMP::core::CentroidOfRefined Class Reference

Set the coordinates of the particle to be the centoid of the particles. More...

#include <IMP/core/CentroidOfRefined.h>

+ Inheritance diagram for IMP::core::CentroidOfRefined:

Public Member Functions

 CentroidOfRefined (Refiner *r, FloatKey weight=FloatKey(), FloatKeys ks=XYZ::get_xyz_keys())
 Set the keys ks to be the average of the refined particles.
 
virtual void apply_index (kernel::Model *m, kernel::ParticleIndex a) const
 
virtual void apply_indexes (kernel::Model *m, const ParticleIndexes &o, unsigned int lower_bound, unsigned int upper_bound) const
 
virtual kernel::ModelObjectsTemp do_get_inputs (kernel::Model *m, const kernel::ParticleIndexes &pis) const
 
virtual kernel::ModelObjectsTemp do_get_outputs (kernel::Model *m, const kernel::ParticleIndexes &pis) const
 
virtual std::string get_type_name () const
 
virtual ::IMP::base::VersionInfo get_version_info () const
 Get information about the module and version of the object.
 
- Public Member Functions inherited from IMP::kernel::SingletonModifier
 SingletonModifier (std::string name="SingletonModifier %1%")
 
virtual void apply (Particle *vt) const
 
- Public Member Functions inherited from IMP::kernel::ParticleInputs
virtual ContainersTemp get_input_containers (Particle *p) const
 
virtual ParticlesTemp get_input_particles (Particle *p) const
 
ModelObjectsTemp get_inputs (kernel::Model *m, const ParticleIndexes &pis) const
 
- Public Member Functions inherited from IMP::kernel::ParticleOutputs
virtual ContainersTemp get_output_containers (Particle *p) const
 
virtual ParticlesTemp get_output_particles (Particle *p) const
 
ModelObjectsTemp get_outputs (kernel::Model *m, const ParticleIndexes &pis) const
 
- Public Member Functions inherited from IMP::base::Object
virtual void clear_caches ()
 
virtual void do_destroy ()
 
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::kernel::SingletonModifier
typedef ParticleArgument
 
typedef ParticleIndex IndexArgument
 
- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
 Object ()
 

Detailed Description

An exception is thrown if there are no refined particles. The weight FloatKey can be FloatKey and then all the weights will be equal.

See Also
CoverRefined
DerivativesToRefined
DerivativesFromRefined

Definition at line 31 of file CentroidOfRefined.h.

Member Function Documentation

virtual void IMP::core::CentroidOfRefined::apply_index ( kernel::Model m,
kernel::ParticleIndex  v 
) const
virtual

Apply the function to a single value

Reimplemented from IMP::kernel::SingletonModifier.

virtual void IMP::core::CentroidOfRefined::apply_indexes ( kernel::Model m,
const ParticleIndexes o,
unsigned int  lower_bound,
unsigned int  upper_bound 
) const
virtual

Apply the function to a collection of ParticlesTemp If bounds are passed, only apply to ones between the upper and lower bounds.

Reimplemented from IMP::kernel::SingletonModifier.

Definition at line 46 of file CentroidOfRefined.h.

virtual kernel::ModelObjectsTemp IMP::core::CentroidOfRefined::do_get_inputs ( kernel::Model m,
const kernel::ParticleIndexes pis 
) const
virtual

Overload this method to specify the inputs.

Reimplemented from IMP::kernel::ParticleInputs.

virtual kernel::ModelObjectsTemp IMP::core::CentroidOfRefined::do_get_outputs ( kernel::Model m,
const kernel::ParticleIndexes pis 
) const
virtual

Overload this method to specify the outputs.

Reimplemented from IMP::kernel::ParticleOutputs.


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