Stray Light (Flare) Documentation

Stray Light (Flare) Settings

Current Documentation

All documentation versions


Stray light (flare) documentation pages

Introduction: Intro to stray light testing and normalized stray light | Outputs from Imatest stray light analysis | History

Background: Examples of stray light | Root Causes | Test overview | Test factors | Test Considerations | Glossary

Calculations: Metric image | Normalization methods | Light source mask methods | Summary Metrics | Analysis Channels | Saturation

Instructions: High-level Imatest analysis instructions (Master and IT) | Computing normalized stray light with Imatest | Motorized Gimbal instructions

Settings: Settings list and INI keys/values | Standards and Recommendations | Configuration file input



This page provides a list and description of the settings for Imatest stray light source analysis, as well as corresponding INI field-value pairs.

Settings Contents

Settings Sections

Enumerations

Settings Sections

Stray Light Source

Description

Settings for analyzing image(s) of a stray light source.

Settings

Setting Description Default Options/Value Type INI Key Notes
Memory Usage Option for how to prioritize memory or speed when performing an analysis. Low Memory 
[straylight] memory_mode

Sub-Sections

Sub-Section Description Notes
Calculation Calculation settings.
Batch Outputs Settings for saving stray light batch outputs.

Calculation

Description

Calculation settings.

Sub-Sections

Sub-Section Description Notes
Core Calculation Core calculation settings.
Saturation Settings for how to calculate the saturation level.
Channel Settings for selecting which channels to analyze.
Normalization Settings for performing stray light normalization.
Analysis Image Mask Settings for creating a mask the analysis images(s).
Spatial Calculation Spatial stray light calculation settings.
Metadata Settings about metadata for the stray light run.
Extra Calculation Miscellaneous stray light calculation settings.

Used In

Stray Light Source

Batch Outputs

Description

Settings for saving stray light batch outputs.

Sub-Sections

Sub-Section Description Notes
Image Outputs What image outputs to save.
Plot Save/Display Settings for the saving or displaying of plots.
Video Settings for saving videos/image sequences.
Result Files Select which result file(s) to save.
Save Location Select where to save the result file(s).

Used In

Stray Light Source

Core Calculation

Description

Core calculation settings.
See the metric image calculations documentation page for more details on these settings.

Settings

Setting Description Default Options/Value Type INI Key Notes
Calculation Type The type of stray light calculation. Transmission 
[straylight] calculation
Data Transform The transform applied to the data. Linear 
[straylight] data_transform
Dark Level The dark level of the image(s) in digital numbers (DNs). 0
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] dark_level_dn
  • Units: DN
Clip To One Enable to clip image values to one (image values are clipped to zero if disabled). This prevents infinite stray light in attenuation calculations and logarithm-based data transforms. false
  • Setting Type: Boolean
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] clip_to_one

Used In

Calculation

Saturation

Description

Settings for how to calculate the saturation level.

Settings

Setting Description Default Options/Value Type INI Key Notes
Measurement Type The type of saturation measurement to perform. Container Max
  • Setting Type: Saturation Specification Enumeration (excluding: Classic, ITU-R BT.601)
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] saturation_method
Value The saturation value for the image(s) in digital numbers. 65535
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] saturation_user_value
  • Units: DN
  • The use of this field is contingent on the value of Measurement Type.
Bit Depth The saturation value for the image(s) as a bit depth. 16
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] saturation_user_bit_depth
  • Units: bits
  • The use of this field is contingent on the value of Measurement Type.

Used In

Calculation

Channel

Description

Settings for selecting which channels to analyze.
See the analysis channels documentation page for more details on these settings.

Settings

Setting Description Default Options/Value Type INI Key Notes
Analysis Channel(s) Select the channels to analyze. Automatic 
[straylight] channel_type
Luminance Type The luminance calculation to use. IEC 61966-2-1 
[straylight] channel_lum_type
  • The use of this field is contingent on the value of Analysis Channel(s).
Custom RGB Weights The luminance calculation to use. [0.33333, 0.33333, 0.33333]
  • Setting Type: Number
  • Setting Size: Fixed-Length Array (3 items)
  • INI Type: Float
  • INI Size: Array
 
[straylight] channel_lum_custom_rgb_weights
  • Order:

    Red, Green, Blue

  • The use of this field is contingent on the value of Analysis Channel(s).
  • The use of this field is contingent on the value of Luminance Type.
RGB Order The order of the channels. Red, Green, Blue 
[straylight] channel_rgb_order
  • The use of this field is contingent on the value of Analysis Channel(s).
Statistics Select the statistic to use. Mean 
[straylight] channel_stats_type
  • The use of this field is contingent on the value of Analysis Channel(s).

Used In

Calculation

Normalization

Description

Settings for performing stray light normalization.
See the normalization documentation page for a description of these methods.

Settings

Setting Description Default Options/Value Type INI Key Notes
Normalization Type The type of normalization to perform. None 
[straylight] normalization

Sub-Sections

Sub-Section Description Notes
Level Additional settings for level-based normalization.
  • The use of this field is contingent on the value of Normalization Type.
Direct Image Additional settings for direct image-based normalization.
  • The use of this field is contingent on the value of Normalization Type.
Lambertian Image Additional settings for Lambertian image-based normalization.
  • The use of this field is contingent on the value of Normalization Type.
Reference Image Source Detection Settings for detecting the light source for the reference image(s).
  • The use of this field is contingent on the value of Normalization Type.

Used In

Calculation

Analysis Image Mask

Description

Settings for creating a mask the analysis images(s).
See the stray light masking documentation page for more details on these settings.

Settings

Setting Description Default Options/Value Type INI Key Notes
Mask Method The methodology for identifying where the light source is in the image. None
  • Setting Type: Stray Light: Mask Method Enumeration (excluding: Manually-specified Circle)
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] mask_method

Sub-Sections

Sub-Section Description Notes
Image Processing Settings for image-processing-based masking.
  • The use of this field is contingent on the value of Mask Method.
Geometric Calibration Mask the source via a geometric camera calibration model.
  • The use of this field is contingent on the value of Mask Method.
Circle Radius The circular radius settings.
  • The use of this field is contingent on the value of Mask Method.

Used In

Calculation

Spatial Calculation

Description

Spatial stray light calculation settings.

Sub-Sections

Sub-Section Description Notes
Downsampling Settings for downsampling an image for analysis.
Crop Settings for cropping an image.

Used In

Calculation

Metadata

Description

Settings about metadata for the stray light run.
The following options provide an alternative to the stray light configuration file for defining capture metadata. The alternate approach uses regular expression to parse the image filename and extract metadata that would otherwise come from the config file. If enabled, the regular-expression-derived metadata will have precedence over metadata from a configuration file.

Settings

Setting Description Default Options/Value Type INI Key Notes
Filename Regular Expression Method The regular expression method to apply to the filename. None 
[straylight] file_regex_method
Filename Regular Expression A regular expression to apply to a filename and extract metadata.
  • Setting Type: String
  • Setting Size: Scalar
  • INI Type: String
  • INI Size: Scalar
 
[straylight] file_regex
  • The use of this field is contingent on the value of Filename Regular Expression Method.
Decimal Point A character representing the decimal place. .
  • Setting Type: String
  • Setting Size: Scalar
  • INI Type: String
  • INI Size: Scalar
 
[straylight] decimal_place
  • The use of this field is contingent on the value of Filename Regular Expression Method.

Example Numeric Regular Expressions

The following are example regular expressions for matching numbers. Note that named capture groups are required to associate the extracted string with a particular field.

Regular Expression Description 
\d+
Matches positive integers 
[0-9]+
Matches positive integers 
-?\d+
Matches positive or negative integers 
-?[0-9]+
Matches positive or negative integers 
[+-]?\d+(?:\.\d+)?
Matches decimal numbers with at least one digit to the left of the decimal (i.e., will not match .1) 
[+-]?\d+(?:\.\d+)?(?:[Ee][+-]?\d+)?
Matches decimal numbers with at least one digit to the left of the decimal including those using “E” scientific notation (i.e., will not match .2E-7)

Example Settings

The following are example settings and what values will be extracted from the filename.

Regular Expression Decimal C://path/to/az0.2_fa-4.6.png \path\to\camera123\field20_azimuth32.tiff C://path/to/camera123/az0p2_fa-4p6.png 
fa(?-?\d+(?:\.\d*)?)

.
  • Field Angle: -4.6
  • Azimuth Angle: (no match)
  • Comment: (no match)
  • Field Angle: (no match)
  • Azimuth Angle: (no match)
  • Comment: (no match)
  • Field Angle: (no match)
  • Azimuth Angle: (no match)
  • Comment: (no match)
 
field(?-?\d+)_azimuth(?-?\d+)

.
  • Field Angle: (no match)
  • Azimuth Angle: (no match)
  • Comment: (no match)
  • Field Angle: 20
  • Azimuth Angle: 32
  • Comment: (no match)
  • Field Angle: (no match)
  • Azimuth Angle: (no match)
  • Comment: (no match)
 
(?[A-Za-z0-9 ]+)\/az(?-?\d+(?:p\d*)?)_fa(?-?\d+(?:p\d*)?)

p
  • Field Angle: (no match)
  • Azimuth Angle: (no match)
  • Comment: (no match)
  • Field Angle: (no match)
  • Azimuth Angle: (no match)
  • Comment: (no match)
  • Field Angle: -4.6
  • Azimuth Angle: 0.2
  • Comment: camera123

Regular Expression Notes

Generic Regular Expression Notes

  • AI utilities may help to construct a regular expression.
  • Testing the regular expression with utilities such as regex101.com is recommended.

Metadata Extraction Regular Expression Notes

  • Having a consistent filename format will help make a reusable regular expression.
  • With the current architecture, the entire regex must match to extract any metadata (there is no partial extraction).

Used In

Calculation

Extra Calculation

Description

Miscellaneous stray light calculation settings.

Settings

Setting Description Default Options/Value Type INI Key Notes
Percentile Ranks The percentile ranks [0-100] (e.g., 95 = 95th percentile). [95]
  • Setting Type: Number
  • Setting Size: Variable-Length Array (0 or more items)
  • INI Type: Float
  • INI Size: Array
 
[straylight] percentile_ranks100
Count Type The format of the level count-based summary metrics. Percent of Pixels 
[straylight] count_type
Level Count Thresholds The thresholds of stray light level for producing results that show the number of pixels worse than said threshold. []
  • Setting Type: Number
  • Setting Size: Variable-Length Array (0 or more items)
  • INI Type: Float
  • INI Size: Array
 
[straylight] level_count_thresh

Used In

Calculation

Image Outputs

Description

What image outputs to save.

Settings

Setting Description Default Options/Value Type INI Key Notes
Save Mask Enable to save out a FITS file containing the mask of the source for each image. false
  • Setting Type: Boolean
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] save_mask
Save Metric Image Enable to save out a FITS file containing the metric image(s). true
  • Setting Type: Boolean
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] save_metric_image

Used In

Batch Outputs

Plot Save/Display

Description

Settings for the saving or displaying of plots.

Settings

Setting Description Default Options/Value Type INI Key Notes
Plot Type The file format(s) to save the plots. [PNG]
  • Setting Type: Plot Save Format Enumeration
  • Setting Size: Variable-Length Array (1 or more items)
  • INI Type: Integer
  • INI Size: Array
 
[straylight] plot_save_types

Sub-Sections

Sub-Section Description Notes
Level Plot Options for creating plots based on the stray light level.
Count Plot Options for creating plots based on the number of pixels.
Diagnostic Plots Options for creating diagnostic plots.

Used In

Batch Outputs

Video

Description

Settings for saving videos/image sequences.

Sub-Sections

Sub-Section Description Notes
Colormapped Metric Image Options for saving a colormapped metric image.
Histogram Options for saving histogram images/video(s).

Used In

Batch Outputs

Result Files

Description

Select which result file(s) to save.

Settings

Setting Description Default Options/Value Type INI Key Notes
Summary Results Types The file type(s) to save summary results as. [JSON] 
[straylight] result_save_types

Used In

Batch Outputs

Save Location

Description

Select where to save the result file(s).

Settings

Setting Description Default Options/Value Type INI Key Notes
Save In Image Folder? Save in the image folder or a custom folder. true
  • Setting Type: Boolean
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] save_in_image_folder
Save Subfolder The sub-folder of the image folder to save the result(s) in. Leave empty to save in image folder. Results
  • Setting Type: String
  • Setting Size: Scalar
  • INI Type: String
  • INI Size: Scalar
 
[straylight] save_subfolder
  • The use of this field is contingent on the value of Save In Image Folder?.
Custom Save Folder The folder where to save the result(s).
  • Setting Type: Folder Path
  • Setting Size: Scalar
  • INI Type: String
  • INI Size: Scalar
 
[straylight] custom_save_folder
  • The use of this field is contingent on the value of Save In Image Folder?.
Use image name as basename? Enable to use the image filename as the root filename. true
  • Setting Type: Boolean
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] use_image_as_root
Custom Root Filename The custom root name of the result file(s).
  • Setting Type: String
  • Setting Size: Scalar
  • INI Type: String
  • INI Size: Scalar
 
[straylight] custom_root_filename
  • The use of this field is contingent on the value of Use image name as basename?.
Open Results Folder Enable to open the save folder at the end of each analysis run. true
  • Setting Type: Boolean
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] open_save_folder

Used In

Batch Outputs

Level

Description

Additional settings for level-based normalization.
The following options apply if the normalization method is Level. See the normalization documentation page for a description of the Level normalization method.

Settings

Setting Description Default Options/Value Type INI Key Notes
Normalization Level The normalization level in digital numbers (DNs). 1
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] norm_level_value

Used In

Normalization

Direct Image

Description

Additional settings for direct image-based normalization.
The following options apply if the normalization method is Direct Reference Image. See the normalization documentation page for a description of the Direct Reference Image normalization method.

Settings

Setting Description Default Options/Value Type INI Key Notes
Reference Image File(s) The fully-qualified path to the reference image file(s). []
  • Setting Type: String
  • Setting Size: Variable-Length Array
  • INI Type: String
  • INI Size: Array
 
[straylight] norm_refim_files
Normalization Aggregation The methodology for aggregating the masked pixels into a normalization factor. Median 
[straylight] norm_refim_aggregation

Sub-Sections

Sub-Section Description Notes
Source Compensation Settings for compensating for light source differences between the reference and test image.
Camera Compensation Settings for compensating for camera state differences between the reference and analysis images.

Used In

Normalization

Lambertian Image

Description

Additional settings for Lambertian image-based normalization.
The following options apply if the normalization method is Direct Reference Image. See the normalization documentation page for a description of the Direct Reference Image normalization method.

Settings

Setting Description Default Options/Value Type INI Key Notes
Reference Image File(s) The fully-qualified path to the reference image file(s). []
  • Setting Type: String
  • Setting Size: Variable-Length Array
  • INI Type: String
  • INI Size: Array
 
[straylight] norm_lrefim_files
Normalization Aggregation The methodology for aggregating the masked pixels into a normalization factor. Mean 
[straylight] norm_lrefim_aggregation

Sub-Sections

Sub-Section Description Notes
Light Source Measurements Information about the light source measurements for Lambertian normalization.
Camera Compensation Settings for compensating for camera state differences between the reference and analysis images.

Used In

Normalization

Reference Image Source Detection

Description

Settings for detecting the light source for the reference image(s).
See the stray light masking documentation page for more details on these settings.

Settings

Setting Description Default Options/Value Type INI Key Notes
Detection Method The methodology for identifying where the light source is in the image. Image Processing
  • Setting Type: Stray Light: Mask Method Enumeration (excluding: None, Geometric Camera Model + Circle)
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] refmask_method

Sub-Sections

Sub-Section Description Notes
Image Processing Settings for image-processing-based masking.
  • The use of this field is contingent on the value of Detection Method.
Circle Center Settings describing the center of a manually-placed circular mask.
  • The use of this field is contingent on the value of Detection Method.
Circle Radius The circular radius settings.
  • The use of this field is contingent on the value of Detection Method.

Used In

Normalization

Image Processing

Description

Settings for image-processing-based masking.
See the stray light masking documentation page for more details on these settings.

Settings

Setting Description Default Options/Value Type INI Key Notes
Level Threshold Type How to threshold the image. Percentage of Max 
[straylight] mask_improc_level_thresh_type
Level Threshold (Value) The threshold above which is considered the image of the light source, in digital numbers. 65535
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] mask_improc_level_threshold
  • Units: DN
  • The use of this field is contingent on the value of Level Threshold Type.
Level Threshold (Percent) The threshold above which is considered the image of the light source, as a percentage of the maximum value. 100
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] mask_improc_level_threshold_pct
  • Units: %
  • The use of this field is contingent on the value of Level Threshold Type.
Minimum Source Level The minimum value that can be considered a direct image of the light source. 1
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] mask_improc_minimum_source_level
  • Units: DN
  • The use of this field is contingent on the value of Level Threshold Type.
Image Close Radius The radius of an image close morphology step. This helps to remove holes in the mask. Set to 0 to skip this step. 5
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] mask_improc_image_close_radius
  • Units: px
Multiple Connected Component Strategy The strategy for how to deal with multiple connected components. Pick Biggest 
[straylight] mask_improc_multiple_cc_strategy
Mask Area Threshold The minimum number of pixels that the image of the light source should be. 1
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] mask_improc_mask_area_threshold
  • Units: px

Used In

Analysis Image Mask

Geometric Calibration

Description

Mask the source via a geometric camera calibration model.

Settings

Setting Description Default Options/Value Type INI Key Notes
Negate Field Angle Enable to negate the field angle. false
  • Setting Type: Boolean
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] mask_geocal_negate_field
Negate Azimuth Angle Enable to negate the azimuth angle. false
  • Setting Type: Boolean
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] mask_geocal_negate_azimuth

Sub-Sections

Sub-Section Description Notes
Geometric Camera Model The settings for describing a geometric calibration model.

Used In

Analysis Image Mask

Circle Radius

Description

The circular radius settings.
See the stray light masking documentation page for more details on these settings.

Settings

Setting Description Default Options/Value Type INI Key Notes
Method The method for determining the radius. User-Specified 
[straylight] mask_2pcr_radius_type
Radius The radius in pixels. 10
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] mask_2pcr_radius
  • Units: px
  • The use of this field is contingent on the value of Method.
Camera Pixel Pitch The pixel pitch of the camera in μm. 5
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] mask_2pcr_radius_dut_pp
  • Units: μm
  • The use of this field is contingent on the value of Method.
Camera Focal Length The focal length of the camera in mm. 10
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] mask_2pcr_radius_dut_fl
  • Units: mm
  • The use of this field is contingent on the value of Method.
Source Focal Length The focal length of the light source in mm. 100
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] mask_2pcr_radius_col_fl
  • Units: mm
  • The use of this field is contingent on the value of Method.
Source Diameter The diameter of the light source in mm. 25
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] mask_2pcr_radius_col_dia
  • Units: mm
  • The use of this field is contingent on the value of Method.

Used In

Analysis Image Mask

Downsampling

Description

Settings for downsampling an image for analysis.

Settings

Setting Description Default Options/Value Type INI Key Notes
Size Measurement The method for determining the size of the down-sampled image. Full Resolution 
[straylight] downsample_size_type
Factor The factor by which the image will be downsampled. 1
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] downsample_factor
  • The use of this field is contingent on the value of Size Measurement.
Output Image Size The desired output image size. [1024, 1024]
  • Setting Type: Number
  • Setting Size: Fixed-Length Array (2 items)
  • INI Type: Integer
  • INI Size: Array
 
[straylight] downsample_image_size
  • Order:

    # Cols, # Rows

  • The use of this field is contingent on the value of Size Measurement.
Row Count The number of rows in the in downsampled image. 1024
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] downsample_rows
  • The use of this field is contingent on the value of Size Measurement.
Column Count The number of columns in the output image. 1024
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] downsample_cols
  • The use of this field is contingent on the value of Size Measurement.

Used In

Spatial Calculation

Crop

Description

Settings for cropping an image.

Settings

Setting Description Default Options/Value Type INI Key Notes
Crop The number of pixels to crop off the left, right, top, and bottom of the image. [0, 0, 0, 0]
  • Setting Type: Number
  • Setting Size: Fixed-Length Array (4 items)
  • INI Type: Float
  • INI Size: Array
 
[straylight] crop_lrtb
  • Order:

    Left, Right, Top, Bottom

  • Units: px

Used In

Spatial Calculation

Level Plot

Description

Options for creating plots based on the stray light level.
Note: level plots require two or more test images.

Settings

Setting Description Default Options/Value Type INI Key Notes
Save/Display Save or display the level plot(s). [Save]
  • Setting Type: Save/Display Plot Enumeration
  • Setting Size: Variable-Length Array
  • INI Type: Integer
  • INI Size: Array
 
[straylight] level_plot_save_display
Channel Grouping How to group the data within a plot. At least one is required to produce this plot. [All Channels On The Same Plot] 
[straylight] level_plot_channel_grouping
  • The use of this field is contingent on the value of Save/Display.
Named Data The data to plot on level summary plot(s). [Mean, Maximum] 
[straylight] level_plot_include_named_data
  • The use of this field is contingent on the value of Save/Display.
  • The use of this field is contingent on the value of Include Percentiles.
Include Percentiles Enable to include percentiles on the level summary plot(s). true
  • Setting Type: Boolean
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] level_plot_include_pctls
  • The use of this field is contingent on the value of Save/Display.
  • The use of this field is contingent on the value of Named Data.
Per Plot Scaling The scaling of the y-axis of the level plots relative to each other. Global 
[straylight] level_plot_per_plot_scaling
  • The use of this field is contingent on the value of Save/Display.
Y-Axis Scale The scaling of the y-axis of the plot. Linear
  • Setting Type: Axis Scaling Enumeration
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] level_plot_y_axis_scale
  • The use of this field is contingent on the value of Save/Display.

Used In

Plot Save/Display

Count Plot

Description

Options for creating plots based on the number of pixels.
Note: count plots require two or more test images.

Settings

Setting Description Default Options/Value Type INI Key Notes
Save/Display Save or display the count plot(s). [Save]
  • Setting Type: Save/Display Plot Enumeration
  • Setting Size: Variable-Length Array
  • INI Type: Integer
  • INI Size: Array
 
[straylight] count_plot_save_display
Channel Grouping How to group the data within a plot. At least one is required to produce this plot. [All Channels On The Same Plot] 
[straylight] count_plot_channel_grouping
  • The use of this field is contingent on the value of Save/Display.
Named Data The data to plot on count summary plot(s). [Source Count, Saturation Count] 
[straylight] count_plot_include_named_data
  • The use of this field is contingent on the value of Save/Display.
  • The use of this field is contingent on the value of Include Level Counts.
Include Level Counts Enable to include the number of pixels worse than user-provided thresholds on the count plot(s).). true
  • Setting Type: Boolean
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] count_plot_include_level_counts
  • The use of this field is contingent on the value of Save/Display.
  • The use of this field is contingent on the value of Named Data.
Per Plot Scaling The scaling of the y-axis of the count plots relative to each other. Global 
[straylight] count_plot_per_plot_scaling
  • The use of this field is contingent on the value of Save/Display.
Y-Axis Scale The scaling of the y-axis of the plot. Log
  • Setting Type: Axis Scaling Enumeration
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] count_plot_y_axis_scale
  • The use of this field is contingent on the value of Save/Display.

Used In

Plot Save/Display

Diagnostic Plots

Description

Options for creating diagnostic plots.

Settings

Setting Description Default Options/Value Type INI Key Notes
Save/Display Reference Image Detection Plot Save or display the reference image detection diagnostic plot. [Save]
  • Setting Type: Save/Display Plot Enumeration
  • Setting Size: Variable-Length Array
  • INI Type: Integer
  • INI Size: Array
 
[straylight] reference_detection_diagnostic_plot
Save/Display Analysis Image Mask Plot Save or display the analysis image masking diagnostic plot(s). Display is not recommended. []
  • Setting Type: Save/Display Plot Enumeration
  • Setting Size: Variable-Length Array
  • INI Type: Integer
  • INI Size: Array
 
[straylight] analysis_mask_diagnostic_plot

Used In

Plot Save/Display

Colormapped Metric Image

Description

Options for saving a colormapped metric image.

Settings

Setting Description Default Options/Value Type INI Key Notes
Video Formats The format(s) to save the video as. [] 
[straylight] metric_video_video_formats
Image Formats The image format(s) to save each frame of the video as. [] 
[straylight] metric_video_image_formats
Frame Rate The framerate in frames per second. 10
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] metric_video_frame_rate
  • Units: fps
  • The use of this field is contingent on the value of Video Formats.
Colormapped Image Transform The transform applied to the data when saving a colormapped metric image. Note: This is only used when the data transform is linear. Linear 
[straylight] metric_video_linear_output_scale
  • The use of this field is contingent on the value of Video Formats.
  • The use of this field is contingent on the value of Image Formats.
Colormap The colormap to apply to the metric image. MATLAB parula
  • Setting Type: Colormap Enumeration (excluding: MATLAB lines, MATLAB colorcube, MATLAB prism, MATLAB flag)
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] metric_video_colormap
  • The use of this field is contingent on the value of Video Formats.
  • The use of this field is contingent on the value of Image Formats.
Flip Colormap Enable to flip the order of the colormap. false
  • Setting Type: Boolean
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] metric_video_flip_colormap
  • The use of this field is contingent on the value of Video Formats.
  • The use of this field is contingent on the value of Image Formats.
Display Masked Pixels Enable to display the masked pixels on the color mapped metric image. This significantly slows down the analysis. false
  • Setting Type: Boolean
  • Setting Size: Scalar
  • INI Type: Integer
  • INI Size: Scalar
 
[straylight] metric_video_display_mask
  • The use of this field is contingent on the value of Video Formats.
  • The use of this field is contingent on the value of Image Formats.

Used In

Video

Histogram

Description

Options for saving histogram images/video(s).

Settings

Setting Description Default Options/Value Type INI Key Notes
Video Formats The format(s) to save the video as. [] 
[straylight] hist_video_video_formats
Image Formats The image format(s) to save each frame of the video as. [] 
[straylight] hist_video_image_formats
Frame Rate The framerate in frames per second. 10
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] hist_video_frame_rate
  • Units: fps
  • The use of this field is contingent on the value of Video Formats.
Y-Axis Max Type The method for determining the upper limit for the y-axis of the histogram plots. Automatic 
[straylight] hist_video_ymax_type
  • The use of this field is contingent on the value of Video Formats.
  • The use of this field is contingent on the value of Image Formats.
Y-Axis Max The user-defined maximum value for the y-axis of histograms. 1000000
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] hist_video_ymax_value
  • The use of this field is contingent on the value of Video Formats.
  • The use of this field is contingent on the value of Image Formats.
  • The use of this field is contingent on the value of Y-Axis Max Type.

Used In

Video

Source Compensation

Description

Settings for compensating for light source differences between the reference and test image.

Settings

Setting Description Default Options/Value Type INI Key Notes
Light Level Ratio The ratio of the reference light level divided by the test light level. 1
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] norm_refim_comp_light_level_ratio

Sub-Sections

Sub-Section Description Notes
Neutral Density Settings for quantifying a neutral density filter.

Used In

Direct Image

Camera Compensation

Description

Settings for compensating for camera state differences between the reference and analysis images.

Settings

Setting Description Default Options/Value Type INI Key Notes
Integration Time Ratio The ratio of the reference integration time divided by the test integration time. 1
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] norm_refim_comp_int_time_ratio
Gain Ratio The ratio of the reference gain divided by the test gain. 1
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] norm_refim_comp_gain_ratio

Used In

Direct Image

Light Source Measurements

Description

Information about the light source measurements for Lambertian normalization.

Settings

Setting Description Default Options/Value Type INI Key Notes
Light Measurement Units The type of measurement of the source. Radiometric 
[straylight] norm_lrefim_source_meas_type
Luminance From Lambertian Diffuser The luminance [cd/m²] from the Lambertian diffuser in the reference image. 1
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] norm_lrefim_ref_luminance
  • Units: cd/m²
  • The use of this field is contingent on the value of Light Measurement Units.
Illuminance At The Camera Location The illuminance [lux] at the location of the camera for the test image(s). 1
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] norm_lrefim_illuminance
  • Units: lux
  • The use of this field is contingent on the value of Light Measurement Units.
Radiance From Lambertian Diffuser The measured radiance [W/m²/sr] from the Lambertian diffuser in the reference image. 1
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] norm_lrefim_ref_radiance
  • Units: W/m²/sr
  • The use of this field is contingent on the value of Light Measurement Units.
Irradiance At The Camera Location The measured irradiance [W/m²] at the location of the camera for the test image(s). 1
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] norm_lrefim_irradiance
  • Units: W/m²
  • The use of this field is contingent on the value of Light Measurement Units.

Used In

Lambertian Image

Camera Compensation

Description

Settings for compensating for camera state differences between the reference and analysis images.

Settings

Setting Description Default Options/Value Type INI Key Notes
Integration Time Ratio The ratio of the reference integration time divided by the test integration time. 1
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] norm_lrefim_comp_int_time_ratio
Gain Ratio The ratio of the reference gain divided by the test gain. 1
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] norm_lrefim_comp_gain_ratio

Used In

Lambertian Image

Image Processing

Description

Settings for image-processing-based masking.
See the stray light masking documentation page for more details on these settings.

Settings

Setting Description Default Options/Value Type INI Key Notes
Level Threshold Type How to threshold the image. Otsu’s Method 
[straylight] refmask_improc_level_thresh_type
Level Threshold (Value) The threshold above which is considered the image of the light source, in digital numbers. 65535
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] refmask_improc_level_threshold
  • Units: DN
  • The use of this field is contingent on the value of Level Threshold Type.
Level Threshold (Percent) The threshold above which is considered the image of the light source, as a percentage of the maximum value. 100
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] refmask_improc_level_threshold_pct
  • Units: %
  • The use of this field is contingent on the value of Level Threshold Type.
Image Close Radius The radius of an image close morphology step. This helps to remove holes in the mask. Set to 0 to skip this step. 5
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] refmask_improc_image_close_radius
  • Units: px
Multiple Connected Component Strategy The strategy for how to deal with multiple connected components. Pick Biggest 
[straylight] refmask_improc_multiple_cc_strategy
Mask Area Threshold The minimum number of pixels that the image of the light source should be. 1
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] refmask_improc_mask_area_threshold
  • Units: px

Used In

Reference Image Source Detection

Circle Center

Description

Settings describing the center of a manually-placed circular mask.

Settings

Setting Description Default Options/Value Type INI Key Notes
Method The method for specifying the circle center. Numeric Image Center 
[straylight] refmask_circle_center_type
Image Coordinate System The image coordinate system of the user-provided coordinate. IEEE Std. 2020™ Type IV 
[straylight] refmask_circle_im_coord
  • The use of this field is contingent on the value of Method.
Center Coordinate The center of the circular region for the reference image. [0, 0]
  • Setting Type: Number
  • Setting Size: Fixed-Length Array (2 items)
  • INI Type: Float
  • INI Size: Array
 
[straylight] refmask_circle_custom_center
  • Order:

    x, y

  • The use of this field is contingent on the value of Method.

Used In

Reference Image Source Detection

Circle Radius

Description

The circular radius settings.
See the stray light masking documentation page for more details on these settings.

Settings

Setting Description Default Options/Value Type INI Key Notes
Method The method for determining the radius. User-Specified 
[straylight] refmask_2pcr_radius_type
Radius The radius in pixels. 10
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] refmask_2pcr_radius
  • Units: px
  • The use of this field is contingent on the value of Method.
Camera Pixel Pitch The pixel pitch of the camera in μm. 5
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] refmask_2pcr_radius_dut_pp
  • Units: μm
  • The use of this field is contingent on the value of Method.
Camera Focal Length The focal length of the camera in mm. 10
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] refmask_2pcr_radius_dut_fl
  • Units: mm
  • The use of this field is contingent on the value of Method.
Source Focal Length The focal length of the light source in mm. 100
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] refmask_2pcr_radius_col_fl
  • Units: mm
  • The use of this field is contingent on the value of Method.
Source Diameter The diameter of the light source in mm. 25
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] refmask_2pcr_radius_col_dia
  • Units: mm
  • The use of this field is contingent on the value of Method.

Used In

Reference Image Source Detection

Geometric Camera Model

Description

The settings for describing a geometric calibration model.

Settings

Setting Description Default Options/Value Type INI Key Notes
Model Type The type of camera model. Simple Pinhole 
[straylight] geocal_model_type

Sub-Sections

Sub-Section Description Notes
Image Coordinate System Settings about the image coordinate system.
Intrinsics Settings about the intrisic properties of the camera.
OpenCV Distortion Settings about the OpenCV Distortion properties of the camera.
  • The use of this field is contingent on the value of Model Type.

Used In

Geometric Calibration

Neutral Density

Description

Settings for quantifying a neutral density filter.

Settings

Setting Description Default Options/Value Type INI Key Notes
ND Type The type of ND measurement. None 
[straylight] norm_refim_comp_nd_type
Transmission The transmission (0-100) of the ND filter. 100
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] norm_refim_comp_nd_transmission_value
  • Units: %
  • The use of this field is contingent on the value of ND Type.
Density The density of the ND filter. 0
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] norm_refim_comp_nd_density_value
  • The use of this field is contingent on the value of ND Type.

Used In

Source Compensation

Image Coordianate System

Description

Settings for defining the image coordinate system.

Settings

Setting Description Default Options/Value Type INI Key Notes
Type The type of image coordinate system to use. IEEE Std. 2020™ Type IV 
[straylight] image_coord_type

Used In

Geometric Camera Model

Intrinsics

Description

Settings for the camera intrinsics.

Settings

Setting Description Default Options/Value Type INI Key Notes
Focal Length The focal length in pixels. 1000
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] geocal_intrinsics_f
  • Units: px
Principal Point Type The method for providing the principal point. Numeric Image Center 
[straylight] geocal_intrinsics_pp_type
Principal Point The principal point in the specified coordinate system. [0, 0]
  • Setting Type: Number
  • Setting Size: Fixed-Length Array (2 items)
  • INI Type: Float
  • INI Size: Array
 
[straylight] geocal_intrinsics_user_pp
  • Order:

    x, y

  • The use of this field is contingent on the value of Principal Point Type.
Alpha The ratio of the y focal length to the x focal length. 1
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] geocal_intrinsics_alpha
Skew The skew. 0
  • Setting Type: Number
  • Setting Size: Scalar
  • INI Type: Float
  • INI Size: Scalar
 
[straylight] geocal_intrinsics_skew

Used In

Geometric Camera Model

Geometric Calbiration Model: OpenCV Distortion

Description

Settings for describing the OpenCV distortion model.

Settings

Setting Description Default Options/Value Type INI Key Notes
Radial Coefficients The radial distortion coefficients. [0, 0, 0, 0, 0, 0]
  • Setting Type: Number
  • Setting Size: Fixed-Length Array (6 items)
  • INI Type: Float
  • INI Size: Array
 
[straylight] geocal_opencv_distortion_radial
  • Order:

    k₁, k₂, k₃, k₄, k₅, k₆
Tangential Coefficients The tangential distortion coefficients. [0, 0]
  • Setting Type: Number
  • Setting Size: Fixed-Length Array (2 items)
  • INI Type: Float
  • INI Size: Array
 
[straylight] geocal_opencv_distortion_tangential
  • Order:

    p₁, p₂
Thin-Prism Coefficients The thin-prism distortion coefficients. [0, 0, 0, 0]
  • Setting Type: Number
  • Setting Size: Fixed-Length Array (4 items)
  • INI Type: Float
  • INI Size: Array
 
[straylight] geocal_opencv_distortion_thin_prism
  • Order:

    s₁, s₂, s₃, s₄
Tilt Coefficients The tilt distortion coefficients. [0, 0]
  • Setting Type: Number
  • Setting Size: Fixed-Length Array (2 items)
  • INI Type: Float
  • INI Size: Array
 
[straylight] geocal_opencv_distortion_tilt
  • Order:

    τx, τy

  • Units: rad

Used In

Geometric Camera Model

Enumerations

Analysis Channel: Channel Selection Types

Description

Common types of collections of analysis channels.

Options

Option Description INI Value
Automatic Automatically choose analysis channel(s). 0
Each Channel Analyze each channel in the image. 1
RGB Analyze each RGB channel. 2
Monochrome Analyze a single channel as monochrome. 3
Statistics Analyze a statistic of the provided channels. 4
Luminance Analyze the computed luminance channel. 5
RGB + Luminance Analyze each RGB channel and the computed luminance channel. 6

Used In

Analysis Channel: Luminance Channel Standards

Description

The standards for computing a luminance channel from RGB images.

Options

Option Description INI Value
IEC 61966-2-1 RGB Weights: 0.2126, 0.7152, 0.0722. These are the same weights as ITU-R BT.709-6. 1
ITU-R BT.601-7 RGB Weights: 0.299, 0.587, 0.114. This is sometimes called ‘NTSC’ Luminance. 2
ITU-R BT.709-6 RGB Weights: 0.2126, 0.7152, 0.0722. These are the same weights as IEC 61966-2-1. 3
ITU-R BT.2020-2 RGB Weights: 0.2627, 0.678, 0.0593. 4
ITU-R BT.709-1 RGB Weights: 0.2125, 0.7154, 0.0721. 8
NTSC (Rounded) RGB Weights: 0.3, 0.59, 0.11. This is ITU-R BT.601-7 rounded to 2 significant digits. 9
MATLAB RGB Weights: 0.298936, 0.587043, 0.114021. Use MATLAB’s rgb2gray function. 6
Custom RGB Weights Use custom RGB weights. 7

Used In

Analysis Channel: RGB Order

Description

The order of RGB data.

Options

Option Description INI Value
Red, Green, Blue The image data are ordered red, green, blue. 0
Blue, Green, Red The image data are ordered blue, green, red. 1

Used In

Analysis Channel: Statistics Channels

Description

Types of statistics.

Options

Option Description INI Value
Mean Analyze the spectral mean of all channels. 0
Median Analyze the spectral median of all channels. 1

Used In

Axis Scaling

Description

The way to scale the plot axis.

Options

Option Description INI Value
Linear Use a linear scale on the axis. 0
Log Use a logarthmic scale on the axis. 1

Used In

Colormap

Description

The choice of colormap.

Options

Option Description INI Value
MATLAB parula The MATLAB parula colormap. 1
MATLAB turbo The MATLAB turbo colormap. 2
MATLAB hsv The MATLAB hsv colormap. 3
MATLAB hot The MATLAB hot colormap. 4
MATLAB cool The MATLAB cool colormap. 5
MATLAB spring The MATLAB spring colormap. 6
MATLAB summer The MATLAB summer colormap. 7
MATLAB autumn The MATLAB autumn colormap. 8
MATLAB winter The MATLAB winter colormap. 9
MATLAB gray The MATLAB gray colormap. 10
MATLAB bone The MATLAB bone colormap. 11
MATLAB copper The MATLAB copper colormap. 12
MATLAB pink The MATLAB pink colormap. 13
MATLAB sky The MATLAB sky colormap. 14
MATLAB abyss The MATLAB abyss colormap. 15
MATLAB jet The MATLAB jet colormap. 17
MATLAB lines The MATLAB lines colormap. 18
MATLAB colorcube The MATLAB colorcube colormap. 19
MATLAB prism The MATLAB prism colormap. 20
MATLAB flag The MATLAB flag colormap. 21

Used In

Downsample Scale Types

Description

The method for how to specify the size of the downsampled image.

Options

Option Description INI Value
Full Resolution Use the full resolution image. 0
Scale Factor Select a downsampling factor. 1
Output Image Size Select the size of the output image. 2
Output Image Rows Select the number of rows of the output image. 3
Output Image Columns Select the number of columns of the output image. 4

Used In

Geometric Camera Model: Camera Model Type

Description

A description for the camera model.

Options

Option Description INI Value
Simple Pinhole Use a simple pinhole (no distortion) camera model. The forward (image formation) order of operations is: extrinsics, intrinsics. 0
OpenCV Use an OpenCV camera model. The forward (image formation) order of operations is: extrinsics, distortion, intrinsics. 2

Used In

Geometric Camera Model: Image Center Type

Description

How an image center is specified.

Options

Option Description INI Value
Numeric Image Center The numeric center of the image. 0
User-Specified A user-specified coordinate. 1

Used In

Geometric Camera Model: Image Coordinate System

Description

The description of the image coordinate system.

Options

Option Description INI Value
IEEE Std. 2020™ Type I 0-indexed, origin in lower left. 1
IEEE Std. 2020™ Type II 0-indexed, origin in upper left. e.g., OpenCV. 2
IEEE Std. 2020™ Type III 1-indexed, origin in lower left. 3
IEEE Std. 2020™ Type IV 1-indexed, origin in upper left. e.g., MATLAB. 4

Used In

Neutral Density Measurement Type

Description

Methods of describing a neutral density (ND) measurement.

Options

Option Description INI Value
None No neutral density filter. 0
Density Neutral density filter used, measured in density units. 1
Transmission Neutral density filter used, measured in transmission units. 2

Used In

Plot Save Format

Description

The format(s) to save a figure as.

Options

Option Description INI Value
JPEG Joint Photographic Experts Group 1
PNG Portable Network Graphics 2
Compressed TIFF Compressed Tagged Image File Format 3
Uncompressed TIFF Uncompressed Tagged Image File Format 4
MATLAB Figure MATLAB Figure 5
PDF Portable Document Format 6
EPS Level 3 Black & White Encapsulated PostScript Level 3 Black & White 7
EPS Level 3 Color Encapsulated PostScript Level 3 Color 8
EPS Level 2 Black & White Encapsulated PostScript Level 2 Black & White 9
EPS Level 2 Color Encapsulated PostScript Level 2 Color 10
SVG Scalable Vector Graphics 11

Used In

Saturation Specification

Description

The method for how to determine the saturation level.

Options

Option Description INI Value
Container Max Use the maximum size of the data container. 0
Image Max Use the maximum value in the image(s). 1
Image Max (Power of Two) Use the maximum value in the image, rounded up to 2ᴺ-1. 2
Image Max (Even Power of Two) Use the maximum value in the image, rounded up to 2²ᴺ-1. 3
User-Specified Bit Depth Specify the saturation level as a bit depth. 4
User-Specified Value Specify the the saturation level as a digital number value. 5
Classic 6
ITU-R BT.601 7

Used In

Save/Display Plot

Description

The option(s) to save and/or display a plot.

Options

Option Description INI Value
Save Save the plot to disk. 1
Display Display the plot on the screen. 2

Used In

Stray Light: Calculation Method

Description

The method for calculating stray light.

Options

Option Description INI Value
Transmission Calculation is image / normalization factor. 0
Attenuation Calculation is normalization factor / image. 1

Used In

Stray Light: Count Statistics

Description

The named count-based stray light metrics.

Options

Option Description INI Value
Total Count The number of pixels in the image. 1
Source Count The number of pixels identified as the light source. 2
Saturation Count The number of pixels at or above the saturation level. 4

Used In

Stray Light: Count Type

Description

The method for reporting count-based stray light metrics.

Options

Option Description INI Value
Number of Pixels The number of pixels that meet the criteria. 1
Percent of Pixels The percentage of the pixels in the focal plane that meet the criteria. 2

Used In

Stray Light: Data Transforms

Description

Transforms that applied to the linear stray light measurements.

Options

Option Description INI Value
Linear Perform no transform. 0
Log10 Transform data with a base 10 logarithm. 1
dB (Power) Transform data into decibels (10 log10). 2
dB (Voltage) Transform data into decibels (20 log10). 3
Log2 Transform data with a base 2 logarithm. 4
Natural Log Transform data with a natural logarithm. 5

Used In

Stray Light: Histogram Y-Axis Maximum

Description

The method for specifying the maximum y-value for histogram plots.

Options

Option Description INI Value
Automatic Automatically set the limit for each plot. 1
User-defined Apply a fixed, user-specified limit for each plot. 2

Used In

Stray Light: Level Statistics

Description

The named level-based stray light metrics.

Options

Option Description INI Value
Minimum The minimum stray light value. 1
Minimum (Non-0) The minimum stray light value corresponding to the image values greater than the dark level. 2
Maximum The maximum stray light value. 4
Mean The mean stray light value. 8
Median The median stray light value. 16
RMS The root mean square of the stray light values. 32
Standard Deviation The standard deviation of the stray light values. 64

Used In

Stray Light: Light Measurement

Description

The method of light measurement.

Options

Option Description INI Value
Radiometric Use radiometric light measurements. 0
Photometric Use photometric light measurements. 1

Used In

Stray Light: Mask Method

Description

The method for masking the light source.

Options

Option Description INI Value
None Don’t mask the source. 0
Image Processing Use image processing to mask the source. 10
Image Processing + Circle Find the center via Image Processing, then use a circle to mask. 13
Manually-specified Circle Create a circular mask around a specified image point. 2
Geometric Camera Model + Circle Use a geometric camera model to place the mask. 4

Used In

Stray Light: Mask Radius Type

Description

Methods for setting the radius of a circular mask.

Options

Option Description INI Value
User-Specified The radius is specified in pixels. 0
Focal Length Ratio The radius is specified via focal length ratios of the source and camera. 1

Used In

Stray Light: Mask Threshold Type

Description

The method for selecting the mask threshold.

Options

Option Description INI Value
Value The threshold is in digital numbers. 0
Percentage of Max The threshold is a percentage [0-100] of the maximum value. 1
Otsu’s Method Use Otsu’s method to automatically determine a threshold. 2

Used In

Stray Light: Masking Multiple Connected Component Strategy

Description

The method for dealing with multiple connected components when performing image-processing masking.

Options

Option Description INI Value
Don’t Mask If multiple CCs are found, assume the source is not in the image. 1
Pick Biggest Pick the largest of the connected components.This is useful if the other bright image features are small bits of noise. 2
Pick Smallest Pick the smallest of the connected components. This is useful if the direct image the source is well-focused relative to other bright image features. Note: this is used after filtering out small regions. 3

Used In

Stray Light: Memory Mode

Description

The options for prioritizing memory use during a stray light analysis run.

Options

Option Description INI Value
High Memory Faster analysis that requires all images be stored in memory. 1
Low Memory Slower analysis for use with lower memory machines or a large number of images. 2

Used In

Stray Light: Metadata from Filename

Description

The method for extracting metadata from a filename.

Options

Option Description INI Value
None Do not perform a regular expression search. The only way to provide metadata is via a stray light config file. 0
Regular Expression Use a single regular expression extract metadata from the filename. The regular expression must contain one or more named capture groups: ‘field’, ‘azimuth’, and ‘comment’. If enabled, this will overwrite any metadata provided in a stray light config file. 1

Used In

Stray Light: Normalization Type

Description

The normalization method for stray light.

Options

Option Description INI Value
None Perform no normalization. Results will be in digital numbers. 0
Level Normalize with a user-provided source level in digital numbers. 1
Direct Reference Image Normalize with a reference image of the direct light source (light source is typically on-axis). 3
Lambertian Reference Image Normalize with a reference image of the light source with a Lambertian diffuser (light source is typically on-axis). 4

Used In

Stray Light: Normaliztion Aggregation

Description

The method for aggregating the source pixels for image-based normalization.

Options

Option Description INI Value
Mean Use the arithmetic average (mean) of selected pixels. 0
Median Use the median of the selected pixels. 1
Total Use the total (sum) of the selected pixels. 2

Used In

Stray Light: Plot Scaling

Description

The method for frame-to-frame scaling of stray light plots and colormapped images.

Options

Option Description INI Value
Global All frames have the same scaling. 0
Per Subset All frames of the same subset (channel) have the same scaling. 1
Per Image Each frame of the video will have its own scale. 2

Used In

Stray Light: Plotting Channel Subset

Description

The subsets of channel(s) to put on each plot.

Options

Option Description INI Value
All Channels On The Same Plot All channels are plotted on the same plot. 1
Each Channel On Separate Plots Each channel is plotted on a separate plot. 2

Used In

Summary Results Output Types

Description

The format(s) of summary results files.

Options

Option Description INI Value
JSON Save summary results as a JSON file. 1
CSV Save summary results as a CSV file. 2
HDF5 Save summary results as an HDF5 file. 4
XML Save summary results as an XML file. 3

Used In

Video Outputs: Image Formats

Description

The image formats for saving each frame of a video.

Options

Option Description INI Value
png Save as a PNG. 1
jpg Save as a JPG. 2
tiff Save as a TIFF. 4

Used In

Video Outputs: Video Files

Description

The formats for saving a video as.

Options

Option Description INI Value
mp4 Save as a MP4. Not available on linux. 1
avi Save as an AVI. 2
gif Save as a GIF. 4

Used In

INI Notes

Array

Arrays are stored in the INI file as comma-separated values within square braces. For example, storing a four-element array of the digits 1-4 in the INI will look like: 

key=[1, 2, 3, 4]

Older modules may use legacy array syntax.

Legacy Array

Legacy arrays are stored in the INI file as space-separated values. For example, storing a four-element array of the digits 1-4 in the INI will look like: 

key=1  2  3  4

Newer modules (Concentric Rings FOV and Stray Light) may use array syntax.

Boolean

Booleans are stored in the INI file as 0’s and 1’s.

Value Ini Syntax 
true

1

false

0

For example, storing true in the INI will look like: 

key=1

Storing false in the INI will look like: 

key=0

Older modules may use legacy boolean syntax.

Legacy Boolean

Legacy booleans are stored in the INI file as strings.

Value Ini Syntax 
true

Max

false

Min

For example, storing true in the INI will look like: 

key=Max

Storing false in the INI will look like: 

key=Min

Newer modules (Concentric Rings FOV and Stray Light) may use boolean syntax.

String

Strings are stored in the INI file inside double quotes (“). For example, storing Hello World in the INI will look like: 

key="Hello World"

Older modules may use legacy string syntax.

Legacy String

Legacy string are stored in the INI file without any extra characters. For example, storing Hello World in the INI will look like: 

key=Hello World

Newer modules (Concentric Rings FOV and Stray Light) may use string syntax.

History

24.2 Breaking Changes

INI Syntax Updates

  • Arrays are now comma-separated and contained within square brackets. This affects: 
    [straylight] crop_lrtb

    , 

    [straylight] pctl_ranks100

    , 

    [straylight] level_count_thresh

    , 

    [straylight] plot_save_types

    .

  • Strings are now contained within double quotes This affects: 
    [straylight] norm_refim_filename

    , 

    [straylight] norm_lrefim_filename

    .

Ini Key Updates

The following INI keys have been updated

Old INI Key New INI Key(s) 
[straylight] channels

[straylight] channel_type

[straylight] count_per_plot_scaling

[straylight] count_plot_per_plot_scaling

[straylight] count_plot_options_groups

[straylight] count_plot_channel_grouping

[straylight] count_plot_options_include_level_counts

[straylight] count_plot_include_level_counts

[straylight] count_plot_options_mode_options

[straylight] count_plot_save_display

[straylight] count_plot_options_mode_save_types

[straylight] plot_save_type

[straylight] count_plot_options_y_data

[straylight] count_plot_include_named_data

[straylight] count_plot_yaxisscale

[straylight] count_plot_y_axis_scale

[straylight] hist_video_opts_frame_rate

[straylight] hist_video_frame_rate

[straylight] hist_video_opts_image_formats

[straylight] hist_video_image_formats

[straylight] hist_video_opts_video_formats

[straylight] hist_video_video_formats

[straylight] level_plot_options_groups

[straylight] level_plot_channel_grouping

[straylight] level_plot_options_include_pctls

[straylight] level_plot_include_pctls

[straylight] level_plot_options_mode_options

[straylight] level_save_display

[straylight] level_plot_options_mode_save_types

[straylight] plot_save_type

[straylight] level_plot_options_y_axis_scale

[straylight] level_plot_y_axis_scale

[straylight] level_plot_options_y_data

[straylight] level_plot_include_named_data

[straylight] lum_type

[straylight] channel_lum_type

[straylight] metric_video_opts_frame_rate

[straylight] metric_video_frame_rate

[straylight] metric_video_opts_image_formats

[straylight] metric_video_image_formats

[straylight] metric_video_opts_video_formats

[straylight] metric_video_video_formats

[straylight] output_dir

[straylight] save_in_image_folder

[straylight] custom_save_folder

[straylight] save_subfolder

[straylight] pctl_ranks100

[straylight] percentile_ranks100

[straylight] plot_output_scale

[straylight] metric_video_linear_output_scale

[straylight] result_files

[straylight] result_save_types

[straylight] rgb_order

[straylight] channel_rgb_order

The following INI keys have been deprecated:

  • [straylight] mask_postfix

  • [straylight] mask_prefix

  • [straylight] metric_image_postfix

  • [straylight] metric_image_prefix

  • [straylight] metric_video_opts_basename

  • [straylight] hist_video_opts_basename

  • [straylight] video_prefix

  • [straylight] video_postfix

  • [straylight] video_output_scale

Plot Save Format Updates

Save Format Old INI Value New INI Value
0 []
JPEG 1 1
PNG 2 2
TIFF (uncompressed) 4 3
TIFF (compressed 8 4
BMP 16 Deprecated
HDF 32 Deprecated
PBM 64 Deprecated
PCX 128 Deprecated
PGM 256 Deprecated
PPM 512 Deprecated
PDF 1024 6
EPS 2048 7
SVG 4096 11
PS 8192 Deprecated
MATLAB FIG 16384 5

Python INI Migrator

To help with migrating the stray light portion of your INI to 24.2, a python migration utility is provided with Imatest 24.2.
The python code for 

imatest_straylight_24_2_ini_migrator

comes already installed as a Python package in the Python interpreter that is included in the Imatest Master or IT installation (see 

/bin/python39

). The relevant Python function has the following interface:


def migrate_ini(filename: str) -> None

and can be invoked in this interpreter with 


from imatest_straylight_24_2_ini_migrator.imatest_straylight_24_2_ini_migrator import migrate_ini
migrate_ini("/some/folder/imatest-v2.ini")

In addition to the Python code, there is also a standalone executable (located at /bin/python39/bin for macOS and Linux and /bin/python39/Scriptsfor Windows) named imatest-straylight-24-2-ini-migrator. The application’s interface is as follows:


$ imatest-straylight-24-2-ini-migrator.exe --help
usage: imatest-straylight-24-2-ini-migrator [-h] filename
Migrate the stray light section of an Imatest INI file from 24.1 to 24.2.
positional arguments:
  filename The path to the INI file. The default INI location is `C:\Users\Imatest\AppData\Roaming\Imatest\imatest-v2.ini`.
optional arguments:
  -h, --help show this help message and exit

, which can be invoked with a call such as


imatest-straylight-24-2-ini-migrator "/some/folder/imatest-v2.ini"