Skip to content
Snippets Groups Projects
Unverified Commit 759971f9 authored by Mathieu Doucet's avatar Mathieu Doucet Committed by GitHub
Browse files

Convert all the * to ``

parent 82e5a48c
No related branches found
No related tags found
No related merge requests found
...@@ -95,12 +95,12 @@ Generate event filters by time ...@@ -95,12 +95,12 @@ Generate event filters by time
############################## ##############################
Event filters can be created by defining start time, stop time and time intervals. Event filters can be created by defining start time, stop time and time intervals.
The three input properties for them are *StartTime*, *StopTime* and *TimeInterval*, The three input properties for them are ``StartTime``, ``StopTime`` and ``TimeInterval``,
respectively. respectively.
*TimeInterval* accepts an array of doubles. ``TimeInterval`` accepts an array of doubles.
If the array size is zero, then there will be one and only splitter will be If the array size is zero, then there will be one and only splitter will be
created from *StartTime* and *StopTime*. created from ``StartTime`` and ``StopTime``.
If the size of the array is one, then all event splitters will have the same duration If the size of the array is one, then all event splitters will have the same duration
of time. of time.
In general if the array is composed as :math:`t_1, t_2, \cdots, t_n`, In general if the array is composed as :math:`t_1, t_2, \cdots, t_n`,
...@@ -115,7 +115,7 @@ Unit of time ...@@ -115,7 +115,7 @@ Unit of time
============ ============
There are three types of units that are supported for time. There are three types of units that are supported for time.
They are second, nanosecond and percentage of duration from *StartTime* to *StopTime*. They are second, nanosecond and percentage of duration from ``StartTime`` to ``StopTime``.
.. _filterbylogv-GenerateEventFilter-ref: .. _filterbylogv-GenerateEventFilter-ref:
...@@ -158,25 +158,25 @@ Algorithm Parameters and Examples ...@@ -158,25 +158,25 @@ Algorithm Parameters and Examples
Here are the introductions to some important parameters (i.e., algorithm's properties). Here are the introductions to some important parameters (i.e., algorithm's properties).
Parameter: *Centre* Parameter: ``Centre``
################### #####################
The input Boolean parameter *centre* is for filtering by log value(s). The input Boolean parameter ``centre`` is for filtering by log value(s).
If option *centre* is taken, then for each interval, If option ``centre`` is taken, then for each interval,
- starting time = log\_time - tolerance\_time; - starting time = log\_time - tolerance\_time;
- stopping time = log\_time - tolerance\_time; - stopping time = log\_time - tolerance\_time;
It is a shift to left. It is a shift to left.
Parameter: *FastLog* Parameter: ``FastLog``
#################### ######################
When *FastLog* is set to True, a :ref:`MatrixWorkspace <MatrixWorkspace>` will be used to store the event When ``FastLog`` is set to True, a :ref:`MatrixWorkspace <MatrixWorkspace>` will be used to store the event
splitters, which is more appropriate for fast changing logs. (see above for details). splitters, which is more appropriate for fast changing logs. (see above for details).
Parameter: *MinimumLogValue*, *MaximumLogValue*, *LogValueTolerance* and *LogValueInterval* Parameter: ``MinimumLogValue``, ``MaximumLogValue``, ``LogValueTolerance`` and ``LogValueInterval``
########################################################################################### ###################################################################################################
These four parameters are used to determine the log value intervals for These four parameters are used to determine the log value intervals for
filtering events. filtering events.
...@@ -197,11 +197,11 @@ Integer value log ...@@ -197,11 +197,11 @@ Integer value log
It is a little bit different for sample log recorded with integer. It is a little bit different for sample log recorded with integer.
- *MinimumLogValue* and *MaximumLogValue* can be same such that only entries with exacly the same log value - ``MinimumLogValue`` and ``MaximumLogValue`` can be same such that only entries with exacly the same log value
will be considered; will be considered;
- If *LogValueInterval* is not give (i.e., default value is used), then any log enetry with log value - If ``LogValueInterval`` is not give (i.e., default value is used), then any log enetry with log value
larger and equal to *MinimumLogValue* and smaller and equal to *MaximumLogValue* will be considered. larger and equal to ``MinimumLogValue`` and smaller and equal to ``MaximumLogValue`` will be considered.
Be noticed that in the same case for double value log, log entry with value equal to *MaximumLogValue* Be noticed that in the same case for double value log, log entry with value equal to ``MaximumLogValue``
will be excluded. will be excluded.
......
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