View source for Detailed information about your captured high speed video

= Metadata =

Each time a captured video is saved, an associated file, called the metadata file, is also saved, '''using the same filename but with the extension .txt'''. The metadata file contains all available captured video related information.  Other information, such as the lens used, the lens settings, a user assigned experiment identifier, and any other text information can be added by the user in the Notes field.  The Notes field can be viewed or modified by clicking on the wrench in the button box, then selecting the Overlay tab.  If you overlay the note on each video frame, the note may be truncated, depending on length, but the entire note (up to 128 characters) will be included in the metadata file.

= Example medatadata file = 

Below is the metadata file for the [https://vimeo.com/171262212 three martini lunch video] created for the introduction of the SC2 model edgertronic camera.

<pre style="background:#d6e4f1">
Camera time:	Wed Dec 14 05:04:44 2016	
Model:	SC1 Monochrome 8 GB	
Sensitivity:	6400	ISO
Shutter:	1/500	Seconds
Frame Rate:	30	Frames/Second
Horizontal:	1280	Pixels
Vertical:	1024	Pixels
Sub-sampling:	Off	sub-sample
Duration:	4	Seconds
Pre-trigger:	50	percent
Overclock:	0	level
Extended Dynamic Range:	0	level
Genlock:	Off	genlock
Force monochrome:	Off	Sensor behaves normally
Multishot Buffers:	3	buffers
External trigger debounce:	On	5 ms debounce delay after external trigger falling edge
Review before save:	On	enable review before save
Notes:	
Overlay notes:	Off	disabled
Overlay logo:	Off	disabled
Overlay settings:	Off	disabled
Overlay frame number:	On	enabled
Active pipeline:	H264HIGH:pipelines_factory.txt	configuration
Pipeline description:	H.264 high encode quality	 

Multishot buffer:	1	number
Frame count:	120	frames
Pre-trigger frames:	60	frames
Trigger time:	1481691878	(sec since 1970)
Trigger delay:	0.019473857	sec (time from trigger input to start of triggered frame)
First saved frame:	-1	where frame zero is the trigger frame
Last saved frame:	1	where frame zero is the trigger frame
Genlock locked:	NA	

DACVREFADC:	0xb3	
FPGA temp:	32	C
Sensor temp:	29	C
Time since dark frame:	9 seconds
Time since power on:	14 hours, 21 minutes	

Model number:	0x0001	
Serial number:	0x013A	
Hardware revision:	0x0006	
Hardware configuration:	0x1FF0001	
Build date:	20141219	(YYYYMMDD)
IR filter:	True	IR filter is installed
Sensor type:	Monochrome	sensor
DDR3 memory size:	8	GB
Ethernet MAC address:	00:1B:C5:09:61:3A	
FPGA version:	88	
Software build date:	20161212083243	(YYYYMMDDhhmmss)
Software version:	v2.2.1rc2	release
</pre>

= Metadata fields =

Host CAMAPI supports a method to fetch a metadata file from the camera and parse the file contents into a dictionary.  The table below lists both the metadata file and the Host CAMAPI dictionary key, plus a description.

{| class="wikitable"
! Metadata file<br>row title !! Host CAMAPI<br>dictionary key !! Description
|-
| Camera time || <tt>camera_time</tt> || Human readable time when metadata file was created.  Not the same as the trigger time.
|-
| Model || <tt>model_string</tt> || Human readable camera model description
|-
| Sensitivity || <tt>iso</tt> || ISO sensitivity.
|-
| Shutter || 1 /<tt>exposure</tt> || Shutter speed (1/exposure time) of each frame.
|-
| Frame Rate || <tt>frame_rate</tt> || Frames per second capture rate.
|-
| Horizontal || <tt>horizontal</tt> || Horizontal resolution in pixels.
|-
| Vertical || <tt>vertical</tt> || Vertical resolution in pixels.
|-
| Sub-sampling || <tt>subsample</tt> || Skips every other pixel and and every other line when the resolution is 1/4 or smaller of the maximum resolution.  SC1 only.
|-
| Duration || <tt>duration</tt>  || Captured video duration, including pre and post trigger times.  Trimming the video during save or using CAMAPI selective_save() does not effect the capture duration.
|-
| Pre-trigger || <tt>pretrigger</tt> || Percentage of the saved video that occurred before the trigger event.   Trimming the video during save or using CAMAPI selective_save() does not effect the pre-trigger capture percentage, nor does triggering before the pretrigger buffer has filled.
|-
| Overclock || <tt>overclock</tt> || A selection of overclock amounts from Off (0 value) being operating within the CMOS sensor's documented capabilities, and clock rate increasing A (1), B (2), C (3), and D (4) for higher levels of overclocking, ranging approximately 10% to 40% faster.  SC1 only.
|-
| Extended Dynamic Range || <tt>edr</tt>|| A non-linear transfer function is used to allow a greater dynamic range of luminosity to fit in the same number of luminance data bits.  Off (0),  increasing A (1), B (2), C (3), and D (4) for larger non-linear transfer function curve.  SC1 only.
|-
| Genlock || <tt>genlock</tt> ||  Multi-camera interconnect setting.  Off, Master, Slave, or External.
|-
| Force monochrome || <tt>force_monochrome</tt> || For color camera, can be set to On to only save captured videos using the lumanince value, otherwise set to Off.
|-
| Multishot Buffers || <tt>multishot_count</tt> || Maximum number of videos that can be captured before the captured data is either saved or discarded.
|-
| External trigger debounce || <tt>trigger_debounce</tt> ||
|-
| Notes || <tt>notes</tt> || User supplied text string.
|-
| Overlay notes || <tt>overlay_notes</tt> ||
|-
| Overlay logo || <tt>overlay_logo</tt> ||
|-
| Overlay settings || <tt>overlay_settings</tt> ||
|-
| Overlay frame number || <tt>overlay_frame_number</tt> ||
|-
| Active pipeline || <tt>pipeline</tt> || Section and filename for the [[Pipeline support|GStreamer pipelines]] used for live preview and video save.
|-
| Pipeline description || <tt>pipeline_description</tt> || Description string for the active pipeline.
|-
| Multishot buffer || <tt>multishot_buffer</tt> || Capture index when multishot count is greater than one, zero otherwise.
|-
| Frame count || <tt>captured_frames</tt> || The number of captured frames.  This is typically (frame_rate * duration), but if you trigger before the pre-trigger buffer is full, then the frame count will be less. Trimming the video during save or using CAMAPI selective_save() does not effect the number of frames captured, just the number of frames saved in the video file.
|-
| Pre-trigger frames || <tt>pretrigger_frames</tt> || Number of frames captured before frame zero, the trigger frame.  This is typically (frame_rate * duration * pre_trigger), if you trigger before the pre-trigger buffer is full, then the pre-trigger frame count will be less. Trimming the video during save or using CAMAPI selective_save() does not effect the number of captured pre-trigger frames, but may effect the number of pre-trigger frames saved in the video file.  If you have enabled frame number overlay, then frames with a negative number indicate the frame occurred before the trigger event.
|-
| Trigger time || <tt>trigger_time</tt> || Time in seconds since 1970 (the epoch) when the trigger occurred. The value is intended to assist in associating the captured video with other captured event data.  The value will be off a few seconds depending if you enabled NTP, how the clocks on the other captured devices are set, etc.  
|-
| Trigger delay || <tt>trigger_to_exposure_delay</tt> || Time, in seconds, from trigger event to start of exposure on the triggered frame.
|-
| First saved frame || <tt>first_saved_frame</tt> || Captured frame number of the first frame in the video file.  Frame 0 is the trigger frame, with pre-trigger frames having negative numbers.  This value can be effected by trimming the video during save or using CAMAPI selective_save().
|-
| Last saved frame || <tt>last_saved_frame</tt>  || Captured frame number of the last frame in the video file.  Frame 0 is the trigger frame, with pre-trigger frames having negative numbers.  This value can be effected by trimming the video during save or using CAMAPI selective_save().
|-
| Genlock locked || <tt>genlocked_locked</tt> || NA if genlock is not set to slave mode.  Other set to True if genlock was locked for entire capture duration otherwise False.
|-
| DACVREFADC || <tt>dacvrefadc</tt> || SC1 only.
|-
| FPGA temp || <tt>fpga_temp</tt> ||
|-
| Sensor temp || <tt>is_temp</tt> ||
|-
| DDR3 temp || <tt>ddr3_temp</tt> || Optional, some cameras do not have access to the DDR3 temperature
|-
| Time since dark frame || <tt>time_since_dark_frame</tt> || Human readable text containing the approximate elasped time since the last drark frame was taken.
|-
| Time since power on || <tt>uptime</tt> || Human readable text containing the approximate elasped time since the camera was powered on.
|-
| Model number || <tt>model_number</tt> || Set to 0x0001 for model SC1, 0x0002 for models SC2/SC2+, and 0x0003 for model SC2X.
|-
| Serial number || <tt>serial_number</tt> || If you have more than one edgertronic camera, you can use the last 3 hexadecimal digits of the ethernet MAC address, which is also the camera's serial number, to determine which video was captured by which camera.
|-
| Hardware revision || <tt>hardware_revision</tt> || Version of the printed circuit board in the camera.
|-
| Hardware configuration || <tt>hardware_configuration</tt> || Very goofy number used by nerdy engineers.  Normal people tend to use the IR filter, sensor type, and other human readable values instead.
|-
| Build date || <tt>build_date</tt> || The date your glorious camera was assembled.
|-
| IR filter || <tt>ir_filter_installed</tt> || True if the IR filter is installed, False otherwise.
|-
| Sensor type || <tt>sensor_type</tt> || Color or Monochrome
|-
| DDR3 memory size || <tt>memory_size</tt> || Number, in gigabytes, of the DDR3 memory used to hold captured videos.
|-
| Ethernet MAC address || <tt>ethernet_mac_address</tt> || Factory assigned ethernet MAC address.
|-
| FPGA version || <tt>fpga_verson</tt> || Code version loaded into the FPGA.
|-
| Software build date || <tt>software_build_date</tt> || Date, in YYYYMMDDhhmmss ordering, when the software in your camera was built.
|-
| Software version || <tt>software_version</tt> || Somewhat human readable text string describing the version of software running in your camera.
|}

= Metadata file format =

The file format is designed to be both human readable and computer readable.  All line that start with a pound sign or hash symbol (#) are ignored.  All other lines should have three columns which are divided by tab characters, meaning there are two tabs in each line and the line ends with a newline character.  The first column is the field name and ends in a colon character.  The next column is the value.  The third field is most often documents the value's units (such as seconds or pixels).

= Software version details =

== Version 2.2.0 and older ==

The duration, genlock locked and frame count values were based on the number of frames saved in the video file.  Specifically, these value could change when the video was trimmed during save (meaning CAMAPI <tt>save_stop()</tt>was called).

== Version 2.2.1 and newer ==

The duration, genlock locked and frame count values are based on what was captured.  Two new fields, first saved frame and last saved frame indicate which of the captured frames were saved in the video file.  Only first saved frame and last saved frame are effected by trim (e.g. CAMAPI <tt>save_stop()</tt>) and selective save (e.g. CAMAPI <tt>selective_save()</tt>).

[[Category:Developer]]