Commit 2d93de2a authored by Pierre Aubert's avatar Pierre Aubert
Browse files

Add doc

parent 5144e385
......@@ -2,25 +2,63 @@
----
Code
----
# Code
https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/PhoenixFileBinaryAnalyzer
Documentation
----
# Documentation
https://cta-lapp.pages.in2p3.fr//PHOENIX_LIBS/PhoenixFileBinaryAnalyzer/
Requirements
------------
# Requirements
- c++ compiler >=5.3.1
- cmake > 3
- make
- HDF5 C++
Installation for Users
----------------------
# Installation for Users
$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/PhoenixFileBinaryAnalyzer.git
$ cd PhoenixFileBinaryAnalyzer
$ ./install.sh
# Basic use
```
phoenix_binary_analyzer -i rawMessage.h5 -f fullEvent.h5
```
Where :
- **rawMessage.h5** contains raw binary data (we will determine the offset in it)
- **fullEvent.h5** contains the different values (in HDF5 DataSet columns) we will search into the **rawMessage.h5** file
These two files have to have only one **DataSet** at the top of the file (its name does not matter) :
- the DataSet of the raw file has only one column (its name does not matter either) which contains all the raw data we need to analyse
- the DataSet of the full file has as many columns as you want to get their offset
The number of rows of the two DataSet has to be the same.
This number of rows allows to improve the discrimination between attributes in columns.
Do not use to many rows, at least files of 50 MB can be analysed in few seconds depending of how much conflicts and uncertainties the program will have to solve.
A typical output is :
```
Attribute 'configurationId' offset = 49
Attribute 'eventId' offset = 58
Attribute 'pedId' offset = Not enough data to conclude (potential conflict with other searched Attributes) => 4278 possibilities
Attribute 'tabPixelStatus' offset = 296908
Attribute 'telEventId' offset = 67
Attribute 'triggerTimeQns' offset = Not enough data to conclude (potential conflict with other searched Attributes) => 4301 possibilities
Attribute 'triggerTimeS' offset = Not enough data to conclude (potential conflict with other searched Attributes) => 4301 possibilities
Attribute 'triggerType' offset = Not enough data to conclude (potential conflict with other searched Attributes) => 4301 possibilities
Attribute 'waveform' offset = 100
```
The offset is given in bytes (when it has been found) and an explaination is given when there are several possibilities for columns which cannot be determined based on the given data.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment