Skip to content
Snippets Groups Projects
Commit 7f5d8721 authored by Owen Arnold's avatar Owen Arnold
Browse files

refs #9955. Document and format.

parent 346f9eaa
No related branches found
No related tags found
No related merge requests found
This diff is collapsed.
......@@ -22,6 +22,16 @@ The workspaces must be histogrammed. Use
:ref:`algm-ConvertToHistogram` on workspaces prior to
passing them to this algorithm.
**Special Value Processing**
Special values, meaning infinite and NaN double precision values, are treated in a different way by the algorithm. The processing is as follows:
#. The workspaces are initially rebinned, as prescribed by the rebin Params (determined automatically if not provided)
#. Each spectra is searched for signal values and error values that are special values. Positions and type of special value are recorded
#. Special values found in the previous step are set to zero
#. Stitching proceeds, integration will not be performed considering any special values
#. Post processing the indexes of the special values are used to put the special values back where they came from
Usage
-----
**Example - a basic example using stitch1D to stitch two workspaces together.**
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment