pasdPeak |
index |
Objects associated with pasdPot.PASDPot energy terms: Peak,
PeakAssignment and ShiftAssignment
class Peak
A Peak is associated with each peak in an NOE spectrum.
It can have several possible assignments. It has an upper and lower
distance bound, which each assignment can correct (for things like
methyl groups).
Constructor:
Peak(name="")
Read-only accessor:
name() - return name given during construction
Read/Write accessors:
upBound - upper distance bound
lowBound - lower distance bound
fromProtonShift - chemical shift value for from proton
toProtonShift - chemical shift value for to proton
fromHeavyatomShift - chemical shift value for from heavy atom
toHeavyatomShift - chemical shift value for to heavy atom
intensity - peak intensity
Functions to manipulate notations in the note member:
note() - return the notation string.
setNote(val) - set note to string val
appendToNote(val) - append string val to existing note
These accessors are used to set the corresponding quantity
to invalid values.
resetFromProtonShift()
resetToProtonShift()
resetFromHeavyatomShift()
resetToHeavyatomShift()
resetIntensity()
These accessors return boolean indicating whether the corresponding
value has been set to a valid value:
hasFromProtonShift()
hasToProtonShift()
hasFromHeavyatomShift()
hasToHeavyatomShift()
hasIntensity()
peakAssignments() - return the list of PeakAssignment objects
addPeakAssignment() - add a PeakAssignment.
removePeakAssignmentNamed(name) - remove the PeakAssignment with the
specified name (a string). If no
PeakAssigment is found, an exception
is raised.
removeAllPeakAssignments() - remove all PeakAssignments.
hasPeakAssignmentNamed(name) - return boolean value indicating whether
a PeakAssignment exists with the
specified name.
peakAssignmentNamed(name) - return the PeakAssignment with the
specified name. If no PeakAssigment is
found, an exception is raised.
numPeakAssignments() - return len(peakAssignments)
isAssigned() - return True if len(peakAssignments)>0,
otherwise False.
fromShiftAssignments() - return a list of from ShiftAssignments
toShiftAssignments() - return a list of to ShiftAssignments
numFromShiftAssignments() - return len(fromShiftAssignments)
numToShiftAssignments() - return len(toShiftAssignments)
addShiftAssignment(val) - add val, a ShiftAssignment
removeShiftAssignmentNamed(name) - remove the ShiftAssignment with the
specified name (a string). If no
ShiftAssigment is found, an exception
is raised.
removeAllShiftAssignments() - remove all ShiftAssignments
hasShiftAssignmentNamed(name) - return boolean value indicating whether
a ShiftAssignment exists with the
specified name.
shiftAssignmentNamed(name) - return the ShiftAssignment with the
specified name. If no ShiftAssigment is
found, an exception is raised.
peakAssignmentsWithShiftAssignmentNamed(name) -
Return a list of PeakAssignments with the specified
ShiftAssignment name.
Accessors querying difference in primary sequence of the
PeakAssignment with the smallest such distance.
updatePrimarySeqDist() - call each PeakAssignment's updatePrimarySeqDist()
primarySeqDist() - return the smallest sequence difference. If the
PeakAssignment is intermolecular, a value
of 99999 is returned.
Convenience sequence distance query accessors:
isIntraresidue()
isSequential()
isShortRange(cutoff) - True if sequence differs by more than one residue,
and and less than cutoff.
isLongRange(cutoff) - True if sequence differs by more than cutoff,
or it is intermolecular.
isIntermolecular() - True if the PeakAssignment is intermolecular.
lowestViolation() - return the lowest distance violation of all
constituent PeakAssignments.
prevLikelihood() - likelihood of this PeakAssignment with the
largest such value.
lowestViolationsPrimarySeqDist() - return the primary sequence distance
of the PeakAssignment with the smallest
distance violation.
isGood() - return True if any PeakAssignment
has been marked as good.
Methods for activating PeakAssignments:
activateAllPeakAssigns() - make all PeakAssignments active
inactivateAllPeakAssigns() - make no PeakAssignment active
updateActivation(useSingleAssignment,
characteristicDist,
violationWeight,
previousLikelihoodWeight) -
This method updates PeakAssignment activation.
PeakAssignments are activated by a Monte Carlo procedure
based on a weighted sum of previousLikelihoods and likelihoods
generated from distance violations in the current coordinates,
weighted by previousLikelihoodWeight and violationWeight,
respectively. The value characteristicDist is used to
scale distance violations in this calculation.
For useSingleAssignment=True, a single PeakAssignment is activated,
whie for useSingleAssignment=False, zero or more PeakAssignments
are activated using an analogous procedure.
Results are queried with these accessor methods:
numActivePeakAssigns() - self-explanatory
isActive() - True if at least one PeakAssignment is active
isInactive() - True if no PeakAssignment is active
chosenPeakAssignment() - return PeakAssignment chosen by updateActivation(),
only if useSingleAssignment=True.
updateInWrongNeighborhood(cutoff) - support for marking PeakAssignments as
in wrong neighborhood, based on their
distance and their shiftAssignments'
neighborhood flags
updateShiftAssignmentActivePeakPositions() - support for shiftAssignment's
likelihood calculation
State-saving:
resetSavedState()
saveCurrentState()
revertToSavedState()
Peak-wise energy:
EnergyReport calcEnergy(useQuadraticPotential,
forceConst,
switchViol)
Currently, the crowded concept is not implemented, and the following
methods are not used:
isCrowded()
setIsCrowded()
setNotCrowded()
class PeakAssignment;:
A PeakAssignment is a type that correlates a pair of ShiftAssignments
with a Peak.
PeakAssignments can specfify multiple "to" and "from" atoms, with R-6 sum
averaging of their distances. They can be given corrections to apply
to the upper and lower distance bounds used in their violation
calculation (eg., if this PeakAssignment involves a methyl, one might
like to add half an Angstrom to the distance estimated from the
NOE's intensity). PeakAssignments can also be assigned an estimate of
their likelihood, based on the previous pass's results. PeakAssignments do
not calculate that likelihood themselves.
Constructor:
PeakAssignment(name) - name is a string argument
Methods:
name() - return name given during construction
Functions to manipulate notations in the note member:
note() - return the notation string.
setNote(val) - set note to string val
appendToNote(val) - append string val to existing note
Read/Write Accessors (read using value(), set using setValue(newVal)):
toAssignment - the to ShiftAssignment
fromAssignment - the from ShiftAssignment
upBoundCorrection - distance correction to apply to this PeakAssignment's
upper bound
lowBoundCorrection - distance correction to apply to this PeakAssignment's
lower bound
nMono - value used in distance calculation for
ambiguous ShiftAssignments in symmetric multimers -
should be set to the number of subunits. See
documentation for noePot.NOEPot. [Default: 1]
aveExp - exponent to use in computation of distance for
ambiguous ShiftAssignments. See documentation for
noePot.NOEPot. [Default: 6]
Read-only Accessors (read using value()):
toAssignmentName - return toAssignment.name()
fromAssignmentName - return fromAssignment.name()
toProtonSelection - toAssignment.protonSelection
fromProtonSelection - an atomSel.AtomSel
distance() - distance computed between atoms in the to and from
ShiftAssignment proton selections.
violation(upBound,lowBound) - violation given the upper and lower
distance bounds, the current
distance() value, and the upper and
lower bounds corrections.
Accessors for the shift table entries that matched this peakAssignment to
its peak
hasFromProtonShift() - whether the specified shift is present
hasToProtonShift()
hasFromHeavyatomShift()
hasToHeavyatomShift()
fromProtonShift() - the value of the specified chemical shift
toProtonShift()
fromHeavyatomShift()
toHeavyatomShift()
Accessors for the unfolded position of this PeakAssignment's NOE peak
position
resetUnfoldedFromProtonPeakPosition() - set specified value to invalid
resetUnfoldedFromHeavyatomPeakPosition() value
resetUnfoldedToProtonPeakPosition()
resetUnfoldedToHeavyatomPeakPosition()
hasUnfoldedFromProtonPeakPosition() - return boolean indicating presence
hasUnfoldedFromHeavyatomPeakPosition() of specified shift value
hasUnfoldedToProtonPeakPosition()
hasUnfoldedToHeavyatomPeakPosition()
unfoldedFromProtonPeakPosition() - chemical shift value of specified
unfoldedFromHeavyatomPeakPosition() peak dimension. These are settable
unfoldedToProtonPeakPosition()
unfoldedToHeavyatomPeakPosition()
Accessors for the good/bad flag which indicates whether this PeakAssignment
is violated in some reference structure.
setGood()
setBad()
isGood()
Manipulate the previousLikelihood member:
resetPreviousLikelihood() - set to invalid value
hasPreviousLikelihood() - has a valid value
previousLikelihood() - the value
setPreviousLikelihood(val) - set the value
Set/query the activation state
isActive() - query
activate() - setters
inactivate()
Manipulate inWrongNeighborhood state
updateInWrongNeighborhood(cutoff) - marks this PeakAssignment as being in
the right or wrong neighborhood,
based on its distance violation
(relative to cutoff) and its
ShiftAssignments' neighborhood flags
inWrongNeighborhood() - getter
setInWrongNeighborhood(bool) - setter
Saving activation state
resetSavedState()
saveCurrentState()
revertToSavedState()
PeakAssignments whose activation is linked to this one -
manipulated by name or value
addLinkedPeakAssignmentName(peakName, assName)
resetLinkedPeakAssignmentNames();
linkedPeakAssignmentNames()
removeLinkedPeakAssignmentName(peakName, assName)
resetLinkedPeakAssignments();
addLinkedPeakAssignment(peakAssignment)
linkedPeakAssignments()
Primary sequence distance - see description above for the Peak class
updatePrimarySeqDist() - compute
primarySeqDist() - read-only accessors
isIntraresidue()
isBackboneSequential()
isSequential() - return True if any of the from- and to-
shiftAssigments are between adjacent
residues, else False.
isShortRange(deltaRes) - return True if none of the from- and to-
shiftAssigments are between adjacent
residues, and the smallest primary sequence
distance is less than deltaRes, else False.
isLongRange(deltaRes) - return True if the smallest primary sequence
distance is greater than or equal to deltaRes,
else False.
isIntermolecular() - return True if the assignments are intermolecular,
and none is intramolecular, else False
isBackbone flag - the selection is hard-wired, and this flag is
not currently used in PASD functionality. If it were to be used,
the selection should be made settable. It is currently hard-wired
to the selection string "name HA HA* HB HB* HN HT* H"
isBackbone() - boolean: whether or not this PeakAssignment's
proton selections only involve protein backbone atoms.
updateIsBackbone() - recompute this value.
Intersecting selections flag: True if the atom selections of the
ShiftAssignments for the from and to protons overlap.
selectionsIntersect() - query value - returns a bool
updateSelectionsIntersect() - recompute value
Number of peakAssign filters that this PeakAssignment failed -
this value is manipulated and used by the network filter.
numFiltersFailed() - query accessor
resetNumFiltersFailed() - reset to zero
incrementNumFiltersFailed() - increment the value
Not Documented:
calcEnergy(useQuadraticPotential,
forceConst,
switchViol,
upBound,
lowBound)
updateActivation(upBound,
lowBound,
characteristicDist,
violationWeight,
previousLikelihoodWeight)
class ShiftAssignment:
This object contains an atomSel for the proton, an optional atomSel for its
connected heavy atom, the raw shift values for both (in ppm), and indication
as to whether it represents an assignment along the "from" or "to" axis/axes.
It is intended for use with both normal NOE assignments and inverse
(repulsive) NOEs.
// It also has flags for whether it's a methyl group,
// whether , whether it's currently in the correct neighborhood, and
// whether it's compatible with a reference structure.
Constructor:
ShiftAssignment(name) - name is a string argument
Functions to manipulate notations in the note member:
note() - return the notation string.
setNote(val) - set note to string val
appendToNote(val) - append string val to existing note
These read/write accessors correspond to the primary quantities of
the ShiftAssignment: the specified selection or its string, the
associated chemical shift(s) and the axis identity.
protonSelection
protonSelectionString
heavyatomSelection
heavyatomSelectionString
protonShift
heavyatomShift
isFrom
isTo
foldedSign - the value +/-1
foldedProtonShift
foldedHeavyatomShift
protonTolerance
heavyatomTolerance
previousLikelihood
noeCompleteness
Associated are these query accessors and resetters:
hasProtonSelection() - return bool value
hasHeavyatomSelection()
hasProtonShift()
hasHeavyatomShift()
hasFoldedProtonShift()
hasFoldedHeavyatomShift()
hasProtonTolerance()
hasHeavyatomTolerance()
hasPreviousLikelihood()
hasNoeCompleteness()
resetProtonShift()
resetHeavyatomShift()
resetFoldedProtonShift()
resetFoldedHeavyatomShift()
resetProtonTolerance()
resetHeavyatomTolerance()
resetPreviousLikelihood()
resetNoeCompleteness()
The toFromPartner ShiftAssignment for protons which appear in both
from and to axes.
Read/write accessors
toFromPartner - ShiftAssignment of partner
toFromPartnerName - name of partner ShiftAssignment
Query accessors - returns a bool
hasToFromPartner()
hasToFromPartnerName()
Resetters - to a blank state
resetToFromPartner()
resetToFromPartnerName()
The stereoPartner ShiftAssignment (e.g. for methylene protons)
Read/write accessors
stereoPartner - by ShiftAssignment value
stereoPartnerName - by name
Query accessors - returns a bool
hasStereoPartner()
hasStereoPartnerName()
Resetters - to a blank state
resetStereoPartnerName()
resetStereoPartner()
Linked ShiftAssignment manipulation
addLinkedShiftAssignment(val)
addLinkedShiftAssignmentName(name)
linkedShiftAssignments() - returns a list of ShiftAssignments
linkedShiftAssignmentNames()
numLinkedShiftAssignments()
removeAllLinkedShiftAssignments()
removeLinkedShiftAssignmentName(name)
void resetProtonPeakPositions();
void recordProtonPeakPosition(const String& newName,
float_type newVal,
int bothInRightNeighborhood);
float_type protonPeakPositionScatter();
CDSList<float_type> scatterValues(int rightNeighborhoodsOnly);
updateInWrongNeighborhood(charNoeCompleteness,
charScatter,
prevLikeliWeight,
completenessWeight,
scatterWeight)
Probabilistic updating of inWrongNeighborhood flags of all
linkedShiftAssignments (including this ShiftAssignment, and any
possible to/FromPartner), based on an overall likelihood computed as the
scaled sum of weighted completeness, scatter and previous likelihoods.
Access with:
inWrongNeighborhood() - getter
setInWrongNeighborhood( bool ) - setter
float_type distanceToShiftAssignment(const ShiftAssignment *otherShiftAssignment) const;
int shiftAssignWithinDist(const ShiftAssignment* otherShiftAssignment,
const float_type& cutoff) const;
int primarySeqDistToSA(const ShiftAssignment *otherShiftAssignment) const;
int isMonomericallyEqualTo(const ShiftAssignment* otherShiftAssignment) const;
Methods to manipulate various boolean flags:
isMethyl() - isMethyl
setIsMethyl()
setNotMethyl()
isGood() - isGood
setGood()
setBad()
State-saving:
resetSavedState()
saveCurrentState()
revertToSavedState()
Undocumented:
cachedIndex()
resetCachedIndex()
hasCachedIndex()
setCachedIndex(val)
numAccountedNeighbors()
resetNumAccountedNeighbors()
incrementNumAccountedNeighbors()
numUnaccountedNeighbors()
resetNumUnaccountedNeighbors()
incrementNumUnaccountedNeighbors()
# 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.
Classes | ||||||||||||||||||||||||||||||||||||||||||
|
Functions | ||
|
Data | ||
cvar = <Swig global variables> |