diff --git a/Code/Mantid/docs/source/algorithms/LoadMappingTable-v1.rst b/Code/Mantid/docs/source/algorithms/LoadMappingTable-v1.rst index a7c0b68c7809760503dc90ee8b6a802974639ea3..71b1c294c5a948f32b3e695254904e4a34263b6b 100644 --- a/Code/Mantid/docs/source/algorithms/LoadMappingTable-v1.rst +++ b/Code/Mantid/docs/source/algorithms/LoadMappingTable-v1.rst @@ -9,12 +9,12 @@ Description ----------- -Loads the mapping table between spectra and `IDetector <IDetector>`__ +Loads the mapping table between spectra and `IDetector <http://www.mantidproject.org/IDetector>`__ from a RAW file. It fills the -`SpectraToDetectorMap <SpectraToDetectorMap>`__ object contained in a -`workspace <workspace>`__. This algorithm will fail if the -`workspace <workspace>`__ does not already point to a full -`instrument <instrument>`__ `geometry <geometry>`__ (which usually means +`SpectraToDetectorMap <http://www.mantidproject.org/SpectraToDetectorMap>`__ object contained in a +`workspace <http://www.mantidproject.org/workspace>`__. This algorithm will fail if the +`workspace <http://www.mantidproject.org/workspace>`__ does not already point to a full +`instrument <http://www.mantidproject.org/instrument>`__ `geometry <http://www.mantidproject.org/geometry>`__ (which usually means it must be run after :ref:`algm-LoadInstrument`/:ref:`algm-LoadInstrumentFromRaw`). @@ -24,4 +24,16 @@ contribute to different spectra (for example in DAE2 (Data Aquisition Electronic) when a spectra containing electronically focussed data is created simultaneously with individual spectra). +Usage +----- + +.. testcode:: + + # Create a workspace + ws = CreateSampleWorkspace() + # Replace the instrument in the workspace with HRPD + LoadInstrument(ws,InstrumentName='HRPD') + # Map spectra to detectors according to an HRPD raw file. + LoadMappingTable('HRP39180.RAW',ws) + .. categories::