Compare commits
6 Commits
Author | SHA1 | Date | |
---|---|---|---|
730b3dad83 | |||
9c69e94102 | |||
bd9135820a | |||
![]() |
4404590c44 | ||
441110afd6 | |||
a81e18eebc |
15
README.md
15
README.md
@@ -31,6 +31,8 @@ On the [Record Evolution Platform](https://www.record-evolution.de/en/home-en/),
|
|||||||
|
|
||||||
## File format
|
## File format
|
||||||
|
|
||||||
|
[Warning: Take a look at [this issue](https://github.com/RecordEvolution/IMCtermite/issues/14) when reading this section regarding the file format.]
|
||||||
|
|
||||||
A data file of the _IMC Bus Format_ type with the extension _.raw_ is a _mixed text/binary
|
A data file of the _IMC Bus Format_ type with the extension _.raw_ is a _mixed text/binary
|
||||||
file_ featuring a set of markers (keys) that indicate the start of various blocks
|
file_ featuring a set of markers (keys) that indicate the start of various blocks
|
||||||
of data that provide meta information and the actual measurement data. Every single
|
of data that provide meta information and the actual measurement data. Every single
|
||||||
@@ -153,7 +155,8 @@ python3 -m pip install IMCtermite
|
|||||||
which provides binary wheels for multiple architectures on _Windows_ and _Linux_
|
which provides binary wheels for multiple architectures on _Windows_ and _Linux_
|
||||||
and most _Python 3.x_ distributions. However, if your platform/architecture is
|
and most _Python 3.x_ distributions. However, if your platform/architecture is
|
||||||
not supported you can still compile the source distribution yourself, which
|
not supported you can still compile the source distribution yourself, which
|
||||||
requires _python3_setuptools_ and _gcc version >= 10.2.0_.
|
requires _python3_setuptools_ and an up-to-date compiler supporting C++11
|
||||||
|
standard (e.g. _gcc version >= 10.2.0_).
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@@ -189,23 +192,23 @@ options `imctermite sample-data.raw -b -c -s '|'`.
|
|||||||
|
|
||||||
### Python
|
### Python
|
||||||
|
|
||||||
Given the `imctermite` module is available, we can import it and declare an instance
|
Given the `IMCtermite` module is available, we can import it and declare an instance
|
||||||
of it by passing a _raw_ file to the constructor:
|
of it by passing a _raw_ file to the constructor:
|
||||||
|
|
||||||
```Python
|
```Python
|
||||||
import imc_termite
|
import IMCtermite
|
||||||
|
|
||||||
imcraw = imc_termite.imctermite(b"sample/sampleA.raw")
|
imcraw = IMCtermite.imctermite(b"sample/sampleA.raw")
|
||||||
```
|
```
|
||||||
|
|
||||||
An example of how to create an instance and obtain the list of channels is:
|
An example of how to create an instance and obtain the list of channels is:
|
||||||
|
|
||||||
```Python
|
```Python
|
||||||
import imc_termite
|
import IMCtermite
|
||||||
|
|
||||||
# declare and initialize instance of "imctermite" by passing a raw-file
|
# declare and initialize instance of "imctermite" by passing a raw-file
|
||||||
try :
|
try :
|
||||||
imcraw = imc_termite.imctermite(b"samples/sampleA.raw")
|
imcraw = IMCtermite.imctermite(b"samples/sampleA.raw")
|
||||||
except RuntimeError as e :
|
except RuntimeError as e :
|
||||||
print("failed to load/parse raw-file: " + str(e))
|
print("failed to load/parse raw-file: " + str(e))
|
||||||
|
|
||||||
|
@@ -84,6 +84,7 @@ namespace imc
|
|||||||
// noncritical keys
|
// noncritical keys
|
||||||
key(false,"NO","origin of data",1),
|
key(false,"NO","origin of data",1),
|
||||||
key(false,"NT","timestamp of trigger",1),
|
key(false,"NT","timestamp of trigger",1),
|
||||||
|
key(false,"NT","timestamp of trigger",2),
|
||||||
key(false,"ND","(color) display properties",1),
|
key(false,"ND","(color) display properties",1),
|
||||||
key(false,"NU","user defined key",1),
|
key(false,"NU","user defined key",1),
|
||||||
key(false,"Np","property of channel",1),
|
key(false,"Np","property of channel",1),
|
||||||
|
2
makefile
2
makefile
@@ -31,7 +31,7 @@ INST := /usr/local/bin
|
|||||||
#-----------------------------------------------------------------------------#
|
#-----------------------------------------------------------------------------#
|
||||||
# C++ and CLI tool
|
# C++ and CLI tool
|
||||||
|
|
||||||
# build exectuable
|
# build executable
|
||||||
$(EXE): check-tags $(GVSN) main.o
|
$(EXE): check-tags $(GVSN) main.o
|
||||||
$(CC) $(OPT) main.o -o $@
|
$(CC) $(OPT) main.o -o $@
|
||||||
|
|
||||||
|
@@ -1 +1 @@
|
|||||||
2.0.3
|
2.0.5
|
||||||
|
Reference in New Issue
Block a user