Documentation – Current v25.1

Results


Information

Overview

This page provides documentation of the results for the following modules:

Result File Formats

Imatest currently supports the following result file formats: CSV, HDF5, JSON, and XML.

CSV

Overview

Comma Separated Values (CSV) is a text output file. CSV files will typically use a .csv extension.

Imatest-Specific Notes

  • Section titles use Title Case and are in square braces.
  • Property titles use Title Case.
  • Units are in square braces after the title and before the first comma. They may be Unicode.
  • The element delimiter is a comma (,).
  • The line delimiter is a Unix new line (\n).
  • The entries of a subsection each have an element delimiter before them to visually separate sections.
  • Image data is not stored within text files.

HDF5

Overview

Hierarchical Data Format (HDF) 5 is a binary file format to organize large amounts of data within a single file. The file is broken up into datasets (typed multidimensional arrays) and groups (containers that can hold other datasets or groups). Both datasets and attributes may contain information about the data. HDF5 files will typically use a .h5 extension.

Interacting with HDF5 Files

Selected Viewers
Viewer Type Price
HDFView Desktop Application Free (requires free account)
myHDF5 Web Application Free
Programming Languages

HDF5 support for many programming languages exists, including but not limited to:

Resources

Imatest-Specific Notes

  • Booleans are not defined within HDF5. All Boolean data are converted to a uint8 inside the HDF5 file.
  • Section titles use Title Case.
  • Property titles use Title Case.
  • Units are stored in a units attribute. They may be Unicode.
  • As this is a binary file format, image data may be stored inside the result.

JSON

Overview

JavaScript Object Notation (JSON) is a text output file. JSON files will typically use a .json extension.

JSON Schema

  • JSON Schema
  • provides a way to declare the syntax of a JSON file.
  • Each results section has a link to its JSON Schema.

Imatest-Specific Notes

  • Section titles use snake_case and are lowercase.
  • Property titles use snake_case and are lowercase. Note that units may be uppercase.
  • Units are appended to the section title.
  • NaN and Inf are not defined in the JSON specification. These values are converted to null.
  • Image data is not stored within text files.

XML

Overview

eXtensible Markup Language (XML) is a text output file. XML files will typically use a .xml extension.

Imatest-Specific Notes

  • Section titles use snake_case and are lowercase.
  • Property titles use snake_case and are lowercase. Note that units may be uppercase.
  • Units are appended to the section title.
  • Vectors are stored within CDATA.
  • Image data is not stored within text files.

Getting Started

Organization

The Imatest results covered by this document may be broken up into sections. Each section may contain one or more properties and/or subsections.
This document is broken up into two main parts:

The remaining documentation sections are in alphabetical order.

Section

Description

Description provides a brief description of the results section.

Result Field(s)

Result Field(s) describe each of the results entries within the results section.

Column Description
Title The title of result field.
Description A description of the result field.
Validation Validation of the result.

  • Subcontainers will have a link to its documentation.
  • Constant values will be indicated with Constant followed by the constant value.
  • Enumerations will list the possible values.
Included In: Key The result file formats this field is saved in and how the key will be formatted in that file type.
JSON Type The JSON data type of the value.
Notes Fields that do not necessarily appear in the result are marked as Conditional.

Variable Key Result Field(s)

Variable Key Result Field(s) describe each of the results that have variable (changing) keys. These are the same as a regular Result Field, except 0 or more instances of this field may be present (each with a different key) and the key changes. These are currently used in Stray Light where the user may enter multiple tresholds or percentiles.

Column Description
Title The title of result field.
Description A description of the result field.
Validation Validation of the result.

  • Subcontainers will have a link to its documentation.
  • Constant values will be indicated with Constant followed by the constant value.
  • Enumerations will list the possible values.
Included In: Pattern The result file formats this field is saved in and how the key will be patterned in that file type.
JSON Type The JSON data type of the value.
Notes Fields that do not necessarily appear in the result are marked as Conditional.

Used In

Used In lists the other results sections that use this results section. This can be useful to return to a previous results section documentation.

Instances

If the section describes a template, this provide links to the documentation of the instances of the template.

JSON Schema

JSON Schema provides a link to the JSON Schema that describe the results section.

Members

If the section describes an enumeration, then its members will be listed here.

Notes

Notes provides section-level information.

Results Documentation

Imatest Root

Description

The root level of an Imatest result.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Imatest Result The results from an Imatest analysis.
  • JSON: imatest_result
  • CSV: [Imatest Result]
  • HDF5: /Imatest Result
  • XML: imatest_result
 object

JSON Schema

https://www.imatest.com/schema/25-1/common-root

Imatest Results Base

Description

The result(s) of an Imatest analysis run.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Imatest Information about the Imatest run.
  • JSON: imatest
  • CSV: [Imatest]
  • HDF5: /Imatest
  • XML: imatest
 object
Concentric Rings FOV Inputs and results from a concentric rings fov analysis run.
  • JSON: concentric_rings_fov
  • CSV: [Concentric Rings FOV]
  • HDF5: /Concentric Rings FOV
  • XML: concentric_rings_fov
 object
  • Conditional
Stray Light Inputs and results from a stray light analysis run.
  • JSON: stray_light
  • CSV: [Stray Light]
  • HDF5: /Stray Light
  • XML: stray_light
 object
  • Conditional
Note (TRIAL ONLY) Information that results are not saveable in a trial.
  • Constant: Cannot save full results in a trial.
  • JSON: note
  • CSV: Note
  • HDF5: /Note
  • XML
 string
  • In XML files, this will be an XML comment (no tag).
  • Conditional

JSON Schema

https://www.imatest.com/schema/25-1/common-base

Used In

Channel Extraction Information

Description

The information for selecting an analysis channel.

Result Field(s)

  • The following properties will exist in all instances of this result. Some instances may have other properties.
Title Description Validation Included In: Key JSON Type Note(s)
Name The name of the channel.
  • JSON: name
  • CSV: Name
  • HDF5: /Name
  • XML: name
 string
Type The type of the channel.
  • Enumeration Members:
    • Monochrome
    • Index
    • Weighted
    • Mean
    • Median
    • Luminance
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string

Instances

This result is a placeholder for one of the following instances.

JSON Schema

https://www.imatest.com/schema/25-1/common-channel-extractor

Notes

  • Other methods will be available in future versions of Imatest.

Used In

Channel Extraction Information: Index

Description

The information for selecting an analysis channel from an index.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Name The name of the channel.
  • JSON: name
  • CSV: Name
  • HDF5: /Name
  • XML: name
 string
Type The type of the channel.
  • Constant: Index
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Index The one-based index of the analysis channel.
  • JSON: index
  • CSV: Index
  • HDF5: /Index
  • XML: index
 integer

JSON Schema

https://www.imatest.com/schema/25-1/common-channel-extractor-index

Notes

Channel Extraction Information: Luminance

Description

The information for selecting a luminance analysis channel.

Result Field(s)

  • The following properties will exist in all instances of this result. Some instances may have other properties.
Title Description Validation Included In: Key JSON Type Note(s)
Name The name of the channel.
  • JSON: name
  • CSV: Name
  • HDF5: /Name
  • XML: name
 string
Type The type of the channel.
  • Constant: Luminance
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Luminance Type The method/standard for computing a luminance channel.
  • JSON: luminance_type
  • CSV: Luminance Type
  • HDF5: /Luminance Type
  • XML: luminance_type
 string

Instances

This result is a placeholder for one of the following instances.

JSON Schema

https://www.imatest.com/schema/25-1/common-channel-extractor-luminance

Notes

  • Other luminance types may be available in future versions of Imatest.

Luminance Channel Extraction Information: IEC 61966-2-1

Description

The information for selecting an IEC 61966-2-1 luminance analysis channel.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Name The name of the channel.
  • JSON: name
  • CSV: Name
  • HDF5: /Name
  • XML: name
 string
Type The type of the channel.
  • Constant: Luminance
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Luminance Type The method/standard for computing a luminance channel.
  • JSON: luminance_type
  • CSV: Luminance Type
  • HDF5: /Luminance Type
  • XML: luminance_type
 string
RGB Weights The weights applied to red, green, and blue channels.
  • Constant: [0.2126, 0.7152, 0.0722]
  • JSON: rgb_weights
  • CSV: RGB Weights
  • HDF5: /RGB Weights
  • XML: rgb_weights
 array of number

JSON Schema

https://www.imatest.com/schema/25-1/common-channel-extractor-luminance-iec-61966-2-1

Notes

Luminance Channel Extraction Information: ITU-R BT.2020-2

Description

The information for selecting an ITU-R BT.2020-2 luminance analysis channel.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Name The name of the channel.
  • JSON: name
  • CSV: Name
  • HDF5: /Name
  • XML: name
 string
Type The type of the channel.
  • Constant: Luminance
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Luminance Type The method/standard for computing a luminance channel.
  • JSON: luminance_type
  • CSV: Luminance Type
  • HDF5: /Luminance Type
  • XML: luminance_type
 string
RGB Weights The weights applied to red, green, and blue channels.
  • Constant: [0.2627, 0.678, 0.0593]
  • JSON: rgb_weights
  • CSV: RGB Weights
  • HDF5: /RGB Weights
  • XML: rgb_weights
 array of number

JSON Schema

https://www.imatest.com/schema/25-1/common-channel-extractor-luminance-itu-r-bt-2020-2

Notes

Luminance Channel Extraction Information: ITU-R BT.601-7

Description

The information for selecting an ITU-R BT.601-7 luminance analysis channel.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Name The name of the channel.
  • JSON: name
  • CSV: Name
  • HDF5: /Name
  • XML: name
 string
Type The type of the channel.
  • Constant: Luminance
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Luminance Type The method/standard for computing a luminance channel.
  • JSON: luminance_type
  • CSV: Luminance Type
  • HDF5: /Luminance Type
  • XML: luminance_type
 string
RGB Weights The weights applied to red, green, and blue channels.
  • Constant: [0.299, 0.587, 0.114]
  • JSON: rgb_weights
  • CSV: RGB Weights
  • HDF5: /RGB Weights
  • XML: rgb_weights
 array of number

JSON Schema

https://www.imatest.com/schema/25-1/common-channel-extractor-luminance-itu-r-bt-601-7

Notes

Luminance Channel Extraction Information: ITU-R BT.709-1

Description

The information for selecting an ITU-R BT.709-1 luminance analysis channel.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Name The name of the channel.
  • JSON: name
  • CSV: Name
  • HDF5: /Name
  • XML: name
 string
Type The type of the channel.
  • Constant: Luminance
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Luminance Type The method/standard for computing a luminance channel.
  • JSON: luminance_type
  • CSV: Luminance Type
  • HDF5: /Luminance Type
  • XML: luminance_type
 string
RGB Weights The weights applied to red, green, and blue channels.
  • Constant: [0.2125, 0.7154, 0.0721]
  • JSON: rgb_weights
  • CSV: RGB Weights
  • HDF5: /RGB Weights
  • XML: rgb_weights
 array of number

JSON Schema

https://www.imatest.com/schema/25-1/common-channel-extractor-luminance-itu-r-bt-709-1

Notes

Luminance Channel Extraction Information: ITU-R BT.709-6

Description

The information for selecting an ITU-R BT.709-6 luminance analysis channel.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Name The name of the channel.
  • JSON: name
  • CSV: Name
  • HDF5: /Name
  • XML: name
 string
Type The type of the channel.
  • Constant: Luminance
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Luminance Type The method/standard for computing a luminance channel.
  • JSON: luminance_type
  • CSV: Luminance Type
  • HDF5: /Luminance Type
  • XML: luminance_type
 string
RGB Weights The weights applied to red, green, and blue channels.
  • Constant: [0.2126, 0.7152, 0.0722]
  • JSON: rgb_weights
  • CSV: RGB Weights
  • HDF5: /RGB Weights
  • XML: rgb_weights
 array of number

JSON Schema

https://www.imatest.com/schema/25-1/common-channel-extractor-luminance-itu-r-bt-709-6

Notes

Luminance Channel Extraction Information: MATLAB

Description

The information for selecting a MATLAB luminance analysis channel. This uses MATLAB’s rgb2gray function.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Name The name of the channel.
  • JSON: name
  • CSV: Name
  • HDF5: /Name
  • XML: name
 string
Type The type of the channel.
  • Constant: Luminance
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Luminance Type The method/standard for computing a luminance channel.
  • JSON: luminance_type
  • CSV: Luminance Type
  • HDF5: /Luminance Type
  • XML: luminance_type
 string

JSON Schema

https://www.imatest.com/schema/25-1/common-channel-extractor-luminance-matlab

Notes

Luminance Channel Extraction Information: NTSC (Rounded)

Description

The information for selecting an NTSC (Rounded) luminance analysis channel. This is ITU-R BT.601-7 rounded to 2 significant digits.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Name The name of the channel.
  • JSON: name
  • CSV: Name
  • HDF5: /Name
  • XML: name
 string
Type The type of the channel.
  • Constant: Luminance
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Luminance Type The method/standard for computing a luminance channel.
  • JSON: luminance_type
  • CSV: Luminance Type
  • HDF5: /Luminance Type
  • XML: luminance_type
 string
RGB Weights The weights applied to red, green, and blue channels.
  • Constant: [0.3, 0.59, 0.11]
  • JSON: rgb_weights
  • CSV: RGB Weights
  • HDF5: /RGB Weights
  • XML: rgb_weights
 array of number

JSON Schema

https://www.imatest.com/schema/25-1/common-channel-extractor-luminance-ntsc-rounded

Notes

Channel Extraction Information: Mean

Description

The information for selecting a mean analysis channel.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Name The name of the channel.
  • JSON: name
  • CSV: Name
  • HDF5: /Name
  • XML: name
 string
Type The type of the channel.
  • Constant: Mean
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string

JSON Schema

https://www.imatest.com/schema/25-1/common-channel-extractor-mean

Notes

Channel Extraction Information: Median

Description

The information for selecting a median analysis channel.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Name The name of the channel.
  • JSON: name
  • CSV: Name
  • HDF5: /Name
  • XML: name
 string
Type The type of the channel.
  • Constant: Median
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string

JSON Schema

https://www.imatest.com/schema/25-1/common-channel-extractor-median

Notes

Channel Extraction Information: Monochrome

Description

The information for selecting a monochrome analysis channel.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Name The name of the channel.
  • JSON: name
  • CSV: Name
  • HDF5: /Name
  • XML: name
 string
Type The type of the channel.
  • Constant: Monochrome
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string

JSON Schema

https://www.imatest.com/schema/25-1/common-channel-extractor-monochrome

Notes

Channel Extraction Information: Weighted Channels

Description

The information for selecting a median analysis channel.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Name The name of the channel.
  • JSON: name
  • CSV: Name
  • HDF5: /Name
  • XML: name
 string
Type The type of the channel.
  • Constant: Weighted
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Weights The weights to apply to each channel.
  • JSON: weights
  • CSV: Weights
  • HDF5: /Weights
  • XML: weights
 array of number

JSON Schema

https://www.imatest.com/schema/25-1/common-channel-extractor-weights

Notes

Filename + MD5 Hash

Description

A filename and its MD5 hash.

Properties

Title Description Validation Included In: Key JSON Type Note(s)
Filename The path to a file.
  • JSON: filename
  • CSV: Filename
  • HDF5: /Filename
 string
  • In some instances, there may be a prefix (e.g., ‘Image’) to the filename key.
MD5 If the file does not exist, then the reported MD5 hash will be an empty string.
  • JSON: md5
  • CSV: MD5
 string
  • If the file does not exist, then the reported MD5 hash will be an empty string.
  • In some instances, there may be a prefix (e.g., ‘Image’) to the md5 key.
  • For CSV files, the filename and MD5 hash are separate lines.
  • For HDF files, the MD5 hash is added as an attribute of the data set.
  • For XML files, the MD5 hash is added as an attribute of the element.

JSON Schema

https://www.imatest.com/schema/25-1/common-filename-md5

Used In

Filename + MD5 Hash List

Description

A list of multiple filenames and their MD5 hashes.

This is a collection of zero or more

Filename + MD5 Hash.

JSON Schema

https://www.imatest.com/schema/25-1/common-filename-md5-array

HDF5 Notes

  • Each file (and MD5) in the HDF5 file is in its own numbered dataset.

Used In

Imatest Header

Description

Common information about an Imatest analysis run.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Imatest Version The version of Imatest that was used for the analysis.
  • JSON: imatest_version
  • CSV: Imatest Version
  • HDF5: /Imatest Version
  • XML: imatest_version
 string
Build The build of Imatest that was used.
  • JSON: build
  • CSV: Build
  • HDF5: /Build
  • XML: build
 string
Run Date Time The date and time of the Imatest analysis run.
  • JSON: run_date_time
  • CSV: Run Date Time
  • HDF5: /Run Date Time
  • XML: run_date_time
 string
INI File The INI file that was used for the run.
  • JSON: ini_file
  • CSV: INI File Filename, INI File MD5
  • HDF5: /INI File
  • XML: ini_file
 object
  • CSV files have the file and MD5 has split across separate lines.
Memory Information about the memory usage.
  • JSON: memory
  • CSV: [Memory]
  • HDF5: /Memory
  • XML: memory
 object

JSON Schema

https://www.imatest.com/schema/25-1/common-header

Used In

Memory

Description

Information about the memory usage.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
MATLAB Used The memory used by MATLAB in MB.
  • JSON: matlab_used_MB
  • CSV: MATLAB Used [MB]
  • HDF5: /MATLAB Used
  • XML: matlab_used
 number
Physical Free The free physical memory in MB.
  • JSON: physical_free_MB
  • CSV: Physical Free [MB]
  • HDF5: /Physical Free
  • XML: physical_free
 number
Physical Total The total physical memory in MB.
  • JSON: physical_total_MB
  • CSV: Physical Total [MB]
  • HDF5: /Physical Total
  • XML: physical_total
 number

JSON Schema

https://www.imatest.com/schema/25-1/common-memory

Used In

Imatest Number

Description

A number from an Imatest output that may contain values not defined in JSON.

File-Specific Behavior

JSON

  • There are numeric values including `NaN` and `Infinity` which are not defined in the JSON file format.
  • These values are converted to `null` in JSON outputs.
  • A null in the result indicates one of the following: (1) The value was NaN (indicating an invalid measurement). (2) The value was infinite.

CSV

  • There is no change in behavior for CSV files.

HDF5

  • There is no change in behavior for HDF5 files.

JSON Schema

https://www.imatest.com/schema/25-1/common-number

Used In

Percentile

Description

The percentile(s) for given rank(s).

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Ranks The ranks (0-100) where the percentile is calculated.
  • JSON: ranks
  • CSV: Ranks
  • HDF5: /Ranks
  • XML: ranks
 array of number
Values The percentile(s).
  • JSON: values
  • CSV: Values
  • HDF5: /Values
  • XML: values
 array of number

JSON Schema

https://www.imatest.com/schema/25-1/common-results-percentiles

Used In

Registration Mark

Description

Information about a detected registration mark.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Regmark Center The detected center of the registration mark.
  • JSON: regmark_center_px
  • CSV: Regmark Center [px]
  • HDF5: /Regmark Center
  • XML: regmark_center
 array of number
Regmark Radius The detected radius of the registration mark.
  • JSON: regmark_radius_px
  • CSV: Regmark Radius [px]
  • HDF5: /Regmark Radius
  • XML: regmark_radius
 number

JSON Schema

https://www.imatest.com/schema/25-1/common-results-registration-mark

Used In

Channel Selection Settings

Description

The user-provided settings for selecting analysis channel(s).

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Type The user-provided set of channels to analyze.
  • Enumeration Members:
    • Automatic
    • Each Channel
    • RGB
    • Monochrome
    • Statistics
    • Luminance
    • RGB + Luminance
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Luminance Type The user-provided method for what calculation to use.
  • JSON: luminance_type
  • CSV: Luminance Type
  • HDF5: /Luminance Type
  • XML: luminance_type
 string
  • Conditional
Custom RGB Weights The user-provided custom luminance weights.
  • JSON: custom_rgb_weights
  • CSV: Custom RGB Weights
  • HDF5: /Custom RGB Weights
  • XML: custom_rgb_weights
 array of number
  • Conditional
RGB Order The user-provided ordering of RGB data.
  • JSON: rgb_order
  • CSV: RGB Order
  • HDF5: /RGB Order
  • XML: rgb_order
 string
  • Conditional
Statistics The user-provided statistics type.
  • JSON: statistics
  • CSV: Statistics
  • HDF5: /Statistics
  • XML: statistics
 string
  • Conditional

JSON Schema

https://www.imatest.com/schema/25-1/common-settings-channel

Used In

Luminance Channel Standards

Description

The user-provided method for extracting a luminance channel from RGB images.

Members

  • IEC 61966-2-1
  • ITU-R BT.601-7
  • ITU-R BT.709-6
  • ITU-R BT.2020-2
  • ITU-R BT.709-1
  • NTSC (Rounded)
  • MATLAB
  • Custom RGB Weights

JSON Schema

https://www.imatest.com/schema/25-1/common-settings-channel-luminance-type-enum

Used In

RGB Order

Description

The user-provided ordering of RGB data.

Members

  • Red, Green, Blue
  • Blue, Green, Red

JSON Schema

https://www.imatest.com/schema/25-1/common-settings-channel-rgb-order-enum

Used In

Statistics Channel Extraction

Description

The user-provided method for extracting a statistics channel.

Members

  • Mean
  • Median

JSON Schema

https://www.imatest.com/schema/25-1/common-settings-channel-stats-enum

Used In

Crop LRTB Settings

Description

The user-provided settings for a stray light analysis run.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
LRTB The user-provided crop values (left, right, top, bottom) in pixels.
  • JSON: lrtb_px
  • CSV: LRTB [px]
  • HDF5: /LRTB
  • XML: lrtb
 array of integer

JSON Schema

https://www.imatest.com/schema/25-1/common-settings-crop-lrtb

Used In

Plot Save Format

Description

The user-provided format(s) to save a figure as.

Members

  • Save
  • Display

JSON Schema

https://www.imatest.com/schema/25-1/common-settings-figure-save-display-enum

Used In

Plot Save Format

Description

The user-provided format(s) to save a figure as.

Members

  • JPEG
  • PNG
  • Compressed TIFF
  • Uncompressed TIFF
  • MATLAB Figure
  • PDF
  • EPS Level 3 Black & White
  • EPS Level 3 Color
  • EPS Level 2 Black & White
  • EPS Level 2 Color
  • SVG

JSON Schema

https://www.imatest.com/schema/25-1/common-settings-figure-save-type-enum

Used In

Image Series Formats

Description

The user-provided format(s) for saving each frame of the video.

Members

  • png
  • jpg
  • tiff

JSON Schema

https://www.imatest.com/schema/25-1/common-settings-image-frame-formats-enum

Used In

Neutral Density Settings

Description

The user-provided measurement of a neutral-density filter.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Type The user-provided type of neutral density filter measurement.
  • Enumeration Members:
    • None
    • Density
    • Transmission
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Transmission The user-provided transmission percentage (0-100) for the neutral density filter.
  • JSON: transmission
  • CSV: Transmission
  • HDF5: /Transmission
  • XML: transmission
 number
  • Conditional
Density The user-provided density for the neutral density filter.
  • JSON: density
  • CSV: Density
  • HDF5: /Density
  • XML: density
 number
  • Conditional

JSON Schema

https://www.imatest.com/schema/25-1/common-settings-neutral-density

Used In

Registration Mark Detection

Description

The user-provided settings for detecting registration marks.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Method The user-provided method for detecting registration marks.
  • Enumeration Members:
    • Classic Autodetect
    • ML/CV Autodetect
  • JSON: method
  • CSV: Method
  • HDF5: /Method
  • XML: method
 string
Confidence Threshold The user-provided machine vision confidence threshold.
  • JSON: confidence_threshold
  • CSV: Confidence Threshold
  • HDF5: /Confidence Threshold
  • XML: confidence_threshold
 number
  • Conditional
High Noise The user-provided option to enable high-noise compensation.
  • JSON: high_noise
  • CSV: High Noise
  • HDF5: /High Noise
  • XML: high_noise
 boolean
Skip Refinement The user-provided option to skip the refinement step.
  • JSON: skip_refinement
  • CSV: Skip Refinement
  • HDF5: /Skip Refinement
  • XML: skip_refinement
 boolean

JSON Schema

https://www.imatest.com/schema/25-1/common-settings-registration-mark

Used In

Summary Results Settings

Description

The user-provided selection for what result file(s) to save.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Result Files The user-provided selection for what type(s) of results files to save.
  • JSON: result_files
  • CSV: Result Files
  • HDF5: /Result Files
  • XML: result_files
 array of string

JSON Schema

https://www.imatest.com/schema/25-1/common-settings-result-files

Used In

Summary Results Output Types

Description

The user-provided options for saving summary results files.

Members

  • JSON
  • CSV
  • HDF5
  • XML

JSON Schema

https://www.imatest.com/schema/25-1/common-settings-results-format-enum

Used In

Saturation Settings

Description

The user-provided settings for computing the saturation in an image.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Type The user-provided method for calculating the saturation level.
  • Enumeration Members:
    • Container Max
    • Image Max
    • Image Max (Power of Two)
    • Image Max (Even Power of Two)
    • User-Specified Bit Depth
    • User-Specified Value
    • Classic
    • ITU-R BT.601
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
User-Specified Value The user-provided saturation level in digital numbers.
  • JSON: user_specified_value_DN
  • CSV: User-Specified Value [DN]
  • HDF5: /User-Specified Value
  • XML: user_specified_value
 number
  • Conditional
User-Specified Bit Depth The user-provided saturation level in bits.
  • JSON: user_specified_bit_depth_bits
  • CSV: User-Specified Bit Depth [bits]
  • HDF5: /User-Specified Bit Depth
  • XML: user_specified_bit_depth
 integer
  • Conditional

JSON Schema

https://www.imatest.com/schema/25-1/common-settings-saturation

Used In

Save Location

Description

User-provided settings for where to save results.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Save In Image Subfolder User-provided setting if the result(s) should be saved in the same folder as the image.
  • JSON: save_in_image_subfolder
  • CSV: Save In Image Subfolder
  • HDF5: /Save In Image Subfolder
  • XML: save_in_image_subfolder
 boolean
Sub Folder The user-provided sub-folder of the image folder to save the result(s) in.
  • JSON: sub_folder
  • CSV: Sub Folder
  • HDF5: /Sub Folder
  • XML: sub_folder
 string
  • Conditional
Custom Save Folder The user-provided folder to save the result(s) in.
  • JSON: custom_save_folder
  • CSV: Custom Save Folder
  • HDF5: /Custom Save Folder
  • XML: custom_save_folder
 string
  • Conditional
Use Image Name As Root The user-provided option to use the image name as the root of the result file(s). This is only in results when `save_in_image_subfolder` is `false`.
  • JSON: use_image_name_as_root
  • CSV: Use Image Name As Root
  • HDF5: /Use Image Name As Root
  • XML: use_image_name_as_root
 boolean
Custom Root Name The user-provided custom root name for the result file(s).
  • JSON: custom_root_name
  • CSV: Custom Root Name
  • HDF5: /Custom Root Name
  • XML: custom_root_name
 string
  • Conditional
Open Save Folder The user-provided option for opening the result folder at the end of an analysis run.
  • JSON: open_save_folder
  • CSV: Open Save Folder
  • HDF5: /Open Save Folder
  • XML: open_save_folder
 boolean

JSON Schema

https://www.imatest.com/schema/25-1/common-settings-save-location

Used In

Video Output Format

Description

The user-provided format(s) for saving a video.

Members

  • mp4
  • avi
  • gif

JSON Schema

https://www.imatest.com/schema/25-1/common-settings-video-formats-enum

Used In

Concentric Ring FOV: Root Results

Description

The results from a concentric rings FOV module run.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Inputs Information about the inputs to the concentric rings FOV module.
  • JSON: inputs
  • CSV: [Inputs]
  • HDF5: /Inputs
  • XML: inputs
 object
Results The results from a concentric rings FOV module analysis.
  • JSON: results
  • CSV: [Results]
  • HDF5: /Results
  • XML: results
 object

JSON Schema

https://www.imatest.com/schema/25-1/results-rings-root

Used In

Concentric Ring FOV: Inputs

Description

Inputs to the Concentric Rings FOV module.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Image File The image file that was analyzed.
  • JSON: image_file
  • CSV: Image File Filename, Image File MD5
  • HDF5: /Image File
  • XML: image_file
 object
  • CSV files have the file and MD5 has split across separate lines.
Image The image that was analyzed.
  • HDF5: /Image
 N/A
Settings The user-provided settings for the analysis run.
  • JSON: settings
  • CSV: [Settings]
  • HDF5: /Settings
  • XML: settings
 object

JSON Schema

https://www.imatest.com/schema/25-1/rings-inputs

Used In

Concentric Rings FOV Results: Field Angle

Description

The maximum field angles for each of the radials.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
East The field angle in degrees along the east radial.
  • JSON: east_deg
  • CSV: East [°]
  • HDF5: /East
  • XML: east
 number
South East The field angle in degrees along the south east radial.
  • JSON: south_east_deg
  • CSV: South East [°]
  • HDF5: /South East
  • XML: south_east
 number
South The field angle in degrees along the south radial.
  • JSON: south_deg
  • CSV: South [°]
  • HDF5: /South
  • XML: south
 number
South West The field angle in degrees along the south west radial.
  • JSON: south_west_deg
  • CSV: South West [°]
  • HDF5: /South West
  • XML: south_west
 number
West The field angle in degrees along the west radial.
  • JSON: west_deg
  • CSV: West [°]
  • HDF5: /West
  • XML: west
 number
North West The field angle in degrees along the north west radial.
  • JSON: north_west_deg
  • CSV: North West [°]
  • HDF5: /North West
  • XML: north_west
 number
North The field angle in degrees along the north radial.
  • JSON: north_deg
  • CSV: North [°]
  • HDF5: /North
  • XML: north
 number
North East The field angle in degrees along the north east radial.
  • JSON: north_east_deg
  • CSV: North East [°]
  • HDF5: /North East
  • XML: north_east
 number

JSON Schema

https://www.imatest.com/schema/25-1/rings-results-field-angle

Used In

Concentric Rings FOV Summary Results: Field of View

Description

The field of views calculated from a concentric rings FOV module analysis.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Horizontal The horizontal field of view in degrees.
  • JSON: horizontal_deg
  • CSV: Horizontal [°]
  • HDF5: /Horizontal
  • XML: horizontal
 number
Vertical The vertical field of view in degrees.
  • JSON: vertical_deg
  • CSV: Vertical [°]
  • HDF5: /Vertical
  • XML: vertical
 number
Diagonal The diagonal field of view in degrees. This is the average of the positive and negative diagonal FOVs.
  • JSON: diagonal_deg
  • CSV: Diagonal [°]
  • HDF5: /Diagonal
  • XML: diagonal
 number
Positive Diagonal The positive diagonal field of view in degrees.
  • JSON: positive_diagonal_deg
  • CSV: Positive Diagonal [°]
  • HDF5: /Positive Diagonal
  • XML: positive_diagonal
 number
Negative Diagonal The negative diagonal field of view in degrees.
  • JSON: negative_diagonal_deg
  • CSV: Negative Diagonal [°]
  • HDF5: /Negative Diagonal
  • XML: negative_diagonal
 number

JSON Schema

https://www.imatest.com/schema/25-1/rings-results-fov

Used In

Concentric Rings FOV Radial Result

Description

The raw data for a radial.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Radial Direction The label for the radial direction.
  • Enumeration Members:
    • East
    • South East
    • South
    • South West
    • West
    • North West
    • North
    • North East
  • JSON: radial_direction
  • CSV: Radial Direction
  • HDF5: /Radial Direction
  • XML: radial_direction
 string
Line Azimuth Angle The azimuth angle of the radial in degrees.
  • JSON: line_azimuth_angle_deg
  • CSV: Line Azimuth Angle [°]
  • HDF5: /Line Azimuth Angle
  • XML: line_azimuth_angle
 number
End Point The x, y coordinate of the endpoint (furthest from the center) of the radial.
  • JSON: end_point
  • CSV: End Point
  • HDF5: /End Point
  • XML: end_point
 array of number
Ring Coordinates X The x coordinate of each ring detection along the radial.
  • JSON: ring_coordinates_x_px
  • CSV: Ring Coordinates X [px]
  • HDF5: /Ring Coordinates X
  • XML: ring_coordinates_x
 array of number
Ring Coordinates Y The y coordinate of each ring detection along the radial.
  • JSON: ring_coordinates_y_px
  • CSV: Ring Coordinates Y [px]
  • HDF5: /Ring Coordinates Y
  • XML: ring_coordinates_y
 array of number
Ring Count The number of detected rings along the radial.
  • JSON: ring_count
  • CSV: Ring Count
  • HDF5: /Ring Count
  • XML: ring_count
 integer
Ring Field Angle The field angle of each ring in degrees.
  • JSON: ring_field_angle_deg
  • CSV: Ring Field Angle [°]
  • HDF5: /Ring Field Angle
  • XML: ring_field_angle
 array of number
Image-Derived Ring Radius The radius of the ring in pixels, derived from the input image.
  • JSON: image_derived_ring_radius_px
  • CSV: Image-Derived Ring Radius [px]
  • HDF5: /Image-Derived Ring Radius (Pixels)
  • XML: image_derived_ring_radius
 array of number
Chart-Derived Ring Radius The radius of the ring in millimeters, derived from the chart parameters.
  • JSON: chart_derived_ring_radius_mm
  • CSV: Chart-Derived Ring Radius [mm]
  • HDF5: /Chart-Derived Ring Radius (mm)
  • XML: chart_derived_ring_radius
 array of number
Chart-Derived Ring Radius The radius of the ring in pixels, derived from the chart parameters.
  • JSON: chart_derived_ring_radius_px
  • CSV: Chart-Derived Ring Radius [px]
  • HDF5: /Chart-Derived Ring Radius (Pixels)
  • XML: chart_derived_ring_radius
 array of number
Image-Derived Ring Radius The radius of the ring in millimeters, derived from the input image.
  • JSON: image_derived_ring_radius_mm
  • CSV: Image-Derived Ring Radius [mm]
  • HDF5: /Image-Derived Ring Radius (mm)
  • XML: image_derived_ring_radius
 array of number
Optical Distortion The optical distortion percentage.
  • JSON: optical_distortion_pct
  • CSV: Optical Distortion [%]
  • HDF5: /Optical Distortion
  • XML: optical_distortion
 array of number

JSON Schema

https://www.imatest.com/schema/25-1/rings-results-radial

Used In

Concentric Ring FOV: Results

Description

The calculated results from a concentric rings FOV module analysis.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Registration Mark Information about the detected registration mark.
  • JSON: registration_mark
  • CSV: [Registration Mark]
  • HDF5: /Registration Mark
  • XML: registration_mark
 object
Summary The summary results from the analysis.
  • JSON: summary
  • CSV: [Summary]
  • HDF5: /Summary
  • XML: summary
 object
Raw Data The raw results for each radial.
  • JSON: raw_data
  • CSV: [Raw Data###]
  • HDF5: /Raw Data###
  • XML: Raw Data
 array of object
  • For CSV and/or HDF5 outputs, the one-based index is appended to each entry as indicated by the ###.

JSON Schema

https://www.imatest.com/schema/25-1/rings-results-root

Used In

Concentric Rings FOV Summary Results

Description

The summary results from a concentric rings FOV module analysis.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
FOV The calculated fields of view.
  • JSON: fov
  • CSV: [FOV]
  • HDF5: /FOV
  • XML: fov
 object
Field Angle The field angles calculated for each radial.
  • JSON: field_angle
  • CSV: [Field Angle]
  • HDF5: /Field Angle
  • XML: field_angle
 object

JSON Schema

https://www.imatest.com/schema/25-1/rings-results-summary

Used In

Concentric Rings FOV: Batch Output Settings

Description

The user-provided batch output settings for the Concentric Rings FOV module.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Plot Save Settings The user-provided settings for saving plot(s).
  • JSON: plot_save_settings
  • CSV: [Plot Save Settings]
  • HDF5: /Plot Save Settings
  • XML: plot_save_settings
 object
Result Files The user-provided settings for saving summary result file(s).
  • JSON: result_files
  • CSV: [Result Files]
  • HDF5: /Result Files
  • XML: result_files
 object
Save Location The user-provided settings for where the result file(s) are saved.
  • JSON: save_location
  • CSV: [Save Location]
  • HDF5: /Save Location
  • XML: save_location
 object

JSON Schema

https://www.imatest.com/schema/25-1/rings-settings-batch-outputs

Used In

Concentric Ring FOV: Settings

Description

The user-provided settings for the concentric rings module.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Target Properties The user-provided target settings.
  • JSON: target_properties
  • CSV: [Target Properties]
  • HDF5: /Target Properties
  • XML: target_properties
 object
Test Measurements The user-provided test measurements.
  • JSON: test_measurements
  • CSV: [Test Measurements]
  • HDF5: /Test Measurements
  • XML: test_measurements
 object
Registration Mark The user-provided settings for detecting a registration mark.
  • JSON: registration_mark
  • CSV: [Registration Mark]
  • HDF5: /Registration Mark
  • XML: registration_mark
 object
Batch Outputs The user-provided batch output settings.
  • JSON: batch_outputs
  • CSV: [Batch Outputs]
  • HDF5: /Batch Outputs
  • XML: batch_outputs
 object

JSON Schema

https://www.imatest.com/schema/25-1/rings-settings-root

Used In

Concentric Rings FOV Plotting Settings

Description

User-provided plot settings for the Concentric Rings FOV module.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Plot Type The user-provided settings for the file format(s) to save plots as.
  • JSON: plot_type
  • CSV: Plot Type
  • HDF5: /Plot Type
  • XML: plot_type
 array of string
Plot 1: Radius vs Field Angle The user-provided settings for how to save/display the plot.
  • JSON: plot_1_radius_vs_field_angle
  • CSV: Plot 1: Radius vs Field Angle
  • HDF5: /Plot 1: Radius vs Field Angle
  • XML: plot_1_radius_vs_field_angle
 array of string
Plot 2: Detection and FOV Summary The user-provided settings for how to save/display the plot.
  • JSON: plot_2_detection_and_fov_summary
  • CSV: Plot 2: Detection and FOV Summary
  • HDF5: /Plot 2: Detection and FOV Summary
  • XML: plot_2_detection_and_fov_summary
 array of string
Plot 3: Relative Distortion [mm] The user-provided settings for how to save/display the plot.
  • JSON: plot_3_relative_distortion_mm
  • CSV: Plot 3: Relative Distortion [mm]
  • HDF5: /Plot 3: Relative Distortion [mm]
  • XML: plot_3_relative_distortion_mm
 array of string
Plot 4: Relative Distortion [px] The user-provided settings for how to save/display the plot.
  • JSON: plot_4_relative_distortion_px
  • CSV: Plot 4: Relative Distortion [px]
  • HDF5: /Plot 4: Relative Distortion [px]
  • XML: plot_4_relative_distortion_px
 array of string
Plot 5: Optical Distortion Percentage The user-provided settings for how to save/display the plot.
  • JSON: plot_5_optical_distortion_percentage
  • CSV: Plot 5: Optical Distortion Percentage
  • HDF5: /Plot 5: Optical Distortion Percentage
  • XML: plot_5_optical_distortion_percentage
 array of string
Plot 5: Optical Distortion X-Axis The user-provided x-axis for the optical distortion plot.
  • Enumeration Members:
    • Field Angle
    • Distorted Radii
    • Undistorted Radii
  • JSON: plot_5_optical_distortion_x_axis
  • CSV: Plot 5: Optical Distortion X-Axis
  • HDF5: /Plot 5: Optical Distortion X-Axis
  • XML: plot_5_optical_distortion_x_axis
 string
  • Conditional

JSON Schema

https://www.imatest.com/schema/25-1/rings-settings-save-plots

Used In

Concentric Ring FOV: Target Settings

Description

The user-provided settings describing the target properties.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Type The user-provided method for describing the target.
  • Enumeration Members:
    • Constant Angle
    • Constant Distance
    • IMA-FOV-1X
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
FOV of First Ring The field of view (in degrees) that corresponds to the first (innermost) ring at the nominal test distance.
  • JSON: fov_of_first_ring_deg
  • CSV: FOV of First Ring [°]
  • HDF5: /FOV of First Ring
  • XML: fov_of_first_ring
 number
  • Conditional
Ring Separation Angle The angle (in degrees) between rings.
  • JSON: ring_separation_angle_deg
  • CSV: Ring Separation Angle [°]
  • HDF5: /Ring Separation Angle
  • XML: ring_separation_angle
 number
  • Conditional
Nominal Test Distance The test distance in mm that the chart is designed to be used.
  • JSON: nominal_test_distance_mm
  • CSV: Nominal Test Distance [mm]
  • HDF5: /Nominal Test Distance
  • XML: nominal_test_distance
 number
  • Conditional
Start Distance The distance in mm from the center of the chart to the first ring.
  • JSON: start_distance_mm
  • CSV: Start Distance [mm]
  • HDF5: /Start Distance
  • XML: start_distance
 number
  • Conditional
Delta Distance The distance in mm between rings.
  • JSON: delta_distance_mm
  • CSV: Delta Distance [mm]
  • HDF5: /Delta Distance
  • XML: delta_distance
 number
  • Conditional

JSON Schema

https://www.imatest.com/schema/25-1/rings-settings-target

Used In

Concentric Ring FOV: Test Setup

Description

The user-provided test measurements for the concentric ring FOV module.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Test Distance The user-provided measurement for the camera-target distance in mm.
  • JSON: test_distance_mm
  • CSV: Test Distance [mm]
  • HDF5: /Test Distance
  • XML: test_distance
 number

JSON Schema

https://www.imatest.com/schema/25-1/rings-settings-test-measurement

Used In

Stray Light Data Transforms

Description

The user-provided transform applied to stray light metric image data.

Members

  • Linear
  • Log10
  • dB (Power)
  • dB (Voltage)
  • Log2
  • Natural Log

JSON Schema

https://www.imatest.com/schema/25-1/stray-light-settings-data-transform-enum

Used In

Stray Light Inputs

Description

The user-provided inputs for a stray light analysis run.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Settings The user-provided settings (from an INI file).
  • JSON: settings
  • CSV: [Settings]
  • HDF5: /Settings
  • XML: settings
 object
Configuration Note Any user-provided notes from the stray light configuration file.
  • JSON: configuration_note
  • CSV: Configuration Note
  • HDF5: /Configuration Note
  • XML
 string
  • In XML files, this will be an XML comment (no tag).
  • Conditional

JSON Schema

https://www.imatest.com/schema/25-1/straylight-inputs

Used In

Stray Light Results

Description

The stray light results.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Normalization The normalization results.
  • JSON: normalization
  • CSV: [Normalization]
  • HDF5: /Normalization
  • XML: normalization
 object
Minimum Measurable Stray Light The minimum measurable stray light level for the current setup. This is the stray light value that is obtained from 1 DN higher than the dark level.
  • JSON: minimum_measurable_stray_light
  • CSV: Minimum Measurable Stray Light
  • HDF5: /Minimum Measurable Stray Light
  • XML: minimum_measurable_stray_light
 number
Maximum Measurable Stray Light The maximum measurable stray light level for the current setup. This is the stray light value that is obtained from 1 DN lower than the saturation level.
  • JSON: maximum_measurable_stray_light
  • CSV: Maximum Measurable Stray Light
  • HDF5: /Maximum Measurable Stray Light
  • XML: maximum_measurable_stray_light
 number
Saturation The calculated saturation value (in digital numbers) across all images in the analysis.
  • JSON: saturation_DN
  • CSV: Saturation [DN]
  • HDF5: /Saturation
  • XML: saturation
 number
Per Capture The results for each capture position.
  • JSON: per_capture
  • CSV: [Per Capture###]
  • HDF5: /Per Capture###
  • XML: Per Capture
 array of object
  • For CSV and/or HDF5 outputs, the one-based index is appended to each entry as indicated by the ###.
Summary The summary results.
  • JSON: summary
  • CSV: [Summary###]
  • HDF5: /Summary###
  • XML: Summary
 array of object
  • For CSV and/or HDF5 outputs, the one-based index is appended to each entry as indicated by the ###.
Note A comment from the stray light configuration file.
  • JSON: note
  • CSV: Note
  • HDF5: /Note
  • XML: note
 string
  • Conditional

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results

Used In

Stray Light Mask Results

Description

Information about the mask of the light source.

Result Field(s)

  • The following properties will exist in all instances of this result. Some instances may have other properties.
Title Description Validation Included In: Key JSON Type Note(s)
Type The type of mask result.
  • Enumeration Members:
    • Error
    • None
    • Image Processing
    • Image Processing + Circle
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Mask File The mask file(s) generated during the analysis.
  • JSON: mask_file
  • CSV: Mask File Filename, Mask File MD5
  • HDF5: /Mask File
  • XML: mask_file
 array of object
  • CSV files have the file and MD5 has split across separate lines.
Channel The channel used to produce the mask.
  • JSON: channel
  • CSV: Channel
  • HDF5: /Channel
  • XML: channel
 string

Instances

This result is a placeholder for one of the following instances.

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-mask

Used In

Stray Light Mask Results: Image Processing + Circle

Description

Information about the mask of the light source via the image processing + circle method.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Type The type of mask result.
  • Constant: Image Processing + Circle
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Mask File The mask file(s) generated during the analysis.
  • JSON: mask_file
  • CSV: Mask File Filename, Mask File MD5
  • HDF5: /Mask File
  • XML: mask_file
 array of object
  • CSV files have the file and MD5 has split across separate lines.
Channel The channel used to produce the mask.
  • JSON: channel
  • CSV: Channel
  • HDF5: /Channel
  • XML: channel
 string
Source In FOV True if the light source was determined to be in the FOV.
  • JSON: source_in_fov
  • CSV: Source In FOV
  • HDF5: /Source In FOV
  • XML: source_in_fov
 boolean
Source Pixel Count The number of pixels that were masked out.
  • JSON: source_pixel_count
  • CSV: Source Pixel Count
  • HDF5: /Source Pixel Count
  • XML: source_pixel_count
 integer
Connected Component Count The number of connected components for the masked-out light source(s).
  • JSON: connected_component_count
  • CSV: Connected Component Count
  • HDF5: /Connected Component Count
  • XML: connected_component_count
 integer
X Centroid The x-value of the centroid of the mask.
  • JSON: x_centroid_px
  • CSV: X Centroid [px]
  • HDF5: /X Centroid
  • XML: x_centroid
 number or null
Y Centroid The y-value of the centroid of the mask.
  • JSON: y_centroid_px
  • CSV: Y Centroid [px]
  • HDF5: /Y Centroid
  • XML: y_centroid
 number or null
Pass 1 Information about the masking of the first pass.
  • JSON: pass_1
  • CSV: [Pass 1]
  • HDF5: /Pass 1
  • XML: pass_1
 object
Radius The radius of the circular mask in pixels.
  • JSON: radius_px
  • CSV: Radius [px]
  • HDF5: /Radius
  • XML: radius
 number

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-mask-circle

Notes

Stray Light Mask Results: Error

Description

Mask information when an error occurred.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Type The type of mask result.
  • Constant: Error
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Mask File The mask file(s) generated during the analysis.
  • JSON: mask_file
  • CSV: Mask File Filename, Mask File MD5
  • HDF5: /Mask File
  • XML: mask_file
 array of object
  • CSV files have the file and MD5 has split across separate lines.
Channel The channel used to produce the mask.
  • JSON: channel
  • CSV: Channel
  • HDF5: /Channel
  • XML: channel
 string
Note Information that an error occurred.
  • Constant: An error occurred while performing the masking.
  • JSON: note
  • CSV: Note
  • HDF5: /Note
  • XML
 string
  • In XML files, this will be an XML comment (no tag).
Error Message The error message.
  • JSON: error_message
  • CSV: Error Message
  • HDF5: /Error Message
  • XML: error_message
 string
Error Id The error identifier.
  • JSON: error_id
  • CSV: Error Id
  • HDF5: /Error Id
  • XML: error_id
 string

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-mask-error

Notes

Stray Light Mask Results: Image Processing

Description

Information about the mask of the light source via the image processing method.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Type The type of mask result.
  • Constant: Image Processing
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Mask File The mask file(s) generated during the analysis.
  • JSON: mask_file
  • CSV: Mask File Filename, Mask File MD5
  • HDF5: /Mask File
  • XML: mask_file
 array of object
  • CSV files have the file and MD5 has split across separate lines.
Channel The channel used to produce the mask.
  • JSON: channel
  • CSV: Channel
  • HDF5: /Channel
  • XML: channel
 string
Source In FOV True if the light source was determined to be in the FOV.
  • JSON: source_in_fov
  • CSV: Source In FOV
  • HDF5: /Source In FOV
  • XML: source_in_fov
 boolean
Source Pixel Count The number of pixels that were masked out.
  • JSON: source_pixel_count
  • CSV: Source Pixel Count
  • HDF5: /Source Pixel Count
  • XML: source_pixel_count
 integer
Connected Component Count The number of connected components for the masked-out light source(s).
  • JSON: connected_component_count
  • CSV: Connected Component Count
  • HDF5: /Connected Component Count
  • XML: connected_component_count
 integer
X Centroid The x-value of the centroid of the mask.
  • JSON: x_centroid_px
  • CSV: X Centroid [px]
  • HDF5: /X Centroid
  • XML: x_centroid
 number or null
Y Centroid The y-value of the centroid of the mask.
  • JSON: y_centroid_px
  • CSV: Y Centroid [px]
  • HDF5: /Y Centroid
  • XML: y_centroid
 number or null
Threshold The threshold for masking in digital numbers.
  • JSON: threshold_DN
  • CSV: Threshold [DN]
  • HDF5: /Threshold
  • XML: threshold
 number
Exit Condition The condition for completing the masking method.
  • Enumeration Members:
    • Invalid Threshold
    • Multiple regions found
    • All regions are too small
    • Threshold less than minimum source level
    • No regions found
    • Single region found
    • Picking the largest region
    • Picking the smallest region
    • Unknown
  • JSON: exit_condition
  • CSV: Exit Condition
  • HDF5: /Exit Condition
  • XML: exit_condition
 string

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-mask-image-processing

Notes

Stray Light Mask Results: None

Description

Mask information when the user specified not to mask.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Type The type of mask result.
  • Constant: None
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Mask File The mask file(s) generated during the analysis.
  • JSON: mask_file
  • CSV: Mask File Filename, Mask File MD5
  • HDF5: /Mask File
  • XML: mask_file
 array of object
  • CSV files have the file and MD5 has split across separate lines.
Channel The channel used to produce the mask.
  • JSON: channel
  • CSV: Channel
  • HDF5: /Channel
  • XML: channel
 string

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-mask-none

Notes

Stray Light Normalization

Description

The normalization data.

Result Field(s)

  • The following properties will exist in all instances of this result. Some instances may have other properties.
Title Description Validation Included In: Key JSON Type Note(s)
Factor The computed normalization factor in digital numbers.
  • JSON: factor_DN
  • CSV: Factor [DN]
  • HDF5: /Factor
  • XML: factor
 number

Instances

This result is a placeholder for one of the following instances.

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-normalization

Used In

Stray Light Reference Image Compensation Data

Description

Information about the normalization compensation.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Compensation Factor The total normalization compensation factor.
  • JSON: compensation_factor
  • CSV: Compensation Factor
  • HDF5: /Compensation Factor
  • XML: compensation_factor
 number
Source The compensation information from the reference image of the direct source.
  • JSON: source
  • CSV: [Source]
  • HDF5: /Source
  • XML: source
 object
Camera The compensation information from the camera.
  • JSON: camera
  • CSV: [Camera]
  • HDF5: /Camera
  • XML: camera
 object

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-normalization-compensation

Used In

Stray Light Camera Compensation

Description

Information about the camera-side normalization compensation.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Compensation Factor The overall camera-side compensation factor.
  • JSON: compensation_factor
  • CSV: Compensation Factor
  • HDF5: /Compensation Factor
  • XML: compensation_factor
 number
Integration Time Compensation Factor The compensation factor from the integration time.
  • JSON: integration_time_compensation_factor
  • CSV: Integration Time Compensation Factor
  • HDF5: /Integration Time Compensation Factor
  • XML: integration_time_compensation_factor
 number
Gain Compensation Factor The compensation factor from the gain.
  • JSON: gain_compensation_factor
  • CSV: Gain Compensation Factor
  • HDF5: /Gain Compensation Factor
  • XML: gain_compensation_factor
 number

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-normalization-compensation-camera

Used In

Stray Light Direct Reference Image Compensation Data

Description

Information about the light source compensation for a direct reference image normalization.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Compensation Factor The overall compensation factor from the direct image of the source.
  • JSON: compensation_factor
  • CSV: Compensation Factor
  • HDF5: /Compensation Factor
  • XML: compensation_factor
 number
Light Level Compensation Factor The compensation factor from the difference in light level.
  • JSON: light_level_compensation_factor
  • CSV: Light Level Compensation Factor
  • HDF5: /Light Level Compensation Factor
  • XML: light_level_compensation_factor
 number
Neutral Density Compensation Factor The compensation factor from the neutral density filter.
  • JSON: neutral_density_compensation_factor
  • CSV: Neutral Density Compensation Factor
  • HDF5: /Neutral Density Compensation Factor
  • XML: neutral_density_compensation_factor
 number

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-normalization-compensation-direct-source

Notes

Stray Light Lambertian Reference Image Compensation Data

Description

Information about the light source compensation for a Lambertian reference image normalization.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Compensation Factor The overall compensation factor from the image of the Lambertian source.
  • JSON: compensation_factor
  • CSV: Compensation Factor
  • HDF5: /Compensation Factor
  • XML: compensation_factor
 number

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-normalization-compensation-lambertian-source

Notes

Stray Light Light Source Compensation Data

Description

Information about the light source compensation.

Instances

This result is a placeholder for one of the following instances.

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-normalization-compensation-source

Used In

Stray Light Normalization: Level

Description

The normalization data for level normalization.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Factor The computed normalization factor in digital numbers.
  • JSON: factor_DN
  • CSV: Factor [DN]
  • HDF5: /Factor
  • XML: factor
 number

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-normalization-level

Notes

Stray Light Normalization: None

Description

The normalization data for None normalization.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Factor The computed normalization factor in digital numbers.
  • Constant: 1
  • JSON: factor_DN
  • CSV: Factor [DN]
  • HDF5: /Factor
  • XML: factor
 number

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-normalization-none

Notes

Stray Light Normalization: Reference Image

Description

The normalization data from reference image normalization (direct or Lambertian).

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Factor The computed normalization factor in digital numbers.
  • JSON: factor_DN
  • CSV: Factor [DN]
  • HDF5: /Factor
  • XML: factor
 number
Base Factor The computed base normalization factor (pre-compensation) in digital numbers.
  • JSON: base_factor_DN
  • CSV: Base Factor [DN]
  • HDF5: /Base Factor
  • XML: base_factor
 number
Compensation Information about the normalization compensation.
  • JSON: compensation
  • CSV: [Compensation]
  • HDF5: /Compensation
  • XML: compensation
 object
Channel Information about the channel that was used to produce the normalization.
  • JSON: channel
  • CSV: [Channel]
  • HDF5: /Channel
  • XML: channel
 object
Mask Information about the mask of the reference (normalization) image.
  • JSON: mask
  • CSV: [Mask]
  • HDF5: /Mask
  • XML: mask
 object
Saturation The calculated saturation value for the reference image in digital numbers.
  • JSON: saturation_DN
  • CSV: Saturation [DN]
  • HDF5: /Saturation
  • XML: saturation
 number
Image The normalization image.
  • HDF5: /Image
 N/A

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-normalization-reference-image

Notes

Overall Stats

Description

Summary statistics over all captures within the subset.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Min The minimum stray light value for all captures over this subset.
  • JSON: min
  • CSV: Min
  • HDF5: /Min
  • XML: min
 number
Min Non-0 The minimum (of the non-zero values in the original image) stray light value for all captures over this subset.
  • JSON: min_non_0
  • CSV: Min Non-0
  • HDF5: /Min Non-0
  • XML: min_non_0
 number
Max The maximum stray light value for all captures over this subset.
  • JSON: max
  • CSV: Max
  • HDF5: /Max
  • XML: max
 number

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-overall-summary

Used In

Stray Light Results: Per Capture

Description

Stray light results from each capture position.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Capture Index The one-based index of the capture.
  • JSON: capture_index
  • CSV: Capture Index
  • HDF5: /Capture Index
  • XML: capture_index
 integer
Source Field Angle The field angle of the light source in degrees.
  • JSON: source_field_angle_deg
  • CSV: Source Field Angle [deg]
  • HDF5: /Source Field Angle
  • XML: source_field_angle
 number or null
Source Azimuth Angle The azimuth angle of the light source in degrees.
  • JSON: source_azimuth_angle_deg
  • CSV: Source Azimuth Angle [deg]
  • HDF5: /Source Azimuth Angle
  • XML: source_azimuth_angle
 number or null
Image File The analysis image.
  • JSON: image_file
  • CSV: Image File Filename, Image File MD5
  • HDF5: /Image File
  • XML: image_file
 object
  • CSV files have the file and MD5 has split across separate lines.
Input Image The image to be analyzed.
  • HDF5: /Input Image
 N/A
Saturation The calculated saturation value for this image in digital numbers.
  • JSON: saturation_DN
  • CSV: Saturation [DN]
  • HDF5: /Saturation
  • XML: saturation
 number
Mask Information about the mask of the light source.
  • JSON: mask
  • CSV: [Mask]
  • HDF5: /Mask
  • XML: mask
 object
Note The user-provided notes for the capture position.
  • JSON: note
  • CSV: Note
  • HDF5: /Note
  • XML
 string
  • In XML files, this will be an XML comment (no tag).
  • Conditional
Subsets The summary statistics for each subset (analysis channel).
  • JSON: subsets
  • CSV: [Subsets###]
  • HDF5: /Subsets###
  • XML: Subsets
 array of object
  • For CSV and/or HDF5 outputs, the one-based index is appended to each entry as indicated by the ###.
Low-Memory Result Files The summary output file(s) for this capture if operating in low memory mode.
  • JSON: low_memory_result_files
  • CSV: Low-Memory Result Files Filename, Low-Memory Result Files MD5
  • HDF5: /Low-Memory Result Files
  • XML: low_memory_result_files
 array of object
  • Conditional
  • CSV files have the file and MD5 has split across separate lines.

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-per-capture

Used In

Level Counts

Description

The number of pixels with stray light worse than user-provided thresholds.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Thresholds The user-provided thresholds.
  • JSON: thresholds
  • CSV: Thresholds
  • HDF5: /Thresholds
  • XML: thresholds
 array of number
Counts The number of pixels of stray light worse than the user-provided thresholds within the subset.
  • JSON: counts
  • CSV: Counts
  • HDF5: /Counts
  • XML: counts
 array of integer

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-per-capture-level-count

Notes

  • A subset is a combination of an analysis channel and a region of interest.

Used In

Stray Light Results: Per Capture Subset

Description

Stray light results from a subset of a capture.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Channel The name of the channel.
  • JSON: channel
  • CSV: Channel
  • HDF5: /Channel
  • XML: channel
 string
ROI The name of the region of interest.
  • Constant: All
  • JSON: roi
  • CSV: ROI
  • HDF5: /ROI
  • XML: roi
 string
Metric Image File The metric image file associated with this subset.
  • JSON: metric_image_file
  • CSV: Metric Image File Filename, Metric Image File MD5
  • HDF5: /Metric Image File
  • XML: metric_image_file
 array of object
  • CSV files have the file and MD5 has split across separate lines.
Data Transform The transform applied to the metric image.
  • JSON: data_transform
  • CSV: Data Transform
  • HDF5: /Data Transform
  • XML: data_transform
 string
Channel Image The image for this channel.
  • HDF5: /Channel Image
 N/A
Metric Image The metric image.
  • HDF5: /Metric Image
 N/A
Min The minimum stray light value within the subset.
  • JSON: min
  • CSV: Min
  • HDF5: /Min
  • XML: min
 number
Min (Non-Zero) The minimum (of the non-zero values in the original image) stray light value within the subset.
  • JSON: min_non_zero
  • CSV: Min (Non-Zero)
  • HDF5: /Min (Non-Zero)
  • XML: min_non_zero
 number
Max The maximum stray light value within the subset.
  • JSON: max
  • CSV: Max
  • HDF5: /Max
  • XML: max
 number
Mean The mean stray light value within the subset.
  • JSON: mean
  • CSV: Mean
  • HDF5: /Mean
  • XML: mean
 number
Median The median stray light value within the subset.
  • JSON: median
  • CSV: Median
  • HDF5: /Median
  • XML: median
 number
Standard Deviation The standard deviation of the stray light values within the subset.
  • JSON: standard_deviation
  • CSV: Standard Deviation
  • HDF5: /Standard Deviation
  • XML: standard_deviation
 number
RMS The root mean square of the stray light values within the subset.
  • JSON: rms
  • CSV: RMS
  • HDF5: /RMS
  • XML: rms
 number
Total Count The count of all of the pixels within the subset.
  • JSON: total_count
  • CSV: Total Count
  • HDF5: /Total Count
  • XML: total_count
 integer
Source Count The count of the source-masked pixels within the subset.
  • JSON: source_count
  • CSV: Source Count
  • HDF5: /Source Count
  • XML: source_count
 integer
Saturation Count The count of the pixels at or above the computed saturation level.
  • JSON: saturation_count
  • CSV: Saturation Count
  • HDF5: /Saturation Count
  • XML: saturation_count
 integer
Percentiles The percentiles of the stray light values within the subset.
  • JSON: percentiles
  • CSV: [Percentiles]
  • HDF5: /Percentiles
  • XML: percentiles
 object
Level Counts The number of pixels of stray light worse than the user-provided thresholds within the subset.
  • JSON: level_counts
  • CSV: [Level Counts]
  • HDF5: /Level Counts
  • XML: level_counts
 object

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-per-capture-subset

Notes

  • A subset is a combination of an analysis channel and a region of interest.

Used In

Summary Results

Description

The stray light summary results for a subset.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Channel The name of the channel.
  • JSON: channel
  • CSV: Channel
  • HDF5: /Channel
  • XML: channel
 string
ROI The name of the region of interest (ROI).
  • Constant: All
  • JSON: roi
  • CSV: ROI
  • HDF5: /ROI
  • XML: roi
 string
Data Transform The transform applied to the data.
  • JSON: data_transform
  • CSV: Data Transform
  • HDF5: /Data Transform
  • XML: data_transform
 string
Per Capture The arrays of per-capture stray light summary metrics.
  • JSON: per_capture
  • CSV: [Per Capture]
  • HDF5: /Per Capture
  • XML: per_capture
 object
Overall The overall summary metrics across all captures within the subset.
  • JSON: overall
  • CSV: [Overall]
  • HDF5: /Overall
  • XML: overall
 object

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-summary

Notes

  • A subset is a combination of an analysis channel and a region of interest.

Used In

Stray Light Per-Capture Summary Results (Vectorized)

Description

The array of per-capture summary metrics within the subset.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Capture Index The one-based index of the capture.
  • JSON: capture_index
  • CSV: Capture Index
  • HDF5: /Capture Index
  • XML: capture_index
 array of integer
Source Field Angle The field angle of the source in degrees.
  • JSON: source_field_angle_deg
  • CSV: Source Field Angle [deg]
  • HDF5: /Source Field Angle
  • XML: source_field_angle
 array of number or null
Source Azimuth Angle The azimuth angle of the source in degrees.
  • JSON: source_azimuth_angle_deg
  • CSV: Source Azimuth Angle [deg]
  • HDF5: /Source Azimuth Angle
  • XML: source_azimuth_angle
 array of number or null
Minimum The array of per-capture minimum stray light value within the subset.
  • JSON: minimum
  • CSV: Minimum
  • HDF5: /Minimum
  • XML: minimum
 array of number
Minimum Non-Zero The array of per-capture minimum (of the non-zero values in the original image) stray light value within the subset.
  • JSON: minimum_non_zero
  • CSV: Minimum Non-Zero
  • HDF5: /Minimum Non-Zero
  • XML: minimum_non_zero
 array of number
Maximum The array of per-capture maximum stray light value within the subset.
  • JSON: maximum
  • CSV: Maximum
  • HDF5: /Maximum
  • XML: maximum
 array of number
Mean The array of per-capture mean stray light value within the subset.
  • JSON: mean
  • CSV: Mean
  • HDF5: /Mean
  • XML: mean
 array of number
Median The array of per-capture median stray light value within the subset.
  • JSON: median
  • CSV: Median
  • HDF5: /Median
  • XML: median
 array of number
RMS The array of per-capture root mean square of the stray light values within the subset.
  • JSON: rms
  • CSV: RMS
  • HDF5: /RMS
  • XML: rms
 array of number
Standard Deviation The array of per-capture standard deviation of the stray light values within the subset.
  • JSON: standard_deviation
  • CSV: Standard Deviation
  • HDF5: /Standard Deviation
  • XML: standard_deviation
 array of number
Total Count The array of per-capture count of all of the pixels within the subset.
  • JSON: total_count
  • CSV: Total Count
  • HDF5: /Total Count
  • XML: total_count
 array of integer
Source Count The array of per-capture count of the source-masked pixels within the subset.
  • JSON: source_count
  • CSV: Source Count
  • HDF5: /Source Count
  • XML: source_count
 array of integer
Saturation Count The array of the per-capture count of the pixels at or above the computed saturation level.
  • JSON: saturation_count
  • CSV: Saturation Count
  • HDF5: /Saturation Count
  • XML: saturation_count
 array of integer

Variable Key Result Field(s)

  • The results in this section have a variable key.
Title Description Validation Included In: Pattern JSON Type Note(s)
Percentiles The array of per-capture percentile stray light value within the subset. The ranks are encoded within the property name, e.g., 99p9 corresponds to the 99.9th percentile.
  • JSON: percentile_1?[0-9]{1,2}(?:p[0-9]+)?
  • CSV: Percentile ###
  • HDF5: /Percentile ###
  • XML: percentile
 array of number
  • Conditional
Level Count Values The array of per-capture number of pixels of stray light worse than the user-provided threshold within the subset. The thresholds are encoded within the property name, e.g., 0p0001 corresponds to 0.0001.
  • JSON: level_count_at_[0-9]+(?:p[0-9]+)?
  • CSV: Level Count at ###
  • HDF5: /Level Count At ###
  • XML: level_count
 array of integer
  • Conditional

JSON Schema

https://www.imatest.com/schema/25-1/straylight-results-summary-per-capture

Notes

  • A subset is a combination of a channel and region of interest.

Used In

Stray Light Root

Description

The root level of an Imatest stray light result.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Inputs The inputs for a stray light run.
  • JSON: inputs
  • CSV: [Inputs]
  • HDF5: /Inputs
  • XML: inputs
 object
Results The results from a stray light run.
  • JSON: results
  • CSV: [Results]
  • HDF5: /Results
  • XML: results
 object

JSON Schema

https://www.imatest.com/schema/25-1/straylight-root

Used In

Stray Light Settings

Description

The user-provided settings for a stray light analysis run.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Memory Mode The user-provided memory mode for the analysis run.
  • Enumeration Members:
    • High Memory
    • Low Memory
  • JSON: memory_mode
  • CSV: Memory Mode
  • HDF5: /Memory Mode
  • XML: memory_mode
 string
Calculation The user-provided calculation settings.
  • JSON: calculation
  • CSV: [Calculation]
  • HDF5: /Calculation
  • XML: calculation
 object
Batch Outputs The user-provided batch output settings.
  • JSON: batch_outputs
  • CSV: [Batch Outputs]
  • HDF5: /Batch Outputs
  • XML: batch_outputs
 object

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings

Used In

Stray Light Batch Outputs Settings

Description

The user-provided settings for saving batch outputs.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Image Outputs The user-provided settings for what images to produce.
  • JSON: image_outputs
  • CSV: [Image Outputs]
  • HDF5: /Image Outputs
  • XML: image_outputs
 object
Plot Save Settings The user-provided settings for what plots to produce.
  • JSON: plot_save_settings
  • CSV: [Plot Save Settings]
  • HDF5: /Plot Save Settings
  • XML: plot_save_settings
 object
Video The user-provided settings for what videos to produce.
  • JSON: video
  • CSV: [Video]
  • HDF5: /Video
  • XML: video
 object
Result Files The user-provided settings for saving summary result file(s).
  • JSON: result_files
  • CSV: [Result Files]
  • HDF5: /Result Files
  • XML: result_files
 object
Save Location The user-provided settings for where the result file(s) are saved.
  • JSON: save_location
  • CSV: [Save Location]
  • HDF5: /Save Location
  • XML: save_location
 object

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-batch-outputs

Used In

Stray Light Calculation Settings

Description

The user-provided stray light calculation settings.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Core Calculation The user-provided core calculation settings.
  • JSON: core_calculation
  • CSV: [Core Calculation]
  • HDF5: /Core Calculation
  • XML: core_calculation
 object
Saturation The user-provided saturation calculation settings.
  • JSON: saturation
  • CSV: [Saturation]
  • HDF5: /Saturation
  • XML: saturation
 object
Channel The user-provided channel selection settings.
  • JSON: channel
  • CSV: [Channel]
  • HDF5: /Channel
  • XML: channel
 object
Normalization The user-provided normalization settings.
  • JSON: normalization
  • CSV: [Normalization]
  • HDF5: /Normalization
  • XML: normalization
 object
Analysis Mask The user-provided analysis image mask settings.
  • JSON: analysis_mask
  • CSV: [Analysis Mask]
  • HDF5: /Analysis Mask
  • XML: analysis_mask
 object
Crop The user-provided crop settings.
  • JSON: crop
  • CSV: [Crop]
  • HDF5: /Crop
  • XML: crop
 object
Capture Metadata The user-provided metadata settings.
  • JSON: capture_metadata
  • CSV: [Capture Metadata]
  • HDF5: /Capture Metadata
  • XML: capture_metadata
 object
Other The user-provided other calculation settings.
  • JSON: other
  • CSV: [Other]
  • HDF5: /Other
  • XML: other
 object

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-calculation

Used In

Stray Light Capture Metadata

Description

User-provided settings for providing metadata to the analysis.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Filename Regular Expression Method The user-provided method for extracting metadata from a filename.
  • Enumeration Members:
    • None
    • Regular Expression
  • JSON: filename_regular_expression_method
  • CSV: Filename Regular Expression Method
  • HDF5: /Filename Regular Expression Method
  • XML: filename_regular_expression_method
 string
Filename Regular Expression The user-provided regular expression to apply to a filename and extract metadata.
  • JSON: filename_regular_expression
  • CSV: Filename Regular Expression
  • HDF5: /Filename Regular Expression
  • XML: filename_regular_expression
 string
  • Conditional
Decimal Point The user-provided decimal point character.
  • JSON: decimal_point
  • CSV: Decimal Point
  • HDF5: /Decimal Point
  • XML: decimal_point
 string
  • Conditional

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-capture-metadata

Used In

Core Calculation

Description

The user-provided core calculation settings.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Calculation The user-provided type of calculation.
  • Enumeration Members:
    • Transmission
    • Attenuation
  • JSON: calculation
  • CSV: Calculation
  • HDF5: /Calculation
  • XML: calculation
 string
Data Transform The user-provided transform of the data.
  • JSON: data_transform
  • CSV: Data Transform
  • HDF5: /Data Transform
  • XML: data_transform
 string
Dark Level The user-provided dark level in digital numbers.
  • JSON: dark_level_DN
  • CSV: Dark Level [DN]
  • HDF5: /Dark Level
  • XML: dark_level
 number
Clip To One The user-provided setting to clip dark-level-subtracted images to one (instead of zero).
  • JSON: clip_to_one
  • CSV: Clip To One
  • HDF5: /Clip To One
  • XML: clip_to_one
 boolean

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-core

Used In

Stray Light Image Outputs Settings

Description

The user-provided settings for saving image (FITS) file(s).

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Save Mask The user-provided option to save mask files.
  • JSON: save_mask
  • CSV: Save Mask
  • HDF5: /Save Mask
  • XML: save_mask
 boolean
Save Metric Image The user-provided option to save metric image files.
  • JSON: save_metric_image
  • CSV: Save Metric Image
  • HDF5: /Save Metric Image
  • XML: save_metric_image
 boolean

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-image-outputs

Used In

Mask Settings

Description

The user-provided source masking settings for the test image(s).

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Type The user-provided masking method.
  • Enumeration Members:
    • None
    • Image Processing
    • Image Processing + Circle
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Image Processing The user-provided image processing settings.
  • JSON: image_processing
  • CSV: [Image Processing]
  • HDF5: /Image Processing
  • XML: image_processing
 object
  • Conditional
Radius The user-provided radius settings.
  • JSON: radius
  • CSV: [Radius]
  • HDF5: /Radius
  • XML: radius
 object
  • Conditional

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-mask

Used In

Mask Settings: Image Processing

Description

The user-provided source masking settings for the image processing method.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Level Threshold Type The user-provided level threshold type.
  • Enumeration Members:
    • Value
    • Percentage of Max
    • Otsu’s Method
  • JSON: level_threshold_type
  • CSV: Level Threshold Type
  • HDF5: /Level Threshold Type
  • XML: level_threshold_type
 string
Level Threshold (Value) The user-provided level threshold in digital numbers.
  • JSON: level_threshold_value_DN
  • CSV: Level Threshold (Value) [DN]
  • HDF5: /Level Threshold (Value)
  • XML: level_threshold_value
 number
  • Conditional
Level Threshold (Percent) The user-provided level threshold as a percent of the maximum value.
  • JSON: level_threshold_percent
  • CSV: Level Threshold (Percent)
  • HDF5: /Level Threshold (Percent)
  • XML: level_threshold_percent
 number
  • Conditional
Minimum Source Level The user-provided minimum level considered to be the image of the source.
  • JSON: minimum_source_level_DN
  • CSV: Minimum Source Level [DN]
  • HDF5: /Minimum Source Level
  • XML: minimum_source_level
 integer
Image Close Radius The user-provided image closing radius in pixels.
  • JSON: image_close_radius_px
  • CSV: Image Close Radius [px]
  • HDF5: /Image Close Radius
  • XML: image_close_radius
 integer
Multiple CC Strategy The user-provided strategy for dealing with multiple connected components.
  • Enumeration Members:
    • Don’t Mask
    • Pick Biggest
    • Pick Smallest
  • JSON: multiple_cc_strategy
  • CSV: Multiple CC Strategy
  • HDF5: /Multiple CC Strategy
  • XML: multiple_cc_strategy
 string
Mask Area Threshold The user-provided minimum area of a connected component.
  • JSON: mask_area_threshold_px
  • CSV: Mask Area Threshold [px]
  • HDF5: /Mask Area Threshold
  • XML: mask_area_threshold
 number

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-mask-image-processing

Used In

Mask Settings: Radius

Description

The user-provided radius source masking settings.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Method The user-provided method for providing a radius.
  • Enumeration Members:
    • User-Specified
    • Focal Length Ratio
  • JSON: method
  • CSV: Method
  • HDF5: /Method
  • XML: method
 string
Radius The user-provided radius of the light source in pixels.
  • JSON: radius_px
  • CSV: Radius [px]
  • HDF5: /Radius
  • XML: radius
 number
  • Conditional
Source Diameter The user-provided diameter of the light source in mm.
  • JSON: source_diameter_mm
  • CSV: Source Diameter [mm]
  • HDF5: /Source Diameter
  • XML: source_diameter
 number
  • Conditional
Source Focal Length The user-provided focal length of the source in mm.
  • JSON: source_focal_length_mm
  • CSV: Source Focal Length [mm]
  • HDF5: /Source Focal Length
  • XML: source_focal_length
 number
  • Conditional
Camera Focal Length The user-provided focal length of the camera in mm.
  • JSON: camera_focal_length_mm
  • CSV: Camera Focal Length [mm]
  • HDF5: /Camera Focal Length
  • XML: camera_focal_length
 number
  • Conditional
Camera Pixel Pitch The user-provided pixel pitch of the camera in micrometers.
  • JSON: camera_pixel_pitch_mum
  • CSV: Camera Pixel Pitch [μm]
  • HDF5: /Camera Pixel Pitch
  • XML: camera_pixel_pitch
 number
  • Conditional

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-mask-radius

Used In

Normalization Settings

Description

The user-provided settings for computing the normalization factor.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Type The user-provided normalization method.
  • Enumeration Members:
    • None
    • Level
    • Direct Reference Image
    • Lambertian Reference Image
  • JSON: type
  • CSV: Type
  • HDF5: /Type
  • XML: type
 string
Level The user-provided level normalization settings.
  • JSON: level
  • CSV: [Level]
  • HDF5: /Level
  • XML: level
 object
  • Conditional
Direct Reference Image The user-provided direct reference image normalization settings.
  • JSON: direct_reference_image
  • CSV: [Direct Reference Image]
  • HDF5: /Direct Reference Image
  • XML: direct_reference_image
 object
  • Conditional
Lambertian Reference Image The user-provided Lambertian reference image normalization settings.
  • JSON: lambertian_reference_image
  • CSV: [Lambertian Reference Image]
  • HDF5: /Lambertian Reference Image
  • XML: lambertian_reference_image
 object
  • Conditional
Reference Mask The user-provided reference image masking settings.
  • JSON: reference_mask
  • CSV: [Reference Mask]
  • HDF5: /Reference Mask
  • XML: reference_mask
 object
  • Conditional

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-normalization

Used In

Direct Reference Image Settings

Description

The user-provided settings for computing the normalization factor from a reference image of the direct source.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Reference Image The user-provided image file used for an on-axis normalization.
  • JSON: reference_image
  • CSV: Reference Image Filename, Reference Image MD5
  • HDF5: /Reference Image
  • XML: reference_image
 object
  • CSV files have the file and MD5 has split across separate lines.
Aggregation The user-provided aggregation method used to compute the normalization factor.
  • Enumeration Members:
    • Mean
    • Median
    • Total
  • JSON: aggregation
  • CSV: Aggregation
  • HDF5: /Aggregation
  • XML: aggregation
 string
Camera Normalization Compensation The user-provided camera normalization compensation settings.
  • JSON: camera_normalization_compensation
  • CSV: [Camera Normalization Compensation]
  • HDF5: /Camera Normalization Compensation
  • XML: camera_normalization_compensation
 object
Source Normalization Compensation The user-provided light source normalization compensation settings.
  • JSON: source_normalization_compensation
  • CSV: [Source Normalization Compensation]
  • HDF5: /Source Normalization Compensation
  • XML: source_normalization_compensation
 object

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-normalization-direct-reference-image

Used In

Lambertian Light Level Measurement

Description

The user-provided measurement of light levels for Lambertian image normalization.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Light Measurement Type The user-provided type of light measurement.
  • Enumeration Members:
    • Radiometric
    • Photometric
  • JSON: light_measurement_type
  • CSV: Light Measurement Type
  • HDF5: /Light Measurement Type
  • XML: light_measurement_type
 string
Luminance From Lambertian Diffuser The luminance [cd/m²] from the Lambertian diffuser in the reference image.
  • JSON: luminance_from_lambertian_diffuser_cd_per_m2
  • CSV: Luminance From Lambertian Diffuser [cd/m²]
  • HDF5: /Luminance From Lambertian Diffuser
  • XML: luminance_from_lambertian_diffuser
 number
  • Conditional
Illuminance At The Camera Location The illuminance [lux] at the location of the camera for the test image(s).
  • JSON: illuminance_at_the_camera_location_lux
  • CSV: Illuminance At The Camera Location [lux]
  • HDF5: /Illuminance At The Camera Location
  • XML: illuminance_at_the_camera_location
 number
  • Conditional
Radiance From Lambertian Diffuser The measured radiance [W/m²/sr] from the Lambertian diffuser in the reference image.
  • JSON: radiance_from_lambertian_diffuser_W_per_m2_per_sr
  • CSV: Radiance From Lambertian Diffuser [W/m²/sr]
  • HDF5: /Radiance From Lambertian Diffuser
  • XML: radiance_from_lambertian_diffuser
 number
  • Conditional
Irradiance At The Camera Location The measured irradiance [W/m²] at the location of the camera for the test image(s).
  • JSON: irradiance_at_the_camera_location_W_per_m2
  • CSV: Irradiance At The Camera Location [W/m²]
  • HDF5: /Irradiance At The Camera Location
  • XML: irradiance_at_the_camera_location
 number
  • Conditional

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-normalization-lambertian-light-measurement

Used In

Lambertian Reference Image Settings

Description

The user-provided settings for computing the normalization factor from a reference image of a Lambertian source.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Reference Image The user-provided reference image.
  • JSON: reference_image
  • CSV: Reference Image Filename, Reference Image MD5
  • HDF5: /Reference Image
  • XML: reference_image
 object
  • CSV files have the file and MD5 has split across separate lines.
Aggregation The user-provided aggregation method used to compute the normalization factor.
  • Enumeration Members:
    • Mean
    • Median
    • Total
  • JSON: aggregation
  • CSV: Aggregation
  • HDF5: /Aggregation
  • XML: aggregation
 string
Light Source Measurements The user-provided measurements used for normalizing data with a Lambertian source.
  • JSON: light_source_measurements
  • CSV: [Light Source Measurements]
  • HDF5: /Light Source Measurements
  • XML: light_source_measurements
 object
Camera Normalization Compensation The user-provided information about any camera-side compensation necessary for the reference capture.
  • JSON: camera_normalization_compensation
  • CSV: [Camera Normalization Compensation]
  • HDF5: /Camera Normalization Compensation
  • XML: camera_normalization_compensation
 object

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-normalization-lambertian-reference-image

Used In

Stray Light Level-Based Normalization Settings

Description

The user-provided settings for computing the level normalization factor.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Value The user-provided normalization factor in digital number.
  • JSON: value_DN
  • CSV: Value [DN]
  • HDF5: /Value
  • XML: value
 number

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-normalization-level

Used In

Stray Light Reference Image Camera Compensation

Description

The user-provided camera-side compensation measurements.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Integration Time Ratio The user-provided ratio of integration time of the reference capture to the analysis capture(s).
  • JSON: integration_time_ratio
  • CSV: Integration Time Ratio
  • HDF5: /Integration Time Ratio
  • XML: integration_time_ratio
 number
Gain Ratio The user-provided ratio of camera gain of the reference capture to the analysis capture(s).
  • JSON: gain_ratio
  • CSV: Gain Ratio
  • HDF5: /Gain Ratio
  • XML: gain_ratio
 number

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-normcomp-camera

Used In

Stray Light Reference Image Source Compensation

Description

The user-provided settings for the source-side compensation for a direct image of the source.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Light Level Ratio The user-provided ratio of source light level of the reference capture to the analysis capture(s).
  • JSON: light_level_ratio
  • CSV: Light Level Ratio
  • HDF5: /Light Level Ratio
  • XML: light_level_ratio
 number
Neutral Density The user-provided settings describing the ND filter used for the reference image.
  • JSON: neutral_density
  • CSV: [Neutral Density]
  • HDF5: /Neutral Density
  • XML: neutral_density
 object

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-normcomp-direct-source

Used In

Stray Light Other Calculation Settings

Description

The user-provided other calculation settings.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Percentile Ranks The user-provided percentile ranks.
  • JSON: percentile_ranks
  • CSV: Percentile Ranks
  • HDF5: /Percentile Ranks
  • XML: percentile_ranks
 array of number
Count Type The user-provided method for reporting count-based metrics.
  • Enumeration Members:
    • Number of Pixels
    • Percent of Pixels
  • JSON: count_type
  • CSV: Count Type
  • HDF5: /Count Type
  • XML: count_type
 string
Level Count Thresholds The user-provided thresholds to count the number of pixels with worse stray light.
  • JSON: level_count_thresholds
  • CSV: Level Count Thresholds
  • HDF5: /Level Count Thresholds
  • XML: level_count_thresholds
 array of number

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-other-calc

Used In

Stray Light Count Plot Settings

Description

The user-provided settings for count plots.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Save Or Display The user-provided settings for how to save/display the plot.
  • JSON: save_or_display
  • CSV: Save Or Display
  • HDF5: /Save Or Display
  • XML: save_or_display
 array of string
Channel Grouping The user-provided grouping of channel data on the plot.
  • Enumeration Members:
    • All Channels On The Same Plot
    • Each Channel On Separate Plots
  • JSON: channel_grouping
  • CSV: Channel Grouping
  • HDF5: /Channel Grouping
  • XML: channel_grouping
 array of string
Named Data The user-provided selection of which named data to include on the plot.
  • Enumeration Members:
    • Total Count
    • Source Count
    • Saturation Count
  • JSON: named_data
  • CSV: Named Data
  • HDF5: /Named Data
  • XML: named_data
 array of string
Include Level Counts The user-provided option to include level-count data on the plot.
  • JSON: include_level_counts
  • CSV: Include Level Counts
  • HDF5: /Include Level Counts
  • XML: include_level_counts
 boolean
Per Plot Scaling The user-provided option for how each plot is scaled relative to the others.
  • Enumeration Members:
    • Global
    • Per Subset
    • Per Image
  • JSON: per_plot_scaling
  • CSV: Per Plot Scaling
  • HDF5: /Per Plot Scaling
  • XML: per_plot_scaling
 string
Y-Axis Scale The user-provided option for how to scale the y-axis.
  • Enumeration Members:
    • Linear
    • Log
  • JSON: y_axis_scale
  • CSV: Y-Axis Scale
  • HDF5: /Y-Axis Scale
  • XML: y_axis_scale
 string

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-plot-count

Used In

Stray Light Level Plot Settings

Description

The user-provided settings for level plots.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Save Or Display The user-provided settings for how to save/display the plot.
  • JSON: save_or_display
  • CSV: Save Or Display
  • HDF5: /Save Or Display
  • XML: save_or_display
 array of string
Channel Grouping The user-provided grouping of channel data on the plot.
  • Enumeration Members:
    • All Channels On The Same Plot
    • Each Channel On Separate Plots
  • JSON: channel_grouping
  • CSV: Channel Grouping
  • HDF5: /Channel Grouping
  • XML: channel_grouping
 array of string
Named Data The user-provided selection of which named data to include on the plot.
  • Enumeration Members:
    • Minimum
    • Minimum (Non-0)
    • Maximum
    • Mean
    • Median
    • RMS
    • Standard Deviation
  • JSON: named_data
  • CSV: Named Data
  • HDF5: /Named Data
  • XML: named_data
 array of string
Include Percentiles The user-provided option to include percentile data on the plot.
  • JSON: include_percentiles
  • CSV: Include Percentiles
  • HDF5: /Include Percentiles
  • XML: include_percentiles
 boolean
Per Plot Scaling The user-provided option for how each plot is scaled relative to the others.
  • Enumeration Members:
    • Global
    • Per Subset
    • Per Image
  • JSON: per_plot_scaling
  • CSV: Per Plot Scaling
  • HDF5: /Per Plot Scaling
  • XML: per_plot_scaling
 string
Y-Axis Scale The user-provided option for how to scale the y-axis.
  • Enumeration Members:
    • Linear
    • Log
  • JSON: y_axis_scale
  • CSV: Y-Axis Scale
  • HDF5: /Y-Axis Scale
  • XML: y_axis_scale
 string

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-plot-level

Used In

Stray Light Plotting Settings

Description

User-provided plot settings for the Stray Light module.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Plot Type The user-provided settings for the file format(s) to save plots as.
  • JSON: plot_type
  • CSV: Plot Type
  • HDF5: /Plot Type
  • XML: plot_type
 array of string
Level Plot The user-provided Level plot settings.
  • JSON: level_plot
  • CSV: [Level Plot]
  • HDF5: /Level Plot
  • XML: level_plot
 object
Count Plot The user-provided Count plot settings.
  • JSON: count_plot
  • CSV: [Count Plot]
  • HDF5: /Count Plot
  • XML: count_plot
 object

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-save-plots

Used In

Histogram Video Stats

Description

The user-provided settings for saving histograms.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Video Types The user-provided format(s) for saving a video.
  • JSON: video_types
  • CSV: Video Types
  • HDF5: /Video Types
  • XML: video_types
 array of string
Image Types The user-provided format(s) for saving each frame of the video.
  • JSON: image_types
  • CSV: Image Types
  • HDF5: /Image Types
  • XML: image_types
 array of string
Frame Rate The user-provided frame rate in frames per second.
  • JSON: frame_rate_fps
  • CSV: Frame Rate [fps]
  • HDF5: /Frame Rate
  • XML: frame_rate
 number
  • Conditional
Y Max Type The user-provided method for determining the maximum y value.
  • Enumeration Members:
    • Automatic
    • User-defined
  • JSON: y_max_type
  • CSV: Y Max Type
  • HDF5: /Y Max Type
  • XML: y_max_type
 string
Y Max Value The user-provided maximum y value.
  • JSON: y_max_value_px
  • CSV: Y Max Value [px]
  • HDF5: /Y Max Value
  • XML: y_max_value
 number
  • Conditional

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-video-histogram

Used In

Colormapped Metric Image

Description

The user-provided settings for saving colormapped metric images.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Video Types The user-provided format(s) for saving a video.
  • JSON: video_types
  • CSV: Video Types
  • HDF5: /Video Types
  • XML: video_types
 array of string
Image Types The user-provided format(s) for saving each frame of the video.
  • JSON: image_types
  • CSV: Image Types
  • HDF5: /Image Types
  • XML: image_types
 array of string
Frame Rate The user-provided frame rate in frames per second.
  • JSON: frame_rate_fps
  • CSV: Frame Rate [fps]
  • HDF5: /Frame Rate
  • XML: frame_rate
 number
  • Conditional
Data Transform The user-provided data transform.
  • JSON: data_transform
  • CSV: Data Transform
  • HDF5: /Data Transform
  • XML: data_transform
 string

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-video-metric-image

Used In

Stray Light Video Settings

Description

The user-provided settings saving video (or series of image) files.

Result Field(s)

Title Description Validation Included In: Key JSON Type Note(s)
Metric Image The user-provided settings for saving color-mapped metric images.
  • JSON: metric_image
  • CSV: [Metric Image]
  • HDF5: /Metric Image
  • XML: metric_image
 object
Histogram The user-provided settings for saving histogram videos.
  • JSON: histogram
  • CSV: [Histogram]
  • HDF5: /Histogram
  • XML: histogram
 object

JSON Schema

https://www.imatest.com/schema/25-1/straylight-settings-videos

Used In