Background | Testing | Calculation | Testing With Imatest | Inputs | Outputs |
Table of Contents
Calculation Settings
Calculation-related settings for stray light analysis:
Normalization Settings |
|||
Normalization |
The type of normalization to perform. |
Choose one of the following options:
|
normalization
|
ND Measurement Type |
The type of neutral density measurement used for the on-axis reference capture. Setting only available for On-Axis Normalization. |
Choose one of the following options:
|
normalization_on_axis_nd_type
|
ND Measurement Value |
The value of neutral density measurement used for the on-axis reference capture. Units are determined by ND Measurement Type. Setting only available for On-Axis Normalization. |
Double (greater than 0) |
normalization_on_axis_nd_value |
Image Filename |
The fully-qualified path to the on-axis reference image. Setting only available for On-Axis Normalization. |
Path to a valid image file |
normalization_on_axis_filename |
Mask Calculation Settings |
|||
Mask Method |
The methodology for masking out the light source in the image(s) |
Choose one of the following options:
|
mask_options_method
|
Mask Radius |
The radius in pixels for the mask. |
Double (greater than 0) |
mask_options_radius |
Level Threshold Type |
The type of threshold used for localizing the light source in the image. |
Choose one of the following options
|
mask_options_image_processing_level_thresh_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. |
Double (greater than 0) |
mask_options_image_processing_image_close_radius |
Multiple CC Strategy |
The strategy for how to deal with multiple connected components when computing the mask. |
Choose one of the following options:
|
mask_options_image_processing_multiple_cc_strategy
|
Mask Area Threshold |
The minimum number of pixels that the direct image of the light source should be (minimum area in pixels for the mask). |
Double (greater than 0) |
mask_options_image_processing_mask_area_threshold |
Other Calculation Settings |
|||
Calculation |
The type of stray light calculation. |
Choose one of the following options:
Note: 0 is a valid digital number for image data. If choosing reciprocal, any image with 0’s in it will get infinity for the calculated stray light. Summary statistics (e.g., mean, max) of data containing infinity become meaningless. As such Normal is recommended. |
calculation
|
Crop LRTB |
The number of pixels to crop off the left, right, top, and bottom of the image. |
Double (list of four values greater than or equal to 0) |
crop_lrtb |
Percentile Ranks |
The percential ranks [0-100] (e.g., 95 = 95th percential) to calculate. |
Double (list of values greater than 0, less than 100) |
pctl_ranks100 |
Output Settings
Output-related settings for stray light analysis:
Standard Output Settings |
|||
Output Directory |
The path to the save results to. Note: inclusion of the following characters may result in failure to save .fits output files (metric images and masks): “(*:<>?[| |
Path to a valid output directory |
output_dir |
Results Files |
The results files to save. |
Choose one or more of the following options:
|
result_files
|
Intermediate File Settings |
|||
Save Mask |
Enable to save out a file containing the mask of the source for each image. |
Boolean |
save_mask |
Mask Prefix |
A string to be prepended to the mask file(s). |
String |
mask_prefix |
Mask Postfix |
A string to be appended to the mask file(s). |
String |
mask_postfix |
Save Metric Image |
Enable to save out a file containing the metric image(s). |
Boolean |
save_metric_image |
Metric Image Prefix |
A string to be prepended to the metric image file(s). |
String |
metric_image_prefix |
Metric Image Postfix |
A string to be appended to the metric image file(s) |
String |
metric_image_postfix |
Level Plot Settings Note: two or more images are required to produce this plot. |
|||
Save Options |
How should level summary plot(s) be created? |
Choose one or more of the following options:
|
level_plot_options_mode_options
|
Save Types |
The image formats to save the plot as. At least one is required to save the plot. |
Choose one or more of the following options:
|
level_plot_options_mode_save_types
|
Groups |
How to group the data within a plot. At least one is required to produce this plot. |
Choose one or more of the following options:
|
level_plot_options_groups
|
Y Data |
The data to plot on level summary plot(s) |
Choose one or more of the following options:
|
level_plot_options_y_data
|
Include Percentiles |
Enable to include percentiles on the level summary plot(s). |
Boolean |
level_plot_options_include_pctls |
Y-Axis Scale |
The scaling of the y-axis of the plot. |
Choose one of the following options:
|
level_plot_options_y_axis_scale
|
Count Plot Settings Note: two or more images are required to produce this plot. |
|||
Save Options |
How should level summary plot(s) be created? |
(Same options as Level plot) |
count_plot_options_mode_options |
Save Types |
The image formats to save the plot as. At least one is required to save the plot. |
(Same options as Level plot) |
count_plot_options_mode_save_types |
Groups |
How to group the data within a plot. At least one is required to produce this plot. |
(Same options as Level plot) |
count_plot_options_groups |
Y Data |
The data to plot on level summary plot(s) |
Choose one or more of the following options:
|
count_plot_options_y_data
|
Y-Axis Scale |
The scaling of the y-axis of the plot. |
(Same options as Level plot) |
count_plot_options_y_axis_scale |
Metric Videos Settings |
|||
Save Video Formats |
The formats to save the metric image video as. Note: MP4 is not available on Linux. |
Choose one or more of the following options:
|
metric_video_opts_video_formats
|
Save Image Formats: |
The image formats to save each frame of the metric image video as. |
Choose one or more of the following options:
|
metric_video_opts_image_formats
|
Video Frame Rate |
The framerate in frames per second for the metric video. |
Double (greater than 0, less than 40) |
metric_video_opts_frame_rate |
Base Name |
A string to prepend to the metric video file. |
String |
metric_video_opts_basename |
Histogram Video Settings |
|||
Save Video Formats |
The formats to save the histogram image video as. |
(Same options as Metric Video) |
hist_video_opts_video_formats |
Save Image Formats |
The image formats to save each frame of the histogram video as. |
(Same options as Metric Video) |
hist_video_opts_image_formats |
Video Frame Rate |
The framerate in frames per second for the histogram video. |
Double (greater than 0, less than 40) |
hist_video_opts_frame_rate |
Base Name |
A string to prepend to the histogram video file. |
String |
hist_video_opts_basename |
Other Video Settings |
|||
Frame Scaling |
How to scale the frames of the video. |
Choose one of the following options:
|
frame_scaling |
Video Output Scale |
How to scale the data before making video(s). |
Choose one of the following options:
|
video_output_scale |
Plot Output Scale |
How to scale the data before making the summary metric plot(s). |
(Same options as Video Output Scale) |
plot_output_scale |
Histogram Output Scale |
How to scale the data before taking a histogram. |
(Same options as Video Output Scale) |
hist_scale |
Video Prefix |
A prefix added to the video filename(s). |
String |
video_prefix |
Video Postfix |
A postfix added to the video filename(s). |
String |
video_postfix |