You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Doc_BoxAlgorithm_CSVFileReader.dox-part 2.4KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. /**
  2. * \page BoxAlgorithm_CSVFileReader CSV File Reader
  3. __________________________________________________________________
  4. Detailed description
  5. __________________________________________________________________
  6. * |OVP_DocBegin_BoxAlgorithm_CSVFileReader_Description|
  7. This box reads a Comma Separated Values (CSV) text file. The file must be written using a specific
  8. OpenViBE convention. The format is described in detail in \ref Doc_BoxAlgorithm_CSVFileWriter
  9. The file can contain two streams, one for matrix-type data and one for stimulations.
  10. * |OVP_DocEnd_BoxAlgorithm_CSVFileReader_Description|
  11. __________________________________________________________________
  12. Outputs description
  13. __________________________________________________________________
  14. * |OVP_DocBegin_BoxAlgorithm_CSVFileReader_Outputs|
  15. * |OVP_DocEnd_BoxAlgorithm_CSVFileReader_Outputs|
  16. * |OVP_DocBegin_BoxAlgorithm_CSVFileReader_Output1|
  17. This output can carry Signal, Streamed Matrix, Covariance, Spectrum and Feature Vector data.
  18. * |OVP_DocEnd_BoxAlgorithm_CSVFileReader_Output1|
  19. * |OVP_DocBegin_BoxAlgorithm_CSVFileReader_Output2|
  20. This output will contain stimulations read from the file.
  21. * |OVP_DocEnd_BoxAlgorithm_CSVFileReader_Output2|
  22. __________________________________________________________________
  23. Settings description
  24. __________________________________________________________________
  25. * |OVP_DocBegin_BoxAlgorithm_CSVFileReader_Settings|
  26. * |OVP_DocEnd_BoxAlgorithm_CSVFileReader_Settings|
  27. * |OVP_DocBegin_BoxAlgorithm_CSVFileReader_Setting1|
  28. Path of the CSV file to read.
  29. * |OVP_DocEnd_BoxAlgorithm_CSVFileReader_Setting1|
  30. __________________________________________________________________
  31. Examples description
  32. __________________________________________________________________
  33. * |OVP_DocBegin_BoxAlgorithm_CSVFileReader_Examples|
  34. Example of a scenario using the CSV Reader box to read a signal file and display it using an Oscilloscope.
  35. \image html csv-file-reader-example.png "Reading a CSV file"
  36. \image latex csv-file-reader-example.png "Reading a CSV file" width=8cm
  37. * |OVP_DocEnd_BoxAlgorithm_CSVFileReader_Examples|
  38. __________________________________________________________________
  39. Miscellaneous description
  40. __________________________________________________________________
  41. * |OVP_DocBegin_BoxAlgorithm_CSVFileReader_Miscellaneous|
  42. * |OVP_DocEnd_BoxAlgorithm_CSVFileReader_Miscellaneous|
  43. */