Commit aa78cf97a5b065a430a5dd9a7726be1bd7eea2c4

Authored by Arnaud Blanchard
1 parent 71679031

Update README.md

Showing 1 changed file with 31 additions and 5 deletions
1 Set of programs to manipulate data in blc_channels. They do not have any lib dependency. 1 Set of programs to manipulate data in blc_channels. They do not have any lib dependency.
2 2
3 -i_keyboard  
4 -========== 3 +Acquire input values
  4 +====================
5 5
6 -Change values with the keyboard arrows or specific keys. `i_keyboard` 6 +From keyboard
  7 +-------------
  8 +
  9 +`i_keyboard` changes values with the keyboard arrows or specific keys:
7 10
8 Waiting for one key in '0123456789abcdef'. Quitting with 'q' 11 Waiting for one key in '0123456789abcdef'. Quitting with 'q'
9 /i_keyboard31058 12 /i_keyboard31058
10 13
11 -This means that a channel (/i_keyboard31058) of 16 ( because 16 characters in the string) 'UIN8' (default) has been created.  
12 -Press Up and Down to increase or decrease the first value. Use Right and Left or key of the key list to select another value to change. `Esc` sets the value back to neutral values (default 50% i.e. 127) 14 +This means that a channel (/i_keyboard31058) of 16 ( by default there is 16 characters in the string) 'UIN8' has been created.
  15 +Press Up and Down to increase or decrease the first value. Use Right and Left or one key of the key list to select another value to change.
  16 +`Esc` sets the value back to neutral values (default 50% i.e. 127)
13 17
14 i_keyboard has many options (use `ikeyboard h` to list them) we illustrate some: 18 i_keyboard has many options (use `ikeyboard h` to list them) we illustrate some:
15 19
@@ -30,6 +34,28 @@ You can change the min and max with -m and -M. The default step of one keypresse @@ -30,6 +34,28 @@ You can change the min and max with -m and -M. The default step of one keypresse
30 34
31 Sometime you do not want intermediate values but only toggle to max and min then use -T. 35 Sometime you do not want intermediate values but only toggle to max and min then use -T.
32 36
  37 +From files
  38 +----------
  39 +
  40 + `i_fread <filename.tsv>`
  41 +
  42 +Read a line of data from the file in tsv (i.e. '0.3 0.55 0.56 ' is a vector of 3 values) and creates a channel (a vector) containing these data.
  43 +If there are many lines, it updates the data as fast as possible with each time.
  44 +It is very fast you can be either be synchronized or using -p to requiert a minimal time between each update.
  45 +You can also use a first column describing the time in µs to read the line.
  46 +Finaly you can limit the number of line read by using -n.
  47 +
  48 +
  49 +Generate outputs
  50 +================
  51 +
  52 +to a file
  53 +---------
  54 +
  55 + `o_fread <channel> -f <filename.tsv>`
  56 +
  57 +Create a tsv file with the data of the channel. The options are symetrical with i_fread.
  58 +
33 59
34 60
35 61