nbTargetPotTools
index
/home/schwitrs/xplor/python/nbTargetPotTools.py


 
Helper tools for nbTargetPot. Used to fit effective surface
accesibility for solvent NOE and PRE data, 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).

 
Functions
       
analyze(potList)
perform analysis of NBTargetPot terms and return nicely formatted summary
calibrate(term, selection='all', cutoff=None, verbose=False)
Given a nbTargetPot.NBTargetPot term, compute and apply the slope and
intercept so that the computed values best fit the target (experimental)
values. The optional selection argument can be used to specify a subset
of restraints to use in the fit. At this time, errors are not used to
weight the fit.
 
In addition to specifying an atom selection to restrict the restraints used
in performing the fit, one can specify a cutoff: restraints whose target
values are greater than this cutoff will not be used in calibration.
correlation(term)
create_NBTargetPot(name, filename=None, restraints='', moveTol=3, invPow=2, cutoffDist=20, slope=1, intercept=0, restraintFormat='residValErr', restraintSegid=None, restraintAtom='N', obsErr=None, selection='not pseudo and not name H*')
Create an NBTargetPot term with the instanceName given by the first argument.
Restraints can be specified by filename or as a string using the restraints
argument. Default values of nbTargetPot.NBTargetPot's moveTol, invPow,
and cutoffDist are specified by arguments of those names. The slope and
intercept arguments are passed to the NBTargetPot object to be applied to
the calculated values. The restraintFormat argument can be 'residValErr' or
'xplor'. For the former, lines in the restraint table should be of the
form
    resid obsVal osbErr
while for the xplor restraintFormat, the restraints are given using an
XPLOR atom selection in the format:
    assign (selection) obsVal obsErr
The restraintSegid is useful when using residValErr restraints so that a
segid can be specified. restraintAtom specifies the atom in each
residue to which distances are to be measured - it is only used for the
residValErr format. If obsErr is specified, it overrides the values
in the restraint tables.
The selection argument species which atoms are included in sums as described
in the documentation for NBTargetPot.
readPlainRestraints(restraintString)
readRestraint(line)
readRestraints(restraintString, format='residValErr', slope=1, intercept=0, obsErr=None, atomName='N', segid=None)
Read restraints from the specified restraintString. A linear transformation
is applied to the observed target values using the slope and
intercept arguments. The format argument can be 'residValErr' or
'xplor'. For the former, lines in the restraint table should be of the
form
    resid obsVal osbErr
while for the xplor format, the restraints are given using an
XPLOR atom selection in the format:
    assign (selection) obsVal obsErr
The segid is useful when using residValErr restraints so that a
segid can be specified. If obsErr is specified, it overrides the values
in the restraint tables.
readXplorRestraints(restraintString)