Imatest Root

Description

The root level of an Imatest result.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-root.schema",
  "title": "Imatest Root",
  "description": "The root level of an Imatest result.",
  "type": "object",
  "properties": {
    "imatest_result": {
      "description": "The results from an Imatest analysis.",
      "$ref": "imatest-common-base.schema"
    }
  },
  "required": [
    "imatest_result"
  ],
  "unevaluatedProperties": false
}

Imatest Results Base

Description

The result(s) of an imatest run.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-base.schema",
  "title": "Imatest Results Base",
  "description": "The result(s) of an imatest run.",
  "type": "object",
  "properties": {
    "imatest": {
      "description": "Information about the Imatest run.",
      "$ref": "imatest-common-header.schema"
    },
    "concentric_rings_fov": {
      "description": "Inputs and results from a concentric rings fov analysis run.",
      "$ref": "imatest-results-rings-root.schema"
    },
    "stray_light": {
      "description": "Inputs and results from a stray light analysis run.",
      "$ref": "imatest-straylight-root.schema"
    },
    "note": {
      "description": "(TRIAL ONLY) Information that results are not saveable in a trial.",
      "type": "string",
      "const": "Cannot save full results in a trial."
    }
  },
  "required": [
    "imatest"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Name The name of the channel.  
  • JSON
  • CSV
  • HDF5
name string Name /Name  
Type The type of the channel.
  • Enumeration Members:
    • Monochrome
    • Index
    • Weighted
    • Mean
    • Median
    • Luminance
  • JSON
  • CSV
  • HDF5
type string Type /Type  

Instances

This result a placeholder for one of the following instances.

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-channel-extractor.schema",
  "title": "Channel Extraction Information",
  "description": "The information for selecting an analysis channel.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "type": {
      "description": "The type of the channel.",
      "type": "string",
      "enum": [
        "Monochrome",
        "Index",
        "Weighted",
        "Mean",
        "Median",
        "Luminance"
      ]
    }
  },
  "required": [
    "name",
    "type"
  ],
  "anyOf": [
    {
      "$ref": "imatest-common-channel-extractor-index.schema"
    },
    {
      "$ref": "imatest-common-channel-extractor-mean.schema"
    },
    {
      "$ref": "imatest-common-channel-extractor-median.schema"
    },
    {
      "$ref": "imatest-common-channel-extractor-monochrome.schema"
    },
    {
      "$ref": "imatest-common-channel-extractor-weights.schema"
    },
    {
      "$ref": "imatest-common-channel-extractor-luminance.schema"
    }
  ],
  "$comment": "Other methods will be available in future versions of Imatest."
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Name The name of the channel.  
  • JSON
  • CSV
  • HDF5
name string Name /Name  
Type The type of the channel.
  • Constant: Index
  • JSON
  • CSV
  • HDF5
type string Type /Type  
Index The one-based index of the analysis channel.  
  • JSON
  • CSV
  • HDF5
index integer Index /Index  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-channel-extractor-index.schema",
  "title": "Channel Extraction Information: Index",
  "description": "The information for selecting an analysis channel from an index.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "type": {
      "description": "The type of the channel.",
      "type": "string",
      "const": "Index"
    },
    "index": {
      "description": "The one-based index of the analysis channel.",
      "type": "integer"
    }
  },
  "required": [
    "name",
    "type",
    "index"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Name The name of the channel.  
  • JSON
  • CSV
  • HDF5
name string Name /Name  
Type The type of the channel.
  • Constant: Luminance
  • JSON
  • CSV
  • HDF5
type string Type /Type  
Luminance Type The method/standard for computing a luminance channel.
  • JSON
  • CSV
  • HDF5
luminance_type string Luminance Type /Luminance Type  

Instances

This result a placeholder for one of the following instances.

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-channel-extractor-luminance.schema",
  "title": "Channel Extraction Information: Luminance",
  "description": "The information for selecting a luminance analysis channel.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "type": {
      "description": "The type of the channel.",
      "type": "string",
      "const": "Luminance"
    },
    "luminance_type": {
      "description": "The method/standard for computing a luminance channel.",
      "$ref": "imatest-common-settings-channel-luminance-type-enum.schema"
    }
  },
  "required": [
    "name",
    "type",
    "luminance_type"
  ],
  "anyOf": [
    {
      "$ref": "imatest-common-channel-extractor-luminance-iec-61966-2-1.schema"
    },
    {
      "$ref": "imatest-common-channel-extractor-luminance-itu-r-bt-601-7.schema"
    },
    {
      "$ref": "imatest-common-channel-extractor-luminance-itu-r-bt-709-1.schema"
    },
    {
      "$ref": "imatest-common-channel-extractor-luminance-itu-r-bt-709-6.schema"
    },
    {
      "$ref": "imatest-common-channel-extractor-luminance-itu-r-bt-2020-2.schema"
    },
    {
      "$ref": "imatest-common-channel-extractor-luminance-matlab.schema"
    },
    {
      "$ref": "imatest-common-channel-extractor-luminance-ntsc-rounded.schema"
    }
  ],
  "$comment": "Other luminance types may be available in future versions of Imatest."
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Name The name of the channel.  
  • JSON
  • CSV
  • HDF5
name string Name /Name  
Type The type of the channel.
  • Constant: Luminance
  • JSON
  • CSV
  • HDF5
type string Type /Type  
Luminance Type The method/standard for computing a luminance channel.
  • JSON
  • CSV
  • HDF5
luminance_type string Luminance Type /Luminance Type  
RGB Weights The weights applied to red, green, and blue channels.
  • Constant: [0.2126, 0.7152, 0.0722]
  • JSON
  • CSV
  • HDF5
rgb_weights array of number RGB Weights /RGB Weights  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-channel-extractor-luminance-iec-61966-2-1.schema",
  "title": "Luminance Channel Extraction Information: IEC 61966-2-1",
  "description": "The information for selecting an IEC 61966-2-1 luminance analysis channel.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "type": {
      "description": "The type of the channel.",
      "type": "string",
      "const": "Luminance"
    },
    "luminance_type": {
      "description": "The method/standard for computing a luminance channel.",
      "type": "string",
      "const": "IEC 61966-2-1"
    },
    "rgb_weights": {
      "description": "The weights applied to red, green, and blue channels.",
      "type": "array",
      "const": [
        0.2126,
        0.7152,
        0.0722
      ],
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "name",
    "type",
    "luminance_type",
    "rgb_weights"
  ],
  "unevaluatedProperties": false,
  "$comment": "This uses the same weights as ITU-R BT.709-6."
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Name The name of the channel.  
  • JSON
  • CSV
  • HDF5
name string Name /Name  
Type The type of the channel.
  • Constant: Luminance
  • JSON
  • CSV
  • HDF5
type string Type /Type  
Luminance Type The method/standard for computing a luminance channel.
  • JSON
  • CSV
  • HDF5
luminance_type string Luminance Type /Luminance Type  
RGB Weights The weights applied to red, green, and blue channels.
  • Constant: [0.2627, 0.678, 0.0593]
  • JSON
  • CSV
  • HDF5
rgb_weights array of number RGB Weights /RGB Weights  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-channel-extractor-luminance-itu-r-bt-2020-2.schema",
  "title": "Luminance Channel Extraction Information: ITU-R BT.2020-2",
  "description": "The information for selecting an ITU-R BT.2020-2 luminance analysis channel.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "type": {
      "description": "The type of the channel.",
      "type": "string",
      "const": "Luminance"
    },
    "luminance_type": {
      "description": "The method/standard for computing a luminance channel.",
      "type": "string",
      "const": "ITU-R BT.2020-2"
    },
    "rgb_weights": {
      "description": "The weights applied to red, green, and blue channels.",
      "type": "array",
      "const": [
        0.2627,
        0.678,
        0.0593
      ],
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "name",
    "type",
    "luminance_type",
    "rgb_weights"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Name The name of the channel.  
  • JSON
  • CSV
  • HDF5
name string Name /Name  
Type The type of the channel.
  • Constant: Luminance
  • JSON
  • CSV
  • HDF5
type string Type /Type  
Luminance Type The method/standard for computing a luminance channel.
  • JSON
  • CSV
  • HDF5
luminance_type string Luminance Type /Luminance Type  
RGB Weights The weights applied to red, green, and blue channels.
  • Constant: [0.299, 0.587, 0.114]
  • JSON
  • CSV
  • HDF5
rgb_weights array of number RGB Weights /RGB Weights  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-channel-extractor-luminance-itu-r-bt-601-7.schema",
  "title": "Luminance Channel Extraction Information: ITU-R BT.601-7",
  "description": "The information for selecting an ITU-R BT.601-7 luminance analysis channel.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "type": {
      "description": "The type of the channel.",
      "type": "string",
      "const": "Luminance"
    },
    "luminance_type": {
      "description": "The method/standard for computing a luminance channel.",
      "type": "string",
      "const": "ITU-R BT.601-7"
    },
    "rgb_weights": {
      "description": "The weights applied to red, green, and blue channels.",
      "type": "array",
      "const": [
        0.299,
        0.587,
        0.114
      ],
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "name",
    "type",
    "luminance_type",
    "rgb_weights"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Name The name of the channel.  
  • JSON
  • CSV
  • HDF5
name string Name /Name  
Type The type of the channel.
  • Constant: Luminance
  • JSON
  • CSV
  • HDF5
type string Type /Type  
Luminance Type The method/standard for computing a luminance channel.
  • JSON
  • CSV
  • HDF5
luminance_type string Luminance Type /Luminance Type  
RGB Weights The weights applied to red, green, and blue channels.
  • Constant: [0.2125, 0.7154, 0.0721]
  • JSON
  • CSV
  • HDF5
rgb_weights array of number RGB Weights /RGB Weights  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-channel-extractor-luminance-itu-r-bt-709-1.schema",
  "title": "Luminance Channel Extraction Information: ITU-R BT.709-1",
  "description": "The information for selecting an ITU-R BT.709-1 luminance analysis channel.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "type": {
      "description": "The type of the channel.",
      "type": "string",
      "const": "Luminance"
    },
    "luminance_type": {
      "description": "The method/standard for computing a luminance channel.",
      "type": "string",
      "const": "ITU-R BT.709-1"
    },
    "rgb_weights": {
      "description": "The weights applied to red, green, and blue channels.",
      "type": "array",
      "const": [
        0.2125,
        0.7154,
        0.0721
      ],
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "name",
    "type",
    "luminance_type",
    "rgb_weights"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Name The name of the channel.  
  • JSON
  • CSV
  • HDF5
name string Name /Name  
Type The type of the channel.
  • Constant: Luminance
  • JSON
  • CSV
  • HDF5
type string Type /Type  
Luminance Type The method/standard for computing a luminance channel.
  • JSON
  • CSV
  • HDF5
luminance_type string Luminance Type /Luminance Type  
RGB Weights The weights applied to red, green, and blue channels.
  • Constant: [0.2126, 0.7152, 0.0722]
  • JSON
  • CSV
  • HDF5
rgb_weights array of number RGB Weights /RGB Weights  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-channel-extractor-luminance-itu-r-bt-709-6.schema",
  "title": "Luminance Channel Extraction Information: ITU-R BT.709-6",
  "description": "The information for selecting an ITU-R BT.709-6 luminance analysis channel.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "type": {
      "description": "The type of the channel.",
      "type": "string",
      "const": "Luminance"
    },
    "luminance_type": {
      "description": "The method/standard for computing a luminance channel.",
      "type": "string",
      "const": "ITU-R BT.709-6"
    },
    "rgb_weights": {
      "description": "The weights applied to red, green, and blue channels.",
      "type": "array",
      "const": [
        0.2126,
        0.7152,
        0.0722
      ],
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "name",
    "type",
    "luminance_type",
    "rgb_weights"
  ],
  "unevaluatedProperties": false,
  "$comment": "This uses the same weights as IEC 61966-2-1."
}

Notes

Luminance Channel Extraction Information: MATLAB

Description

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

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-channel-extractor-luminance-matlab.schema",
  "title": "Luminance Channel Extraction Information: MATLAB",
  "description": "The information for selecting an MATLAB luminance analysis channel. This uses MATLAB's rgb2gray function.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "type": {
      "description": "The type of the channel.",
      "type": "string",
      "const": "Luminance"
    },
    "luminance_type": {
      "description": "The method/standard for computing a luminance channel.",
      "type": "string",
      "const": "MATLAB"
    }
  },
  "required": [
    "name",
    "type",
    "luminance_type"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Name The name of the channel.  
  • JSON
  • CSV
  • HDF5
name string Name /Name  
Type The type of the channel.
  • Constant: Luminance
  • JSON
  • CSV
  • HDF5
type string Type /Type  
Luminance Type The method/standard for computing a luminance channel.
  • JSON
  • CSV
  • HDF5
luminance_type string Luminance Type /Luminance Type  
RGB Weights The weights applied to red, green, and blue channels.
  • Constant: [0.3, 0.59, 0.11]
  • JSON
  • CSV
  • HDF5
rgb_weights array of number RGB Weights /RGB Weights  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-channel-extractor-luminance-ntsc-rounded.schema",
  "title": "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.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "type": {
      "description": "The type of the channel.",
      "type": "string",
      "const": "Luminance"
    },
    "luminance_type": {
      "description": "The method/standard for computing a luminance channel.",
      "type": "string",
      "const": "NTSC (Rounded)"
    },
    "rgb_weights": {
      "description": "The weights applied to red, green, and blue channels.",
      "type": "array",
      "const": [
        0.3,
        0.59,
        0.11
      ],
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "name",
    "type",
    "luminance_type",
    "rgb_weights"
  ],
  "unevaluatedProperties": false
}

Notes

Channel Extraction Information: Mean

Description

The information for selecting a mean analysis channel.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-channel-extractor-mean.schema",
  "title": "Channel Extraction Information: Mean",
  "description": "The information for selecting a mean analysis channel.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "type": {
      "description": "The type of the channel.",
      "type": "string",
      "const": "Mean"
    }
  },
  "required": [
    "name",
    "type"
  ],
  "unevaluatedProperties": false
}

Notes

Channel Extraction Information: Median

Description

The information for selecting a median analysis channel.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-channel-extractor-median.schema",
  "title": "Channel Extraction Information: Median",
  "description": "The information for selecting a median analysis channel.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "type": {
      "description": "The type of the channel.",
      "type": "string",
      "const": "Median"
    }
  },
  "required": [
    "name",
    "type"
  ],
  "unevaluatedProperties": false
}

Notes

Channel Extraction Information: Monochrome

Description

The information for selecting a monochrome analysis channel.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-channel-extractor-monochrome.schema",
  "title": "Channel Extraction Information: Monochrome",
  "description": "The information for selecting a monochrome analysis channel.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "type": {
      "description": "The type of the channel.",
      "type": "string",
      "const": "Monochrome"
    }
  },
  "required": [
    "name",
    "type"
  ],
  "unevaluatedProperties": false
}

Notes

Channel Extraction Information: Weighted Channels

Description

The information for selecting a median analysis channel.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-channel-extractor-weights.schema",
  "title": "Channel Extraction Information: Weighted Channels",
  "description": "The information for selecting a median analysis channel.",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "type": {
      "description": "The type of the channel.",
      "type": "string",
      "const": "Weighted"
    },
    "weights": {
      "description": "The weights to apply to each channel.",
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "name",
    "type",
    "weights"
  ],
  "unevaluatedProperties": false
}

Notes

Filename + MD5 Hash

Description

A filename and its MD5 hash.

Properties

Title Description Validation Included In JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Filename The path to a file.  
  • JSON
  • CSV
  • HDF5
filename string Filename /Filename  
MD5 If the file does not exist, then this will be an empty string.  
  • JSON
md5 string N/A N/A
  • If the file does not exist, then this will be an empty string.
  • For CSV files, the filename and MD5 hash are separate lines.
  • For HDF files, the MD5 hash is added as an attribute of the filename.

JSON Schema

{
  "$id": "imatest-common-filename-md5.schema",
  "title": "Filename + MD5 Hash",
  "description": "A filename and its MD5 hash.",
  "type": "object",
  "properties": {
    "filename": {
      "description": "The path to a file.",
      "type": "string"
    },
    "md5": {
      "description": "The MD5 hash of the file.",
      "type": "string",
      "$comment": "If the file does not exist, then this will be an empty string."
    }
  },
  "required": [
    "filename",
    "md5"
  ],
  "unevaluatedProperties": false
}

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

{
  "$id": "imatest-common-filename-md5-array.schema",
  "title": "Filename + MD5 Hash List",
  "description": "A list of multiple filenames and their MD5 hashes.",
  "type": "array",
  "items": {
    "$ref": "imatest-common-filename-md5.schema"
  }
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Imatest Version The version of Imatest that was used for the analysis.  
  • JSON
  • CSV
  • HDF5
imatest_version string Imatest Version /Imatest Version  
Build The build of Imatest that was used.  
  • JSON
  • CSV
  • HDF5
build string Build /Build  
Run Date Time The datetime of the Imatest analysis run.  
  • JSON
  • CSV
  • HDF5
run_date_time string Run Date Time /Run Date Time  
INI File The INI file that was used for the run.
  • JSON
  • CSV
  • HDF5
ini_file object INI File Filename
INI File MD5
/INI File
  • CSV files have the file and MD5 has split across separate lines.
Memory Information about the memory usage.
  • JSON
  • CSV
  • HDF5
memory object [Memory] /Memory  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-header.schema",
  "title": "Imatest Header",
  "description": "Common information about an Imatest analysis run.",
  "type": "object",
  "properties": {
    "imatest_version": {
      "description": "The version of Imatest that was used for the analysis.",
      "type": "string"
    },
    "build": {
      "description": "The build of Imatest that was used.",
      "type": "string"
    },
    "run_date_time": {
      "description": "The datetime of the Imatest analysis run.",
      "type": "string"
    },
    "ini_file": {
      "description": "The INI file that was used for the run.",
      "$ref": "imatest-common-filename-md5.schema"
    },
    "memory": {
      "description": "Information about the memory usage.",
      "$ref": "imatest-common-memory.schema"
    }
  },
  "required": [
    "imatest_version",
    "build",
    "run_date_time",
    "ini_file",
    "memory"
  ],
  "unevaluatedProperties": false
}

Used In

Memory

Description

Information about the memory usage.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-memory.schema",
  "title": "Memory",
  "description": "Information about the memory usage.",
  "type": "object",
  "properties": {
    "matlab_used_MB": {
      "description": "The memory used by MATLAB in MB.",
      "type": "number"
    },
    "physical_free_MB": {
      "description": "The free physical memory in MB.",
      "type": "number"
    },
    "physical_total_MB": {
      "description": "The total physical memory in MB.",
      "type": "number"
    }
  },
  "required": [
    "matlab_used_MB",
    "physical_free_MB",
    "physical_total_MB"
  ],
  "unevaluatedProperties": false
}

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

{
  "$id": "imatest-common-number.schema",
  "title": "Imatest Number",
  "description": "A number from an Imatest output that may contain values not defined in JSON.",
  "oneOf": [
    {
      "type": "number"
    },
    {
      "type": "null",
      "$comment": "A null in the result indicates one of the following: (1) The value was NaN (indicating an invalid measurement). (2) The value was infinite."
    }
  ]
}

Used In

Percentile

Description

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

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-results-percentiles.schema",
  "title": "Percentile",
  "description": "The percentile(s) for given rank(s).",
  "type": "object",
  "properties": {
    "ranks": {
      "description": "The ranks (0-100) where the percentile is calculated.",
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "values": {
      "description": "The percentile(s).",
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "ranks",
    "values"
  ],
  "unevaluatedProperties": false
}

Used In

Registration Mark

Description

Information about a detected registration mark.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-results-registration-mark.schema",
  "title": "Registration Mark",
  "description": "Information about a detected registration mark.",
  "type": "object",
  "properties": {
    "regmark_center_px": {
      "description": "The detected center of the registration mark.",
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "regmark_radius_px": {
      "description": "The detected radius of the registration mark.",
      "type": "number"
    }
  },
  "required": [
    "regmark_center_px",
    "regmark_radius_px"
  ],
  "unevaluatedProperties": false
}

Used In

Channel Selection Settings

Description

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

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-settings-channel.schema",
  "title": "Channel Selection Settings",
  "description": "The user-provided settings for selecting analysis channel(s).",
  "type": "object",
  "properties": {
    "type": {
      "description": "The user-provided set of channels to analyze.",
      "type": "string",
      "enum": [
        "Automatic",
        "Each Channel",
        "RGB",
        "Monochrome",
        "Statistics",
        "Luminance",
        "RGB + Luminance"
      ]
    },
    "luminance_type": {
      "description": "The user-provided method for what calculation to use.",
      "$ref": "imatest-common-settings-channel-luminance-type-enum.schema"
    },
    "custom_rgb_weights": {
      "description": "The user-provided custom luminance weights.",
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "rgb_order": {
      "description": "The user-provided ordering of RGB data.",
      "$ref": "imatest-common-settings-channel-rgb-order-enum.schema"
    },
    "statistics": {
      "description": "The user-provided statistics type.",
      "$ref": "imatest-common-settings-channel-stats-enum.schema"
    }
  },
  "required": [
    "type"
  ],
  "unevaluatedProperties": false
}

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

{
  "$id": "imatest-common-settings-channel-luminance-type-enum.schema",
  "title": "Luminance Channel Standards",
  "description": "The user-provided method for extracting a luminance channel from RGB images.",
  "type": "string",
  "enum": [
    "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"
  ]
}

Used In

RGB Order

Description

The user-provided ordering of RGB data.

Members

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

JSON Schema

{
  "$id": "imatest-common-settings-channel-rgb-order-enum.schema",
  "title": "RGB Order",
  "description": "The user-provided ordering of RGB data.",
  "type": "string",
  "enum": [
    "Red, Green, Blue",
    "Blue, Green, Red"
  ]
}

Used In

Statistics Channel Extraction

Description

The user-provided method for extracting a statistics channel.

Members

  • Mean
  • Median

JSON Schema

{
  "$id": "imatest-common-settings-channel-stats-enum.schema",
  "title": "Statistics Channel Extraction",
  "description": "The user-provided method for extracting a statistics channel.",
  "type": "string",
  "enum": [
    "Mean",
    "Median"
  ]
}

Used In

Crop LRTB Settings

Description

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

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-settings-crop-lrtb.schema",
  "title": "Crop LRTB Settings",
  "description": "The user-provided settings for a stray light analysis run.",
  "type": "object",
  "properties": {
    "lrtb_px": {
      "description": "The user-provided crop values (left, right, top, bottom) in pixels.",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "required": [
    "lrtb_px"
  ],
  "unevaluatedProperties": false
}

Used In

Plot Save Format

Description

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

Members

  • Save
  • Display

JSON Schema

{
  "$id": "imatest-common-settings-figure-save-display-enum.schema",
  "title": "Plot Save Format",
  "description": "The user-provided format(s) to save a figure as.",
  "type": "string",
  "enum": [
    "Save",
    "Display"
  ]
}

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

{
  "$id": "imatest-common-settings-figure-save-type-enum.schema",
  "title": "Plot Save Format",
  "description": "The user-provided format(s) to save a figure as.",
  "type": "string",
  "enum": [
    "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"
  ]
}

Used In

Image Series Formats

Description

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

Members

  • png
  • jpg
  • tiff

JSON Schema

{
  "$id": "imatest-common-settings-image-frame-formats-enum.schema",
  "title": "Image Series Formats",
  "description": "The user-provided format(s) for saving each frame of the video.",
  "type": "string",
  "enum": [
    "png",
    "jpg",
    "tiff"
  ]
}

Used In

Neutral Density Settings

Description

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

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-settings-neutral-density.schema",
  "title": "Neutral Density Settings",
  "description": "The user-provided measurement of a neutral-density filter.",
  "type": "object",
  "properties": {
    "type": {
      "description": "The user-provided type of neutral density filter measurement used.",
      "type": "string",
      "enum": [
        "None",
        "Density",
        "Transmission"
      ]
    },
    "transmission": {
      "description": "The user-provided transmission percentage (0-100) for the neutral density filter.",
      "type": "number"
    },
    "density": {
      "description": "The user-provided density for the neutral density filter.",
      "type": "number"
    }
  },
  "required": [
    "type"
  ],
  "unevaluatedProperties": false
}

Used In

Registration Mark Detection

Description

The user-provided settings for detecting registration marks.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-settings-registration-mark.schema",
  "title": "Registration Mark Detection",
  "description": "The user-provided settings for detecting registration marks.",
  "type": "object",
  "properties": {
    "method": {
      "description": "The user-provided method for detecting registration marks.",
      "type": "string",
      "enum": [
        "Classic Autodetect",
        "ML/CV Autodetect"
      ]
    },
    "confidence_threshold": {
      "description": "The user-provided machine vision confidence threshold.",
      "type": "number"
    },
    "high_noise": {
      "description": "The user-provided option to enable high-noise compensation.",
      "type": "boolean"
    },
    "skip_refinement": {
      "description": "The user-provided option to skip the refinement step.",
      "type": "boolean"
    }
  },
  "required": [
    "method",
    "high_noise",
    "skip_refinement"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Result Files The user-provided selection for what type(s) of results files to save.
  • JSON
  • CSV
  • HDF5
result_files array of string Result Files /Result Files  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-settings-result-files.schema",
  "title": "Summary Results Settings",
  "description": "The user-provided selection for what result file(s) to save.",
  "type": "object",
  "properties": {
    "result_files": {
      "description": "The user-provided selection for what type(s) of results files to save.",
      "type": "array",
      "items": {
        "$ref": "imatest-common-settings-results-format-enum.schema"
      }
    }
  },
  "required": [
    "result_files"
  ],
  "unevaluatedProperties": false
}

Used In

Summary Results Output Types

Description

The user-provided options for saving summary results files.

Members

  • JSON
  • CSV
  • HDF5

JSON Schema

{
  "$id": "imatest-common-settings-results-format-enum.schema",
  "title": "Summary Results Output Types",
  "description": "The user-provided options for saving summary results files.",
  "type": "string",
  "enum": [
    "JSON",
    "CSV",
    "HDF5"
  ]
}

Used In

Saturation Settings

Description

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

Result Field(s)

Title Description Validation Included In JSON Key JSON Type CSV Key HDF5 Dataset 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
  • CSV
  • HDF5
type string Type /Type  
User-Specified Value The user-provided saturation level in digital numbers.  
  • JSON
  • CSV
  • HDF5
user_specified_value_DN number User-Specified Value [DN] /User-Specified Value
  • Conditional
User-Specified Bit Depth The user-provided saturation level in bits.  
  • JSON
  • CSV
  • HDF5
user_specified_bit_depth_bits integer User-Specified Bit Depth [bits] /User-Specified Bit Depth
  • Conditional

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-settings-saturation.schema",
  "title": "Saturation Settings",
  "description": "The user-provided settings for computing the saturation in an image.",
  "type": "object",
  "properties": {
    "type": {
      "description": "The user-provided method for calculating the saturation level.",
      "type": "string",
      "enum": [
        "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"
      ]
    },
    "user_specified_value_DN": {
      "description": "The user-provided saturation level in digital numbers.",
      "type": "number"
    },
    "user_specified_bit_depth_bits": {
      "description": "The user-provided saturation level in bits.",
      "type": "integer"
    }
  },
  "required": [
    "type"
  ],
  "unevaluatedProperties": false
}

Used In

Save Location

Description

User-provided settings for where to save results.

Result Field(s)

Title Description Validation Included In JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Save In Image Subfolder User-provided setting if the result(s) should be saved in the same folder as the image.  
  • JSON
  • CSV
  • HDF5
save_in_image_subfolder boolean Save In Image Subfolder /Save In Image Subfolder  
Sub Folder The user-provided sub-folder of the image folder to save the result(s) in.  
  • JSON
  • CSV
  • HDF5
sub_folder string Sub Folder /Sub Folder
  • Conditional
Custom Save Folder The user-provided folder to save the result(s) in.  
  • JSON
  • CSV
  • HDF5
custom_save_folder string Custom Save Folder /Custom Save Folder
  • 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
  • CSV
  • HDF5
use_image_name_as_root boolean Use Image Name As Root /Use Image Name As Root  
Custom Root Name The user-provided custom root name for the result file(s).  
  • JSON
  • CSV
  • HDF5
custom_root_name string Custom Root Name /Custom Root Name
  • Conditional
Open Save Folder The user-provided option for opening the result folder at the end of an analysis run.  
  • JSON
  • CSV
  • HDF5
open_save_folder boolean Open Save Folder /Open Save Folder  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-common-settings-save-location.schema",
  "title": "Save Location",
  "description": "User-provided settings for where to save results.",
  "type": "object",
  "properties": {
    "save_in_image_subfolder": {
      "description": "User-provided setting if the result(s) should be saved in the same folder as the image.",
      "type": "boolean"
    },
    "sub_folder": {
      "description": "The user-provided sub-folder of the image folder to save the result(s) in.",
      "type": "string"
    },
    "custom_save_folder": {
      "description": "The user-provided folder to save the result(s) in.",
      "type": "string"
    },
    "use_image_name_as_root": {
      "description": "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`.",
      "type": "boolean"
    },
    "custom_root_name": {
      "description": "The user-provided custom root name for the result file(s).",
      "type": "string"
    },
    "open_save_folder": {
      "description": "The user-provided option for opening the result folder at the end of an analysis run.",
      "type": "boolean"
    }
  },
  "required": [
    "save_in_image_subfolder",
    "use_image_name_as_root",
    "open_save_folder"
  ],
  "unevaluatedProperties": false
}

Used In

Video Output Format

Description

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

Members

  • mp4
  • avi
  • gif

JSON Schema

{
  "$id": "imatest-common-settings-video-formats-enum.schema",
  "title": "Video Output Format",
  "description": "The user-provided format(s) for saving a video.",
  "type": "string",
  "enum": [
    "mp4",
    "avi",
    "gif"
  ]
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Inputs Information about the inputs to the concentric rings FOV module.
  • JSON
  • CSV
  • HDF5
inputs object [Inputs] /Inputs  
Results The results from a concentric rings FOV module analysis.
  • JSON
  • CSV
  • HDF5
results object [Results] /Results  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-results-rings-root.schema",
  "title": "Concentric Ring FOV: Root Results",
  "description": "The results from a concentric rings FOV module run.",
  "type": "object",
  "properties": {
    "inputs": {
      "description": "Information about the inputs to the concentric rings FOV module.",
      "$ref": "imatest-rings-inputs.schema"
    },
    "results": {
      "description": "The results from a concentric rings FOV module analysis.",
      "$ref": "imatest-rings-results-root.schema"
    }
  },
  "required": [
    "inputs",
    "results"
  ],
  "unevaluatedProperties": false
}

Used In

Concentric Ring FOV: Inputs

Description

Inputs to the Concentric Rings FOV module.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-rings-inputs.schema",
  "title": "Concentric Ring FOV: Inputs",
  "description": "Inputs to the Concentric Rings FOV module.",
  "type": "object",
  "properties": {
    "image_file": {
      "description": "The image file that was analyzed.",
      "$ref": "imatest-common-filename-md5.schema"
    },
    "settings": {
      "description": "The user-provided settings for the analysis run.",
      "$ref": "imatest-rings-settings-root.schema"
    }
  },
  "required": [
    "image_file",
    "settings"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
East The field angle in degrees along the east radial.  
  • JSON
  • CSV
  • HDF5
east_deg number East [°] /East  
South East The field angle in degrees along the south east radial.  
  • JSON
  • CSV
  • HDF5
south_east_deg number South East [°] /South East  
South The field angle in degrees along the south radial.  
  • JSON
  • CSV
  • HDF5
south_deg number South [°] /South  
South West The field angle in degrees along the south west radial.  
  • JSON
  • CSV
  • HDF5
south_west_deg number South West [°] /South West  
West The field angle in degrees along the west radial.  
  • JSON
  • CSV
  • HDF5
west_deg number West [°] /West  
North West The field angle in degrees along the north west radial.  
  • JSON
  • CSV
  • HDF5
north_west_deg number North West [°] /North West  
North The field angle in degrees along the north radial.  
  • JSON
  • CSV
  • HDF5
north_deg number North [°] /North  
North East The field angle in degrees along the north east radial.  
  • JSON
  • CSV
  • HDF5
north_east_deg number North East [°] /North East  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-rings-results-field-angle.schema",
  "title": "Concentric Rings FOV Results: Field Angle",
  "description": "The maximum field angles for each of the radials.",
  "type": "object",
  "properties": {
    "east_deg": {
      "description": "The field angle in degrees along the east radial.",
      "type": "number"
    },
    "south_east_deg": {
      "description": "The field angle in degrees along the south east radial.",
      "type": "number"
    },
    "south_deg": {
      "description": "The field angle in degrees along the south radial.",
      "type": "number"
    },
    "south_west_deg": {
      "description": "The field angle in degrees along the south west radial.",
      "type": "number"
    },
    "west_deg": {
      "description": "The field angle in degrees along the west radial.",
      "type": "number"
    },
    "north_west_deg": {
      "description": "The field angle in degrees along the north west radial.",
      "type": "number"
    },
    "north_deg": {
      "description": "The field angle in degrees along the north radial.",
      "type": "number"
    },
    "north_east_deg": {
      "description": "The field angle in degrees along the north east radial.",
      "type": "number"
    }
  },
  "required": [
    "east_deg",
    "south_east_deg",
    "south_deg",
    "south_west_deg",
    "west_deg",
    "north_west_deg",
    "north_deg",
    "north_east_deg"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Horizontal The horizontal field of view in degrees.  
  • JSON
  • CSV
  • HDF5
horizontal_deg number Horizontal [°] /Horizontal  
Vertical The vertical field of view in degrees.  
  • JSON
  • CSV
  • HDF5
vertical_deg number Vertical [°] /Vertical  
Diagonal The diagonal field of view in degrees. This is the average of the positive and negative diagonal FOVs.  
  • JSON
  • CSV
  • HDF5
diagonal_deg number Diagonal [°] /Diagonal  
Positive Diagonal The positive diagonal field of view in degrees.  
  • JSON
  • CSV
  • HDF5
positive_diagonal_deg number Positive Diagonal [°] /Positive Diagonal  
Negative Diagonal The negative diagonal field of view in degrees.  
  • JSON
  • CSV
  • HDF5
negative_diagonal_deg number Negative Diagonal [°] /Negative Diagonal  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-rings-results-fov.schema",
  "title": "Concentric Rings FOV Summary Results: Field of View",
  "description": "The field of views calculated from a concentric rings FOV module analysis.",
  "type": "object",
  "properties": {
    "horizontal_deg": {
      "description": "The horizontal field of view in degrees.",
      "type": "number"
    },
    "vertical_deg": {
      "description": "The vertical field of view in degrees.",
      "type": "number"
    },
    "diagonal_deg": {
      "description": "The diagonal field of view in degrees. This is the average of the positive and negative diagonal FOVs.",
      "type": "number"
    },
    "positive_diagonal_deg": {
      "description": "The positive diagonal field of view in degrees.",
      "type": "number"
    },
    "negative_diagonal_deg": {
      "description": "The negative diagonal field of view in degrees.",
      "type": "number"
    }
  },
  "required": [
    "horizontal_deg",
    "vertical_deg",
    "diagonal_deg",
    "positive_diagonal_deg",
    "negative_diagonal_deg"
  ],
  "unevaluatedProperties": false
}

Used In

Concetric Rings FOV Radial Result

Description

The raw data for a radial.

Result Field(s)

Title Description Validation Included In JSON Key JSON Type CSV Key HDF5 Dataset 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
  • CSV
  • HDF5
radial_direction string Radial Direction /Radial Direction  
Line Azimuth Angle The azimuth angle of the radial in degrees.  
  • JSON
  • CSV
  • HDF5
line_azimuth_angle_deg number Line Azimuth Angle [°] /Line Azimuth Angle  
End Point The x, y coordinate of the end point (furthest from the center) of the radial.  
  • JSON
  • CSV
  • HDF5
end_point array of number End Point /End Point  
Ring Coordinates X The x coordinate of each ring detection along the radial.  
  • JSON
  • CSV
  • HDF5
ring_coordinates_x_px array of number Ring Coordinates X [px] /Ring Coordinates X  
Ring Coordinates Y The y coordinate of each ring detection along the radial.  
  • JSON
  • CSV
  • HDF5
ring_coordinates_y_px array of number Ring Coordinates Y [px] /Ring Coordinates Y  
Ring Count The number of detected rings along the radial.  
  • JSON
  • CSV
  • HDF5
ring_count integer Ring Count /Ring Count  
Ring Field Angle The field angle of each ring in degrees.  
  • JSON
  • CSV
  • HDF5
ring_field_angle_deg array of number Ring Field Angle [°] /Ring Field Angle  
Image-Derived Ring Radius The radius of the ring in pixels, derived from the input image.  
  • JSON
  • CSV
  • HDF5
image_derived_ring_radius_px array of number Image-Derived Ring Radius [px] /Image-Derived Ring Radius  
Chart-Derived Ring Radius The radius of the ring in millimeters, derived from the chart parameters.  
  • JSON
  • CSV
  • HDF5
chart_derived_ring_radius_mm array of number Chart-Derived Ring Radius [mm] /Chart-Derived Ring Radius  
Chart-Derived Ring Radius The radius of the ring in pixels, derived from the chart parameters.  
  • JSON
  • CSV
  • HDF5
chart_derived_ring_radius_px array of number Chart-Derived Ring Radius [px] /Chart-Derived Ring Radius  
Image-Derived Ring Radius The radius of the ring in millimeters, derived from the input image.  
  • JSON
  • CSV
  • HDF5
image_derived_ring_radius_mm array of number Image-Derived Ring Radius [mm] /Image-Derived Ring Radius  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-rings-results-radial.schema",
  "title": "Concetric Rings FOV Radial Result",
  "description": "The raw data for a radial.",
  "type": "object",
  "properties": {
    "radial_direction": {
      "description": "The label for the radial direction.",
      "type": "string",
      "enum": [
        "East",
        "South East",
        "South",
        "South West",
        "West",
        "North West",
        "North",
        "North East"
      ]
    },
    "line_azimuth_angle_deg": {
      "description": "The azimuth angle of the radial in degrees.",
      "type": "number"
    },
    "end_point": {
      "description": "The x, y coordinate of the end point (furthest from the center) of the radial.",
      "type": "array",
      "items": {
        "type": "number"
      },
      "minItems": 2,
      "maxItems": 2
    },
    "ring_coordinates_x_px": {
      "description": "The x coordinate of each ring detection along the radial.",
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "ring_coordinates_y_px": {
      "description": "The y coordinate of each ring detection along the radial.",
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "ring_count": {
      "description": "The number of detected rings along the radial.",
      "type": "integer"
    },
    "ring_field_angle_deg": {
      "description": "The field angle of each ring in degrees.",
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "image_derived_ring_radius_px": {
      "description": "The radius of the ring in pixels, derived from the input image.",
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "chart_derived_ring_radius_mm": {
      "description": "The radius of the ring in millimeters, derived from the chart parameters.",
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "chart_derived_ring_radius_px": {
      "description": "The radius of the ring in pixels, derived from the chart parameters.",
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "image_derived_ring_radius_mm": {
      "description": "The radius of the ring in millimeters, derived from the input image.",
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "radial_direction",
    "line_azimuth_angle_deg",
    "end_point",
    "ring_coordinates_x_px",
    "ring_coordinates_y_px",
    "ring_count",
    "ring_field_angle_deg",
    "image_derived_ring_radius_px",
    "chart_derived_ring_radius_mm",
    "chart_derived_ring_radius_px",
    "image_derived_ring_radius_mm"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Registration Mark Information about the detected registration mark.
  • JSON
  • CSV
  • HDF5
registration_mark object [Registration Mark] /Registration Mark  
Summary The summary results from the analysis.
  • JSON
  • CSV
  • HDF5
summary object [Summary] /Summary  
Raw Data The raw results from for each radial.
  • JSON
  • CSV
  • HDF5
raw_data array of object [Raw Data###] /Raw Data###
  • For CSV and/or HDF5 outputs, the one-based index is appended to each entry as indicated by the ###.

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-rings-results-root.schema",
  "title": "Concentric Ring FOV: Results",
  "description": "The calculated results from a concentric rings FOV module analysis.",
  "type": "object",
  "properties": {
    "registration_mark": {
      "description": "Information about the detected registration mark.",
      "$ref": "imatest-common-results-registration-mark.schema"
    },
    "summary": {
      "description": "The summary results from the analysis.",
      "$ref": "imatest-rings-results-summary.schema"
    },
    "raw_data": {
      "description": "The raw results from for each radial.",
      "type": "array",
      "items": {
        "$ref": "imatest-rings-results-radial.schema"
      },
      "minItems": 8,
      "maxItems": 8
    }
  },
  "required": [
    "registration_mark",
    "summary",
    "raw_data"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
FOV The calculated fields of view.
  • JSON
  • CSV
  • HDF5
fov object [FOV] /FOV  
Field Angle The field angles calculated for each radial.
  • JSON
  • CSV
  • HDF5
field_angle object [Field Angle] /Field Angle  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-rings-results-summary.schema",
  "title": "Concentric Rings FOV Summary Results",
  "description": "The summary results from a concentric rings FOV module analysis.",
  "type": "object",
  "properties": {
    "fov": {
      "description": "The calculated fields of view.",
      "$ref": "imatest-rings-results-fov.schema"
    },
    "field_angle": {
      "description": "The field angles calculated for each radial.",
      "$ref": "imatest-rings-results-field-angle.schema"
    }
  },
  "required": [
    "fov",
    "field_angle"
  ],
  "unevaluatedProperties": false
}

Used In

Concentric Ring FOV: Batch Output Settings

Description

The user-provided batch output settings for the concentric rings module.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-rings-settings-batch-outputs.schema",
  "title": "Concentric Ring FOV: Batch Output Settings",
  "description": "The user-provided batch output settings for the concentric rings module.",
  "type": "object",
  "properties": {
    "plot_save_settings": {
      "description": "The user-provided settings for saving plot(s).",
      "$ref": "imatest-rings-settings-save-plots.schema"
    },
    "result_files": {
      "description": "The user-provided settings for saving summary result file(s).",
      "$ref": "imatest-common-settings-result-files.schema"
    },
    "save_location": {
      "description": "The user-provided settings for where the result file(s) are saved.",
      "$ref": "imatest-common-settings-save-location.schema"
    }
  },
  "required": [
    "plot_save_settings",
    "result_files",
    "save_location"
  ],
  "unevaluatedProperties": false
}

Used In

Concentric Ring FOV: Settings

Description

The user-provided settings for the concentric rings module.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-rings-settings-root.schema",
  "title": "Concentric Ring FOV: Settings",
  "description": "The user-provided settings for the concentric rings module.",
  "type": "object",
  "properties": {
    "target_properties": {
      "description": "The user-provided target settings.",
      "$ref": "imatest-rings-settings-target.schema"
    },
    "test_measurements": {
      "description": "The user-provided test measurements.",
      "$ref": "imatest-rings-settings-test-measurement.schema"
    },
    "registration_mark": {
      "description": "The user-provided settings for detecting a registration mark.",
      "$ref": "imatest-common-settings-registration-mark.schema"
    },
    "batch_outputs": {
      "description": "The user-provided batch output settings.",
      "$ref": "imatest-rings-settings-batch-outputs.schema"
    }
  },
  "required": [
    "target_properties",
    "test_measurements",
    "registration_mark",
    "batch_outputs"
  ],
  "unevaluatedProperties": false
}

Used In

Concentric Rings Plot Settings

Description

The user-provided plot settings for the concentric rings FOV module.

Result Field(s)

Title Description Validation Included In JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Plot Type The user-provided settings for the file format(s) to save plots as.
  • JSON
  • CSV
  • HDF5
plot_type array of string Plot Type /Plot Type  
Plot 1: Radius vs Field Angle The user-provided settings for how to save/display the plot.
  • JSON
  • CSV
  • HDF5
plot_1_radius_vs_field_angle array of string Plot 1: Radius vs Field Angle /Plot 1: Radius vs Field Angle  
Plot 2: Detection and FOV Summary The user-provided settings for how to save/display the plot.
  • JSON
  • CSV
  • HDF5
plot_2_detection_and_fov_summary array of string Plot 2: Detection and FOV Summary /Plot 2: Detection and FOV Summary  
Plot 3: Relative Distortion [mm] The user-provided settings for how to save/display the plot.
  • JSON
  • CSV
  • HDF5
plot_3_relative_distortion_mm array of string Plot 3: Relative Distortion [mm] /Plot 3: Relative Distortion [mm]  
Plot 4: Relative Distortion [px] The user-provided settings for how to save/display the plot.
  • JSON
  • CSV
  • HDF5
plot_4_relative_distortion_px array of string Plot 4: Relative Distortion [px] /Plot 4: Relative Distortion [px]  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-rings-settings-save-plots.schema",
  "title": "Concentric Rings Plot Settings",
  "description": "The user-provided plot settings for the concentric rings FOV module.",
  "type": "object",
  "properties": {
    "plot_type": {
      "description": "The user-provided settings for the file format(s) to save plots as.",
      "type": "array",
      "items": {
        "$ref": "imatest-common-settings-figure-save-type-enum.schema"
      }
    },
    "plot_1_radius_vs_field_angle": {
      "description": "The user-provided settings for how to save/display the plot.",
      "type": "array",
      "items": {
        "$ref": "imatest-common-settings-figure-save-display-enum.schema"
      }
    },
    "plot_2_detection_and_fov_summary": {
      "description": "The user-provided settings for how to save/display the plot.",
      "type": "array",
      "items": {
        "$ref": "imatest-common-settings-figure-save-display-enum.schema"
      }
    },
    "plot_3_relative_distortion_mm": {
      "description": "The user-provided settings for how to save/display the plot.",
      "type": "array",
      "items": {
        "$ref": "imatest-common-settings-figure-save-display-enum.schema"
      }
    },
    "plot_4_relative_distortion_px": {
      "description": "The user-provided settings for how to save/display the plot.",
      "type": "array",
      "items": {
        "$ref": "imatest-common-settings-figure-save-display-enum.schema"
      }
    }
  },
  "required": [
    "plot_type",
    "plot_1_radius_vs_field_angle",
    "plot_2_detection_and_fov_summary",
    "plot_3_relative_distortion_mm",
    "plot_4_relative_distortion_px"
  ],
  "unevaluatedProperties": false
}

Used In

Concentric Ring FOV: Target Settings

Description

The user-provided settings describing the target properties.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-rings-settings-target.schema",
  "title": "Concentric Ring FOV: Target Settings",
  "description": "The user-provided settings describing the target properties.",
  "type": "object",
  "properties": {
    "type": {
      "description": "The user-provided method for describing the target.",
      "type": "string",
      "enum": [
        "Constant Angle",
        "Constant Distance",
        "IMA-FOV-1X"
      ]
    },
    "fov_of_first_ring_deg": {
      "description": "The field of view (in degrees) that corresponds to the first (innermost) ring at the nominal test distance.",
      "type": "number"
    },
    "ring_separation_angle_deg": {
      "description": "The angle (in degrees) between rings.",
      "type": "number"
    },
    "nominal_test_distance_mm": {
      "description": "The test distance in mm that the chart is designed to be used.",
      "type": "number"
    },
    "start_distance_mm": {
      "description": "The distance in mm from the center of the chart to the first ring.",
      "type": "number"
    },
    "delta_distance_mm": {
      "description": "The distance in mm between rings.",
      "type": "number"
    }
  },
  "required": [
    "type"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Test Distance The user-provided measurement for the camera-target distance in mm.  
  • JSON
  • CSV
  • HDF5
test_distance_mm number Test Distance [mm] /Test Distance  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-rings-settings-test-measurement.schema",
  "title": "Concentric Ring FOV: Test Setup",
  "description": "The user-provided test measurements for the concentric ring FOV module.",
  "type": "object",
  "properties": {
    "test_distance_mm": {
      "description": "The user-provided measurement for the camera-target distance in mm.",
      "type": "number"
    }
  },
  "required": [
    "test_distance_mm"
  ],
  "unevaluatedProperties": false
}

Used In

Stray Light Data Transforms

Description

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

Members

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

JSON Schema

{
  "$id": "imatest-stray-light-settings-data-transform-enum.schema",
  "title": "Stray Light Data Transforms",
  "description": "The user-provided tranforms applied to stray light metric image data.",
  "type": "string",
  "enum": [
    "Linear",
    "Log10",
    "dB (Power)",
    "dB (Voltage)",
    "Log2",
    "Natural Log"
  ]
}

Used In

Stray Light Inputs

Description

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

Result Field(s)

Title Description Validation Included In JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Settings The user-provided settings (from an INI file).
  • JSON
  • CSV
  • HDF5
settings object [Settings] /Settings  
Configuration Note Any user-provided notes from the stray light configation file.  
  • JSON
  • CSV
  • HDF5
configuration_note string Configuration Note /Configuration Note
  • Conditional

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-inputs.schema",
  "title": "Stray Light Inputs",
  "description": "The user-provided inputs for a stray light analysis run.",
  "type": "object",
  "properties": {
    "settings": {
      "description": "The user-provided settings (from an INI file).",
      "$ref": "imatest-straylight-settings.schema"
    },
    "configuration_note": {
      "description": "Any user-provided notes from the stray light configation file.",
      "type": "string"
    }
  },
  "required": [
    "settings"
  ],
  "unevaluatedProperties": false
}

Used In

Stray Light Results

Description

The stray light results.

Result Field(s)

Title Description Validation Included In JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Normalization The normalization results.
  • JSON
  • CSV
  • HDF5
normalization object [Normalization] /Normalization  
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
  • CSV
  • HDF5
minimum_measurable_stray_light number Minimum Measurable Stray Light /Minimum Measurable Stray Light  
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
  • CSV
  • HDF5
maximum_measurable_stray_light number Maximum Measurable Stray Light /Maximum Measurable Stray Light  
Saturation The calculated saturation value (in digital numbers) across all images in the analysis.  
  • JSON
  • CSV
  • HDF5
saturation_DN number Saturation [DN] /Saturation  
Per Capture The results for each capture position.
  • JSON
  • CSV
  • HDF5
per_capture array of object [Per Capture###] /Per Capture###
  • For CSV and/or HDF5 outputs, the one-based index is appended to each entry as indicated by the ###.
Summary The summary results.
  • JSON
  • CSV
  • HDF5
summary array of object [Summary###] /Summary###
  • 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
  • CSV
  • HDF5
note string Note /Note
  • Conditional

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results.schema",
  "title": "Stray Light Results",
  "description": "The stray light results.",
  "type": "object",
  "properties": {
    "normalization": {
      "description": "The normalization results.",
      "$ref": "imatest-straylight-results-normalization.schema"
    },
    "minimum_measurable_stray_light": {
      "description": "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.",
      "type": "number"
    },
    "maximum_measurable_stray_light": {
      "description": "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.",
      "type": "number"
    },
    "saturation_DN": {
      "description": "The calculated saturation value (in digital numbers) across all images in the analysis.",
      "type": "number"
    },
    "per_capture": {
      "description": "The results for each capture position.",
      "type": "array",
      "items": {
        "$ref": "imatest-straylight-results-per-capture.schema"
      }
    },
    "summary": {
      "description": "The summary results.",
      "type": "array",
      "items": {
        "$ref": "imatest-straylight-results-summary.schema"
      }
    },
    "note": {
      "description": "A comment from the stray light configuration file.",
      "type": "string"
    }
  },
  "required": [
    "normalization",
    "minimum_measurable_stray_light",
    "maximum_measurable_stray_light",
    "saturation_DN",
    "per_capture",
    "summary"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Type The type of mask result.
  • Enumeration Members:
    • Error
    • None
    • Image Processing
    • Image Processing + Circle
  • JSON
  • CSV
  • HDF5
type string Type /Type  
Mask File The mask file(s) generated during the analysis.
  • JSON
  • CSV
  • HDF5
mask_file array of object Mask File Filename
Mask File MD5
/Mask File
  • CSV files have the file and MD5 has split across separate lines.
Channel The channel used to produce the mask.  
  • JSON
  • CSV
  • HDF5
channel string Channel /Channel  

Instances

This result a placeholder for one of the following instances.

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-mask.schema",
  "title": "Stray Light Mask Results",
  "description": "Information about the mask of the light source.",
  "type": "object",
  "properties": {
    "type": {
      "description": "The type of mask result.",
      "type": "string",
      "enum": [
        "Error",
        "None",
        "Image Processing",
        "Image Processing + Circle"
      ]
    },
    "mask_file": {
      "description": "The mask file(s) generated during the analysis.",
      "$ref": "imatest-common-filename-md5-array.schema"
    },
    "channel": {
      "description": "The channel used to produce the mask.",
      "type": "string"
    }
  },
  "required": [
    "type",
    "mask_file",
    "channel"
  ],
  "anyOf": [
    {
      "$ref": "imatest-straylight-results-mask-image-processing.schema"
    },
    {
      "$ref": "imatest-straylight-results-mask-none.schema"
    },
    {
      "$ref": "imatest-straylight-results-mask-circle.schema"
    },
    {
      "$ref": "imatest-straylight-results-mask-error.schema"
    }
  ]
}

Used In

Stray Light Mask Results: Image Processing + Circle

Description

Information about the mask of the light source.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-mask-circle.schema",
  "title": "Stray Light Mask Results: Image Processing + Circle",
  "description": "Information about the mask of the light source.",
  "type": "object",
  "properties": {
    "type": {
      "description": "The type of mask result.",
      "type": "string",
      "const": "Image Processing + Circle"
    },
    "mask_file": {
      "description": "The mask file(s) generated during the analysis.",
      "$ref": "imatest-common-filename-md5-array.schema"
    },
    "channel": {
      "description": "The channel used to produce the mask.",
      "type": "string"
    },
    "source_in_fov": {
      "description": "True if the light source was determined to be in the FOV.",
      "type": "boolean"
    },
    "source_pixel_count": {
      "description": "The number of pixels that were masked out.",
      "type": "integer"
    },
    "connected_component_count": {
      "description": "The number of connected components for the masked out light source(s).",
      "type": "integer"
    },
    "x_centroid_px": {
      "description": "The x-value of the centroid of the mask.",
      "$ref": "imatest-common-number.schema"
    },
    "y_centroid_px": {
      "description": "The y-value of the centroid of the mask.",
      "$ref": "imatest-common-number.schema"
    },
    "pass_1": {
      "description": "Information about the masking of the first pass.",
      "$ref": "imatest-straylight-results-mask-image-processing.schema"
    }
  },
  "required": [
    "type",
    "mask_file",
    "channel",
    "source_in_fov",
    "source_pixel_count",
    "connected_component_count",
    "pass_1"
  ],
  "unevaluatedProperties": false
}

Notes

Stray Light Mask Results: Error

Description

Mask information when an error occurred.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-mask-error.schema",
  "title": "Stray Light Mask Results: Error",
  "description": "Mask information when an error occurred.",
  "type": "object",
  "properties": {
    "type": {
      "description": "The type of mask result.",
      "type": "string",
      "const": "Error"
    },
    "mask_file": {
      "description": "The mask file(s) generated during the analysis.",
      "$ref": "imatest-common-filename-md5-array.schema"
    },
    "channel": {
      "description": "The channel used to produce the mask.",
      "type": "string"
    },
    "note": {
      "description": "Information that an error occurred.",
      "type": "string",
      "const": "An error occurred while performing the masking."
    },
    "error_message": {
      "description": "The error message.",
      "type": "string"
    },
    "error_id": {
      "description": "The error identifier.",
      "type": "string"
    }
  },
  "required": [
    "type",
    "mask_file",
    "channel",
    "note",
    "error_message",
    "error_id"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Type The type of mask result.
  • Constant: Image Processing
  • JSON
  • CSV
  • HDF5
type string Type /Type  
Mask File The mask file(s) generated during the analysis.
  • JSON
  • CSV
  • HDF5
mask_file array of object Mask File Filename
Mask File MD5
/Mask File
  • CSV files have the file and MD5 has split across separate lines.
Channel The channel used to produce the mask.  
  • JSON
  • CSV
  • HDF5
channel string Channel /Channel  
Source In FOV True if the light source was determined to be in the FOV.  
  • JSON
  • CSV
  • HDF5
source_in_fov boolean Source In FOV /Source In FOV  
Source Pixel Count The number of pixels that were masked out.  
  • JSON
  • CSV
  • HDF5
source_pixel_count integer Source Pixel Count /Source Pixel Count  
Connected Component Count The number of connected components for the masked out light source(s).  
  • JSON
  • CSV
  • HDF5
connected_component_count integer Connected Component Count /Connected Component Count  
X Centroid The x-value of the centroid of the mask.  
  • JSON
  • CSV
  • HDF5
x_centroid_px number or null X Centroid [px] /X Centroid
Y Centroid The y-value of the centroid of the mask.  
  • JSON
  • CSV
  • HDF5
y_centroid_px number or null Y Centroid [px] /Y Centroid
Threshold The threshold for masking in digital numbers.  
  • JSON
  • CSV
  • HDF5
threshold_DN number Threshold [DN] /Threshold  
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
  • CSV
  • HDF5
exit_condition string Exit Condition /Exit Condition  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-mask-image-processing.schema",
  "title": "Stray Light Mask Results: Image Processing",
  "description": "Information about the mask of the light source via the image processing method.",
  "type": "object",
  "properties": {
    "type": {
      "description": "The type of mask result.",
      "type": "string",
      "const": "Image Processing"
    },
    "mask_file": {
      "description": "The mask file(s) generated during the analysis.",
      "$ref": "imatest-common-filename-md5-array.schema"
    },
    "channel": {
      "description": "The channel used to produce the mask.",
      "type": "string"
    },
    "source_in_fov": {
      "description": "True if the light source was determined to be in the FOV.",
      "type": "boolean"
    },
    "source_pixel_count": {
      "description": "The number of pixels that were masked out.",
      "type": "integer"
    },
    "connected_component_count": {
      "description": "The number of connected components for the masked out light source(s).",
      "type": "integer"
    },
    "x_centroid_px": {
      "description": "The x-value of the centroid of the mask.",
      "$ref": "imatest-common-number.schema"
    },
    "y_centroid_px": {
      "description": "The y-value of the centroid of the mask.",
      "$ref": "imatest-common-number.schema"
    },
    "threshold_DN": {
      "description": "The threshold for masking in digital numbers.",
      "type": "number"
    },
    "exit_condition": {
      "description": "The condition for completing the masking method.",
      "type": "string",
      "enum": [
        "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"
      ]
    }
  },
  "required": [
    "type",
    "mask_file",
    "channel",
    "source_in_fov",
    "source_pixel_count",
    "connected_component_count",
    "threshold_DN",
    "exit_condition"
  ],
  "unevaluatedProperties": false
}

Notes

Stray Light Mask Results: None

Description

Mask information when the user specified not to mask.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-mask-none.schema",
  "title": "Stray Light Mask Results: None",
  "description": "Mask information when the user specified not to mask.",
  "type": "object",
  "properties": {
    "type": {
      "description": "The type of mask result.",
      "type": "string",
      "const": "None"
    },
    "mask_file": {
      "description": "The mask file(s) generated during the analysis.",
      "$ref": "imatest-common-filename-md5-array.schema"
    },
    "channel": {
      "description": "The channel used to produce the mask.",
      "type": "string"
    }
  },
  "required": [
    "type",
    "mask_file",
    "channel"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Factor The computed normalization factor in digital numbers.  
  • JSON
  • CSV
  • HDF5
factor_DN number Factor [DN] /Factor  

Instances

This result a placeholder for one of the following instances.

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-normalization.schema",
  "title": "Stray Light Normalization",
  "description": "The normalization data.",
  "type": "object",
  "properties": {
    "factor_DN": {
      "description": "The computed normalization factor in digital numbers.",
      "type": "number"
    }
  },
  "required": [
    "factor_DN"
  ],
  "anyOf": [
    {
      "$ref": "imatest-straylight-results-normalization-level.schema"
    },
    {
      "$ref": "imatest-straylight-results-normalization-reference-image.schema"
    },
    {
      "$ref": "imatest-straylight-results-normalization-none.schema"
    }
  ]
}

Used In

Stray Light Reference Image Compensation Data

Description

Information about the normalization compensation.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-normalization-compensation.schema",
  "title": "Stray Light Reference Image Compensation Data",
  "description": "Information about the normalization compensation.",
  "type": "object",
  "properties": {
    "compensation_factor": {
      "description": "The total normalization compensation factor.",
      "type": "number"
    },
    "source": {
      "description": "The compensation information from the reference image of the direct source.",
      "$ref": "imatest-straylight-results-normalization-compensation-source.schema"
    },
    "camera": {
      "description": "The compensation information from the camera.",
      "$ref": "imatest-straylight-results-normalization-compensation-camera.schema"
    }
  },
  "required": [
    "compensation_factor",
    "source",
    "camera"
  ],
  "unevaluatedProperties": false
}

Used In

Stray Light Camera Compensation

Description

Information about the camera-side normalization compensation.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-normalization-compensation-camera.schema",
  "title": "Stray Light Camera Compensation",
  "description": "Information about the camera-side normalization compensation.",
  "type": "object",
  "properties": {
    "compensation_factor": {
      "description": "The overall camera-side compensation factor.",
      "type": "number"
    },
    "integration_time_compensation_factor": {
      "description": "The compensation factor from the integration time.",
      "type": "number"
    },
    "gain_compensation_factor": {
      "description": "The compensation factor from the gain.",
      "type": "number"
    }
  },
  "required": [
    "compensation_factor",
    "integration_time_compensation_factor",
    "gain_compensation_factor"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Compensation Factor The overall compensation factor from the direct image of the source.  
  • JSON
  • CSV
  • HDF5
compensation_factor number Compensation Factor /Compensation Factor  
Light Level Compensation Factor The compensation factor from the difference in light level.  
  • JSON
  • CSV
  • HDF5
light_level_compensation_factor number Light Level Compensation Factor /Light Level Compensation Factor  
Neutral Density Compensation Factor The compensation factor from the neutral density filter.  
  • JSON
  • CSV
  • HDF5
neutral_density_compensation_factor number Neutral Density Compensation Factor /Neutral Density Compensation Factor  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-normalization-compensation-direct-source.schema",
  "title": "Stray Light Direct Reference Image Compensation Data",
  "description": "Information about the light source compensation for a direct reference image normalization.",
  "type": "object",
  "properties": {
    "compensation_factor": {
      "description": "The overall compensation factor from the direct image of the source.",
      "type": "number"
    },
    "light_level_compensation_factor": {
      "description": "The compensation factor from the difference in light level.",
      "type": "number"
    },
    "neutral_density_compensation_factor": {
      "description": "The compensation factor from the neutral density filter.",
      "type": "number"
    }
  },
  "required": [
    "compensation_factor",
    "light_level_compensation_factor",
    "neutral_density_compensation_factor"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Compensation Factor The overall compensation factor from image of the Lambertian source.  
  • JSON
  • CSV
  • HDF5
compensation_factor number Compensation Factor /Compensation Factor  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-normalization-compensation-lambertian-source.schema",
  "title": "Stray Light Lambertian Reference Image Compensation Data",
  "description": "Information about the light source compensation for a Lambertian reference image normalization.",
  "type": "object",
  "properties": {
    "compensation_factor": {
      "description": "The overall compensation factor from image of the Lambertian source.",
      "type": "number"
    }
  },
  "required": [
    "compensation_factor"
  ],
  "unevaluatedProperties": false
}

Notes

Stray Light Light Source Compensation Data

Description

Information about the light source compensation.

Instances

This result a placeholder for one of the following instances.

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-normalization-compensation-source.schema",
  "title": "Stray Light Light Source Compensation Data",
  "description": "Information about the light source compensation.",
  "type": "object",
  "anyOf": [
    {
      "$ref": "imatest-straylight-results-normalization-compensation-direct-source.schema"
    },
    {
      "$ref": "imatest-straylight-results-normalization-compensation-lambertian-source.schema"
    }
  ]
}

Used In

Stray Light Normalization: Level

Description

The normalization data for level normalization.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-normalization-level.schema",
  "title": "Stray Light Normalization: Level",
  "description": "The normalization data for level normalization.",
  "type": "object",
  "properties": {
    "factor_DN": {
      "description": "The computed normalization factor in digital numbers.",
      "type": "number"
    }
  },
  "required": [
    "factor_DN"
  ],
  "unevaluatedProperties": false
}

Notes

Stray Light Normalization: None

Description

The normalization data for None normalization.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-normalization-none.schema",
  "title": "Stray Light Normalization: None",
  "description": "The normalization data for None normalization.",
  "type": "object",
  "properties": {
    "factor_DN": {
      "description": "The computed normalization factor in digital numbers.",
      "type": "number",
      "const": 1
    }
  },
  "required": [
    "factor_DN"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Factor The computed normalization factor in digital numbers.  
  • JSON
  • CSV
  • HDF5
factor_DN number Factor [DN] /Factor  
Base Factor The computed base normalization factor (pre-compensation) in digital numbers.  
  • JSON
  • CSV
  • HDF5
base_factor_DN number Base Factor [DN] /Base Factor  
Compensation Information about the normalization compensation.
  • JSON
  • CSV
  • HDF5
compensation object [Compensation] /Compensation  
Channel Information about the channel that was used to produce the normalization.
  • JSON
  • CSV
  • HDF5
channel object [Channel] /Channel  
Mask Information about the mask of the reference (normalization) image.
  • JSON
  • CSV
  • HDF5
mask object [Mask] /Mask  
Saturation The calculated saturation value for the reference image in digital numbers.  
  • JSON
  • CSV
  • HDF5
saturation_DN number Saturation [DN] /Saturation  
Image The normalization image.  
  • HDF5
N/A N/A N/A /Image  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-normalization-reference-image.schema",
  "title": "Stray Light Normalization: Reference Image",
  "description": "The normalization data from reference image normalization (direct or Lambertian).",
  "type": "object",
  "properties": {
    "factor_DN": {
      "description": "The computed normalization factor in digital numbers.",
      "type": "number"
    },
    "base_factor_DN": {
      "description": "The computed base normalization factor (pre-compensation) in digital numbers.",
      "type": "number"
    },
    "compensation": {
      "description": "Information about the normalization compensation.",
      "$ref": "imatest-straylight-results-normalization-compensation.schema"
    },
    "channel": {
      "description": "Information about the channel that was used to produce the normalization.",
      "$ref": "imatest-common-channel-extractor.schema"
    },
    "mask": {
      "description": "Information about the mask of the reference (normalization) image.",
      "$ref": "imatest-straylight-results-mask.schema"
    },
    "saturation_DN": {
      "description": "The calculated saturation value for the reference image in digital numbers.",
      "type": "number"
    }
  },
  "required": [
    "factor_DN",
    "base_factor_DN",
    "compensation",
    "channel",
    "mask",
    "saturation_DN"
  ],
  "unevaluatedProperties": false
}

Notes

Overall Stats

Description

Summary statistics over all captures within the subset.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-overall-summary.schema",
  "title": "Overall Stats",
  "description": "Summary statistics over all captures within the subset.",
  "type": "object",
  "properties": {
    "min": {
      "description": "The minimum stray light value for all captures over this subset.",
      "type": "number"
    },
    "min_non_0": {
      "description": "The minimum (of the non-zero values in the original image) stray light value for all captures over this subset.",
      "type": "number"
    },
    "max": {
      "description": "The maximum stray light value for all captures over this subset.",
      "type": "number"
    }
  },
  "required": [
    "min",
    "min_non_0",
    "max"
  ],
  "unevaluatedProperties": false
}

Used In

Stray Light Results: Per Capture

Description

Stray light results from each capture position.

Result Field(s)

Title Description Validation Included In JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Capture Index The one-based index of the capture.  
  • JSON
  • CSV
  • HDF5
capture_index integer Capture Index /Capture Index  
Source Field Angle The field angle of the light source in degrees.  
  • JSON
  • CSV
  • HDF5
source_field_angle_deg number or null Source Field Angle [deg] /Source Field Angle
Source Azimuth Angle The azimuth angle of the light source in degrees.  
  • JSON
  • CSV
  • HDF5
source_azimuth_angle_deg number or null Source Azimuth Angle [deg] /Source Azimuth Angle
Image File The analysis image.
  • JSON
  • CSV
  • HDF5
image_file object Image File Filename
Image File MD5
/Image File
  • CSV files have the file and MD5 has split across separate lines.
Input Image The image to be analyzed.  
  • HDF5
N/A N/A N/A /Input Image  
Saturation The calculated saturation value for this image in digital numbers.  
  • JSON
  • CSV
  • HDF5
saturation_DN number Saturation [DN] /Saturation  
Mask Information about the mask of the light source.
  • JSON
  • CSV
  • HDF5
mask object [Mask] /Mask  
Note The user-provided notes for the capture position.  
  • JSON
  • CSV
  • HDF5
note string Note /Note
  • Conditional
Subsets The summary statistics for each subset (analysis channel).
  • JSON
  • CSV
  • HDF5
subsets array of object [Subsets###] /Subsets###
  • 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
  • CSV
  • HDF5
low_memory_result_files array of object Low-Memory Result Files Filename
Low-Memory Result Files MD5
/Low-Memory Result Files
  • Conditional
  • CSV files have the file and MD5 has split across separate lines.

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-per-capture.schema",
  "title": "Stray Light Results: Per Capture",
  "description": "Stray light results from each capture position.",
  "type": "object",
  "properties": {
    "capture_index": {
      "description": "The one-based index of the capture.",
      "type": "integer"
    },
    "source_field_angle_deg": {
      "description": "The field angle of the light source in degrees.",
      "$ref": "imatest-common-number.schema"
    },
    "source_azimuth_angle_deg": {
      "description": "The azimuth angle of the light source in degrees.",
      "$ref": "imatest-common-number.schema"
    },
    "image_file": {
      "description": "The analysis image.",
      "$ref": "imatest-common-filename-md5.schema"
    },
    "saturation_DN": {
      "description": "The calculated saturation value for this image in digital numbers.",
      "type": "number"
    },
    "mask": {
      "description": "Information about the mask of the light source.",
      "$ref": "imatest-straylight-results-mask.schema"
    },
    "note": {
      "description": "The user-provided notes for the capture position.",
      "type": "string"
    },
    "subsets": {
      "description": "The summary statistics for each subset (analysis channel).",
      "type": "array",
      "items": {
        "$ref": "imatest-straylight-results-per-capture-subset.schema"
      }
    },
    "low_memory_result_files": {
      "description": "The summary output file(s) for this capture if operating in low memory mode.",
      "$ref": "imatest-common-filename-md5-array.schema"
    }
  },
  "required": [
    "capture_index",
    "source_field_angle_deg",
    "source_azimuth_angle_deg",
    "image_file",
    "saturation_DN",
    "mask",
    "subsets"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Thresholds The user-provided thresholds.  
  • JSON
  • CSV
  • HDF5
thresholds array of number Thresholds /Thresholds  
Counts The number of pixels of stray light worse than the user-provided thresholds within the subset.  
  • JSON
  • CSV
  • HDF5
counts array of integer Counts /Counts  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-per-capture-level-count.schema",
  "title": "Level Counts",
  "description": "The number of pixels with stray light worse than user-provided thresholds.",
  "type": "object",
  "properties": {
    "thresholds": {
      "description": "The user-provided thresholds.",
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "counts": {
      "description": "The number of pixels of stray light worse than the user-provided thresholds within the subset.",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "required": [
    "thresholds",
    "counts"
  ],
  "unevaluatedProperties": false,
  "$comment": "A subset is a combination of an analysis channel and a region of interest."
}

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-per-capture-subset.schema",
  "title": "Stray Light Results: Per Capture Subset",
  "description": "Stray light results from a subset of a capture.",
  "type": "object",
  "properties": {
    "channel": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "roi": {
      "description": "The name of the region of interest.",
      "type": "string",
      "const": "All"
    },
    "metric_image_file": {
      "description": "The metric image file associated with this subset.",
      "$ref": "imatest-common-filename-md5-array.schema"
    },
    "data_transform": {
      "description": "The transform applied to the metric image.",
      "$ref": "imatest-stray-light-settings-data-transform-enum.schema"
    },
    "min": {
      "description": "The minimum stray light value within the subset.",
      "type": "number",
      "$comment": "Note any masked-out pixels are excluded from this summary statistic."
    },
    "min_non_zero": {
      "description": "The minimum (of the non-zero values in the original image) stray light value within the subset.",
      "type": "number",
      "$comment": "Note any masked-out pixels are excluded from this summary statistic."
    },
    "max": {
      "description": "The maximum stray light value within the subset.",
      "type": "number",
      "$comment": "Note any masked-out pixels are excluded from this summary statistic."
    },
    "mean": {
      "description": "The mean stray light value within the subset.",
      "type": "number",
      "$comment": "Note any masked-out pixels are excluded from this summary statistic."
    },
    "median": {
      "description": "The median stray light value within the subset.",
      "type": "number",
      "$comment": "Note any masked-out pixels are excluded from this summary statistic."
    },
    "standard_deviation": {
      "description": "The standard deviation of the stray light values within the subset.",
      "type": "number",
      "$comment": "Note any masked-out pixels are excluded from this summary statistic."
    },
    "rms": {
      "description": "The root mean square of the stray light values within the subset.",
      "type": "number",
      "$comment": "Note any masked-out pixels are excluded from this summary statistic."
    },
    "total_count": {
      "description": "The count of all of the pixels within the subset.",
      "type": "integer"
    },
    "source_count": {
      "description": "The count of the source-masked pixels within the subset.",
      "type": "integer"
    },
    "saturation_count": {
      "description": "The count of the pixels at or above the computed saturation level.",
      "type": "integer"
    },
    "percentiles": {
      "description": "The percentiles of the stray light values within the subset.",
      "$ref": "imatest-common-results-percentiles.schema"
    },
    "level_counts": {
      "description": "The number of pixels of stray light worse than the user-provided thresholds within the subset.",
      "$ref": "imatest-straylight-results-per-capture-level-count.schema"
    }
  },
  "required": [
    "channel",
    "roi",
    "metric_image_file",
    "data_transform",
    "min",
    "min_non_zero",
    "max",
    "mean",
    "median",
    "standard_deviation",
    "rms",
    "total_count",
    "source_count",
    "saturation_count",
    "percentiles",
    "level_counts"
  ],
  "unevaluatedProperties": false,
  "$comment": "A subset is a combination of an analysis channel and a region of interest."
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Channel The name of the channel.  
  • JSON
  • CSV
  • HDF5
channel string Channel /Channel  
ROI The name of the region of interest (ROI).
  • Constant: All
  • JSON
  • CSV
  • HDF5
roi string ROI /ROI  
Data Transform The transform applied to the data.
  • JSON
  • CSV
  • HDF5
data_transform string Data Transform /Data Transform  
Per Capture The arrays of per-capture stray light summary metrics.
  • JSON
  • CSV
  • HDF5
per_capture object [Per Capture] /Per Capture  
Overall The overall summary metrics across all captures within the subset.
  • JSON
  • CSV
  • HDF5
overall object [Overall] /Overall  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-summary.schema",
  "title": "Summary Results",
  "description": "The stray light summary results for a subset.",
  "type": "object",
  "properties": {
    "channel": {
      "description": "The name of the channel.",
      "type": "string"
    },
    "roi": {
      "description": "The name of the region of interest (ROI).",
      "type": "string",
      "const": "All",
      "$comment": "Other ROIs may be added in future versions of Imatest."
    },
    "data_transform": {
      "description": "The transform applied to the data.",
      "$ref": "imatest-stray-light-settings-data-transform-enum.schema"
    },
    "per_capture": {
      "description": "The arrays of per-capture stray light summary metrics.",
      "$ref": "imatest-straylight-results-summary-per-capture.schema"
    },
    "overall": {
      "description": "The overall summary metrics across all captures within the subset.",
      "$ref": "imatest-straylight-results-overall-summary.schema"
    }
  },
  "required": [
    "channel",
    "roi",
    "data_transform",
    "per_capture",
    "overall"
  ],
  "unevaluatedProperties": false,
  "$comment": "A subset is a combination of an analysis channel and a region of interest."
}

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

Variable Key Result Field(s)

  • The results in this section have a variable key.
Title Description Validation Included In JSON Pattern JSON Type CSV Pattern HDF5 Dataset Pattern 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
  • CSV
  • HDF5
percentile_1?[0-9]{1,2}(?:p[0-9]+)? array of number Percentile ### /Percentile ###  
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
  • CSV
  • HDF5
level_count_at_[0-9]+(?:p[0-9]+)? array of integer Level Count at ### /Level Count At ###  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-results-summary-per-capture.schema",
  "title": "Stray Light Per-Capture Summary Results (Vectorized)",
  "description": "The array of per-capture summary metrics within the subset.",
  "type": "object",
  "properties": {
    "capture_index": {
      "description": "The one-based index of the capture.",
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "source_field_angle_deg": {
      "description": "The field angle of the source in degrees.",
      "type": "array",
      "items": {
        "$ref": "imatest-common-number.schema"
      }
    },
    "source_azimuth_angle_deg": {
      "description": "The azimuth angle of the source in degrees.",
      "type": "array",
      "items": {
        "$ref": "imatest-common-number.schema"
      }
    },
    "minimum": {
      "description": "The array of per-capture minimum stray light value within the subset.",
      "type": "array",
      "items": {
        "type": "number"
      },
      "$comment": "Note any masked-out pixels are excluded from this summary statistic."
    },
    "minimum_non_zero": {
      "description": "The array of per-capture minimum (of the non-zero values in the original image) stray light value within the subset.",
      "type": "array",
      "items": {
        "type": "number"
      },
      "$comment": "Note any masked-out pixels are excluded from this summary statistic."
    },
    "maximum": {
      "description": "The array of per-capture maximum stray light value within the subset.",
      "type": "array",
      "items": {
        "type": "number"
      },
      "$comment": "Note any masked-out pixels are excluded from this summary statistic."
    },
    "mean": {
      "description": "The array of per-capture mean stray light value within the subset.",
      "type": "array",
      "items": {
        "type": "number"
      },
      "$comment": "Note any masked-out pixels are excluded from this summary statistic."
    },
    "median": {
      "description": "The array of per-capture median stray light value within the subset.",
      "type": "array",
      "items": {
        "type": "number"
      },
      "$comment": "Note any masked-out pixels are excluded from this summary statistic."
    },
    "rms": {
      "description": "The array of per-capture root mean square of the stray light values within the subset.",
      "type": "array",
      "items": {
        "type": "number"
      },
      "$comment": "Note any masked-out pixels are excluded from this summary statistic."
    },
    "standard_deviation": {
      "description": "The array of per-capture standard deviation of the stray light values within the subset.",
      "type": "array",
      "items": {
        "type": "number"
      },
      "$comment": "Note any masked-out pixels are excluded from this summary statistic."
    },
    "total_count": {
      "description": "The array of per-capture count of all of the pixels within the subset.",
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "source_count": {
      "description": "The array of per-capture count of the source-masked pixels within the subset.",
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "saturation_count": {
      "description": "The array of the per-capture count of the pixels at or above the computed saturation level.",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "required": [
    "capture_index",
    "source_field_angle_deg",
    "source_azimuth_angle_deg",
    "minimum",
    "minimum_non_zero",
    "maximum",
    "mean",
    "median",
    "rms",
    "standard_deviation",
    "total_count",
    "source_count",
    "saturation_count"
  ],
  "patternProperties": {
    "percentile_1?[0-9]{1,2}(?:p[0-9]+)?": {
      "description": "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.",
      "type": "array",
      "items": {
        "type": "number"
      },
      "$comment": "Note any masked-out pixels are excluded from this summary statistic."
    },
    "level_count_at_[0-9]+(?:p[0-9]+)?": {
      "description": "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.",
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "unevaluatedProperties": false,
  "$comment": "A subset is a combination of a channel and region of interest."
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Inputs The inputs for a stray light run.
  • JSON
  • CSV
  • HDF5
inputs object [Inputs] /Inputs  
Results The results from a stray light run.
  • JSON
  • CSV
  • HDF5
results object [Results] /Results  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-root.schema",
  "title": "Stray Light Root",
  "description": "The root level of an Imatest stray light result.",
  "type": "object",
  "properties": {
    "inputs": {
      "description": "The inputs for a stray light run.",
      "$ref": "imatest-straylight-inputs.schema"
    },
    "results": {
      "description": "The results from a stray light run.",
      "$ref": "imatest-straylight-results.schema"
    }
  },
  "required": [
    "inputs",
    "results"
  ],
  "unevaluatedProperties": false
}

Used In

Stray Light Settings

Description

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

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings.schema",
  "title": "Stray Light Settings",
  "description": "The user-provided settings for a stray light analysis run.",
  "type": "object",
  "properties": {
    "memory_mode": {
      "description": "The user-provided memory mode for the analysis run.",
      "type": "string",
      "enum": [
        "High Memory",
        "Low Memory"
      ]
    },
    "calculation": {
      "description": "The user-provided calculation settings.",
      "$ref": "imatest-straylight-settings-calculation.schema"
    },
    "batch_outputs": {
      "description": "The user-provided batch output settings.",
      "$ref": "imatest-straylight-settings-batch-outputs.schema"
    }
  },
  "required": [
    "memory_mode",
    "calculation",
    "batch_outputs"
  ],
  "unevaluatedProperties": false
}

Used In

Stray Light Batch Outputs Settings

Description

The user-provided settings saving batch outputs.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-batch-outputs.schema",
  "title": "Stray Light Batch Outputs Settings",
  "description": "The user-provided settings saving batch outputs.",
  "type": "object",
  "properties": {
    "image_outputs": {
      "description": "The user-provided settings for what images to produce.",
      "$ref": "imatest-straylight-settings-image-outputs.schema"
    },
    "plot_save_settings": {
      "description": "The user-provided settings for what plots to produce.",
      "$ref": "imatest-straylight-settings-plots.schema"
    },
    "video": {
      "description": "The user-provided settings for what videos to produce.",
      "$ref": "imatest-straylight-settings-videos.schema"
    },
    "result_files": {
      "description": "The user-provided settings for saving summary result file(s).",
      "$ref": "imatest-common-settings-result-files.schema"
    },
    "save_location": {
      "description": "The user-provided settings for where the result file(s) are saved.",
      "$ref": "imatest-common-settings-save-location.schema"
    }
  },
  "required": [
    "image_outputs",
    "plot_save_settings",
    "video",
    "result_files",
    "save_location"
  ],
  "unevaluatedProperties": false
}

Used In

Stray Light Calculation Settings

Description

The user-provided stray light calculation settings.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-calculation.schema",
  "title": "Stray Light Calculation Settings",
  "description": "The user-provided stray light calculation settings.",
  "type": "object",
  "properties": {
    "core_calculation": {
      "description": "The user-provided core calculation settings.",
      "$ref": "imatest-straylight-settings-core.schema"
    },
    "saturation": {
      "description": "The user-provided saturation calculation settings.",
      "$ref": "imatest-common-settings-saturation.schema"
    },
    "channel": {
      "description": "The user-provided channel selection settings.",
      "$ref": "imatest-common-settings-channel.schema"
    },
    "normalization": {
      "description": "The user-provided normalization settings.",
      "$ref": "imatest-straylight-settings-normalization.schema"
    },
    "analysis_mask": {
      "description": "The user-provided analysis image mask settings.",
      "$ref": "imatest-straylight-settings-mask.schema"
    },
    "crop": {
      "description": "The user-provided crop settings.",
      "$ref": "imatest-common-settings-crop-lrtb.schema"
    },
    "other": {
      "description": "The user-provided other calculation settings settings.",
      "$ref": "imatest-straylight-settings-other-calc.schema"
    }
  },
  "required": [
    "core_calculation",
    "saturation",
    "channel",
    "normalization",
    "analysis_mask",
    "crop",
    "other"
  ],
  "unevaluatedProperties": false
}

Used In

Core Calculation

Description

The user-provided core calculation settings.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-core.schema",
  "title": "Core Calculation",
  "description": "The user-provided core calculation settings.",
  "type": "object",
  "properties": {
    "calculation": {
      "description": "The user-provided type of calculation.",
      "type": "string",
      "enum": [
        "Transmission",
        "Attenuation"
      ]
    },
    "data_transform": {
      "description": "The user-provided transform of the data.",
      "$ref": "imatest-stray-light-settings-data-transform-enum.schema"
    },
    "dark_level_DN": {
      "description": "The user-provided dark level in digital numbers.",
      "type": "number"
    },
    "clip_to_one": {
      "description": "The user-provided setting to clip dark-level-subtracted images to one (instead of zero).",
      "type": "boolean"
    }
  },
  "required": [
    "calculation",
    "data_transform",
    "dark_level_DN",
    "clip_to_one"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Save Mask The user-provided option to save mask files.  
  • JSON
  • CSV
  • HDF5
save_mask boolean Save Mask /Save Mask  
Save Metric Image The user-provided option to save metric image files.  
  • JSON
  • CSV
  • HDF5
save_metric_image boolean Save Metric Image /Save Metric Image  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-image-outputs.schema",
  "title": "Stray Light Image Outputs Settings",
  "description": "The user-provided settings for saving image (FITS) file(s).",
  "type": "object",
  "properties": {
    "save_mask": {
      "description": "The user-provided option to save mask files.",
      "type": "boolean"
    },
    "save_metric_image": {
      "description": "The user-provided option to save metric image files.",
      "type": "boolean"
    }
  },
  "required": [
    "save_mask",
    "save_metric_image"
  ],
  "unevaluatedProperties": false
}

Used In

Mask Settings

Description

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

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-mask.schema",
  "title": "Mask Settings",
  "description": "The user-provided source masking settings for the test image(s).",
  "type": "object",
  "properties": {
    "type": {
      "description": "The user-provided masking method.",
      "type": "string",
      "enum": [
        "None",
        "Image Processing",
        "Image Processing + Circle"
      ]
    },
    "image_processing": {
      "description": "The user-provided image processing settings.",
      "$ref": "imatest-straylight-settings-mask-image-processing.schema"
    },
    "radius": {
      "description": "The user-provided radius settings.",
      "$ref": "imatest-straylight-settings-mask-radius.schema"
    }
  },
  "required": [
    "type"
  ],
  "unevaluatedProperties": false
}

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-mask-image-processing.schema",
  "title": "Mask Settings: Image Processing",
  "description": "The user-provided source masking settings for the image processing method.",
  "type": "object",
  "properties": {
    "level_threshold_type": {
      "description": "The user-provided level threshold type.",
      "type": "string",
      "enum": [
        "Value",
        "Percentage of Max",
        "Otsu's Method"
      ]
    },
    "level_threshold_value_DN": {
      "description": "The user-provided level threshold in digital numbers.",
      "type": "number"
    },
    "level_threshold_percent": {
      "description": "The user-provided level threshold as a percent of the maximum value.",
      "type": "number"
    },
    "minimum_source_level_DN": {
      "description": "The user-provided minimum level considered to be the image of the source.",
      "type": "integer"
    },
    "image_close_radius_px": {
      "description": "The user-provided image closing radius in pixels.",
      "type": "integer"
    },
    "multiple_cc_strategy": {
      "description": "The user-provided strategy for dealing with multiple connected components.",
      "type": "string",
      "enum": [
        "Don't Mask",
        "Pick Biggest",
        "Pick Smallest"
      ]
    },
    "mask_area_threshold_px": {
      "description": "The user-provided mimimum area of a connected component.",
      "type": "number"
    }
  },
  "required": [
    "level_threshold_type",
    "minimum_source_level_DN",
    "image_close_radius_px",
    "multiple_cc_strategy",
    "mask_area_threshold_px"
  ],
  "unevaluatedProperties": false
}

Used In

Mask Settings: Radius

Description

The user-provided radius source masking settings.

Result Field(s)

Title Description Validation Included In JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Radius The user-provided radius of the light source in pixels.  
  • JSON
  • CSV
  • HDF5
radius_px number Radius [px] /Radius  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-mask-radius.schema",
  "title": "Mask Settings: Radius",
  "description": "The user-provided radius source masking settings.",
  "type": "object",
  "properties": {
    "radius_px": {
      "description": "The user-provided radius of the light source in pixels.",
      "type": "number"
    }
  },
  "required": [
    "radius_px"
  ],
  "unevaluatedProperties": false
}

Used In

Normalization Settings

Description

The user-provided settings for computing the normalization factor.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-normalization.schema",
  "title": "Normalization Settings",
  "description": "The user-provided settings for computing the normalization factor.",
  "type": "object",
  "properties": {
    "type": {
      "description": "The user-provided normalization method.",
      "type": "string",
      "enum": [
        "None",
        "Level",
        "Direct Reference Image",
        "Lambertian Reference Image"
      ]
    },
    "level": {
      "description": "The user-provided level normalization settings.",
      "$ref": "imatest-straylight-settings-normalization-level.schema"
    },
    "direct_reference_image": {
      "description": "The user-provided direct reference image normalization settings.",
      "$ref": "imatest-straylight-settings-normalization-direct-reference-image.schema"
    },
    "lambertian_reference_image": {
      "description": "The user-provided Lambertian reference image normalization settings.",
      "$ref": "imatest-straylight-settings-normalization-lambertian-reference-image.schema"
    },
    "reference_mask": {
      "description": "The user-provided reference image masking settings.",
      "$ref": "imatest-straylight-settings-mask.schema"
    }
  },
  "required": [
    "type"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Reference Image The user-provided image file used for an on-axis normalization.
  • JSON
  • CSV
  • HDF5
reference_image object Reference Image Filename
Reference Image MD5
/Reference Image
  • 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
  • CSV
  • HDF5
aggregation string Aggregation /Aggregation  
Camera Normalization Compensation The user-provided camera normalization compensation settings.
  • JSON
  • CSV
  • HDF5
camera_normalization_compensation object [Camera Normalization Compensation] /Camera Normalization Compensation  
Source Normalization Compensation The user-provided light source normalization compensation settings.
  • JSON
  • CSV
  • HDF5
source_normalization_compensation object [Source Normalization Compensation] /Source Normalization Compensation  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-normalization-direct-reference-image.schema",
  "title": "Direct Reference Image Settings",
  "description": "The user-provided settings for computing the normalization factor from a reference image of the direct source.",
  "type": "object",
  "properties": {
    "reference_image": {
      "description": "The user-provided image file used for an on-axis normalization.",
      "$ref": "imatest-common-filename-md5.schema"
    },
    "aggregation": {
      "description": "The user-provided aggregation method used to compute the normalization factor.",
      "type": "string",
      "enum": [
        "Mean",
        "Median",
        "Total"
      ]
    },
    "camera_normalization_compensation": {
      "description": "The user-provided camera normalization compensation settings.",
      "$ref": "imatest-straylight-settings-normcomp-camera.schema"
    },
    "source_normalization_compensation": {
      "description": "The user-provided light source normalization compensation settings.",
      "$ref": "imatest-straylight-settings-normcomp-direct-source.schema"
    }
  },
  "required": [
    "reference_image",
    "aggregation",
    "camera_normalization_compensation",
    "source_normalization_compensation"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Light Measurement Type The user-provided type of light measurement.
  • Enumeration Members:
    • Radiometric
    • Photometric
  • JSON
  • CSV
  • HDF5
light_measurement_type string Light Measurement Type /Light Measurement Type  
Luminance From Lambertian Diffuser The luminance [cd/m²] from the Lambertian diffuser in the reference image.  
  • JSON
  • CSV
  • HDF5
luminance_from_lambertian_diffuser_cd_per_m2 number Luminance From Lambertian Diffuser [cd/m²] /Luminance From Lambertian Diffuser
  • Conditional
Illuminance At The Camera Location The illuminance [lux] at the location of the camera for the test image(s).  
  • JSON
  • CSV
  • HDF5
illuminance_at_the_camera_location_lux number Illuminance At The Camera Location [lux] /Illuminance At The Camera Location
  • Conditional
Radiance From Lambertian Diffuser The measured radiance [W/m²/sr] from the Lambertian diffuser in the reference image.  
  • JSON
  • CSV
  • HDF5
radiance_from_lambertian_diffuser_W_per_m2_per_sr number Radiance From Lambertian Diffuser [W/m²/sr] /Radiance From Lambertian Diffuser
  • Conditional
Irradiance At The Camera Location The measured irradiance [W/m²] at the location of the camera for the test image(s).  
  • JSON
  • CSV
  • HDF5
irradiance_at_the_camera_location_W_per_m2 number Irradiance At The Camera Location [W/m²] /Irradiance At The Camera Location
  • Conditional

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-normalization-lambertian-light-measurement.schema",
  "title": "Lambertian Light Level Measurement",
  "description": "The user-provided measurement of light levels for Lambertian image normalization.",
  "type": "object",
  "properties": {
    "light_measurement_type": {
      "description": "The user-provided type of light measurement.",
      "type": "string",
      "enum": [
        "Radiometric",
        "Photometric"
      ]
    },
    "luminance_from_lambertian_diffuser_cd_per_m2": {
      "description": "The luminance [cd/m²] from the Lambertian diffuser in the reference image.",
      "type": "number"
    },
    "illuminance_at_the_camera_location_lux": {
      "description": "The illuminance [lux] at the location of the camera for the test image(s).",
      "type": "number"
    },
    "radiance_from_lambertian_diffuser_W_per_m2_per_sr": {
      "description": "The measured radiance [W/m²/sr] from the Lambertian diffuser in the reference image.",
      "type": "number"
    },
    "irradiance_at_the_camera_location_W_per_m2": {
      "description": "The measured irradiance [W/m²] at the location of the camera for the test image(s).",
      "type": "number"
    }
  },
  "required": [
    "light_measurement_type"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Reference Image The user-provided reference image.
  • JSON
  • CSV
  • HDF5
reference_image object Reference Image Filename
Reference Image MD5
/Reference Image
  • 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
  • CSV
  • HDF5
aggregation string Aggregation /Aggregation  
Light Source Measurements The user-provided measurements used for normalizing data with a Lambertian source.
  • JSON
  • CSV
  • HDF5
light_source_measurements object [Light Source Measurements] /Light Source Measurements  
Camera Normalization Compensation The user-provided information about any camera-side compensation necessary for the reference capture.
  • JSON
  • CSV
  • HDF5
camera_normalization_compensation object [Camera Normalization Compensation] /Camera Normalization Compensation  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-normalization-lambertian-reference-image.schema",
  "title": "Lambertian Reference Image Settings",
  "description": "The user-provided settings for computing the normalization factor from a reference image of a Lambertian source.",
  "type": "object",
  "properties": {
    "reference_image": {
      "description": "The user-provided reference image.",
      "$ref": "imatest-common-filename-md5.schema"
    },
    "aggregation": {
      "description": "The user-provided aggregation method used to compute the normalization factor.",
      "type": "string",
      "enum": [
        "Mean",
        "Median",
        "Total"
      ]
    },
    "light_source_measurements": {
      "description": "The user-provided measurements used for normalizing data with a Lambertian source.",
      "$ref": "imatest-straylight-settings-normalization-lambertian-light-measurement.schema"
    },
    "camera_normalization_compensation": {
      "description": "The user-provided information about any camera-side compensation necessary for the reference capture.",
      "$ref": "imatest-straylight-settings-normcomp-camera.schema"
    }
  },
  "required": [
    "reference_image",
    "aggregation",
    "light_source_measurements",
    "camera_normalization_compensation"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Value The user-provided normalization factor in digital number.  
  • JSON
  • CSV
  • HDF5
value_DN number Value [DN] /Value  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-normalization-level.schema",
  "title": "Stray Light Level-Based Normalization Settings",
  "description": "The user-provided settings for computing the level normalization factor.",
  "type": "object",
  "properties": {
    "value_DN": {
      "description": "The user-provided normalization factor in digital number.",
      "type": "number"
    }
  },
  "required": [
    "value_DN"
  ],
  "unevaluatedProperties": false
}

Used In

Stray Light Reference Image Camera Compensation

Description

The user-provided camera-side compensation measurements.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-normcomp-camera.schema",
  "title": "Stray Light Reference Image Camera Compensation",
  "description": "The user-provided camera-side compensation measurements.",
  "type": "object",
  "properties": {
    "integration_time_ratio": {
      "description": "The user-provided ratio of integration time of the reference capture to the analysis capture(s).",
      "type": "number"
    },
    "gain_ratio": {
      "description": "The user-provided ratio of camera gain of the reference capture to the analysis capture(s).",
      "type": "number"
    }
  },
  "required": [
    "integration_time_ratio",
    "gain_ratio"
  ],
  "unevaluatedProperties": false
}

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 JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Light Level Ratio The user-provided ratio of source light level of the reference capture to the analysis capture(s).  
  • JSON
  • CSV
  • HDF5
light_level_ratio number Light Level Ratio /Light Level Ratio  
Neutral Density The user-provided settings describing the ND filter used for the reference image.
  • JSON
  • CSV
  • HDF5
neutral_density object [Neutral Density] /Neutral Density  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-normcomp-direct-source.schema",
  "title": "Stray Light Reference Image Source Compensation",
  "description": "The user-provided settings for the source-side compensation for a direct image of the source.",
  "type": "object",
  "properties": {
    "light_level_ratio": {
      "description": "The user-provided ratio of source light level of the reference capture to the analysis capture(s).",
      "type": "number"
    },
    "neutral_density": {
      "description": "The user-provided settings describing the ND filter used for the reference image.",
      "$ref": "imatest-common-settings-neutral-density.schema"
    }
  },
  "required": [
    "light_level_ratio",
    "neutral_density"
  ],
  "unevaluatedProperties": false
}

Used In

Stray Light Other Calculation Settings

Description

THe user-provided other calculation settings.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-other-calc.schema",
  "title": "Stray Light Other Calculation Settings",
  "description": "THe user-provided other calculation settings.",
  "type": "object",
  "properties": {
    "percentile_ranks": {
      "description": "The user-provided percentile ranks.",
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "count_type": {
      "description": "The user-provided method for reporting count-based metrics.",
      "type": "string",
      "enum": [
        "Number of Pixels",
        "Percent of Pixels"
      ]
    },
    "level_count_thresholds": {
      "description": "The user-provided thresholds to count the number of pixels with worse stray light.",
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "percentile_ranks",
    "count_type",
    "level_count_thresholds"
  ],
  "unevaluatedProperties": false
}

Used In

Stray Light Count Plot Settings

Description

The user-provided settings for count plots.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-plot-count.schema",
  "title": "Stray Light Count Plot Settings",
  "description": "The user-provided settings for count plots.",
  "type": "object",
  "properties": {
    "save_or_display": {
      "description": "The user-provided settings for how to save/display the plot.",
      "type": "array",
      "items": {
        "$ref": "imatest-common-settings-figure-save-display-enum.schema"
      }
    },
    "channel_grouping": {
      "description": "The user-provided grouping of channel data on the plot.",
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "All Channels On Same Plot",
          "Each Channel On Separate Plot"
        ]
      }
    },
    "named_data": {
      "description": "The user-provided selection of which named data to include on the plot.",
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "Total Count",
          "Source Count",
          "Saturation Count"
        ]
      }
    },
    "include_level_counts": {
      "description": "The user-provided option to include level-count data on the plot.",
      "type": "boolean"
    },
    "per_plot_scaling": {
      "description": "The user-provided option for how each plot is scaled relative to the others.",
      "type": "string",
      "enum": [
        "Global",
        "Per Subset",
        "Per Image"
      ]
    },
    "y_axis_scale": {
      "description": "The user-provided option for how to scale the y-axis.",
      "type": "string",
      "enum": [
        "Linear",
        "Log"
      ]
    }
  },
  "required": [
    "save_or_display",
    "channel_grouping",
    "named_data",
    "include_level_counts",
    "per_plot_scaling",
    "y_axis_scale"
  ],
  "unevaluatedProperties": false
}

Used In

Stray Light Level Plot

Description

The user-provided settings for level plots.

Result Field(s)

Title Description Validation Included In JSON Key JSON Type CSV Key HDF5 Dataset Note(s)
Save Or Display The user-provided settings for how to save/display the plot.
  • JSON
  • CSV
  • HDF5
save_or_display array of string Save Or Display /Save Or Display  
Channel Grouping The user-provided grouping of channel data on the plot.
  • Enumeration Members:
    • All Channels On Same Plot
    • Each Channel On Separate Plot
  • JSON
  • CSV
  • HDF5
channel_grouping array of string Channel Grouping /Channel Grouping  
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
  • CSV
  • HDF5
named_data array of string Named Data /Named Data  
Include Percentiles The user-provided option to include percentile data on the plot.  
  • JSON
  • CSV
  • HDF5
include_percentiles boolean Include Percentiles /Include Percentiles  
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
  • CSV
  • HDF5
per_plot_scaling string Per Plot Scaling /Per Plot Scaling  
Y Axis Scale The user-provided option for how to scale the y-axis.
  • Enumeration Members:
    • Linear
    • Log
  • JSON
  • CSV
  • HDF5
y_axis_scale string Y Axis Scale /Y Axis Scale  

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-plot-level.schema",
  "title": "Stray Light Level Plot",
  "description": "The user-provided settings for level plots.",
  "type": "object",
  "properties": {
    "save_or_display": {
      "description": "The user-provided settings for how to save/display the plot.",
      "type": "array",
      "items": {
        "$ref": "imatest-common-settings-figure-save-display-enum.schema"
      }
    },
    "channel_grouping": {
      "description": "The user-provided grouping of channel data on the plot.",
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "All Channels On Same Plot",
          "Each Channel On Separate Plot"
        ]
      }
    },
    "named_data": {
      "description": "The user-provided selection of which named data to include on the plot.",
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "Minimum",
          "Minimum (Non-0)",
          "Maximum",
          "Mean",
          "Median",
          "RMS",
          "Standard Deviation"
        ]
      }
    },
    "include_percentiles": {
      "description": "The user-provided option to include percentile data on the plot.",
      "type": "boolean"
    },
    "per_plot_scaling": {
      "description": "The user-provided option for how each plot is scaled relative to the others.",
      "type": "string",
      "enum": [
        "Global",
        "Per Subset",
        "Per Image"
      ]
    },
    "y_axis_scale": {
      "description": "The user-provided option for how to scale the y-axis.",
      "type": "string",
      "enum": [
        "Linear",
        "Log"
      ]
    }
  },
  "required": [
    "save_or_display",
    "channel_grouping",
    "named_data",
    "include_percentiles",
    "per_plot_scaling",
    "y_axis_scale"
  ],
  "unevaluatedProperties": false
}

Used In

Stray Light Plotting Settings

Description

The user-provided settings for plotting.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-plots.schema",
  "title": "Stray Light Plotting Settings",
  "description": "The user-provided settings for plotting.",
  "type": "object",
  "properties": {
    "plot_type": {
      "description": "The user-provided settings for the file format(s) to save plots as.",
      "type": "array",
      "items": {
        "$ref": "imatest-common-settings-figure-save-type-enum.schema"
      }
    },
    "level_plot": {
      "description": "The user-provided level-plot settings.",
      "$ref": "imatest-straylight-settings-plot-level.schema"
    },
    "count_plot": {
      "description": "The user-provided count-plot settings.",
      "$ref": "imatest-straylight-settings-plot-count.schema"
    }
  },
  "required": [
    "plot_type",
    "level_plot",
    "count_plot"
  ],
  "unevaluatedProperties": false
}

Used In

Histogram Video Stats

Description

THe user-provided settings for saving histograms.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-video-histogram.schema",
  "title": "Histogram Video Stats",
  "description": "THe user-provided settings for saving histograms.",
  "type": "object",
  "properties": {
    "video_types": {
      "description": "The user-provided format(s) for saving a video.",
      "type": "array",
      "items": {
        "$ref": "imatest-common-settings-video-formats-enum.schema"
      }
    },
    "image_types": {
      "description": "The user-provided format(s) for saving each frame of the video.",
      "type": "array",
      "items": {
        "$ref": "imatest-common-settings-image-frame-formats-enum.schema"
      }
    },
    "frame_rate_fps": {
      "description": "The user-provided frame rate in frames per second.",
      "type": "number"
    },
    "y_max_type": {
      "description": "The user-provided method for determining the maximum y value.",
      "type": "string",
      "enum": [
        "Automatic",
        "User-defined"
      ]
    },
    "y_max_value_px": {
      "description": "The user-provided maximum y value.",
      "type": "number"
    }
  },
  "required": [
    "video_types",
    "image_types",
    "y_max_type"
  ],
  "unevaluatedProperties": false
}

Used In

Colormapped Metric Image

Description

The user-provided settings for saving colormapped metric images.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-video-metric-image.schema",
  "title": "Colormapped Metric Image",
  "description": "The user-provided settings for saving colormapped metric images.",
  "type": "object",
  "properties": {
    "video_types": {
      "description": "The user-provided format(s) for saving a video.",
      "type": "array",
      "items": {
        "$ref": "imatest-common-settings-video-formats-enum.schema"
      }
    },
    "image_types": {
      "description": "The user-provided format(s) for saving each frame of the video.",
      "type": "array",
      "items": {
        "$ref": "imatest-common-settings-image-frame-formats-enum.schema"
      }
    },
    "frame_rate_fps": {
      "description": "The user-provided frame rate in frames per second.",
      "type": "number"
    },
    "data_transform": {
      "description": "The user-provided data transform.",
      "$ref": "imatest-stray-light-settings-data-transform-enum.schema",
      "$comment": "This only has an effect if the calculation data transform is linear."
    }
  },
  "required": [
    "video_types",
    "image_types",
    "data_transform"
  ],
  "unevaluatedProperties": false
}

Used In

Stray Light Video Settings

Description

The user-provided settings saving batch outputs.

Result Field(s)

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "imatest-straylight-settings-videos.schema",
  "title": "Stray Light Video Settings",
  "description": "The user-provided settings saving batch outputs.",
  "type": "object",
  "properties": {
    "metric_image": {
      "description": "The user-provided settings for saving color-mapped metric images.",
      "$ref": "imatest-straylight-settings-video-metric-image.schema"
    },
    "histogram": {
      "description": "The user-provided settings for saving histogram videos.",
      "$ref": "imatest-straylight-settings-video-histogram.schema"
    }
  },
  "required": [
    "metric_image",
    "histogram"
  ],
  "unevaluatedProperties": false
}

Used In