Rosetta Core  2014.35
Public Member Functions | Private Member Functions | Private Attributes | List of all members
core::scoring::sasa::SasaCalc Class Reference

Main interface to sasa calculations outside of pose metrics. More...

#include <SasaCalc.hh>

Public Member Functions

 SasaCalc ()
 
 SasaCalc (SasaMethodEnum method)
 
virtual ~SasaCalc ()
 
Real calculate (const pose::Pose &pose)
 Calculate Sasa. Atoms not calculated have -1 sasa in AtomID_Map. This is carried over for compatability purposes. More...
 
Real calculate (const pose::Pose &pose, id::AtomID_Map< Real > &atom_sasa)
 
Real calculate (const pose::Pose &pose, utility::vector1< Real > &rsd_sasa, utility::vector1< Real > &rsd_hsasa)
 
Real calculate (const pose::Pose &pose, id::AtomID_Map< Real > &atom_sasa, utility::vector1< Real > &rsd_sasa, utility::vector1< Real > &rsd_hsasa)
 
Real calculate (const pose::Pose &pose, id::AtomID_Map< Real > &atom_sasa, utility::vector1< Real > &rsd_sasa, utility::vector1< Real > &rsd_hsasa, utility::vector1< Real > &rsd_rel_hsasa)
 
id::AtomID_Map< Real > get_atom_sasa () const
 
void fill_data (Real &total_hsasa, Real &total_rel_hsasa, id::AtomID_Map< Real > &atom_sasa, utility::vector1< Real > &rsd_sasa, utility::vector1< Real > &rsd_hsasa, utility::vector1< Real > &rel_hsasa)
 Convenience function to fill most commonly used data. More...
 
utility::vector1< Real > get_residue_sasa () const
 
utility::vector1< Real > get_residue_sasa_bb () const
 
utility::vector1< Real > get_residue_sasa_sc () const
 
utility::vector1< Real > get_residue_hsasa () const
 
utility::vector1< Real > get_residue_hsasa_bb () const
 
utility::vector1< Real > get_residue_hsasa_sc () const
 
utility::vector1< Real > get_rel_hphobic_sasa_by_charge () const
 
Real get_total_sasa () const
 
Real get_total_sasa_sc () const
 
Real get_total_sasa_bb () const
 
Real get_total_hsasa () const
 
Real get_total_hsasa_sc () const
 
Real get_total_hsasa_bb () const
 
Real get_total_rel_hsasa () const
 
void set_defaults ()
 
void set_calculation_method (SasaMethodEnum method)
 
void set_include_hydrogens_explicitly (bool include_hydrogens)
 Include hydrogens explicitly. More...
 
void set_probe_radius (Real probe_radius)
 Probe radius of 1.4 (water) is typically used. More...
 
void set_include_probe_radius_in_atom_radii (bool include_probe_radius)
 This is typically done. Disabling it is more akin to obtaining the Surface Area than the SASA. More...
 
void set_include_carbon_sulfer_only_in_hydrophobic_calc (bool include_c_s_only)
 Typically, only carbon or sulfers are included in the calculation. If you are using ligands - this may not be good enough. More...
 
void set_exclude_polar_atoms_by_charge (bool exclude_polar_all)
 Polar carbons and other atoms should not be included in hydrophobic hSASA - though historically they were. .4 is a relative number. This makes sure that carbonyl and carboxyl carbons are marked as polar, while others (protein-based) are non-polar. More...
 
void set_polar_charge_cutoff (Real cutoff)
 
void set_implicit_hydrogen_included_radii_set (SasaRadii radii_set)
 Radii set to use when not including hydrogens (naccess/chothia, legacy) Do not use legacy unless you know what you are doing and why. More...
 
void set_explicit_hydrogen_included_radii_set (SasaRadii radii_set)
 Radii set to use when including hydrogens (LJ/reduce) More...
 
void set_use_big_polar_hydrogen (bool big_polar_h)
 Not for general use. Used to calculate unsatisfied buried polars with legacy radii (which implicitly had included hydrogens.) More...
 

Private Member Functions

void init (const pose::Pose &pose)
 
void setup_sasa_method (SasaRadii radii_set)
 Creates and sets up the sasa method before calculate is called on the instance. More...
 
void calc_per_res_sasas (const pose::Pose &pose)
 

Private Attributes

SasaMethodEnum method_type_
 
SasaMethodOP method_
 
SasaRadii implicit_radii_set_
 
SasaRadii explicit_radii_set_
 
bool include_hydrogens_
 
Real probe_radius_
 
bool include_c_s_only_in_hsasa_
 
bool exclude_polar_all_in_hsasa_
 
Real polar_charge_cutoff_
 
bool include_probe_radius_
 
bool big_polar_h_
 
id::AtomID_Map< bool > atom_subset_
 
id::AtomID_Map< Real > atom_sasa_
 
utility::vector1< Real > rsd_sasa_
 
utility::vector1< Real > rsd_sasa_sc_
 
utility::vector1< Real > rsd_hsasa_
 
utility::vector1< Real > rsd_hsasa_sc_
 
utility::vector1< Real > rel_hydrophobic_sasa_by_charge_
 
Real total_sasa_
 
Real total_sasa_sc_
 
Real total_hsasa_
 
Real total_hsasa_sc_
 
Real total_rel_hsasa_
 

Detailed Description

Main interface to sasa calculations outside of pose metrics.

Constructor & Destructor Documentation

core::scoring::sasa::SasaCalc::SasaCalc ( )

References core::scoring::sasa::LeGrand, method_type_, and set_defaults().

core::scoring::sasa::SasaCalc::SasaCalc ( SasaMethodEnum  method)

References method_type_, and set_defaults().

core::scoring::sasa::SasaCalc::~SasaCalc ( )
virtual

Member Function Documentation

void core::scoring::sasa::SasaCalc::calc_per_res_sasas ( const pose::Pose &  pose)
private

References core::chemical::ResidueType::atom(), core::conformation::Residue::atom_is_backbone(), atom_sasa_, atom_subset_, core::conformation::Residue::atom_type(), core::chemical::ResidueType::bonded_neighbor(), core::chemical::Atom::charge(), core::chemical::AtomType::element(), exclude_polar_all_in_hsasa_, include_c_s_only_in_hsasa_, include_hydrogens_, core::conformation::Residue::natoms(), polar_charge_cutoff_, rel_hydrophobic_sasa_by_charge_, core::pose::Pose::residue(), rsd_hsasa_, rsd_hsasa_sc_, rsd_sasa_, rsd_sasa_sc_, total_hsasa_, total_hsasa_sc_, total_rel_hsasa_, core::pose::Pose::total_residue(), total_sasa_sc_, core::conformation::Residue::type(), and utility_exit_with_message.

Referenced by calculate().

Real core::scoring::sasa::SasaCalc::calculate ( const pose::Pose &  pose)

Calculate Sasa. Atoms not calculated have -1 sasa in AtomID_Map. This is carried over for compatability purposes.

References atom_sasa_, atom_subset_, calc_per_res_sasas(), explicit_radii_set_, implicit_radii_set_, include_hydrogens_, init(), method_, rsd_sasa_, setup_sasa_method(), and total_sasa_.

Referenced by calculate().

Real core::scoring::sasa::SasaCalc::calculate ( const pose::Pose &  pose,
id::AtomID_Map< Real > &  atom_sasa 
)

References atom_sasa_, and calculate().

Real core::scoring::sasa::SasaCalc::calculate ( const pose::Pose &  pose,
utility::vector1< Real > &  rsd_sasa,
utility::vector1< Real > &  rsd_hsasa 
)

References calculate(), rsd_hsasa_, and rsd_sasa_.

Real core::scoring::sasa::SasaCalc::calculate ( const pose::Pose &  pose,
id::AtomID_Map< Real > &  atom_sasa,
utility::vector1< Real > &  rsd_sasa,
utility::vector1< Real > &  rsd_hsasa 
)

References atom_sasa_, and calculate().

Real core::scoring::sasa::SasaCalc::calculate ( const pose::Pose &  pose,
id::AtomID_Map< Real > &  atom_sasa,
utility::vector1< Real > &  rsd_sasa,
utility::vector1< Real > &  rsd_hsasa,
utility::vector1< Real > &  rsd_rel_hsasa 
)

References calculate(), and rel_hydrophobic_sasa_by_charge_.

void core::scoring::sasa::SasaCalc::fill_data ( Real &  total_hsasa,
Real &  total_rel_hsasa,
id::AtomID_Map< Real > &  atom_sasa,
utility::vector1< Real > &  rsd_sasa,
utility::vector1< Real > &  rsd_hsasa,
utility::vector1< Real > &  rel_hsasa 
)

Convenience function to fill most commonly used data.

References atom_sasa_, rel_hydrophobic_sasa_by_charge_, rsd_hsasa_, rsd_sasa_, total_hsasa_, and total_rel_hsasa_.

id::AtomID_Map< Real > core::scoring::sasa::SasaCalc::get_atom_sasa ( ) const
inline

Data Access

References atom_sasa_.

utility::vector1<Real > core::scoring::sasa::SasaCalc::get_rel_hphobic_sasa_by_charge ( ) const
inline

References rel_hydrophobic_sasa_by_charge_.

utility::vector1< Real > core::scoring::sasa::SasaCalc::get_residue_hsasa ( ) const
inline

References rsd_hsasa_.

vector1< Real > core::scoring::sasa::SasaCalc::get_residue_hsasa_bb ( ) const

References rsd_hsasa_, and rsd_hsasa_sc_.

utility::vector1< Real > core::scoring::sasa::SasaCalc::get_residue_hsasa_sc ( ) const
inline

References rsd_hsasa_sc_.

utility::vector1<Real> core::scoring::sasa::SasaCalc::get_residue_sasa ( ) const
inline

References rsd_sasa_.

vector1< Real > core::scoring::sasa::SasaCalc::get_residue_sasa_bb ( ) const

References rsd_sasa_, and rsd_sasa_sc_.

utility::vector1< Real > core::scoring::sasa::SasaCalc::get_residue_sasa_sc ( ) const
inline

References rsd_sasa_sc_.

Real core::scoring::sasa::SasaCalc::get_total_hsasa ( ) const
inline

References total_hsasa_.

Real core::scoring::sasa::SasaCalc::get_total_hsasa_bb ( ) const
inline

References total_hsasa_, and total_hsasa_sc_.

Real core::scoring::sasa::SasaCalc::get_total_hsasa_sc ( ) const
inline

References total_hsasa_sc_.

Real core::scoring::sasa::SasaCalc::get_total_rel_hsasa ( ) const
inline

References total_rel_hsasa_.

Real core::scoring::sasa::SasaCalc::get_total_sasa ( ) const
inline

References total_sasa_.

Real core::scoring::sasa::SasaCalc::get_total_sasa_bb ( ) const
inline

References total_sasa_, and total_sasa_sc_.

Real core::scoring::sasa::SasaCalc::get_total_sasa_sc ( ) const
inline

References total_sasa_sc_.

void core::scoring::sasa::SasaCalc::init ( const pose::Pose &  pose)
private

References atom_sasa_, atom_subset_, core::id::AtomID_Map< T >::clear(), include_hydrogens_, core::pose::initialize_atomid_map(), core::conformation::Residue::nheavyatoms(), rel_hydrophobic_sasa_by_charge_, core::pose::Pose::residue(), rsd_hsasa_, rsd_hsasa_sc_, rsd_sasa_, rsd_sasa_sc_, total_hsasa_, total_hsasa_sc_, total_rel_hsasa_, core::pose::Pose::total_residue(), total_sasa_, and total_sasa_sc_.

Referenced by calculate().

void core::scoring::sasa::SasaCalc::set_calculation_method ( SasaMethodEnum  method)

References method_type_.

Referenced by set_defaults().

void core::scoring::sasa::SasaCalc::set_defaults ( )

Options

References core::scoring::sasa::get_sasa_method_from_string(), core::scoring::sasa::get_sasa_radii_set_from_string(), option, set_calculation_method(), set_exclude_polar_atoms_by_charge(), set_explicit_hydrogen_included_radii_set(), set_implicit_hydrogen_included_radii_set(), set_include_carbon_sulfer_only_in_hydrophobic_calc(), set_include_hydrogens_explicitly(), set_include_probe_radius_in_atom_radii(), set_polar_charge_cutoff(), set_probe_radius(), and set_use_big_polar_hydrogen().

Referenced by SasaCalc().

void core::scoring::sasa::SasaCalc::set_exclude_polar_atoms_by_charge ( bool  exclude_polar_all)

Polar carbons and other atoms should not be included in hydrophobic hSASA - though historically they were. .4 is a relative number. This makes sure that carbonyl and carboxyl carbons are marked as polar, while others (protein-based) are non-polar.

References exclude_polar_all_in_hsasa_.

Referenced by set_defaults().

void core::scoring::sasa::SasaCalc::set_explicit_hydrogen_included_radii_set ( SasaRadii  radii_set)

Radii set to use when including hydrogens (LJ/reduce)

References explicit_radii_set_.

Referenced by set_defaults().

void core::scoring::sasa::SasaCalc::set_implicit_hydrogen_included_radii_set ( SasaRadii  radii_set)

Radii set to use when not including hydrogens (naccess/chothia, legacy) Do not use legacy unless you know what you are doing and why.

References implicit_radii_set_.

Referenced by set_defaults().

void core::scoring::sasa::SasaCalc::set_include_carbon_sulfer_only_in_hydrophobic_calc ( bool  include_c_s_only)

Typically, only carbon or sulfers are included in the calculation. If you are using ligands - this may not be good enough.

References include_c_s_only_in_hsasa_.

Referenced by set_defaults().

void core::scoring::sasa::SasaCalc::set_include_hydrogens_explicitly ( bool  include_hydrogens)

Include hydrogens explicitly.

References include_hydrogens_.

Referenced by set_defaults().

void core::scoring::sasa::SasaCalc::set_include_probe_radius_in_atom_radii ( bool  include_probe_radius)

This is typically done. Disabling it is more akin to obtaining the Surface Area than the SASA.

References include_probe_radius_.

Referenced by set_defaults().

void core::scoring::sasa::SasaCalc::set_polar_charge_cutoff ( core::Real  cutoff)

References polar_charge_cutoff_.

Referenced by set_defaults().

void core::scoring::sasa::SasaCalc::set_probe_radius ( core::Real  probe_radius)

Probe radius of 1.4 (water) is typically used.

References probe_radius_.

Referenced by set_defaults().

void core::scoring::sasa::SasaCalc::set_use_big_polar_hydrogen ( bool  big_polar_h)

Not for general use. Used to calculate unsatisfied buried polars with legacy radii (which implicitly had included hydrogens.)

Legacy Options

References big_polar_h_.

Referenced by set_defaults().

void core::scoring::sasa::SasaCalc::setup_sasa_method ( SasaRadii  radii_set)
private

Creates and sets up the sasa method before calculate is called on the instance.

References big_polar_h_, core::scoring::sasa::create_sasa_method(), include_probe_radius_, method_, method_type_, and probe_radius_.

Referenced by calculate().

Member Data Documentation

id::AtomID_Map< Real > core::scoring::sasa::SasaCalc::atom_sasa_
private

Referenced by calc_per_res_sasas(), calculate(), fill_data(), get_atom_sasa(), and init().

id::AtomID_Map< bool > core::scoring::sasa::SasaCalc::atom_subset_
private

Referenced by calc_per_res_sasas(), calculate(), and init().

bool core::scoring::sasa::SasaCalc::big_polar_h_
private

Referenced by set_use_big_polar_hydrogen(), and setup_sasa_method().

bool core::scoring::sasa::SasaCalc::exclude_polar_all_in_hsasa_
private

Referenced by calc_per_res_sasas(), and set_exclude_polar_atoms_by_charge().

SasaRadii core::scoring::sasa::SasaCalc::explicit_radii_set_
private

Referenced by calculate(), and set_explicit_hydrogen_included_radii_set().

SasaRadii core::scoring::sasa::SasaCalc::implicit_radii_set_
private

Referenced by calculate(), and set_implicit_hydrogen_included_radii_set().

bool core::scoring::sasa::SasaCalc::include_c_s_only_in_hsasa_
private

Referenced by calc_per_res_sasas(), and set_include_carbon_sulfer_only_in_hydrophobic_calc().

bool core::scoring::sasa::SasaCalc::include_hydrogens_
private

Referenced by calc_per_res_sasas(), calculate(), init(), and set_include_hydrogens_explicitly().

bool core::scoring::sasa::SasaCalc::include_probe_radius_
private

Referenced by set_include_probe_radius_in_atom_radii(), and setup_sasa_method().

SasaMethodOP core::scoring::sasa::SasaCalc::method_
private

Referenced by calculate(), and setup_sasa_method().

SasaMethodEnum core::scoring::sasa::SasaCalc::method_type_
private

Referenced by SasaCalc(), set_calculation_method(), and setup_sasa_method().

Real core::scoring::sasa::SasaCalc::polar_charge_cutoff_
private

Referenced by calc_per_res_sasas(), and set_polar_charge_cutoff().

Real core::scoring::sasa::SasaCalc::probe_radius_
private

Referenced by set_probe_radius(), and setup_sasa_method().

utility::vector1< Real > core::scoring::sasa::SasaCalc::rel_hydrophobic_sasa_by_charge_
private

Referenced by calc_per_res_sasas(), calculate(), fill_data(), get_rel_hphobic_sasa_by_charge(), and init().

utility::vector1< Real > core::scoring::sasa::SasaCalc::rsd_hsasa_
private

Referenced by calc_per_res_sasas(), calculate(), fill_data(), get_residue_hsasa(), get_residue_hsasa_bb(), and init().

utility::vector1< Real > core::scoring::sasa::SasaCalc::rsd_hsasa_sc_
private

Referenced by calc_per_res_sasas(), get_residue_hsasa_bb(), get_residue_hsasa_sc(), and init().

utility::vector1< Real > core::scoring::sasa::SasaCalc::rsd_sasa_
private

Referenced by calc_per_res_sasas(), calculate(), fill_data(), get_residue_sasa(), get_residue_sasa_bb(), and init().

utility::vector1< Real> core::scoring::sasa::SasaCalc::rsd_sasa_sc_
private

Referenced by calc_per_res_sasas(), get_residue_sasa_bb(), get_residue_sasa_sc(), and init().

Real core::scoring::sasa::SasaCalc::total_hsasa_
private

Referenced by calc_per_res_sasas(), fill_data(), get_total_hsasa(), get_total_hsasa_bb(), and init().

Real core::scoring::sasa::SasaCalc::total_hsasa_sc_
private

Referenced by calc_per_res_sasas(), get_total_hsasa_bb(), get_total_hsasa_sc(), and init().

Real core::scoring::sasa::SasaCalc::total_rel_hsasa_
private

Referenced by calc_per_res_sasas(), fill_data(), get_total_rel_hsasa(), and init().

Real core::scoring::sasa::SasaCalc::total_sasa_
private

Referenced by calculate(), get_total_sasa(), get_total_sasa_bb(), and init().

Real core::scoring::sasa::SasaCalc::total_sasa_sc_
private

Referenced by calc_per_res_sasas(), get_total_sasa_bb(), get_total_sasa_sc(), and init().

The documentation for this class was generated from the following files:
Generated on Wed Sep 10 2014 11:28:18 for Rosetta Core by   doxygen 1.8.7