Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
protocols::pose_metric_calculators::NeighborsByDistanceCalculator Class Reference

#include <NeighborsByDistanceCalculator.hh>

Inheritance diagram for protocols::pose_metric_calculators::NeighborsByDistanceCalculator:
Inheritance graph
[legend]

Public Types

typedef
core::pose::metrics::StructureDependentCalculator 
parent
 

Public Member Functions

 NeighborsByDistanceCalculator (core::Size central_residue, core::Real dist_cutoff=basic::options::option[basic::options::OptionKeys::pose_metrics::neighbor_by_distance_cutoff])
 central_residue is the residue whose neighbors we find More...
 
core::pose::metrics::PoseMetricCalculatorOP clone () const override
 
core::Size central_residue () const
 return central residue More...
 
core::Real dist_cutoff () const
 return distance cutoff More...
 
- Public Member Functions inherited from core::pose::metrics::StructureDependentCalculator
 StructureDependentCalculator ()
 
void notify_structure_change () override
 
void get (std::string const &key, basic::MetricValueBase &val, Pose const &this_pose) override
 
std::string get (std::string const &key, Pose const &this_pose) override
 
- Public Member Functions inherited from core::pose::metrics::PoseMetricCalculator
 PoseMetricCalculator ()
 
virtual void notify_energy_change ()
 

Protected Member Functions

void lookup (std::string const &key, basic::MetricValueBase *valptr) const override
 
std::string print (std::string const &key) const override
 
void recompute (core::pose::Pose const &pose) override
 

Private Attributes

core::Size const central_residue_
 stores the input - whose neighbors are we finding? More...
 
core::Real const dist_cutoff_
 stores the input - how far away is a neighbor? More...
 
core::Size num_neighbors_
 the number of neighbors, INCLUSIVE of this residue More...
 
std::set< core::Sizeneighbors_
 the set of neighbors, INCLUSIVE of this residue More...
 

Detailed Description

this calculator determines the number and resids of residues within X angstroms of the given residue. Its intended purpose is the backend for a TaskOperation that allows one to construct a PackerTask based on neighborhoods around a set of particular residues. (It combines with a NeighborhoodByDistanceCalculator for that purpose). It can return the identity of its seeded central residue and distance (just get functions) and calculate the neighbors and count of neighbors around that residue within that distance. It uses the PointGraph class to do this; if you have a better/faster implementation please code it up and replace this one. Note that returned data is INCLUSIVE of the central residue - it is part of the count and part of the std::set.

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::pose_metric_calculators::NeighborsByDistanceCalculator::NeighborsByDistanceCalculator ( core::Size  central_residue,
core::Real  dist_cutoff = basic::options::option[basic::options::OptionKeys::pose_metrics::neighbor_by_distance_cutoff] 
)

central_residue is the residue whose neighbors we find

Member Function Documentation

core::Size protocols::pose_metric_calculators::NeighborsByDistanceCalculator::central_residue ( ) const
inline

return central residue

References central_residue_.

core::pose::metrics::PoseMetricCalculatorOP protocols::pose_metric_calculators::NeighborsByDistanceCalculator::clone ( ) const
overridevirtual
core::Real protocols::pose_metric_calculators::NeighborsByDistanceCalculator::dist_cutoff ( ) const
inline

return distance cutoff

References dist_cutoff_.

void protocols::pose_metric_calculators::NeighborsByDistanceCalculator::lookup ( std::string const &  key,
basic::MetricValueBase *  valptr 
) const
overrideprotectedvirtual
std::string protocols::pose_metric_calculators::NeighborsByDistanceCalculator::print ( std::string const &  key) const
overrideprotectedvirtual
void protocols::pose_metric_calculators::NeighborsByDistanceCalculator::recompute ( core::pose::Pose const &  pose)
overrideprotectedvirtual

Member Data Documentation

core::Size const protocols::pose_metric_calculators::NeighborsByDistanceCalculator::central_residue_
private

stores the input - whose neighbors are we finding?

Referenced by central_residue(), lookup(), print(), and recompute().

core::Real const protocols::pose_metric_calculators::NeighborsByDistanceCalculator::dist_cutoff_
private

stores the input - how far away is a neighbor?

Referenced by dist_cutoff(), lookup(), print(), and recompute().

std::set< core::Size > protocols::pose_metric_calculators::NeighborsByDistanceCalculator::neighbors_
private

the set of neighbors, INCLUSIVE of this residue

Referenced by lookup(), print(), and recompute().

core::Size protocols::pose_metric_calculators::NeighborsByDistanceCalculator::num_neighbors_
private

the number of neighbors, INCLUSIVE of this residue

Referenced by lookup(), print(), and recompute().


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