help.html 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  1. <html>
  2. <head>
  3. <link rel="stylesheet" type="text/css" href="extra_info/styles.css" />
  4. </head>
  5. <body>
  6. </div>
  7. <div class="div_pad_class">
  8. <hr class="hr_sec" />
  9. <div style="padding-top: 0px; margin-top: -0px;"><pre class='padtop' ><center><b>HELP FILE FOR AP-QC</b></center></pre></div>
  10. <div style="padding-top: 0px; margin-top: -0px;" class='container' ><pre><b>afni_proc.py's single subject QC report form</b></pre></div>
  11. </div>
  12. <div class="div_pad_class">
  13. <hr class="hr_sec" />
  14. <div style="padding-top: 0px; margin-top: -0px;"><pre class='padtop' ><center><b>OVERVIEW</b></center></pre></div>
  15. <div style="padding-top: 0px; margin-top: -0px;" class='container' ><pre><b>QC organization
  16. The quality control (QC) is organized into thematic blocks to
  17. check, such as original data acquisition, different alignments,
  18. motion, regression modeling, and more. At the top of the QC page,
  19. there is a navigation bar with a label for each QC block (vorig,
  20. ve2a, etc.) that functions as a button to the top of that section.
  21. Rating
  22. Beneath each section label is a(n initially empty) QC button,
  23. which users can click to set a rating for that QC block and for
  24. the overall subject rating ("FINAL"). Clicking on the QC button
  25. toggles its state through good (+), bad (X) or other (?, which may
  26. include 'ugly', or just a hint to revisit later). Users can also
  27. use convenient 'filler buttons' at the right (A+, Ax, etc.), when
  28. the ratings are constant/uniform-- one hopes for 'all good'
  29. processing, but who knows...
  30. Commenting
  31. Additionally, users can ctrl+click on the QC button to enter a
  32. comment for that block. For example, they can write why a rating
  33. was good or bad, or what question they have led them to rate it as
  34. 'other'.
  35. Saving
  36. Clicking SAVE will let the user save the QC ratings+comments on
  37. their computer for later use, such as inclusion/exclusion criteria
  38. for the subject in group analysis. (NB: This action is treated
  39. the same as downloading a file from online, and is subject to
  40. standard limitations on simplicity due to browser security
  41. settings.)
  42. See also
  43. The online web tutorial:
  44. https://afni.nimh.nih.gov/pub/dist/doc/htmldoc/tutorials/apqc_html/main_toc.html
  45. It's more verbose and pictorial, if that's useful.
  46. </b></pre></div>
  47. </div>
  48. <div class="div_pad_class">
  49. <hr class="hr_sec" />
  50. <div style="padding-top: 0px; margin-top: -0px;"><pre class='padtop' ><center><b>DEFINITIONS</b></center></pre></div>
  51. <div style="padding-top: 0px; margin-top: -0px;" class='container' ><pre><b>QC block
  52. One thematic section of the QC form (original data, alignment
  53. step, etc.). Each block has a label in the navigation bar (vorig,
  54. ve2a, etc.)-- click on the label to jump to that block. Click on
  55. the button below the label to provide a rating for that block.
  56. QC button
  57. Below each QC block label in the navigation bar is a button
  58. (initially empty after running afni_proc.py). The user can click
  59. on it to toggle its state to one of three ratings (good, +; bad,
  60. X; other, ?), as well as to enter a comment for that QC block (via
  61. ctrl+click).
  62. 'FINAL'
  63. Label for the QC button to hold the user's overall/final
  64. evaluation of the subject's data and processing. (Clicking on this
  65. label does nothing.)
  66. filler button
  67. |A+|, |Ax|, |A?|-- located in the upper right corner of the
  68. navigation menu. These can be used to provide uniform ratings
  69. across the QC buttons (click to fill empty buttons, double-click
  70. to fill *all* buttons, regardless of state).
  71. |clr|-- double-clicking on this will empty all ratings+comments
  72. from the QC buttons.
  73. 'SAVE'
  74. Write the ratings+comments to disk. This action is done through
  75. the browser, and is subject to the browser settings; probably
  76. users should not have the browser set to automatically download
  77. all files to the same location, for example.
  78. 'HELP'
  79. Button : well, how did you get here??
  80. 'BC', 'AC'
  81. When using the 'pythonic' HTML style, 1D-plotting (like motion
  82. enorm plots) also produces boxplots to summarize values. When
  83. censoring has been applied, by default there will be two boxplots
  84. made: one of values 'before censoring' (BC), and one of values
  85. 'after censoring' (AC). Those labels are affixed in order to the
  86. titles of the boxplots.
  87. </b></pre></div>
  88. </div>
  89. <div class="div_pad_class">
  90. <hr class="hr_sec" />
  91. <div style="padding-top: 0px; margin-top: -0px;"><pre class='padtop' ><center><b>SET BUTTON RATING</b></center></pre></div>
  92. <div style="padding-top: 0px; margin-top: -0px;" class='container' ><pre><b>
  93. To record an evaluation, click the button below any section label, and
  94. toggle through:
  95. + : good,
  96. X : bad,
  97. ? : other (or 'revisit').
  98. For speed, you can click 'filler button' |A+| once to fill all *empty*
  99. buttons with +, or doubly to fill *all* buttons with +. |Ax| behaves
  100. the same for X, and |A?| for ?.
  101. Double-click |clr| to clear all rating and comment values.
  102. Pro-tip: if data are mostly all in a single state like good or bad,
  103. just use filler buttons to save yourself click time, and then just
  104. click any individual buttons that are different. </b></pre></div>
  105. </div>
  106. <div class="div_pad_class">
  107. <hr class="hr_sec" />
  108. <div style="padding-top: 0px; margin-top: -0px;"><pre class='padtop' ><center><b>COMMENT</b></center></pre></div>
  109. <div style="padding-top: 0px; margin-top: -0px;" class='container' ><pre><b>
  110. Use ctrl+click on a QC button to open (or close) a comment window.
  111. Save a comment with the green (left) button, or hit Enter at any point.
  112. Remove a comment with the pink (right) button, or hit Esc at any point.
  113. Any QC button with a comment gets a pair of quotes added, like ''+''.
  114. Comments are independent of rating, but adding a comment to an empty
  115. button changes its rating to ''?'' (which can be altered further from
  116. there).
  117. </b></pre></div>
  118. </div>
  119. <div class="div_pad_class">
  120. <hr class="hr_sec" />
  121. <div style="padding-top: 0px; margin-top: -0px;"><pre class='padtop' ><center><b>SAVE FORM</b></center></pre></div>
  122. <div style="padding-top: 0px; margin-top: -0px;" class='container' ><pre><b>Click on the 'SAVE' button.
  123. Unfortunately, the file will not be directly saved by this, due to
  124. security settings on most web-browsers, and the user will be prompted
  125. to save the file as if downloading from the Web.</b></pre></div>
  126. </div>
  127. <div class="div_pad_class">
  128. <hr class="hr_sec" />
  129. <div style="padding-top: 0px; margin-top: -0px;"><pre class='padtop' ><center><b>KEYBOARD NAVIGATION</b></center></pre></div>
  130. <div style="padding-top: 0px; margin-top: -0px;" class='container' ><pre><b>
  131. Use Tab to navigate the QC menu mirroring all above functionality.
  132. Hit Tab to move through the menu. Hit Enter on a section label to
  133. scroll the page there.
  134. On QC buttons hit Enter to toggle through the rating list. Use
  135. ctrl+Enter to open comments; as above, use Enter or Esc to keep or
  136. erase, respectively.
  137. On the filler buttons |A+|, |Ax| and |A?|, use Enter to fill empty
  138. QC buttons and ctrl+Enter to fill *all* buttons.
  139. On |clr|, ctrl+Enter clears all rating and comment values.
  140. </b></pre></div>
  141. </div>
  142. <div class="div_pad_class">
  143. <hr class="hr_sec" />
  144. <div style="padding-top: 0px; margin-top: -0px;"><pre class='padtop' ><center><b>QC BLOCKS</b></center></pre></div>
  145. <div style="padding-top: 0px; margin-top: -0px;" class='container' ><pre><b>
  146. vorig
  147. Volumetric mages of data (EPI and anat) in original/native space.
  148. *Coming soon*.
  149. ve2a
  150. Volumetric images of the alignment of the subject's anat
  151. (underlay/grayscale) and EPI (overlay/hot color edges) volumes. Likely
  152. these will be shown in the template space, if using the tlrc block.
  153. va2t
  154. Volumetric images of the alignment of the standard space template
  155. (underlay/grayscale) and subject's anat (overlay/hot color edges)
  156. volumes.
  157. vstat
  158. Volumetric images of (full) F-stat of an overall regression
  159. model. These images are only created for task data sets, i.e., where
  160. GLTs or stimuli are specified (so not for resting state data).
  161. mot
  162. Summary of motion and outlier information, which may each/both be
  163. used as censoring criteria.
  164. The 6 rigid body motion parameters (3 rotation + 3 translation) are
  165. combined into a single quantity: the Euclidean norm (enorm), which has
  166. approx. units of 'mm'. Large changes in the enorm time series show
  167. moments of subject motion.
  168. Separate runs are shown with the background alternating between white
  169. and light gray.
  170. Boxplots summarize parameter values, both before censoring (BC) and
  171. after censoring (AC).
  172. regr
  173. When processing with stimulus time series, both individual and
  174. combined stimulus plots are generated (with any censoring also shown).
  175. The degrees of freedom (DF) summary is also provided, so one can check
  176. if too many get used up during processing (careful with bandpassing!).
  177. And a grayplot of residuals is provided.
  178. warns
  179. Several AFNI programs carry out consistency checks while
  180. processing (e.g., pre-steady state check, regression matrix corr
  181. warnings, left-right flip checks). Warnings are conglomerated here.
  182. Each warning has one of the following levels:
  183. none undecided mild medium severe
  184. The warning level is written, with color coding, at the top of each
  185. warning's text box. The QC block label 'warns' at the top of the page
  186. is also colored according to the maximum warning level present.
  187. radcor
  188. @radial_correlate plots (per run, per block). These can show
  189. scanner coil artifacts, as well as large subject motion; both factors
  190. can lead to large areas of very high correlation, which would be
  191. highlighted here.
  192. qsumm
  193. This is the output of @ss_review_basic, which contains a loooot of
  194. useful information about your single subject processing.
  195. </b></pre></div></body></html>