/**
 * \page BoxAlgorithm_StimulationFilter Stimulation Filter
__________________________________________________________________

Detailed description
__________________________________________________________________

 * |OVP_DocBegin_BoxAlgorithm_StimulationFilter_Description|
 * Filters a stimulation stream in order to select or reject some
 * specific stimulation ranges. The configuration of the box consists
 * of a time range in which the filter will be activated, and 
 * a set of rules which will be executed consecutively. The first
 * rule is the default one, specifying what to do if no other rule
 * matches. The next rules will specify what to do for their respective
 * range of stimulations. The last matching rule is chosen so you should
 * build up your rules from general purpose to specific purpose.
 * Please note that if no time range is specified (i.e. begin and end are both 0),
 * The filter will be \b always active.
 * |OVP_DocEnd_BoxAlgorithm_StimulationFilter_Description|
__________________________________________________________________

Inputs description
__________________________________________________________________

 * |OVP_DocBegin_BoxAlgorithm_StimulationFilter_Inputs|
 * |OVP_DocEnd_BoxAlgorithm_StimulationFilter_Inputs|

 * |OVP_DocBegin_BoxAlgorithm_StimulationFilter_Input1|
 The stimulation set to filter.
 * |OVP_DocEnd_BoxAlgorithm_StimulationFilter_Input1|
__________________________________________________________________

Outputs description
__________________________________________________________________

 * |OVP_DocBegin_BoxAlgorithm_StimulationFilter_Outputs|
 * |OVP_DocEnd_BoxAlgorithm_StimulationFilter_Outputs|

 * |OVP_DocBegin_BoxAlgorithm_StimulationFilter_Output1|
 * The stimulation set filtered according to the specified set of rules.
 * |OVP_DocEnd_BoxAlgorithm_StimulationFilter_Output1|
__________________________________________________________________

Settings description
__________________________________________________________________

 * |OVP_DocBegin_BoxAlgorithm_StimulationFilter_Settings|
 * You can add as many settings as you want. They will be grouped
 * in order to have one action and two stimulation identifiers per rule.
 * |OVP_DocEnd_BoxAlgorithm_StimulationFilter_Settings|

 * |OVP_DocBegin_BoxAlgorithm_StimulationFilter_Setting1|
 * This is the default action to perform if no rule is matching.
 * |OVP_DocEnd_BoxAlgorithm_StimulationFilter_Setting1|
 
 * |OVP_DocBegin_BoxAlgorithm_StimulationFilter_Setting2|
 * The starting time of the filter.
 * |OVP_DocEnd_BoxAlgorithm_StimulationFilter_Setting2|
 
 * |OVP_DocBegin_BoxAlgorithm_StimulationFilter_Setting3|
 * The ending time of the filter.
 * |OVP_DocEnd_BoxAlgorithm_StimulationFilter_Setting3|

 * |OVP_DocBegin_BoxAlgorithm_StimulationFilter_Setting4|
 * This setting contains the action to perform on the specified range of stimulations.
 * The range of stimulations is specified with next two settings.
 * |OVP_DocEnd_BoxAlgorithm_StimulationFilter_Setting4|

 * |OVP_DocBegin_BoxAlgorithm_StimulationFilter_Setting5|
 * The stimulation starting the range.
 * |OVP_DocEnd_BoxAlgorithm_StimulationFilter_Setting5|

 * |OVP_DocBegin_BoxAlgorithm_StimulationFilter_Setting6|
 * The stimulation ending the range.
 * |OVP_DocEnd_BoxAlgorithm_StimulationFilter_Setting6|
__________________________________________________________________

Examples description
__________________________________________________________________

 * |OVP_DocBegin_BoxAlgorithm_StimulationFilter_Examples|
 * A simple example could be a selection from Label 00 to 0F in a stimulation
 * stream. For such example, you would have to turn third setting value (default action)
 * to \c Reject and use one \c Select rule for range Label 00 to Label 0F.
 *
 * A complete example could be to select Label 00 to 0F,
 * and the particular stimulations GDF LEFT and GDF RIGHT. Additionally, for a
 * reason, you want to avoid the Label 07 and Label 08. In this case, you
 * will have to turn the default action setting to \c Reject then build up 4 rules :
 *  - rule 1 : \c Select range Label 00 to Label 0F
 *  - rule 2 : \c Select range GDF Left to GDF Left (only 1 stim in this range)
 *  - rule 3 : \c Select range GDF Right to GDF Right (only 1 stim in this range)
 *  - rule 4 : \c Reject range Label 07 to Label 08
 * |OVP_DocEnd_BoxAlgorithm_StimulationFilter_Examples|
__________________________________________________________________

Miscellaneous description
__________________________________________________________________

 * |OVP_DocBegin_BoxAlgorithm_StimulationFilter_Miscellaneous|
 * |OVP_DocEnd_BoxAlgorithm_StimulationFilter_Miscellaneous|
 */
