IMP logo
IMP Reference Guide  develop.374319d7bb,2024/06/17
The Integrative Modeling Platform
IMP::em2d::DistanceFilterTable Class Reference

#include <IMP/em2d/domino_filter_tables.h>

+ Inheritance diagram for IMP::em2d::DistanceFilterTable:

Detailed Description

Table to create DistanceFilters on demand

Definition at line 22 of file domino_filter_tables.h.

Public Member Functions

 DistanceFilterTable (const domino::Subset &subset_to_act_on, domino::ParticleStatesTable *ps_table, double max_distance)
 
virtual double get_strength (const IMP::domino::Subset &s, const IMP::domino::Subsets &excluded) const override
 The strength is a rough metric of how this filter restricts the subset. More...
 
virtual IMP::domino::SubsetFilterget_subset_filter (const IMP::domino::Subset &s, const IMP::domino::Subsets &excluded) 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::SubsetFilterTable
 SubsetFilterTable (std::string name="SubsetFilterTable%1%")
 
- 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_
 
domino::Subset my_subset_
 
Pointer
< domino::ParticleStatesTable
ps_table_
 

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

Member Function Documentation

virtual double IMP::em2d::DistanceFilterTable::get_strength ( const IMP::domino::Subset s,
const IMP::domino::Subsets prior_subsets 
) const
overridevirtual

The strength is a rough metric of how this filter restricts the subset.

It is still kind of nebulous, but as a rough guide, it should be the fraction of the states that are eliminated by the filter.

Implements IMP::domino::SubsetFilterTable.

virtual IMP::domino::SubsetFilter* IMP::em2d::DistanceFilterTable::get_subset_filter ( const IMP::domino::Subset s,
const IMP::domino::Subsets prior_subsets 
) const
overridevirtual

Return a SubsetFilter which acts on the Subset s, given that all the prior_subsets have already been filtered. This should return nullptr if there is no filtering to be done.

Implements IMP::domino::SubsetFilterTable.

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

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 49 of file domino_filter_tables.h.


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