IMP logo
IMP Reference Guide  2.16.0
The Integrative Modeling Platform
IMP::core::DerivativesToRefined Class Reference

Copy the derivatives from a coarse particle to its refined particles. More...

#include <IMP/core/DerivativesToRefined.h>

+ Inheritance diagram for IMP::core::DerivativesToRefined:

Detailed Description

Copy the derivatives from a coarse particle to its refined particles.

See Also
DerivatvesFromRefinedSingletonModifier
CoverRefined
CentroidOfRefinedSingletonModifier An example showing a how to use such a score state to maintain a cover of the atoms of a protein by a sphere per residue.
1 ## \example core/cover_particles.py
2 # Show how to maintain a sphere per residue which includes all atoms
3 # of the residue. The derivatives are propagated from the sphere
4 # cover to the atoms so that restraints can be used at multiple
5 # levels.
6 
7 import IMP
8 import IMP.core
9 import IMP.atom
10 import sys
11 
12 IMP.setup_from_argv(sys.argv, "cover particles")
13 
14 m = IMP.Model()
15 prot = IMP.atom.read_pdb(IMP.core.get_example_path('example_protein.pdb'), m)
16 res = IMP.atom.get_by_type(prot, IMP.atom.RESIDUE_TYPE)
18 for r in res:
19  # add coordinates and a radius to the residue particle
21  # make sure that the coordinates and the radius define a sphere
22  # which contains all of the leaves (atoms) of the residue
23  IMP.core.Cover.setup_particle(r.get_particle(), pr)
24 # update the coordinates of the residue particles so that they cover the atoms
25 m.update()

Definition at line 29 of file DerivativesToRefined.h.

Public Member Functions

 DerivativesToRefined (Refiner *r, FloatKeys ks=XYZ::get_xyz_keys())
 Copy ks to the particles returned by r. More...
 
virtual void apply_index (Model *m, ParticleIndex a) const
 
virtual void apply_indexes (Model *m, const ParticleIndexes &o, unsigned int lower_bound, unsigned int upper_bound) const
 
virtual ModelObjectsTemp do_get_inputs (Model *m, const ParticleIndexes &pis) const
 Overload this method to specify the inputs. More...
 
virtual ModelObjectsTemp do_get_outputs (Model *m, const ParticleIndexes &pis) const
 Overload this method to specify the outputs. More...
 
virtual std::string get_type_name () const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
- Public Member Functions inherited from IMP::SingletonModifier
 SingletonModifier (std::string name="SingletonModifier %1%")
 
virtual void apply_indexes_moved (Model *m, const ParticleIndexes &o, unsigned int lower_bound, unsigned int upper_bound, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) 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::ParticleOutputs
ModelObjectsTemp get_outputs (Model *m, const ParticleIndexes &pis) const
 Get the ModelObjects changed 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::SingletonModifier
typedef ParticleArgument
 
typedef ParticleIndex IndexArgument
 
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Constructor & Destructor Documentation

IMP::core::DerivativesToRefined::DerivativesToRefined ( Refiner r,
FloatKeys  ks = XYZ::get_xyz_keys() 
)

Copy ks to the particles returned by r.

Member Function Documentation

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

Apply the function to a single value

Implements IMP::SingletonModifier.

virtual void IMP::core::DerivativesToRefined::apply_indexes ( 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::SingletonModifier.

Definition at line 43 of file DerivativesToRefined.h.

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

Overload this method to specify the inputs.

Implements IMP::ParticleInputs.

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

Overload this method to specify the outputs.

Implements IMP::ParticleOutputs.

virtual ::IMP::VersionInfo IMP::core::DerivativesToRefined::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 44 of file DerivativesToRefined.h.


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