check_fidl

qx_utilities.general.fidl.check_fidl(fidlfile=None, fidlfolder='.', plotfile=None, allcodes=None, _log=None)

check_fidl [fidlfile=] [fidlfolder=.] [plotfile=] [allcodes=false]

Print figures showing fidl events and their duration.

Parameters

--fidlfile (str):

The path to the fidl file to plot. By default all the fidl files in the folder if none specified.

--fidlfolder (str, default '.'):

The folder from which to plot the fidl files.

--plotfile (str):

The name of the file to save the plot to. Only makes sense if fidlfile is specified.

--allcodes (bool, default False):

Whether to plot line for all fidl codes even if no event has a particular code.

Notes

Use:

The figure shows one row per event code, each event drawn as a bar spanning its duration, and a row of onset marks along the top. Each row is named beside it, so a code can be read off the figure without counting rows.

Plots are written to a fidlplots folder. With --fidlfolder that folder is created inside it; with --fidlfile it is created beside the fidl file, so a single file plotted on its own lands in the same place it would have as one of a folder. --plotfile names the file within that folder.

By default a code that no event uses gets no row, which keeps the figure to the height the data needs. Pass --allcodes to give every code the header declares a row of its own, whether it is used or not, which is what makes two sessions comparable row for row.

Examples

qunex check_fidl \
    --fidlfolder=jfidls