|
1 | 1 | # fast_sampen: Fast Computation of Sample Entropy
|
2 | 2 |
|
3 |
| -This repository includes a library and a program for fast computation of Sample Entropy, based on kd tree and randomly |
4 |
| -sample (Monte Carlo and quasi-Monte Carlo) method. |
| 3 | +This repository includes a library and a program for fast computation of Sample Entropy, based on kd tree, Range-kd tree and randomly sample (Monte Carlo and quasi-Monte Carlo) method. |
5 | 4 |
|
6 | 5 | ## Requirements
|
7 | 6 |
|
8 | 7 | - Linux, macOS or other UNIX-like OS
|
9 | 8 | - C++ compiler supporting C++11
|
10 | 9 | - CMake (version >= 3.5)
|
| 10 | +- GSL (for quasi-random number generation) |
| 11 | +- Magick++7 (for image manipulation such as io and resize) |
11 | 12 |
|
12 | 13 | ## Compile
|
13 | 14 |
|
@@ -71,44 +72,4 @@ The built binary will be located in `bin` directory in the building directory.
|
71 | 72 |
|
72 | 73 | ## Usage
|
73 | 74 |
|
74 |
| -``` |
75 |
| -Usage: build/fast_sampen --input <INPUT> --input-type {simple, multirecord}\ |
76 |
| - -r <THRESHOLD> -m <TEMPLATE_LENGTH>\ |
77 |
| - -n <N> [-output-level {1,2,3}]\ |
78 |
| - --sample-size <SAMPLE_SIZE> --sample-num <SAMPLE_NUM> |
79 |
| -
|
80 |
| -Options and arguments: |
81 |
| ---input <INPUT> The file name of the input file. |
82 |
| ---input-format <FORMAT> The format of the input file. Should be either simple |
83 |
| - or multirecord. If set to simple, then each line of the |
84 |
| - input file contains exactly one column; if set to |
85 |
| - multirecord, then each line contains <NUM_RECORD> + 1 |
86 |
| - columns, of which the first indicates the line number |
87 |
| - and the remaining columns are instances of the records. |
88 |
| - The default value is simple. |
89 |
| ---input-type <TYPE> The data type of the input data, either int or float. |
90 |
| - Default: double. |
91 |
| --r <R> The threshold argument in sample entropy. |
92 |
| --m <M> The template length argument of sample entropy. Note |
93 |
| - that this program only supports 2 <= m <= 10. |
94 |
| --n <N> If the length of the signal specified by <FILENAME> is |
95 |
| - greater than <N>, then it would be truncated to be of |
96 |
| - length <N>. If <N> is 0, then the the original length |
97 |
| - is employed. The default value is 0. |
98 |
| ---sample-size <N0> The number of points to sample. |
99 |
| ---sample-num <N1> The number of computations where the average is taken. |
100 |
| ---random If this option is enabled, the random seed will be set |
101 |
| - randomly. |
102 |
| --q If this option is enabled, the quasi-Monte Carlo based |
103 |
| - method is conducted. |
104 |
| ---variance If this option is enabled, then the variance of the |
105 |
| - results of sampling methods will be computed. |
106 |
| ---quasi-type <TYPE> The type of the quasi-random sequence for sampling, |
107 |
| - can be one of the following: sobol, halton, |
108 |
| - reversehalton, niederreiter_2 or grid. Default: sobol. |
109 |
| --u If this option is enabled, the Monte Carlo based |
110 |
| - using uniform distribution is conducted. |
111 |
| ---output-level <LEVEL> The amount of information printed. Should be one of |
112 |
| - {0,1,2}. Level 0 is most silent while level 2 is for |
113 |
| - debugging. |
114 |
| -``` |
| 75 | +Run programs with `--help` for usage. |
0 commit comments