|
10 | 10 |
|
11 | 11 | ## <a name="intro"></a>Introduction
|
12 | 12 |
|
13 |
| -Libxdf is a cross-platform C++ library for loading multimodal, multi-rate signals stored in [XDF](https://github.com/sccn/xdf/wiki/Specifications "Extensible Data Format") files. |
| 13 | +Libxdf is a cross-platform C++ library for loading multi-modal, multi-rate signals stored in [XDF](https://github.com/sccn/xdf/wiki/Specifications "Extensible Data Format") files. |
14 | 14 | Libxdf is used in the biosignal viewing application [SigViewer](https://github.com/cbrnr/sigviewer). It can also be integrated into other
|
15 | 15 | C++ applications.
|
16 | 16 |
|
@@ -57,35 +57,32 @@ Example:
|
57 | 57 | ```C++
|
58 | 58 | #include "xdf.h"
|
59 | 59 |
|
60 |
| -Xdf XDFdata; |
61 |
| -XDFdata.load_xdf("C:/example.xdf"); |
| 60 | +Xdf xdf; |
| 61 | +xdf.load_xdf("C:/example.xdf"); |
62 | 62 | ```
|
63 | 63 |
|
64 |
| -To resample the signals to e.g. 100Hz: |
| 64 | +To resample the signals, e.g. to 100Hz: |
65 | 65 |
|
66 | 66 | ```C++
|
67 |
| -XDFdata.resample(100); |
| 67 | +xdf.resample(100); |
68 | 68 | ```
|
69 | 69 |
|
70 |
| -The functions in libxdf must be called following a certain order. For instance, if you call the `subtractMean` function before you load any data, it will cause undefined behavior. |
| 70 | +The methods in libxdf must be called following a certain order. For instance, if you call the `detrend` method before you load any data, it will cause undefined behavior. |
71 | 71 |
|
72 | 72 | The recommended order is shown here. Only `load_xdf` is mandatory.
|
73 | 73 |
|
74 | 74 | ```C++
|
75 |
| -XDFdata.load_xdf(std::string filepath); |
76 |
| -XDFdata.subtractMean(); |
77 |
| -XDFdata.createLabels(); |
78 |
| -XDFdata.resample(int sampleRate); |
79 |
| -XDFdata.freeUpTimeStamps(); |
| 75 | +xdf.load_xdf(std::string filepath); |
| 76 | +xdf.detrend(); |
| 77 | +xdf.create_labels(); |
| 78 | +xdf.resample(int sampling_rate); |
| 79 | +xdf.free_up_time_stamps(); |
80 | 80 | ```
|
81 | 81 |
|
82 | 82 | Libxdf depends on third party libraries [Pugixml v1.8](http://pugixml.org/) for XML parsing and [Smarc](http://audio-smarc.sourceforge.net/) for resampling.
|
83 | 83 |
|
84 | 84 | ## <a name="doc"></a> Documentation
|
85 |
| -Detailed documentation was generated via [Doxygen](http://www.stack.nl/~dimitri/doxygen/index.html) and is available [here](docs/html/class_xdf.html). |
86 |
| - |
87 |
| -## <a name="SigViewer"></a> SigViewer Online Repo |
88 |
| -SigViewer Online Repository is [here](repository/Updates.xml). |
| 85 | +[Documentation](docs/html/class_xdf.html) was generated via [Doxygen](http://www.stack.nl/~dimitri/doxygen/index.html). |
89 | 86 |
|
90 | 87 | ## <a name="support"></a>Support
|
91 | 88 |
|
|
0 commit comments