CICADA Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== .ekhoivs ======

**Version:** 1.0

===== Overview =====

An EKHO IVS file stores a recorded IV-surface recorded from from Ekho. This file is generally produced after processing a recorded EKHO RAW file.

All EKHO IVS files should be named with a **.ekhoivs** extension, to avoid confusion.

===== Format Structure =====

The EKHO IVS file is an ASCII-encoded, JSON file with the following structure:


  {
    "Header": {<fields>}
    "Surface": [<IV-curves>]
  }

The file contains two parts:
  * a **header** that describes how the data was recorded and processed.
  * a **list** of IV-curves.
===== Header fields =====

The file header is a JSON object that contains the following required members:
  * **File Type** (string) — "Ekho IVS".
  * **Format Version** (string) — Represents the version of the EKHO IVS format. So, for this document (version 1.0), the value should be "1.0".
  * **Generated By** (string) — a version number for the conversion software that created it. Each version of each program that generates .ekhoivs files shall have its own unique version string.
  * **Points Per Curve** (number) — the number of points in each IV curve.
  * **Min Voltage** (number) — the voltage value that corresponds with the current in the first point of the recorded IV curves.
  * **Max Voltage** (number) — the voltage value that corresponds with the current in the last point of the recorded IV curves. The voltages will be assigned evenly between the Min and Max voltage values.


===== Optional Members =====


  * **Firmware Version** (string) — represents the version of the firmware that created the file, probably directly copied from the EKHORAW file.
  * **Firmware Build Date** (string) — the **day**, **month**, and **year** that the firmware was compiled. So, for April 3, 2020, should be "03/04/2020".
  * **Controller Version** (string) — the version of the teensy that produced the file. Something like "Teensy 3.6".
  * **Board Version** (string) - the version of the Ekho recorder board used to record the data.
  * **Sampling Rate** (number) — the number of samples per second.
  * **Samples Per Curve** (number) — the number of samples per batch (explanation below).
  * **Curve Fitting Technique** (string) — a description of the curve fitting technique used to create these curves. Yes, if we know the software versions, we could go back and figure this out, but it would be nice to included it for readability.

===== IV Curves =====

Each IV Curve is a JSON Object, with the following members:
  * **TimeStamp** (number) — the time (in milliseconds) since the recording began. This allows for up to 49 days of continuous recording in one file.
  * **Currents** (array of numbers) — This array stores the currents, in amps, for the IV curve. The length of this array needs to match the **Points Per Curve** listed in the header.