Commit 0bbf8937 authored by Serrière Guillaume's avatar Serrière Guillaume

Add doc for evaluation. Fix wrong filename in doc generation.

Signed-off-by: default avatarSerrière Guillaume <guillaume.serriere@inria.fr>
parent 41d38f2e
......@@ -187,7 +187,6 @@ int main(int argc, char ** argv)
{
l_sConfigPath = CString(l_oConfiguration.m_sConfigPath.c_str());
}
l_pKernelContext=l_pKernelDesc->createKernel("plugin-inspector", l_sConfigPath );
if(!l_pKernelContext)
{
......
......@@ -32,7 +32,7 @@ IF(UNIX)
COMMAND @CMAKE_CURRENT_BINARY_DIR@/../../applications/developer-tools/plugin-inspector/openvibe-plugin-inspector
-d "@CMAKE_CURRENT_BINARY_DIR@" -p ${ov_plugin_inspector_load_path}
-k "@CMAKE_CURRENT_BINARY_DIR@/../../kernel/"
-c "@CMAKE_SOURCE_DIR@/kernel/share/openvibe.conf"
-c "@CMAKE_SOURCE_DIR@/kernel/share/openvibe.conf-base"
WORKING_DIRECTORY "@CMAKE_CURRENT_BINARY_DIR@/../../applications/developer-tools/plugin-inspector"
)
ELSEIF(WIN32)
......@@ -40,7 +40,7 @@ ELSEIF(WIN32)
COMMAND @CMAKE_CURRENT_SOURCE_DIR@/openvibe-plugin-inspector.cmd @CMAKE_SOURCE_DIR@ @CMAKE_CURRENT_BINARY_DIR@/../..
-d "@CMAKE_CURRENT_BINARY_DIR@" -p ${ov_plugin_inspector_load_path}
-k "@CMAKE_CURRENT_BINARY_DIR@/../../kernel"
-c "@CMAKE_SOURCE_DIR@/kernel/share/openvibe.conf"
-c "@CMAKE_SOURCE_DIR@/kernel/share/openvibe.conf-base"
WORKING_DIRECTORY "@CMAKE_CURRENT_BINARY_DIR@/../../applications/developer-tools/plugin-inspector"
)
ENDIF(UNIX)
......
/**
* \page BoxAlgorithm_KappaCoefficient Kappa Coefficient
__________________________________________________________________
Detailed description
__________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_KappaCoefficient_Description|
* This box computes the Cohen kappa coefficient that allows to compare the accordance of two classifiers (https://en.wikipedia.org/wiki/Cohen%27s_kappa),
* The box compares the results of the classifier (second input) to the 100% match classifier (first input).
*
* The result is streamed on the first output, and is displayed in real time in a standalone visualization.
* |OVP_DocEnd_BoxAlgorithm_KappaCoefficient_Description|
*
*
_______________________________________________________________
Inputs description
__________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_KappaCoefficient_Inputs|
* |OVP_DocEnd_BoxAlgorithm_KappaCoefficient_Inputs|
* |OVP_DocBegin_BoxAlgorithm_KappaCoefficient_Input1|
* The first input receives the expected stimulation.
* |OVP_DocEnd_BoxAlgorithm_KappaCoefficient_Input1|
* |OVP_DocBegin_BoxAlgorithm_KappaCoefficient_Input2|
* This input receives the stimualtions found by the classifier.
* |OVP_DocEnd_BoxAlgorithm_KappaCoefficient_Input2|
__________________________________________________________________
Outputs description
__________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_KappaCoefficient_Outputs|
* |OVP_DocEnd_BoxAlgorithm_KappaCoefficient_Outputs|
* |OVP_DocBegin_BoxAlgorithm_KappaCoefficient_Output1|
* This output contains the current value of the Kappa coefficient.
* |OVP_DocEnd_BoxAlgorithm_KappaCoefficient_Output1|
__________________________________________________________________
Settings description
__________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_KappaCoefficient_Settings|
* Each setting except the first one corresponds to the stimulation code of a class. A stimulation must be unique.
* |OVP_DocEnd_BoxAlgorithm_KappaCoefficient_Settings|
* |OVP_DocBegin_BoxAlgorithm_KappaCoefficient_Setting1|
* This setting indicates the amount of classes handled by the box. This setting will change the amount of setting.
* |OVP_DocEnd_BoxAlgorithm_KappaCoefficient_Setting1|
* |OVP_DocBegin_BoxAlgorithm_KappaCoefficient_Setting2|
* This setting indicates the stimulation corresponding to the first class.
* |OVP_DocEnd_BoxAlgorithm_KappaCoefficient_Setting2|
*
* * |OVP_DocBegin_BoxAlgorithm_KappaCoefficient_Setting3|
* This setting indicates the stimulation corresponding to the second class.
* |OVP_DocEnd_BoxAlgorithm_KappaCoefficient_Setting3|
__________________________________________________________________
Miscellaneous description
__________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_KappaCoefficient_Miscellaneous|
* All stimulations can be send to the box. They will be filtered.
* |OVP_DocEnd_BoxAlgorithm_KappaCoefficient_Miscellaneous|
*/
/**
* \page BoxAlgorithm_ROCCurve ROC Curve
__________________________________________________________________
Detailed description
__________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_ROCCurve_Description|
* This box computes the ROC (Receiver Operating Characteristic) curve for a classifier (https://fr.wikipedia.org/wiki/Receiver_Operating_Characteristic). One curve will be computes
* by class. This box is designed to work with the probability output of the \ref Doc_BoxAlgorithm_ClassifierProcessor.
*
* The box will compute the curve when it receives the computation trigger on the first input.
*
* The result is displayed when computed in a standalone visualization.
* |OVP_DocEnd_BoxAlgorithm_ROCCurve_Description|
*
*
_______________________________________________________________
Inputs description
__________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_ROCCurve_Inputs|
* |OVP_DocEnd_BoxAlgorithm_ROCCurve_Inputs|
* |OVP_DocBegin_BoxAlgorithm_ROCCurve_Input1|
The first input receives the expected stimulations stream.
* |OVP_DocEnd_BoxAlgorithm_ROCCurve_Input1|
* |OVP_DocBegin_BoxAlgorithm_ROCCurve_Input2|
This input receives the probability output stream of the processor box.
* |OVP_DocEnd_BoxAlgorithm_ROCCurve_Input2|
__________________________________________________________________
Settings description
__________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_ROCCurve_Settings|
* Each setting after the second one corresponds to the stimulation code of a class. A stimulation must be unique.
* |OVP_DocEnd_BoxAlgorithm_ROCCurve_Settings|
* |OVP_DocBegin_BoxAlgorithm_ROCCurve_Setting1|
* Stimulation trigger for the computation.
* |OVP_DocEnd_BoxAlgorithm_ROCCurve_Setting1|
* |OVP_DocBegin_BoxAlgorithm_ROCCurve_Setting2|
* This setting indicates the amount of classes handled by the box. This setting will change the amount of setting.
* |OVP_DocEnd_BoxAlgorithm_ROCCurve_Setting2|
* |OVP_DocBegin_BoxAlgorithm_ROCCurve_Setting3|
* This setting indicates the stimulation corresponding to the first class.
* |OVP_DocEnd_BoxAlgorithm_ROCCurve_Setting3|
*
* * |OVP_DocBegin_BoxAlgorithm_ROCCurve_Setting4|
* This setting indicates the stimulation corresponding to the second class.
* |OVP_DocEnd_BoxAlgorithm_ROCCurve_Setting4|
__________________________________________________________________
Miscellaneous description
__________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_ROCCurve_Miscellaneous|
* All stimulations can be send to the box. They will be filtered.
* |OVP_DocEnd_BoxAlgorithm_ROCCurve_Miscellaneous|
*/
/**
* \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_KappaCoefficient_Miscellaneous|
* |OVP_DocEnd_BoxAlgorithm_KappaCoefficient_Miscellaneous|
*
*/
......@@ -75,7 +75,7 @@ namespace OpenViBEPlugins
virtual OpenViBE::CString getName(void) const { return OpenViBE::CString("General statistics generator"); }
virtual OpenViBE::CString getAuthorName(void) const { return OpenViBE::CString("Serrière Guillaume"); }
virtual OpenViBE::CString getAuthorCompanyName(void) const { return OpenViBE::CString("Inria"); }
virtual OpenViBE::CString getShortDescription(void) const { return OpenViBE::CString("Generate statistic on signal."); }
virtual OpenViBE::CString getShortDescription(void) const { return OpenViBE::CString("Generate statistics on signal."); }
virtual OpenViBE::CString getDetailedDescription(void) const { return OpenViBE::CString("Generate some general purpose statistics on signal and store them in a file."); }
virtual OpenViBE::CString getCategory(void) const { return OpenViBE::CString("Evaluation"); }
virtual OpenViBE::CString getVersion(void) const { return OpenViBE::CString("0.1"); }
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment