 |
|
IMP Reference Guide
2.6.0
The Integrative Modeling Platform
|
Setup cross-link distance restraints from mass spectrometry data. More...
Inherits object.
Setup cross-link distance restraints from mass spectrometry data.
The noise in the data and the structural uncertainty of cross-linked amino-acids is inferred using Bayes theory of probability
ote Wraps an IMP::isd::CrossLinkMSRestraint
Definition at line 20 of file crosslinking.py.
Public Member Functions | |
| def | __init__ |
| Constructor. More... | |
| def | add_to_model |
| Add the restraint to the model so that it is evaluated. More... | |
| def | create_psi |
| This is called internally. More... | |
| def | create_sigma |
| This is called internally. More... | |
| def | get_hierarchies |
| get the hierarchy More... | |
| def | get_output |
| Get the output of the restraint to be used by the IMP.pmi.output object. More... | |
| def | get_particle_pairs |
| Get a list of tuples containing the particle pairs. More... | |
| def | get_particles_to_sample |
| Get the particles to be sampled by the IMP.pmi.sampler object. More... | |
| def | get_restraint |
| get the restraint set (redundant with get_restraint_sets) More... | |
| def | get_restraint_for_rmf |
| get the dummy restraints to be displayed in the rmf file More... | |
| def | get_restraint_sets |
| get the restraint set More... | |
| def | get_restraints |
| get the restraints in a list More... | |
| def | set_label |
| Set the restraint output label. More... | |
| def | set_output_level |
| Set the output level of the output. More... | |
| def | set_psi_is_sampled |
| Switch on/off the sampling of psi particles. More... | |
| def | set_sigma_is_sampled |
| Switch on/off the sampling of sigma particles. More... | |
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.__init__ | ( | self, | |
representation = None, |
|||
root_hier = None, |
|||
CrossLinkDataBase = None, |
|||
length = 10.0, |
|||
resolution = None, |
|||
slope = 0.02, |
|||
label = 'None', |
|||
filelabel = 'None', |
|||
attributes_for_label = None |
|||
| ) |
Constructor.
| representation | DEPRECATED The IMP.pmi.representation.Representation object that contain the molecular system |
| root_hier | The canonical hierarchy containing all the states |
| CrossLinkDataBase | The IMP.pmi.io.crosslink.CrossLinkDataBase object that contains the cross-link dataset |
| length | maximal cross-linker length (including the residue sidechains) |
| resolution | what representation resolution should the cross-link restraint be applied to. |
| slope | The slope of a distance-linear scoring function that funnels the score when the particles are too far away. Suggested value 0.02. |
| label | the extra text to label the restraint so that it is searchable in the output |
| filelabel | automatically generated file containing missing/included/excluded cross-links will be labeled using this text |
| attributes_for_label |
Definition at line 38 of file crosslinking.py.
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.add_to_model | ( | self | ) |
Add the restraint to the model so that it is evaluated.
Definition at line 292 of file crosslinking.py.
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.create_psi | ( | self, | |
| name | |||
| ) |
This is called internally.
Creates a nuisance on the data uncertainty
Definition at line 371 of file crosslinking.py.
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.create_sigma | ( | self, | |
| name | |||
| ) |
This is called internally.
Creates a nuisance on the structural uncertainty
Definition at line 344 of file crosslinking.py.
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.get_hierarchies | ( | self | ) |
get the hierarchy
Definition at line 299 of file crosslinking.py.
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.get_output | ( | self | ) |
Get the output of the restraint to be used by the IMP.pmi.output object.
Definition at line 406 of file crosslinking.py.
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.get_particle_pairs | ( | self | ) |
Get a list of tuples containing the particle pairs.
Definition at line 322 of file crosslinking.py.
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.get_particles_to_sample | ( | self | ) |
Get the particles to be sampled by the IMP.pmi.sampler object.
Definition at line 446 of file crosslinking.py.
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.get_restraint | ( | self | ) |
get the restraint set (redundant with get_restraint_sets)
Definition at line 307 of file crosslinking.py.
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.get_restraint_for_rmf | ( | self | ) |
get the dummy restraints to be displayed in the rmf file
Definition at line 311 of file crosslinking.py.
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.get_restraint_sets | ( | self | ) |
get the restraint set
Definition at line 303 of file crosslinking.py.
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.get_restraints | ( | self | ) |
get the restraints in a list
Definition at line 315 of file crosslinking.py.
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.set_label | ( | self, | |
| s | |||
| ) |
Set the restraint output label.
Definition at line 402 of file crosslinking.py.
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.set_output_level | ( | self, | |
level = 'low' |
|||
| ) |
Set the output level of the output.
Definition at line 331 of file crosslinking.py.
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.set_psi_is_sampled | ( | self, | |
is_sampled = True |
|||
| ) |
Switch on/off the sampling of psi particles.
Definition at line 335 of file crosslinking.py.
| def IMP.pmi.restraints.crosslinking.CrossLinkingMassSpectrometryRestraint.set_sigma_is_sampled | ( | self, | |
is_sampled = True |
|||
| ) |
Switch on/off the sampling of sigma particles.
Definition at line 339 of file crosslinking.py.
