Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
protocols::features::AtomAtomPairFeatures Class Reference

#include <AtomAtomPairFeatures.hh>

Inheritance diagram for protocols::features::AtomAtomPairFeatures:
Inheritance graph
[legend]

Public Member Functions

 AtomAtomPairFeatures ()
 
 AtomAtomPairFeatures (AtomAtomPairFeatures const &src)
 
 ~AtomAtomPairFeatures () override
 
void write_schema_to_db (utility::sql_database::sessionOP db_session) const override
 return string with class name More...
 
utility::vector1< std::string > features_reporter_dependencies () const override
 return the set of features reporters that are required to also already be extracted by the time this one is used. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
 
core::Size report_features (core::pose::Pose const &pose, utility::vector1< bool > const &relevant_residues, StructureID struct_id, utility::sql_database::sessionOP db_session) override
 collect all the feature data for the pose More...
 
void report_atom_pairs (core::pose::Pose const &pose, utility::vector1< bool > const &relevant_residues, StructureID struct_id, utility::sql_database::sessionOP db_session)
 
std::string type_name () const override
 
- Public Member Functions inherited from protocols::features::FeaturesReporter
 FeaturesReporter ()
 
 ~FeaturesReporter () override
 Automatically generated virtual destructor for class deriving directly from VirtualBase. More...
 
virtual std::string schema () const
 return sql statements that sets up the appropriate tables to contain the features. This should be removed once everything has been moved to the schema generator More...
 
core::Size report_features (core::pose::Pose const &, StructureID, utility::sql_database::sessionOP)
 collect all the feature data for the pose. More...
 
virtual void load_into_pose (utility::sql_database::sessionOP, StructureID, core::pose::Pose &)
 
virtual void delete_record (StructureID, utility::sql_database::sessionOP)
 
void set_relevant_residues_mode (RelevantResiduesMode::T setting)
 
RelevantResiduesMode::T get_relevant_residues_mode () const
 
bool check_relevant_residues (utility::vector1< bool > const &relevant_residues, core::Size res1) const
 
bool check_relevant_residues (utility::vector1< bool > const &relevant_residues, core::Size res1, core::Size res2) const
 
bool check_relevant_residues_range (utility::vector1< bool > const &relevant_residues, core::Size res1, core::Size res2) const
 
bool check_relevant_residues (utility::vector1< bool > const &relevant_residues, utility::vector1< core::Size > const &residues) const
 

Static Public Member Functions

static std::string class_name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 

Private Member Functions

void write_atom_pairs_table_schema (utility::sql_database::sessionOP db_session) const
 generate the atom_in_residue_pairs table schema More...
 

Private Attributes

core::Real min_dist_
 
core::Real max_dist_
 
core::Size nbins_
 
utility::vector1< std::string > relevant_atom_names_
 
std::map< core::Size, core::Sizeatom_index_to_relevant_atom_index_
 
std::map< std::string, core::Sizerelevant_elements_
 

Additional Inherited Members

- Protected Member Functions inherited from protocols::features::FeaturesReporter
std::string find_tag (core::pose::Pose const &pose) const
 
void delete_records_from_table (std::string const &table_name, StructureID struct_id, utility::sql_database::sessionOP db_session)
 a helper function for deleting data associated with a given structure from feature database WARNING table_name must be sanitized! More...
 
- Protected Attributes inherited from protocols::features::FeaturesReporter
RelevantResiduesMode::T relevant_residues_mode_
 

Constructor & Destructor Documentation

protocols::features::AtomAtomPairFeatures::AtomAtomPairFeatures ( )
protocols::features::AtomAtomPairFeatures::AtomAtomPairFeatures ( AtomAtomPairFeatures const &  src)
default
protocols::features::AtomAtomPairFeatures::~AtomAtomPairFeatures ( )
overridedefault

Member Function Documentation

std::string protocols::features::AtomAtomPairFeatures::class_name ( )
static
utility::vector1< std::string > protocols::features::AtomAtomPairFeatures::features_reporter_dependencies ( ) const
overridevirtual

return the set of features reporters that are required to also already be extracted by the time this one is used.

Reimplemented from protocols::features::FeaturesReporter.

void protocols::features::AtomAtomPairFeatures::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &   
)
overridevirtual

Reimplemented from protocols::features::FeaturesReporter.

References max_dist_, min_dist_, and nbins_.

void protocols::features::AtomAtomPairFeatures::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::features::AtomAtomPairFeatures::report_atom_pairs ( core::pose::Pose const &  pose,
utility::vector1< bool > const &  relevant_residues,
StructureID  struct_id,
utility::sql_database::sessionOP  db_session 
)
Size protocols::features::AtomAtomPairFeatures::report_features ( core::pose::Pose const &  pose,
utility::vector1< bool > const &  relevant_residues,
StructureID  struct_id,
utility::sql_database::sessionOP  db_session 
)
overridevirtual

collect all the feature data for the pose

Implements protocols::features::FeaturesReporter.

References report_atom_pairs().

std::string protocols::features::AtomAtomPairFeatures::type_name ( ) const
overridevirtual

Reimplemented from protocols::features::FeaturesReporter.

References class_name().

void protocols::features::AtomAtomPairFeatures::write_atom_pairs_table_schema ( utility::sql_database::sessionOP  db_session) const
private

generate the atom_in_residue_pairs table schema

Referenced by write_schema_to_db().

void protocols::features::AtomAtomPairFeatures::write_schema_to_db ( utility::sql_database::sessionOP  db_session) const
overridevirtual

return string with class name

generate the table schemas and write them to the database

Implements protocols::features::FeaturesReporter.

References write_atom_pairs_table_schema().

Member Data Documentation

std::map<core::Size, core::Size> protocols::features::AtomAtomPairFeatures::atom_index_to_relevant_atom_index_
private
core::Real protocols::features::AtomAtomPairFeatures::max_dist_
private

Referenced by parse_my_tag(), and report_atom_pairs().

core::Real protocols::features::AtomAtomPairFeatures::min_dist_
private

Referenced by parse_my_tag(), and report_atom_pairs().

core::Size protocols::features::AtomAtomPairFeatures::nbins_
private

Referenced by parse_my_tag(), and report_atom_pairs().

utility::vector1<std::string> protocols::features::AtomAtomPairFeatures::relevant_atom_names_
private
std::map<std::string, core::Size> protocols::features::AtomAtomPairFeatures::relevant_elements_
private

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