BCIgui/Masterarbeit/openvibe/extras-master/plugins/processing/evaluation/doc/Doc_BoxAlgorithm_StatisticGenerator.dox-part

/**
 * \page BoxAlgorithm_GeneralStatisticsGenerator General Statistic Generator
__________________________________________________________________

Detailed description
__________________________________________________________________

 * |OVP_DocBegin_BoxAlgorithm_GeneralStatisticsGenerator_Description|
 * The box analyses a the two input stream (stimulations and signal).
 * 
 * The box will provide for each channel of the signal the min, the max value and the mean.
 * The box will provide a list of stimulations and provide for them the amount of time they appeared.
 * 
 * |OVP_DocEnd_BoxAlgorithm_GeneralStatisticsGenerator_Description|
__________________________________________________________________

Inputs description
__________________________________________________________________

 * |OVP_DocBegin_BoxAlgorithm_GeneralStatisticsGenerator_Inputs|
 * |OVP_DocEnd_BoxAlgorithm_GeneralStatisticsGenerator_Inputs|

 * |OVP_DocBegin_BoxAlgorithm_GeneralStatisticsGenerator_Input1|
 * The signal stream to analyse.
 * |OVP_DocEnd_BoxAlgorithm_GeneralStatisticsGenerator_Input1|
 * 
 * |OVP_DocBegin_BoxAlgorithm_GeneralStatisticsGenerator_Input2|
 * The stimulation stream to analyse.
 * |OVP_DocEnd_BoxAlgorithm_GeneralStatisticsGenerator_Input2|
__________________________________________________________________

Settings description
__________________________________________________________________

 * |OVP_DocBegin_BoxAlgorithm_GeneralStatisticsGenerator_Settings|
 * |OVP_DocEnd_BoxAlgorithm_GeneralStatisticsGenerator_Settings|

 * |OVP_DocBegin_BoxAlgorithm_GeneralStatisticsGenerator_Setting1|
 * Path to the file where the results will be wrote.
 * |OVP_DocEnd_BoxAlgorithm_GeneralStatisticsGenerator_Setting1|
__________________________________________________________________

Examples description
__________________________________________________________________

 * |OVP_DocBegin_BoxAlgorithm_GeneralStatisticsGenerator_Examples|
 * The resulting file should look like this :
\verbatim
<Statistic>
	<Stimulations-list>
		<Stimulation>
			<Identifier>(0x00000000, 0x00008100)</Identifier>
			<Label>OVTK_StimulationId_Label_00</Label>
			<Count>500</Count>
		</Stimulation>
	</Stimulations-list>
	<Channel-list>
		<Channel>
			<Name>sinusOsc 1</Name>
			<Maximum>2.99595</Maximum>
			<Minimum>-2.99582</Minimum>
			<Mean>0.00374409</Mean>
		</Channel>
		<Channel>
			<Name>sinusOsc 2</Name>
			<Maximum>2.99555</Maximum>
			<Minimum>-2.99594</Minimum>
			<Mean>0.00215169</Mean>
		</Channel>
		<Channel>
			<Name>sinusOsc 3</Name>
			<Maximum>2.99594</Maximum>
			<Minimum>-2.99592</Minimum>
			<Mean>0.000474523</Mean>
		</Channel>
		<Channel>
			<Name>sinusOsc 4</Name>
			<Maximum>2.99591</Maximum>
			<Minimum>-2.99594</Minimum>
			<Mean>0.00127219</Mean>
		</Channel>
	</Channel-list>
</Statistic>
\endverbatim
 * |OVP_DocEnd_BoxAlgorithm_GeneralStatisticsGenerator_Examples|
__________________________________________________________________

Miscellaneous description
__________________________________________________________________
 * |OVP_DocBegin_BoxAlgorithm_KappaCoef_Miscellaneous|
 * |OVP_DocEnd_BoxAlgorithm_KappaCoef_Miscellaneous|
*
*/