Rosetta 3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
core::scoring::ResidualDipolarCoupling Class Reference

ResidualDipolarCouplings are mainly handled by this class related classed: RDC — a single line in an RDC file - representing a single dipolar coupling ResidualDipolarCouplingEnergy – an energy method which triggers computations handled by this class. More...

#include <ResidualDipolarCoupling.hh>

Inheritance diagram for core::scoring::ResidualDipolarCoupling:
Inheritance graph
[legend]
Collaboration diagram for core::scoring::ResidualDipolarCoupling:
Collaboration graph
[legend]

Public Types

typedef core::Real Real
 
typedef core::Size Size
 
typedef utility::vector1
< core::scoring::RDC
RDC_lines
 
typedef core::Real Tensor [3][3]
 
typedef core::Real rvec [3]
 

Public Member Functions

 ResidualDipolarCoupling (std::string const &filename="")
 standard c'stor – will access option -in:file:rdc to read RDC data More...
 
 ResidualDipolarCoupling (RDC_lines data_in)
 alternative c'stor if you have a list of RDC lines More...
 
 ResidualDipolarCoupling (ResidualDipolarCoupling const &other)
 
ResidualDipolarCouplingoperator= (ResidualDipolarCoupling const &other)
 
virtual ~ResidualDipolarCoupling ()
 
basic::datacache::CacheableDataOP clone () const
 
core::Real compute_dipscore (core::pose::Pose const &pose)
 compute dipolar score for given pose will set alignment tensor and force-fields in RDC More...
 
core::Real compute_dipscore_nls (core::pose::Pose const &pose)
 fit rdc using RDC data More...
 
core::Real compute_dipscore_nlsDa (core::pose::Pose const &pose, utility::vector1< Real > const tensorDa)
 
core::Real compute_dipscore_nlsR (core::pose::Pose const &pose, utility::vector1< Real > const tensorR)
 
core::Real compute_dipscore_nlsDaR (core::pose::Pose const &pose, utility::vector1< Real > const tensorDa, utility::vector1< Real > const tensorR)
 
Real iterate_tensor_weights (core::pose::Pose const &pose, core::Real sigma2, core::Real tolerance, bool reset)
 
void show (std::ostream &) const
 
void read_RDC_file ()
 read RDC data from file More...
 
void preprocess_data ()
 fill internal buffers... call always when RDC lines change. More...
 
void release_buffers ()
 free memory of buffers More...
 
void reserve_buffers ()
 get memory for buffers More...
 
RDC_lines const & get_RDC_data () const
 get the raw RDC data More...
 
Real Q () const
 return the Q value ( cornilescu ) — only valid after compute_dipscore More...
 
Real R () const
 return the R value ( M Clore ) — only valid after compute_dipscore More...
 
core::Size get_n_alignments () const
 
Tensortensor ()
 return tensor of certain experiment... exp_id starts at 1 More...
 
core::Real get_al_tensor_trace (core::Size ex) const
 
core::Real get_al_tensor_max_z (core::Size ex) const
 
void compute_tensor_stats ()
 
void show_tensor_stats (std::ostream &, core::Size ex) const
 
void show_tensor_matrix (std::ostream &, core::Size ex) const
 
void show_rdc_values (std::ostream &, core::Size ex) const
 
void show_tensor_stats_nls (std::ostream &, core::Size ex, const double *par) const
 

Private Types

typedef core::Real rvec5 [5]
 some internal buffers in More...
 
typedef core::Real Tensor5 [5][5]
 

Private Member Functions

void read_RDC_file (Size nex, std::string const &filename)
 read RDC data from file More...
 
RDC_linesget_RDC_data_ref ()
 non-const reference to RDC data private use only. More...
 

Private Attributes

RDC_lines All_RDC_lines_
 
rvecEV_
 
rvec5D_
 
rvec5rhs_
 
TensorS_
 
Tensor5T_
 
core::Size nex_
 
core::Size nrows_
 
core::Real R_
 
core::Real rmsd_
 
TensorSD_
 
TensorEIG_
 
core::RealFA_
 
core::Realtrace_
 
core::Realmaxz_
 
core::Realr0_
 
core::Realr1_
 
core::Realr2_
 
core::Realexprdc_
 
core::Realrdcconst_
 
core::Realrdcweight_
 
core::Sizelenex_
 

Detailed Description

ResidualDipolarCouplings are mainly handled by this class related classed: RDC — a single line in an RDC file - representing a single dipolar coupling ResidualDipolarCouplingEnergy – an energy method which triggers computations handled by this class.

Definition at line 41 of file ResidualDipolarCoupling.hh.

Member Typedef Documentation

Definition at line 47 of file ResidualDipolarCoupling.hh.

Definition at line 45 of file ResidualDipolarCoupling.hh.

typedef core::Real core::scoring::ResidualDipolarCoupling::rvec[3]

Definition at line 49 of file ResidualDipolarCoupling.hh.

typedef core::Real core::scoring::ResidualDipolarCoupling::rvec5[5]
private

some internal buffers in

Definition at line 178 of file ResidualDipolarCoupling.hh.

Definition at line 46 of file ResidualDipolarCoupling.hh.

typedef core::Real core::scoring::ResidualDipolarCoupling::Tensor[3][3]

Definition at line 48 of file ResidualDipolarCoupling.hh.

typedef core::Real core::scoring::ResidualDipolarCoupling::Tensor5[5][5]
private

Definition at line 179 of file ResidualDipolarCoupling.hh.

Constructor & Destructor Documentation

core::scoring::ResidualDipolarCoupling::ResidualDipolarCoupling ( std::string const &  filename = "")
inline

standard c'stor – will access option -in:file:rdc to read RDC data

Definition at line 59 of file ResidualDipolarCoupling.hh.

References protocols::abinitio::filename(), preprocess_data(), read_RDC_file(), release_buffers(), and reserve_buffers().

Referenced by clone().

core::scoring::ResidualDipolarCoupling::ResidualDipolarCoupling ( RDC_lines  data_in)
inline

alternative c'stor if you have a list of RDC lines

Definition at line 73 of file ResidualDipolarCoupling.hh.

References preprocess_data(), and reserve_buffers().

core::scoring::ResidualDipolarCoupling::ResidualDipolarCoupling ( ResidualDipolarCoupling const &  other)

Definition at line 125 of file ResidualDipolarCoupling.cc.

References All_RDC_lines_, preprocess_data(), and reserve_buffers().

core::scoring::ResidualDipolarCoupling::~ResidualDipolarCoupling ( )
virtual

Definition at line 250 of file ResidualDipolarCoupling.cc.

References release_buffers().

Member Function Documentation

basic::datacache::CacheableDataOP core::scoring::ResidualDipolarCoupling::clone ( ) const
inline

Definition at line 88 of file ResidualDipolarCoupling.hh.

References ResidualDipolarCoupling().

Real core::scoring::ResidualDipolarCoupling::compute_dipscore ( core::pose::Pose const &  pose)
Real core::scoring::ResidualDipolarCoupling::compute_dipscore_nls ( core::pose::Pose const &  pose)
Real core::scoring::ResidualDipolarCoupling::compute_dipscore_nlsDa ( core::pose::Pose const &  pose,
utility::vector1< Real > const  tensorDa 
)
Real core::scoring::ResidualDipolarCoupling::compute_dipscore_nlsDaR ( core::pose::Pose const &  pose,
utility::vector1< Real > const  tensorDa,
utility::vector1< Real > const  tensorR 
)
Real core::scoring::ResidualDipolarCoupling::compute_dipscore_nlsR ( core::pose::Pose const &  pose,
utility::vector1< Real > const  tensorR 
)
void core::scoring::ResidualDipolarCoupling::compute_tensor_stats ( )
core::Real core::scoring::ResidualDipolarCoupling::get_al_tensor_max_z ( core::Size  ex) const
inline

Definition at line 155 of file ResidualDipolarCoupling.hh.

References maxz_.

core::Real core::scoring::ResidualDipolarCoupling::get_al_tensor_trace ( core::Size  ex) const
inline

Definition at line 149 of file ResidualDipolarCoupling.hh.

References trace_.

core::Size core::scoring::ResidualDipolarCoupling::get_n_alignments ( ) const
inline

Definition at line 136 of file ResidualDipolarCoupling.hh.

References nex_.

RDC_lines const& core::scoring::ResidualDipolarCoupling::get_RDC_data ( ) const
inline
RDC_lines& core::scoring::ResidualDipolarCoupling::get_RDC_data_ref ( )
private

non-const reference to RDC data private use only.

Real core::scoring::ResidualDipolarCoupling::iterate_tensor_weights ( core::pose::Pose const &  pose,
core::Real  sigma2,
core::Real  tolerance,
bool  reset 
)
ResidualDipolarCoupling & core::scoring::ResidualDipolarCoupling::operator= ( ResidualDipolarCoupling const &  other)
void core::scoring::ResidualDipolarCoupling::preprocess_data ( )

fill internal buffers... call always when RDC lines change.

Definition at line 303 of file ResidualDipolarCoupling.cc.

References All_RDC_lines_, nex_, and nrows_.

Referenced by operator=(), read_RDC_file(), and ResidualDipolarCoupling().

Real core::scoring::ResidualDipolarCoupling::Q ( ) const
inline

return the Q value ( cornilescu ) — only valid after compute_dipscore

Definition at line 126 of file ResidualDipolarCoupling.hh.

References R().

Referenced by compute_dipscore(), compute_dipscore_nls(), compute_dipscore_nlsDa(), compute_dipscore_nlsDaR(), and compute_dipscore_nlsR().

Real core::scoring::ResidualDipolarCoupling::R ( ) const
inline

return the R value ( M Clore ) — only valid after compute_dipscore

Definition at line 131 of file ResidualDipolarCoupling.hh.

References R_.

Referenced by Q().

void core::scoring::ResidualDipolarCoupling::read_RDC_file ( )
void core::scoring::ResidualDipolarCoupling::read_RDC_file ( Size  nex,
std::string const &  filename 
)
private

read RDC data from file

Definition at line 144 of file ResidualDipolarCoupling.cc.

References All_RDC_lines_, and core::scoring::tr().

void core::scoring::ResidualDipolarCoupling::release_buffers ( )

free memory of buffers

Definition at line 281 of file ResidualDipolarCoupling.cc.

References D_, EIG_, EV_, exprdc_, FA_, lenex_, maxz_, r0_, r1_, r2_, rdcconst_, rdcweight_, rhs_, S_, SD_, T_, and trace_.

Referenced by operator=(), read_RDC_file(), ResidualDipolarCoupling(), and ~ResidualDipolarCoupling().

void core::scoring::ResidualDipolarCoupling::reserve_buffers ( )

get memory for buffers

Definition at line 254 of file ResidualDipolarCoupling.cc.

References D_, EIG_, EV_, exprdc_, FA_, lenex_, maxz_, nex_, nrows_, r0_, r1_, r2_, rdcconst_, rdcweight_, rhs_, S_, SD_, T_, core::scoring::tr(), and trace_.

Referenced by operator=(), read_RDC_file(), and ResidualDipolarCoupling().

void core::scoring::ResidualDipolarCoupling::show ( std::ostream &  out) const

Definition at line 101 of file ResidualDipolarCoupling.cc.

References All_RDC_lines_.

Referenced by core::scoring::operator<<().

void core::scoring::ResidualDipolarCoupling::show_rdc_values ( std::ostream &  out,
core::Size  ex 
) const
void core::scoring::ResidualDipolarCoupling::show_tensor_matrix ( std::ostream &  out,
core::Size  ex 
) const
void core::scoring::ResidualDipolarCoupling::show_tensor_stats ( std::ostream &  out,
core::Size  ex 
) const
void core::scoring::ResidualDipolarCoupling::show_tensor_stats_nls ( std::ostream &  out,
core::Size  ex,
const double *  par 
) const
Tensor* core::scoring::ResidualDipolarCoupling::tensor ( )
inline

return tensor of certain experiment... exp_id starts at 1

Definition at line 139 of file ResidualDipolarCoupling.hh.

References S_.

Member Data Documentation

RDC_lines core::scoring::ResidualDipolarCoupling::All_RDC_lines_
private
rvec5* core::scoring::ResidualDipolarCoupling::D_
private

Definition at line 182 of file ResidualDipolarCoupling.hh.

Referenced by compute_dipscore(), release_buffers(), and reserve_buffers().

Tensor* core::scoring::ResidualDipolarCoupling::EIG_
private
rvec* core::scoring::ResidualDipolarCoupling::EV_
private
core::Real* core::scoring::ResidualDipolarCoupling::exprdc_
private
core::Real* core::scoring::ResidualDipolarCoupling::FA_
private

Definition at line 194 of file ResidualDipolarCoupling.hh.

Referenced by release_buffers(), and reserve_buffers().

core::Size* core::scoring::ResidualDipolarCoupling::lenex_
private
core::Real* core::scoring::ResidualDipolarCoupling::maxz_
private
core::Size core::scoring::ResidualDipolarCoupling::nex_
private
core::Size core::scoring::ResidualDipolarCoupling::nrows_
private
core::Real* core::scoring::ResidualDipolarCoupling::r0_
private
core::Real* core::scoring::ResidualDipolarCoupling::r1_
private
core::Real* core::scoring::ResidualDipolarCoupling::r2_
private
core::Real core::scoring::ResidualDipolarCoupling::R_
private
core::Real* core::scoring::ResidualDipolarCoupling::rdcconst_
private
core::Real* core::scoring::ResidualDipolarCoupling::rdcweight_
private
rvec5* core::scoring::ResidualDipolarCoupling::rhs_
private

Definition at line 183 of file ResidualDipolarCoupling.hh.

Referenced by compute_dipscore(), release_buffers(), and reserve_buffers().

core::Real core::scoring::ResidualDipolarCoupling::rmsd_
private
Tensor* core::scoring::ResidualDipolarCoupling::S_
private
Tensor* core::scoring::ResidualDipolarCoupling::SD_
private
Tensor5* core::scoring::ResidualDipolarCoupling::T_
private

Definition at line 185 of file ResidualDipolarCoupling.hh.

Referenced by compute_dipscore(), release_buffers(), and reserve_buffers().

core::Real* core::scoring::ResidualDipolarCoupling::trace_
private

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