Updated documentation Refs #11413

mantidproject · Mar 24, 2015 · 5533feb · 5533feb
1 parent 2cff93e
commit 5533feb
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 24 deletions.
diff --git a/Code/Mantid/docs/source/algorithms/IndirectAnnulusAbsorption-v1.rst b/Code/Mantid/docs/source/algorithms/IndirectAnnulusAbsorption-v1.rst
@@ -10,11 +10,12 @@ Description
 -----------
 
 Calculates and applies corrections for scattering abs absorption in a annular
-sample for a run on an indirect inelastic instrument, optionally also performing
-a simple can subtraction is a container workspace is provided.
+sample for a run on an indirect inelastic instrument, optionally allowing for
+the subtraction or corrections of the container.
 
-The corrections workspace (:math:`A_{s,s}`) is the standard Paalman and Pings
-attenuation factor for absorption and scattering in the sample.
+The correction factor workspace is a workspace group containing the correction
+factors in the Paalman and Pings format, note that only :math:`{A_{s,s}}` and
+:math:`A_{c,c}` factors are calculated by thsi algorithm.
 
 Usage
 -----
@@ -28,36 +29,81 @@ Usage
   red_ws = LoadNexusProcessed(Filename='irs26176_graphite002_red.nxs')
   can_ws = LoadNexusProcessed(Filename='irs26173_graphite002_red.nxs')
 
-  corrected, ass = IndirectAnnulusAbsorption(SampleWorkspace=red_ws,
-                                             CanWorkspace=can_ws,
-                                             CanScaleFactor=0.8,
-                                             ChemicalFormula='H2-O',
-                                             CanInnerRadius=0.2,
-                                             SampleInnerRadius=0.15,
-                                             SampleOuterRadius=0.16,
-                                             CanOuterRadius=0.22,
-                                             Events=200)
+  corrected, fact = IndirectAnnulusAbsorption(SampleWorkspace=red_ws,
+                                              SampleChemicalFormula='H2-O',
+                                              CanWorkspace=can_ws,
+                                              CanScaleFactor=0.8,
+                                              CanInnerRadius=0.19,
+                                              SampleInnerRadius=0.2,
+                                              SampleOuterRadius=0.25,
+                                              CanOuterRadius=0.26,
+                                              Events=200)
+
+  ass = fact[0]
 
   print ('Corrected workspace is intensity against %s'
         % (corrected.getAxis(0).getUnit().caption()))
 
-  print ('Corrections workspace is %s against %s'
+  print ('Ass workspace is %s against %s'
         % (ass.YUnitLabel(), ass.getAxis(0).getUnit().caption()))
 
-
 .. testcleanup:: SampleCorrectionsWithCanSubtraction
 
    DeleteWorkspace(red_ws)
    DeleteWorkspace(can_ws)
    DeleteWorkspace(corrected)
-   DeleteWorkspace(ass)
+   DeleteWorkspace(fact)
 
 **Output:**
 
-
 .. testoutput:: SampleCorrectionsWithCanSubtraction
 
   Corrected workspace is intensity against Energy transfer
-  Corrections workspace is Attenuation factor against Wavelength
+  Ass workspace is Attenuation factor against Wavelength
+
+**Example - Sample corrections for IRIS:**
+
+.. testcode:: SampleAndCanCorrections
+
+  red_ws = LoadNexusProcessed(Filename='irs26176_graphite002_red.nxs')
+  can_ws = LoadNexusProcessed(Filename='irs26173_graphite002_red.nxs')
+
+  corrected, fact = IndirectAnnulusAbsorption(SampleWorkspace=red_ws,
+                                              SampleChemicalFormula='H2-O',
+                                              CanWorkspace=can_ws,
+                                              CanChemicalFormula='H2-O',
+                                              CanInnerRadius=0.19,
+                                              SampleInnerRadius=0.2,
+                                              SampleOuterRadius=0.25,
+                                              CanOuterRadius=0.26,
+                                              Events=200,
+                                              UseCanCorrections=True)
+
+  ass = fact[0]
+  acc = fact[1]
+
+  print ('Corrected workspace is intensity against %s'
+        % (corrected.getAxis(0).getUnit().caption()))
+
+  print ('Ass workspace is %s against %s'
+        % (ass.YUnitLabel(), ass.getAxis(0).getUnit().caption()))
+
+  print ('Acc workspace is %s against %s'
+        % (acc.YUnitLabel(), acc.getAxis(0).getUnit().caption()))
+
+.. testcleanup:: SampleAndCanCorrections
+
+   DeleteWorkspace(red_ws)
+   DeleteWorkspace(can_ws)
+   DeleteWorkspace(corrected)
+   DeleteWorkspace(fact)
+
+**Output:**
+
+.. testoutput:: SampleAndCanCorrections
+
+  Corrected workspace is intensity against Energy transfer
+  Ass workspace is Attenuation factor against Wavelength
+  Acc workspace is Attenuation factor against Wavelength
 
 .. categories::
diff --git a/Code/Mantid/docs/source/algorithms/IndirectCylinderAbsorption-v1.rst b/Code/Mantid/docs/source/algorithms/IndirectCylinderAbsorption-v1.rst
@@ -61,7 +61,7 @@ Usage
 
 **Example - Sample and container corrections for IRIS:**
 
-.. testcode:: SampleCorrectionsWithCanCorrections
+.. testcode:: SampleAndCanCorrections
 
   red_ws = LoadNexusProcessed(Filename='irs26176_graphite002_red.nxs')
   can_ws = LoadNexusProcessed(Filename='irs26173_graphite002_red.nxs')
@@ -88,7 +88,7 @@ Usage
   print ('Acc workspace is %s against %s'
         % (acc.YUnitLabel(), acc.getAxis(0).getUnit().caption()))
 
-.. testcleanup:: SampleCorrectionsWithCanCorrections
+.. testcleanup:: SampleAndCanCorrections
 
    DeleteWorkspace(red_ws)
    DeleteWorkspace(can_ws)
@@ -97,7 +97,7 @@ Usage
 
 **Output:**
 
-.. testoutput:: SampleCorrectionsWithCanCorrections
+.. testoutput:: SampleAndCanCorrections
 
    Corrected workspace is intensity against Energy transfer
    Ass workspace is Attenuation factor against Wavelength

diff --git a/Code/Mantid/docs/source/algorithms/IndirectFlatPlateAbsorption-v1.rst b/Code/Mantid/docs/source/algorithms/IndirectFlatPlateAbsorption-v1.rst
@@ -63,7 +63,7 @@ Usage
 
 **Example - Sample and container corrections for IRIS:**
 
-.. testcode:: SampleCorrectionsWithCanSubtraction
+.. testcode:: SampleAndCanCorrections
 
   red_ws = LoadNexusProcessed(Filename='irs26176_graphite002_red.nxs')
   can_ws = LoadNexusProcessed(Filename='irs26173_graphite002_red.nxs')
@@ -91,7 +91,7 @@ Usage
   print ('Acc workspace is %s against %s'
         % (acc.YUnitLabel(), acc.getAxis(0).getUnit().caption()))
 
-.. testcleanup:: SampleCorrectionsWithCanSubtraction
+.. testcleanup:: SampleAndCanCorrections
 
    DeleteWorkspace(red_ws)
    DeleteWorkspace(can_ws)
@@ -100,7 +100,7 @@ Usage
 
 **Output:**
 
-.. testoutput:: SampleCorrectionsWithCanSubtraction
+.. testoutput:: SampleAndCanCorrections
 
    Corrected workspace is intensity against Energy transfer
    Ass workspace is Attenuation factor against Wavelength