IMP logo
IMP Reference Guide  develop.714915d50b,2024/12/07
The Integrative Modeling Platform
IMP::em2d::DistanceFilter Class Reference

SubsetFilter for checking overlap between projections and images. More...

#include <IMP/em2d/domino_filters.h>

+ Inheritance diagram for IMP::em2d::DistanceFilter:

Detailed Description

SubsetFilter for checking overlap between projections and images.

Definition at line 25 of file domino_filters.h.

Public Member Functions

 DistanceFilter (const domino::Subset &subset_to_act_on, const domino::Subset &subset_to_restrain, domino::ParticleStatesTable *ps_table, double max_distance)
 
virtual bool get_is_ok (const IMP::domino::Assignment &assignment) const override
 
virtual std::string get_type_name () const override
 
virtual ::IMP::VersionInfo get_version_info () const override
 Get information about the module and version of the object. More...
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::domino::SubsetFilter
 SubsetFilter (std::string name="SubsetFilter%1%")
 
virtual int get_next_state (int pos, const Assignment &state) const
 Return a next possible acceptable state for the particle in pos. 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)
 

Protected Attributes

double max_distance_
 
Pointer
< domino::ParticleStatesTable
ps_table_
 
domino::Subset subset_acting_on_
 
domino::Subset subset_restrained_
 

Additional Inherited Members

- 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::em2d::DistanceFilter::DistanceFilter ( const domino::Subset subset_to_act_on,
const domino::Subset subset_to_restrain,
domino::ParticleStatesTable ps_table,
double  max_distance 
)

Filter action on the distance between two particles. To be used with DOMINO

Parameters
[in]subset_to_act_onA subset that is going to be filtered.
[in]subset_to_restrainA subset of 2 particles that need to be within a given distance
[in]ps_tabletable containing the states for subset_to_act_on and subset_to_restraint
[in]max_distanceThe maximum distance between the particles in subset_to_restrain

Definition at line 44 of file domino_filters.h.

Member Function Documentation

virtual bool IMP::em2d::DistanceFilter::get_is_ok ( const IMP::domino::Assignment state) const
overridevirtual

Return true if the given state passes this filter for the Subset it was created with

Implements IMP::domino::SubsetFilter.

virtual ::IMP::VersionInfo IMP::em2d::DistanceFilter::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 60 of file domino_filters.h.


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