An official website of the United States government

Here’s how you know

Here’s how you know

Search Site

Potential term used to fit solvent NOEs and solvent PRES to an
empirical measure of surface accessibility as described in
 
   Yu Wang, C.D. Schwieters, N. Tjandra, ``Parameterization of
   Solvent-Protein Interaction and Its Use on NMR Protein
   Structure Determination,'' J. Magn. Res. 221, 76-84 (2012).
 
Please use nbTargetPotTools.create_NBTargetPot to instantiate
instances of this potential term.
 
 
Constructor:
  NBTargetPot(instanceName,
              selection   ) 
 
  instanceName is a user-specified identifier
  selection is a atomSel.AtomSel object specifying the atoms to include
  when calculating sums- see below for details.
 
methods:
 
  calcEnergy()
 
  addRestraints(str) - add restraints specified in the input string
 
  rms()            - rmsd of this term
  correlation()    - correlation of calculated to target values.
  deviation()      - ensemble deviation of the restraints
  violations()     - number of restraints violated
  numRestraints()  - total number of restraints
 
 
  selection()      - atom selection specified when the term was created
  simulation()     - associated simulation.Simulation
 
  info()           - information on the term
  showViolations() - return a string which info on violated restraints.
                     if showAllRestraints()=True, info on all restraints is 
                     returned.
 
  restraints()     - return a sequence of Restraint objects.
 
 The following parameters can be set [defaults in square brackets]
 
    slope      - The slope parameter applied to the calculated values. See 
                 below. [1]
    intercept  - The intercept parameter applied to the calculated values. See 
                 below. [0]
    moveTol    - maximum distance in Angstroms any atom can move before
                 triggering a recalculation of the neighbor list [0].
    cutoffDist - cutoff distance beyond which atom contributions to
                 the sum are not evaluated [10].
    potType    - potential type, "rmsd" or "correlation"  to use in
                 energy computation [RMSD].
    aveType    - averaging type, "center" or "sum"  to use in
                 effective surface area computation [CENTER].
    aveExp     - the exponent used in averaging [6].
    invPow     - the inverse power used in the effective surface area
                 computation [3].
    excludeSameResid  - a boolean specifying whether or not to exclude
                        atoms in the same residue in the sum
                        computation [True]. 
    showAllRestraints - a boolean describing whether or not to print
                        out information on all restraints, rather than
                        only violated restraints, in the violations
                        file [False].
    ensWeights()      - return ensemble weights.
    verbose           - a boolean describing whether or not to print
                        detailed information on the neighbor lists [False].
 
 the above quantities may be retrieved using the member function form
 quantity(), while they are set using the form setQuantity(value).
 
 
Each Restraint contains the following members:
  
  targetSel - atom selection corresponding to one or more atoms whose
              effective surface area has been measured.
  neighbors - a list of indices of atoms which are neighbors. These
              indices correspond to atoms as listed in the associated
              simulation.Simulation.
  targetVal - effective surface area as specified in the input table.
  targetErr - effective surface area error as specified in the input table.
  calcdVal  - effective surface area as computed from the molecular structure.
  variance  - a measure of spread over ensemble members.
 
  name()    - return the restraint name - by default this in the
              string associated with the targetSel
 
 
For "sum" aveType, the effective surface area is calculated as
 
  Sacc = slope * [ \sum_{i,j} |r_i - r_j|^{-aveExp} ]^{-invPow} + intercept
 
while for "center" aveType it is
 
  Sacc = slope * [ \sum_j |r_c - r_j|^{-aveExp} ]^{-invPow} + intercept
 
where i runs over all atoms in targetSel, j runs over all neighbor
atoms, r_i is the position of atom i, and r_c is the average position
of all atoms in targetSel. For ensembleSimulation.EnsembleSimulations, the 
effective surface area is calculated as
 
  Sacc = \sum_k w_k Sacc_k
 
where Sacc_k is the effective surface area of ensemble member k, and
w_k is the associated ensemble weight.
 
For "rmsd" potType, the energy associated with restraint k is 
 
  E_k = ( Sacc - targetVal )^2 / targetErr^2
 
and the overall energy is the scaled sum:
 
  E = scale() * \sum_k E_k
 
For "correlation" potType
 
   E = scale() * correlation()
 
 
 
# This file was automatically generated by SWIG (http://www.swig.org).
# Version 4.0.2
#
# Do not make changes to this file unless you know what you are doing--modify
# the SWIG interface file instead.