IMP::core::GenericBoundingBox3DSingletonScore< UF > Class Template Reference

Score particles based on how far outside a box they are. More...

#include <IMP/core/BoundingBox3DSingletonScore.h>

Inheritance diagram for IMP::core::GenericBoundingBox3DSingletonScore< UF >:

Public Member Functions
	GenericBoundingBox3DSingletonScore (UF *f, const algebra::BoundingBoxD< 3 > &bb)
virtual kernel::ModelObjectsTemp	do_get_inputs (kernel::Model *m, const kernel::ParticleIndexes &pis) const
double	evaluate_if_good_indexes (kernel::Model *m, const kernel::ParticleIndexes &p, DerivativeAccumulator *da, double max, unsigned int lower_bound, unsigned int upper_bound) const
virtual double	evaluate_index (kernel::Model *m, kernel::ParticleIndex p, DerivativeAccumulator *da) const
	Compute the score and the derivative if needed.
double	evaluate_indexes (kernel::Model *m, const kernel::ParticleIndexes &p, DerivativeAccumulator *da, unsigned int lower_bound, unsigned int upper_bound) 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::SingletonScore
	SingletonScore (std::string name="SingletonScore %1%")
Restraints	create_current_decomposition (kernel::Model *m, kernel::ParticleIndex vt) const
virtual double	evaluate (kernel::Particle *vt, DerivativeAccumulator *da) const
	Compute the score and the derivative if needed. More...
virtual double	evaluate_if_good_index (kernel::Model *m, kernel::ParticleIndex vt, DerivativeAccumulator *da, double max) const
	Compute the score and the derivative if needed.
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::SingletonScore
typedef kernel::Particle *	Argument
typedef kernel::ParticleIndex	IndexArgument
typedef SingletonModifier	Modifier
typedef kernel::Particle *	PassArgument
typedef kernel::ParticleIndex	PassIndexArgument
Protected Member Functions inherited from IMP::kernel::SingletonScore
virtual Restraints	do_create_current_decomposition (kernel::Model *m, kernel::ParticleIndex vt) const
Protected Member Functions inherited from IMP::base::Object
	Object (std::string name)
	Construct an object with the given name. More...

Detailed Description

template<class UF>
class IMP::core::GenericBoundingBox3DSingletonScore< UF >

The radius of the particle is ignored, only the center coordinates are used. A particle that is contained within the bounding box has a score of 0. The UnaryFunction passed should return 0 when given a feature size of 0 and a positive value when the feature is positive.

Definition at line 30 of file BoundingBox3DSingletonScore.h.

Member Function Documentation

template<class UF >

virtual kernel::ModelObjectsTemp IMP::core::GenericBoundingBox3DSingletonScore< UF >::do_get_inputs ( kernel::Model *  m, const kernel::ParticleIndexes &  pis  ) const

virtual

Overload this method to specify the inputs.

Reimplemented from IMP::kernel::ParticleInputs.

Definition at line 39 of file BoundingBox3DSingletonScore.h.

Here is the call graph for this function:

template<class UF >

double IMP::core::GenericBoundingBox3DSingletonScore< UF >::evaluate_if_good_indexes ( kernel::Model *  m, const kernel::ParticleIndexes &  o, DerivativeAccumulator *  da, double  max, unsigned int  lower_bound, unsigned int  upper_bound  ) const

virtual

Implementations for these are provided by the IMP_SINGLETON_SCORE() macro.

Reimplemented from IMP::kernel::SingletonScore.

Definition at line 43 of file BoundingBox3DSingletonScore.h.

template<class UF >

double IMP::core::GenericBoundingBox3DSingletonScore< UF >::evaluate_indexes ( kernel::Model *  m, const kernel::ParticleIndexes &  o, DerivativeAccumulator *  da, unsigned int  lower_bound, unsigned int  upper_bound  ) const

virtual

Implementations for these are provided by the IMP_SINGLETON_SCORE() macro.

Reimplemented from IMP::kernel::SingletonScore.

Definition at line 43 of file BoundingBox3DSingletonScore.h.

---

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

• BoundingBox3DSingletonScore.h