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 void	do_show (std::ostream &out) const

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

virtual unsigned int	get_number_of_refined (Particle *) const

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

virtual Particle *	get_refined (Particle *, unsigned int) const
	Get the ith refined particle. More...

Public Member Functions inherited from IMP::kernel::Refiner
	Refiner (std::string name="Refiner %1%")

ContainersTemp	get_input_containers (Particle *p) const

ParticlesTemp	get_input_particles (Particle *p) const

ModelObjectsTemp	get_inputs (Model *m, const ParticleIndexes &pis) const

RefinedIterator	refined_begin (Particle *a) const

RefinedIterator	refined_end (Particle *a) const

Public Member Functions inherited from IMP::base::Object
virtual void	clear_caches ()

virtual IMP::base::VersionInfo	get_version_info () const =0
	Get information about the module and version of the object.

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::kernel::Refiner
virtual ModelObjectsTemp	do_get_inputs (Model *m, const ParticleIndexes &pis) const =0

Related Functions inherited from IMP::kernel::Refiner
typedef IMP::base::Vector < IMP::base::WeakPointer < Refiner > >	RefinersTemp

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.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()