Skip to content

Commit

Permalink
Refs #9584 Add examples for IndirectTransmission.
Browse files Browse the repository at this point in the history
  • Loading branch information
Samuel Jackson committed Jun 6, 2014
1 parent 2e0c252 commit 2bcf058
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions Code/Mantid/docs/source/algorithms/IndirectTransmission-v1.rst
Expand Up @@ -17,4 +17,57 @@ calculate the absorption cross-section. The sample number density &
thickness is input to then calculate the percentage scattering &
transmission.

Usage
-----

**Example - Running IndirectTransmission.**

.. testcode:: ExIndirectTransmissionSimple

table_ws = IndirectTransmission(Instrument='IRIS', ChemicalFormula="C")
param_names = table_ws.column(0)
param_values = table_ws.column(1)

for pair in zip(param_names, param_values):
print "%s : %s" % pair

Output:

.. testoutput:: ExIndirectTransmissionSimple

Wavelength : 6.65800233718
Absorption Xsection : 0.0129590747304
Coherent Xsection : 5.551
Incoherent Xsection : 0.001
Total scattering Xsection : 5.552
Number density : 0.1
Thickness : 0.1
Transmission (abs+scatt) : 0.945870519609
Total scattering : 0.0540068963808

**Example - Running IndirectTransmission with a specified number density and thickness.**

.. testcode:: ExIndirectTransmissionParams

table_ws = IndirectTransmission(Instrument='OSIRIS', NumberDensity=0.5, Thickness=0.3, ChemicalFormula="C")
param_names = table_ws.column(0)
param_values = table_ws.column(1)

for pair in zip(param_names, param_values):
print "%s : %s" % pair

Output:

.. testoutput:: ExIndirectTransmissionParams

Wavelength : 6.65800233718
Absorption Xsection : 0.0129590747304
Coherent Xsection : 5.551
Incoherent Xsection : 0.001
Total scattering Xsection : 5.552
Number density : 0.5
Thickness : 0.3
Transmission (abs+scatt) : 0.433985627752
Total scattering : 0.565169943961

.. categories::

0 comments on commit 2bcf058

Please sign in to comment.