Return the hierarchy children of a particle. More...

#include <IMP/core/ChildrenRefiner.h>

Inheritance diagram for IMP::core::ChildrenRefiner:

Public Member Functions
	ChildrenRefiner (HierarchyTraits tr)
	Create a refiner for a particular type of hierarchy.

virtual kernel::ModelObjectsTemp	do_get_inputs (kernel::Model *m, const kernel::ParticleIndexes &pis) const

virtual bool	get_can_refine (kernel::Particle *) const
	Return true if this refiner can refine that particle. More...

virtual const kernel::ParticlesTemp	get_refined (kernel::Particle *) const
	Refine the passed particle into a set of particles. More...

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::Refiner
	Refiner (std::string name="Refiner %1%")

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

RefinedIterator	refined_begin (Particle *a) const

RefinedIterator	refined_end (Particle *a) 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::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::Refiner
typedef internal::IndexingIterator < Accessor >	RefinedIterator

Protected Member Functions inherited from IMP::base::Object
	Object (std::string name)
	Construct an object with the given name. More...

	Object ()

Detailed Description

A simple example using is

 ## \example core/cover_particles.py
 # Show how to maintain a sphere per residue which includes all atoms
 # of the residue. The derivatives are propagated from the sphere
 # cover to the atoms so that restraints can be used at multiple
 # levels.
 
 import IMP
 import IMP.core
 import IMP.atom
 import IMP.atom
 
 m = IMP.kernel.Model()
 prot = IMP.atom.read_pdb(IMP.core.get_example_path('example_protein.pdb'), m)
 res = IMP.atom.get_by_type(prot, IMP.atom.RESIDUE_TYPE)
 pr = IMP.core.ChildrenRefiner(IMP.atom.Hierarchy.get_traits())
 for r in res:
     # add coordinates and a radius to the residue particle
     IMP.core.XYZR.setup_particle(r)
     # make sure that the coordinates and the radius define a sphere
     # which contains all of the leaves (atoms) of the residue
     IMP.core.Cover.setup_particle(r.get_particle(), pr)
 # update the coordinates of the residue particles so that they cover the atoms
 m.update()