histutils 1.0.1

Utilities for reading HiST data, etc.

HiST Utils

HiST project raw video data reading utilities.

Install

python -m pip install -e .

User Programs/Scripts

These functions are primarily made to be used from the Terminal by a human, they implement a complete program using the module functions.

RunSimulPlay

Simultaneous video playback of two or more cameras.

• -i input file list (.h5)
• -t Time range start/stop
• -o Output directory for plots (optional, slow)

Example

$ python RunSimulFrame.py -i ~/data/cmos2013-01-14T1-15.h5 ~/data/ccd2013-01-14T1-15.h5

using the data from January 13, 2013 experiment during active plasma time.

ConvertDMC2h5.py

Typically used by our staff internally to convert our binary .DMCdata files to human- and fast processing- friendly HDF5 files.

Example

python ConvertDMC2h5.py -p 512 512 -b 1 1 -k 0.0188679245283019 -o testframes_cam0.h5 ~/data/2013-04-14T07-00-CamSer7196_frames_363000-1-369200.DMCdata -s 2013-04-14T06:59:55Z -t 2013-04-14T08:54:10Z 2013-04-14T08:54:10.05Z

python ConvertDMC2h5.py -p 512 512 -b 1 1 -k 0.0333333333333333 -o testframes_cam1.h5 ~/data/2013-04-14T07-00-CamSer1387_frames_205111-1-208621.DMCdata -s 2013-04-14T07:00:07Z -t 2013-04-14T08:54:10Z 2013-04-14T08:54:10.05Z

WhenEnd.py

Just predicts the end of a .DMCdata file "does this file cover the auroral event time?"

Module Functions

These functions are typically targeted for calling from other programs, however, many of these can also be used from the Terminal directly.

Examples

Many more possibilities exist, the -h option on most functions will give some hints as to what the program can do.

Reference Examples

These examples are old, now we use HDF5 files. Kept for reference only.

Read .DMCdata file from within a Python script

from histutils import rawDMCreader
data = rawDMCreader.goRead('myfile.DMCdata')[0]

Using rawDMCreader.py from Terminal

cd histutils/histutils
python3 rawDMCreader.py ~/data/