Cheat sheet: Difference between revisions

m improve
m small wording updates
Line 1: Line 1:
{| class="wikitable"
{| class="wikitable"
|+
|+
!<big>XDS processing workflow</big>. The links given like e.g. [[XDSGUI#Frame]] refer to the XDSwiki at https://wiki.uni-konstanz.de/xds/index.php/
!<big>XDS processing workflow</big>. The links given like e.g. [[XDSGUI#Frame]] refer to the  
XDSwiki at https://wiki.uni-konstanz.de/xds/index.php/
!The programs must have been properly installed - see [[Installation]]. Troubleshooting hints are at [[Problems]].
!The programs must have been properly installed - see [[Installation]]. Troubleshooting hints are at [[Problems]].
|-
|-
Line 23: Line 24:
|-
|-
|<small>'''4.''' '''Define untrusted detector areas.''' Mask the shaded regions of the detector: at least the beamstop and its holder. There is a button <code>Untrusted areas (...)</code> towards the upper right with three tools: UNTRUSTED_ELLIPSE, UNTRUSTED_RECTANGLE, UNTRUSTED_QUADRILATERAL</small>
|<small>'''4.''' '''Define untrusted detector areas.''' Mask the shaded regions of the detector: at least the beamstop and its holder. There is a button <code>Untrusted areas (...)</code> towards the upper right with three tools: UNTRUSTED_ELLIPSE, UNTRUSTED_RECTANGLE, UNTRUSTED_QUADRILATERAL</small>
|<small>This step is important, do not forget it! Reason is in the XDSGUI paper (reference at the end). More explanation of the tools is at [[XDSGUI#Frame]] . Wrongly placed UNTRUSTED areas can be removed by deleting their lines in <code>XDS.INP</code> .</small>
|<small>This step is important, do not forget it! Reason is in the XDSGUI paper (reference below). More explanation of the tools is at [[XDSGUI#Frame]] . Unwanted UNTRUSTED_* areas can be removed by deleting their lines in <code>XDS.INP</code> .</small>
|-
|-
|<small>'''5.''' '''Review and adjust XDS.INP.''' Go to the <code>XDS.INP</code> tab and inspect it. For a first XDS run, accept defaults, except increase MINIMUM_NUMBER_OF_PIXELS_IN_A_SPOT to 6 (rather than 3) for broad reflections with many pixels, i. In later runs, tweak parameters to optimize processing. JOB=XYCORR INIT COLSPOT IDXREF DEFPIX INTEGRATE CORRECT is only needed at the beginning i.e. for the first run.</small>
|<small>'''5.''' '''Review and adjust XDS.INP.''' Go to the <code>XDS.INP</code> tab and inspect it. For a first XDS run, accept defaults, except increase MINIMUM_NUMBER_OF_PIXELS_IN_A_SPOT to 6 (rather than 3) for broad reflections with many pixels, i. In later runs, tweak parameters to optimize processing. JOB=XYCORR INIT COLSPOT IDXREF DEFPIX INTEGRATE CORRECT is only needed at the beginning i.e. for the first run.</small>
|<small>The paradigm of manual processing is to repeat INTEGRATE and CORRECT with optimized parameters that are available after a completed XDS run. Please note that  geometry parameters for INTEGRATE are in <code>XPARM.XDS</code>, not in <code>XDS.INP</code> !</small>
|<small>The paradigm of manual processing is to repeat INTEGRATE and CORRECT with optimised parameters that are available after a completed XDS run. Note that  geometry parameters used by INTEGRATE are in <code>XPARM.XDS</code>, not in <code>XDS.INP</code> !</small>
|-
|-
|<small>'''6.''' '''Run XDS and handle errors.''' After changing <code>XDS.INP</code>, click <code>Save</code> (unless greyed out) and <code>Run XDS</code> . The tasks of the JOB keyword are run one after the other. Thus watch the adjacent tabs to the right flash yellow as they are being filled with text and graphics. Inspect the left (text) and right (graphics) sides of these tabs. Once the CORRECT tab is filled, the XDS run has completed, and the reflection file XDS_ASCII.HKL is available. The goal is to make sure that spacegroup and resolution are correct or at least reasonable, and that the processing is optimal.</small>
|<small>'''6.''' '''Run XDS and handle errors.''' After changing <code>XDS.INP</code>, click <code>Save</code> (unless greyed out) and <code>Run XDS</code> . The tasks of the JOB keyword are run one after the other. Thus watch the adjacent tabs to the right flash yellow as they are being filled with text and graphics. Inspect the left (text) and right (graphics) sides of these tabs. Once the CORRECT tab is filled, the XDS run has completed, and the reflection file XDS_ASCII.HKL is available. The goal is to make sure that spacegroup and resolution are correct or at least reasonable, and that the processing is optimal.</small>
|<small>If XDS stops after the IDXREF step (with ERROR in IDXREF.LP), this most often happens because it could index less than 50% of the spots only. This may be due to ice rings that obviously cannot be indexed, or due to additional lattices. In most cases, this should at least prompt you to think about the possible reasons. To continue, set JOB=DEFPIX INTEGRATE CORRECT in the XDS.INP tab, <code>Save</code> and <code>Run XDS</code>.</small>
|<small>If XDS stops after the IDXREF step (with ERROR in IDXREF.LP), this most often happens because it could index less than 50% of the spots only. This may be due to ice rings that obviously cannot be indexed, or due to additional lattices. In most cases, this should at least prompt you to think about the possible reasons. To continue, set JOB=DEFPIX INTEGRATE CORRECT in XDS.INP, <code>Save</code> and <code>Run XDS</code>.</small>
|-
|-
|<small>'''7.  First run of XDS: inspect and analyse diffraction.'''</small> <small>COLSPOT tab: is the "number of spots" evenly distributed among the frames? If not, it may be a sign of radiation damage or anisotropy, or plate-shaped crystal. Maybe see [https://wiki.uni-konstanz.de/xds/index.php?search=COLSPOT&title=Special%3ASearch&fulltext=1 COLSPOT]</small> <small>IDXREF tab: does the plot of spots appear elliptical - that would indicate anisotropy? Inspect the <code>predictions</code> in <code>Frame</code> . Do they match the observed reflections? ''Visualize reflections in reciprocal space'' : in <code>tools</code> go to <code>Further analyses</code> and click the second button from the top. This will load the indexed reflections (yellow) and non-indexed ones (pink) as pseudo-PDB files into <code>Coot</code>. Inspect the lattices: is the "yellow lattice" convincing, and/or do the pink reflections form their own lattice(s), or are they just random?</small>
|<small>'''7.  First run of XDS: inspect and analyse diffraction.'''</small> <small>COLSPOT tab: is the "number of spots" evenly distributed among the frames? If not, it may be a sign of radiation damage or anisotropy, or plate-shaped crystal. Maybe see [https://wiki.uni-konstanz.de/xds/index.php?search=COLSPOT&title=Special%3ASearch&fulltext=1 COLSPOT]</small> . <small>IDXREF tab: does the plot of spots appear elliptical - that would indicate anisotropy? Inspect the <code>predictions</code> in <code>Frame</code> . Do they match the observed reflections? ''Visualize reflections in reciprocal space'' : in <code>tools</code> go to <code>Further analyses</code> and click the second button from the top. This will load the indexed reflections (yellow) and non-indexed ones (pink) as pseudo-PDB files into <code>Coot</code>. Inspect the lattices: is the "yellow lattice" convincing, and/or do the pink reflections form their own lattice(s), or are they just random?</small>
|<small>IDXREF tab: are the "CLUSTER INDICES" of the difference vectors integer numbers, or close to integers? Are the cell parameters reasonable? Is the first POPULATION of the first SUBTREE close to 3000? Ice rings? See [[IDXREF.LP]] and [[IDXREF]] .</small>
|<small>IDXREF tab: are the "CLUSTER INDICES" of the difference vectors integer numbers, or close to integers? Are the cell parameters reasonable? Is the first POPULATION of the first SUBTREE close to 3000? Ice rings? See [[IDXREF.LP]] and [[IDXREF]] .</small>
<small>INTEGRATE tab: are the curves smooth (good) or are there jumps (bad)? Try to think of reasons for jumps/spikes! Could it be the beamline flux or the crystal changing? Are their straight red and green lines all along the "Beam divergence" and "Mosaicity" plots? If not, too few strong reflections were found (inspect the "THREE-DIMENSIONAL PROFILE" output in the text part) and you should add DELPHI=20 in <code>XDS.INP</code>, or increase the parameter if the keyword already exists.</small>
<small>INTEGRATE tab: are the curves smooth (good) or are there jumps (bad)? Try to think of reasons for jumps/spikes! Could it be the beamline flux or the crystal changing? Are their straight red and green lines all along the "Beam divergence" and "Mosaicity" plots? If not, too few strong reflections were found (inspect the "THREE-DIMENSIONAL PROFILE" output in the text part) and you should add DELPHI=20 in <code>XDS.INP</code>, or increase the parameter if the keyword already exists.</small>
|-
|-
|<small>'''8.''' '''Inspect scaling & statistics.''' In the CORRECT tab: Numerical values and plots are only meaningful if the spacegroup is correct (screw axes don't matter for the statistics, though). If the spacegroup is unknown, the text part reports the spacegroup that XDS determines automatically. To benefit from a more advanced  (but not infallible) algorithm, in <code>tools / Further analyses</code> use <code>determine spacegroups with pointless</code>. Output is in the terminal window! Modify the SPACE_GROUP_NUMBER and UNIT_CELL_CONSTANTS in <code>XDS.INP</code> accordingly (unless you know better, of course). Often there are two [[Space group determination#Space group selected by XDS: ambiguous with respect to enantiomorph and screw axes|enantiomorphic spacegroups]] possible ([[Space group determination#Table of space groups by Laue class and Bravais type|table]]), or a [[Space group determination#Subgroup and supergroup relations of these space groups|subgroup]] is correct; keep that in mind for the structure solution - the correct spacegroup is only confirmed when the structure is solved and well refined.</small>
|<small>'''8.''' '''Inspect scaling & statistics.''' In the CORRECT tab: Numerical values and plots are only meaningful if the spacegroup is correct (screw axes don't matter for the statistics, though). If the spacegroup is unknown, the text part reports the spacegroup that XDS determines automatically. To benefit from a more advanced  (but not infallible) algorithm, in <code>tools / Further analyses</code> use <code>determine spacegroups with pointless</code>. Output is in the terminal window! Modify the SPACE_GROUP_NUMBER and UNIT_CELL_CONSTANTS in <code>XDS.INP</code> accordingly (unless you know better, of course). Often there are two [[Space group determination#Space group selected by XDS: ambiguous with respect to enantiomorph and screw axes|enantiomorphic spacegroups]] possible ([[Space group determination#Table of space groups by Laue class and Bravais type|table]]), or a [[Space group determination#Subgroup and supergroup relations of these space groups|subgroup]] is correct; keep that in mind for the structure solution - the correct spacegroup is only confirmed when the structure is solved and well refined.</small>
|The first look should go to the the first plot (I/sigma unmerged data). The red horizontal line is [[ISa]] - what is its value? The exact numerical value is in the text part, but the plot is enough for a good estimate. If the value is less than 5, something (likely indexing or spacegroup) is severely wrong. Good values are 20 and higher.
|<small>The first look should go to the the first plot (I/sigma unmerged data). The red horizontal line is [[ISa]] - what is its value? The exact numerical value is in the text part, but the plot is enough for a good estimate. If the value is less than 5, something (likely indexing or spacegroup) is severely wrong. Good values are 20 and higher.</small>
The blue line should be well below the red line, otherwise this is a sign of overexposure - in that case, the systematic error limits the quality of the data, not the random error.
<small>The blue line should be well below the red line, otherwise this is a sign of overexposure - in that case, the systematic error limits the quality of the data, not the random error.</small>
|-
|-
|<small>'''9.''' '''Spacegroup and resolution cutoff.''' If the spacegroup that CORRECT determined differs from the one that pointless determined, CORRECT should be re-run: change the JOB=... line to JOB=CORRECT, and go to step 6.</small><small>If the spacegroup is correct, decide about the high-resolution cutoff: go to the section after STATISTICS OF SAVED DATA SET "XDS_ASCII.HKL" and inspect the table SUBSET OF INTENSITY DATA WITH SIGNAL/NOISE >= -3.0 . A useful estimate of the high-resolution limit is the last resolution range that still gets a star "*" in the CC<sub>1/2</sub> column; you may also consider the <nowiki><I/sigma> column. </nowiki>Put the upper resolution value into the INCLUDE_RESOLUTION_RANGE line in <code>XDS.INP</code>, and set JOB=CORRECT. Go to step 6.</small>
|<small>'''9.''' '''Spacegroup and resolution cutoff.''' If the spacegroup that CORRECT determined differs from the one that pointless determined: in XDS.INP, fix SPACE_GROUP_NUMBER and UNIT_CELL_CONSTANTS, change the JOB=... line to JOB=CORRECT, and Run XDS.</small> <small>If the spacegroup is correct, decide about the high-resolution cutoff: go to the section after STATISTICS OF SAVED DATA SET "XDS_ASCII.HKL" and inspect the table SUBSET OF INTENSITY DATA WITH SIGNAL/NOISE >= -3.0 . A useful estimate of the high-resolution limit is the last resolution range that still gets a star "*" in the CC<sub>1/2</sub> column; you may also consider the <nowiki><I/sigma> column. </nowiki>Put the upper resolution value into the INCLUDE_RESOLUTION_RANGE line in <code>XDS.INP</code>, and set JOB=CORRECT. Go to step 6.</small>
|Use FRIEDEL'_LAW=FALSE if the anomalous signal is so strong that you want to see the proper statistics (completeness ...). FRIEDEL'S_LAW= TRUE if scaling and merging should not take the anomalous signal into account. Low resolution anomalous correlation above 60% is what I consider strong. Modify <code>XDS.INP</code> accordingly.
|Use FRIEDEL'_LAW=FALSE if the anomalous signal is so strong that you want to see the proper statistics (completeness ...). FRIEDEL'S_LAW= TRUE if scaling and merging should not take the anomalous signal into account. Low resolution anomalous correlation above 60% is what I consider strong. Modify <code>XDS.INP</code> accordingly.
|-
|-