Skip to content

Commit d191ce5

Browse files
committed
Updated README.md
1 parent 55cc8dd commit d191ce5

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
## <a name="intro"></a>Introduction
1212

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.
1414
Libxdf is used in the biosignal viewing application [SigViewer](https://github.com/cbrnr/sigviewer). It can also be integrated into other
1515
C++ applications.
1616

@@ -57,35 +57,32 @@ Example:
5757
```C++
5858
#include "xdf.h"
5959

60-
Xdf XDFdata;
61-
XDFdata.load_xdf("C:/example.xdf");
60+
Xdf xdf;
61+
xdf.load_xdf("C:/example.xdf");
6262
```
6363

64-
To resample the signals to e.g. 100Hz:
64+
To resample the signals, e.g. to 100Hz:
6565

6666
```C++
67-
XDFdata.resample(100);
67+
xdf.resample(100);
6868
```
6969

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 functions in libxdf must be called following a certain order. For instance, if you call the `detrend` function before you load any data, it will cause undefined behavior.
7171

7272
The recommended order is shown here. Only `load_xdf` is mandatory.
7373

7474
```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();
8080
```
8181

8282
Libxdf depends on third party libraries [Pugixml v1.8](http://pugixml.org/) for XML parsing and [Smarc](http://audio-smarc.sourceforge.net/) for resampling.
8383

8484
## <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).
8986

9087
## <a name="support"></a>Support
9188

0 commit comments

Comments
 (0)