Extract Synchronized ISXD And ISXB Movie Timestamps¶
Overview and purpose¶
Export timestamps from files which originate from the same paired and synced start-stop recording session to a .csv file. Timestamps are aligned to a single start time which is defined as the start time of the specified timing reference file.
This tool uses 1.0 compute credits per hour.
Parameters¶
Parameter | Required? | Default | Description |
---|---|---|---|
Reference File | True | N/A | File to use as the timing reference to align with the other input files |
Files To Align | True | N/A | Files to align to the epoch start time of the input timing reference file. |
Align Column Prefixes | True | N/A | The names of the align data sets to use in the output CSV |
Ref Column Prefix | True | Reference | The names of the align data sets to use in the output csv |
Time Ref | True | start | One of ('start', 'unix', 'tsc') – the time reference for the CSV time stamps |
Details¶
Valid Inputs¶
Source Parameter | File Type | File Format |
---|---|---|
Reference File | miniscope_movie, gpio_data, gpio_traces, movie, miniscope_movie, nvision_movie | isxd, gpio, gpio, isxb, isxd, isxd |
Files To Align | gpio_data, gpio_traces, miniscope_movie, movie, miniscope_movie, movie, nvision_movie | gpio, gpio, isxd, isxb, isxd, isxd, isxd |
Reference File¶
File to use as the timing reference to align with the other input files. Timestamps are exported relative to the start time of this file. This can be either a .gpio file, .isxd movie, or .isxb movie, otherwise the function will throw an error. If the timing reference is a movie, the movie must contain frame timestamps, otherwise this function will throw an error.
Files To Align¶
Files to align to the epoch start time of the input timing reference file. These files can either be a .gpio file, .isxd movie, or .isxb movie, otherwise the function will throw an error. The movies must contain frame timestamps, otherwise this function will throw an error.
Ref Column Prefix¶
The name of the reference data set to use in the output csv.
Align Column Prefixes¶
The names of the align data sets to use in the output csv.
Time Ref¶
The time reference for the CSV time stamps.
If start
is used, the timestamps represent the seconds since the start of the movie.
If unix
is used, the timestamps represent the seconds since the Unix epoch.
If tsc
is used, the timestamps represent the hardware counter value on the acquisition box when each frame was captured.
Outputs¶
Aligned Timestamps¶
A CSV containing aligned timestamps. An example is shown below:
Ref Timestamp (s) | Align Timestamp (s) |
---|---|
0.000000 | 0.321812 |
0.049961 | 0.353842 |
0.099922 | 0.385846 |
0.149882 | 0.421813 |
0.199843 | 0.453826 |
0.249804 | 0.485845 |
0.299765 | 0.521809 |
0.349725 | 0.553832 |
0.399686 | 0.585841 |
0.449647 | 0.621815 |
0.499607 | 0.653830 |
0.549568 | 0.685843 |
0.599529 | 0.721809 |
0.649490 | 0.753829 |
0.699450 | 0.785832 |
0.749411 | 0.821813 |
0.799372 | 0.853836 |
0.849333 | 0.885836 |
0.899293 | 0.921810 |
0.949254 | 0.953836 |
0.999214 | 0.985830 |