Keys and Values

Below are dictionary key: value pairs, followed by a description, for each of the figio dictionary constitutents.

Main figio Dictionary

The figio dictionary is the main dictionary.

• It is stored in an ordinary text file in yml format.
• It is composed of one or more model dictionaries and one or more view dictionaries.

There are three common variations to the figio dictionary:

• 1:1
  • One model
  • One view
  • This is the most basic option.
• 1:n
  • Several models
  • One view
  • This is an advanced option, wherein multiple models are plotted to the same figure. Considerations such as y-axis limits or the possibility of dual y-axes can become important.
• m:n
  • Several models
  • Several views
  • This is the most advanced combination of the three, where all the models are created, and views explicity specify which models get plotted to a particular figure.

Signal processing may be performed on one or more models, using the signal_process dictionary, to create a new model, which can also be used by the view. A conceptual flow diagram of multiple models, one with signal processing, and one view is shown below.

┌───────────────┐                                                    ┌───────────────┐
│     Model     │─────────────────────────┐                          │               │
└───────────────┘                         │                          │               │
                                          │                          │               │
┌───────────────┐                         │                          │               │
│     Model     │─────────────────────────┤                          │               │
└───────────────┘                         │                          │               │
        │                                 │                          │     View      │
                                          ├─────────────────────┬───▶│               │
        │                                 │                     │    │               │
┌───────────────┐                         │                     │    │               │
│     Model     │──┬──────────────────────┘                     │    │               │
└───────────────┘  │   ┌───────────────┐                        │    │               │
                   │   │    Signal     │    ┌───────────────┐   │    │               │
                   └──▶│    Process    │───▶│     Model     │───┘    │               │
                       └───────────────┘    └───────────────┘        └───────────────┘

Model Dictionary

The model dictionary contains items that describe how each (x,y) data set is constructed and shown on the view.

Plot Keywords Dictionary

Dictionary that overrides the matplotlib.pyplot.plot() kwargs default values. Default values used by figio follow:

Signal Processing Keywords Dictionary

Warning: The Signal Processing dictionary and links below are a work in progress.

This dictionary is currently under active development. For additional documentation, see

• Butterworth filter
• Differentiation
• Integration
• Cross correlation (to come, not yet implemented)
• tpav (three points angular velocity) algorithm

Below is a summary of the key: value pairs available within the signal_process dictionary.

        signal_process:
            process_guid_1:
                butterworth:
                    cutoff: 5
                    order: 4
                    type: low
            process_guid_2:
                gradient:
                    order: 1
            process_guid_3:
                integration:
                    order: 3
                    initial_conditions: [-10, 100, 1000]
            process_guid_4:
                crosscorrelation:
                    model_keys: [model_guid_0, model_guid_1]
                    mode: full # (valid | same)
            process_guid_5:
                tpav: { (tpav is three points angular velocity)
                    model_keys: [model_guid_0, model_guid_1, model_guid_2]

All processes support serialization, via

        signal_process:
            process_guid:
                process_key_string:
                    serialize: 1
                    folder: ~/sibl/cli/io/example
                    file: processed_output_file.csv

View Dictionary

The view dictionary contains items that describe how the main figure is constructed.

yaxis_rhs Dictionary

background_image Dictionary