IQ Measurement Automation - User Guide
Contents
List of Figures
Introduction
Main Page
Dark and Light Test Initial Conditions
Dark Tests
Dark Level Stability Test (DLS)
Dark Shading and Pixel Above Mean Test (DSH)
Light Tests
SNR and Structure Noise Test
Light Shading Test
Sensor Response Linearity Test
Sensor Gain Linearity Test
Running the Test- An Example
Light Tests
Dark Tests
Report Summary
Config File
Saving Config File
Loading Config File
Troubleshooting
Dependency Warning
Start Dark Tests button not enabled
Start Light Tests button not enabled
Data is the same for DLS test and Structure noise test
Anchor |
---|
| _Toc488231115 |
---|
| _Toc488231115 |
---|
|
List of Figures
Figure 1 - Main Page
Figure 2 - Dark and light test initial conditions
Figure 3 - Dark Level Stability Test
Figure 4 - Dark Shading Test Input fields:
Figure 5 - Light Tests
Figure 6 - SNR Test
Figure 7 - Light Shading Test
Figure 8 - Sensor Response Linearity Test
Figure 9 - Sensor Gain Linearity Test
Figure 10 - MAIN Page Example
Figure 11 - Light Shading Test Example
Figure 12 - Temperature Setting Prompt
Figure 13 - Test Progress Dialog
Figure 14 - Test Completed Message
Figure 15 - Dark Tests Example
Figure 16 - Running Script Example
Figure 17 - Tests Completed
Figure 18 - Both MCR and XLSXWriter Missing
Figure 19 - MCR Missing
Figure 20 - XLSXWriter Missing
Figure 21 - Matlab Warning
Anchor |
---|
| _Toc488231117 |
---|
| _Toc488231117 |
---|
|
Introduction
...
When started, the plugin displays the main page. When running for the first time, you might get a couple of warnings. This is because the plugin requires a couple of components that are not available by default with DevWare. These are:
- XLSXWriter XlsxWriter package for Python.
- Matlab compiler Runtime version 7.17
Follow the instructions in the warning dialogs displayed by the tool for download and installation.
Note: long Preset names may cause a "No such file or directory" error from XlsxWriter. This is due to the Preset name being used to form the folders and files.
If this error occurs, the only solution is to rename the Preset name in the INI file to a length of 30 characters or less.
Anchor |
---|
| _Toc488231118 |
---|
| _Toc488231118 |
---|
|
Main Page
When the plugin is started, the following page is shown. It gives an introduction to the plugin, and takes some basic inputs from the user to run all tests.
Anchor |
---|
| _Toc488231140 |
---|
| _Toc488231140 |
---|
|
Figure 1 - Main PageInput fields:
- Configuration File – Clicking the Load button allows the user to load a config file. This is a pre-defined config file, best saved from the GUI.
- Test Description – This will be the name of the project. Enter a string. This string will be a part of the report spreadsheet filename.
- Project Path – This will be the location where the test results will be stored. Browse button on the main page helps user navigate the folder structure to select the project path.
- Responsible Name – This will be the name of the Engineer running the test. It will be printed in the summary sheet of the report spreadsheet.
- Hardware Description – This is the name of the sensor/SOC for which the test is being run, and any other details the user wishes to add. This will be printed in the summary sheet of the report spreadsheet.
- Setup Description – this is a description of the setup, indicating illuminant used, etc.
- Tests – The main page also contains checkboxes for each test to be run. Special condition tests are currently not supported, and hence are greyed out. Select the tests you want to run, then click Next
...
Both dark and light tests have "Initial Conditions". The settings in this section apply to all tests in that tab. The initial conditions tab in the GUI is shown below:
Anchor |
---|
| _Toc488231141 |
---|
| _Toc488231141 |
---|
|
Figure 2 - Dark and light test initial conditionsIt has the following inputs:
...
Anchor |
---|
| _Toc488231142 |
---|
| _Toc488231142 |
---|
|
Figure 3 - Dark Level Stability TestThe input fields for the Dark Level Stability test are as below:
...
Anchor |
---|
| _Toc488231143 |
---|
| _Toc488231143 |
---|
|
Figure 4 - Dark Shading TestInput fields:- Pixel Integration time - These are the integration times (in ms) for which the dark shading test is run. Enter multiple values by separating them with a comma (,).
- Color Correction and White Balance – This enables the color correction and white balance in DevWare.
- Digital Gain Stretching – This enables digital gain stretching. Enter a number between 1 and 100 in the box next to it, for a digital gain stretch value.
- Total Frames – This is the total number of frames to capture for the dark shading test.
- Average into one frame – When this check box is selected, the input frames are averaged into one frame before it is saved, and histogram data is collected.
- Output Formats – These are the additional formats of images required to be saved. RAW image will be saved by default.
...
Light tests are run in "flat field conditions". These tests are designed for uniform light conditions throughout the sensor. To run these tests, mount the sensor in a chamber with a flat scene. Do NOT change the light conditions until the measurement process is over.The initial conditions for the Light tests are exactly the same as for Dark Tests. Refer Dark Tests Section for the input fields in "Initial Conditions".
Anchor |
---|
| _Toc488231144 |
---|
| _Toc488231144 |
---|
|
Figure 5 - Light TestsFour Light tests are supported in this plugin:
...
Anchor |
---|
| _Toc488231145 |
---|
| _Toc488231145 |
---|
|
Figure 6 - SNR TestInput fields:
- Image Data Type – This is the image data type to use for the noise exposure sweep.
- Maximum exposure – This is the value of the exposure (in ms) at which the noise exposure sweep stops. Clicking the "Auto Calc" button gets the software to automatically calculate this value as the exposure time at which all the channels saturate.
- Frames Per Sample – This is the number of frames to capture per sample for the noise exposure sweep.
- Log Scale – Sweep through exposure in log scale, or linear scale
- Decades and Samples/Decade – When Log scale checkbox is checked, these fields decide the number of samples for the exposure sweep
- Min Exposure/Num Samples – These fields are valid when the exposure sweep is on linear scale.
- Structure Noise ROI – Use either full frame ROI, or the same ROI as for Dark Level Stability test.
...
Anchor |
---|
| _Toc488231146 |
---|
| _Toc488231146 |
---|
|
Figure 7 - Light Shading TestThis test has the following inputs:
...
The rule is the maximum exposure for the small signal level should be 5% of the maximum exposure for the medium signal level range.
Anchor |
---|
| _Toc488231147 |
---|
| _Toc488231147 |
---|
|
Figure 8 - Sensor Response Linearity TestInputs:
- Auto Calc Exposure Times – The "Auto calc max exposure time" can be used to use the plugin to calculate the max exposure time as the exposure time at which all the channels saturate. Clicking this will fill all the exposure time input fields for this test.
- Default Dark Offset – If this checkbox is checked, the plugin uses default dark offset values in the Linearity test calculations. If unchecked, the user will be prompted to create "dark" conditions, so that the dark offsets can be collected for this test.
- Image Data Type – This is the image data type to use for the noise exposure sweep.
- Frames Per Sample – This is the number of frames to capture per sample for the noise exposure sweep.
- Small Signal Level Sweep – Select the minimum and maximum exposure time for the small signal sweep, and the number of samples for this sweep. The sweep is linear, not log scale.
- Medium Signal Level Sweep – Select the maximum exposure time and number of samples for this sweep. The sweep is linear, not log scale. Also, the minimum exposure time for this sweep is decided by the maximum exposure time in the Small signal level sweep, to avoid overlaps in the sweeps.
...
This test runs a gain sweep for a given pixel integration time. It collects the noise exposure results into a text file, which is then processed by the python script to generate the report summary. The GUI input fields for this test are as shown below:
Anchor |
---|
| _Toc488231148 |
---|
| _Toc488231148 |
---|
|
Figure 9 - Sensor Gain Linearity TestInput Fields:
- Image Data Type – This is the image data type to use for the noise exposure sweep.
- Min Gain – this is the minimum value for the gain sweep. Must be between 1.00 and 8.00.
- Max Gain – This is the maximum gain value for the gain sweep. Must be between 1.00 and 8.00. and greater than Min Gain.
- Pixel Integration Time – The integration times at which the gain sweep is run. Multiple values are separated by a comma(,). The "Auto calc exposure" checkbox can be used to get the plugin to calculate the max exposure time as the exposure time at which all the channels saturate.
- Frames Per Sample – This is the number of frames to capture per sample for the gain sweep.
- Number of Samples – Number of samples for the gain sweep.
- Default Dark Offset – If this checkbox is checked, the plugin uses default dark offset values in the Linearity test calculations. If unchecked, the user will be prompted to create "dark" conditions, so that the dark offsets can be collected for this test.
...
In this section the user is guided through running the plugin from start to end for two dark tests and one light test. The main page GUI for the example is shown below. The results are chosen to be saved at "C:\Aptina Imaging Dev" folder.
Anchor |
---|
| _Toc488231149 |
---|
| _Toc488231149 |
---|
|
Figure 10 - MAIN Page ExampleOn clicking "Next", the test page will be shown. Either the dark or the light tests can be run first. Order does not matter. However, the report summary spreadsheet is generated only when all selected tests have been run. The following sections describe the test progress.
...
Let us run the Light tests first. The screenshot below shows the Light tests tab in the Tests page.As you can see below, only the Light Shading test is enabled. The other tests are marked "(Disabled)". This is because only the Light Shading test was selected on the Main page.After entering all the inputs (refer Light Shading Test section), click the "Start Light Tests" button to start the light tests. If the "Start Light Tests" button is not enabled, it means you are missing an input required to run the tests. Look at the inputs carefully, and ensure none of the fields are empty.
Anchor |
---|
| _Toc488231150 |
---|
| _Toc488231150 |
---|
|
Figure 11 - Light Shading Test ExampleClicking the "Start Light Tests" button starts the test. At the start of every test, the following message box is shown.

Anchor |
---|
| _Toc488231151 |
---|
| _Toc488231151 |
---|
|
Figure 12 - Temperature Setting PromptWhen this box appears, the user must make sure they have the setup set at the temperature requested. Once the setup is ready, the user clicks "OK". This will start the test. Clicking "Cancel" will cancel the test at this point.Once the test is running, the following progress dialog is displayed.

Anchor |
---|
| _Toc488231152 |
---|
| _Toc488231152 |
---|
|
Figure 13 - Test Progress DialogBoth Dark tests and Light tests have a progress dialog. The dialog informs the user which test is currently running, and the conditions for the current test. The test can be cancelled at any time by clicking the "Cancel" button. The test might take a few seconds to cancel, depending on what operation is running at that time. Also, if a test is cancelled, the results folder is deleted.Once light tests are completed, the following message box is shown, indicating that the report spreadsheet will be generated after the selected dark tests are also completed.

Anchor |
---|
| _Toc488231153 |
---|
| _Toc488231153 |
---|
|
Figure 14 - Test Completed Message Anchor |
---|
| _Toc488231130 |
---|
| _Toc488231130 |
---|
|
Dark Tests
The following screenshot shows Dark Tests. Both the Dark Level Stability and Dark Shading tests are selected, and both will be run, in order. A similar progress dialog as shown above will be displayed while the test is being run.
Anchor |
---|
| _Toc488231154 |
---|
| _Toc488231154 |
---|
|
Figure 15 - Dark Tests ExampleWhen all the tests selected have been completed, the python script generates a spreadsheet. This may take a while, especially when the shading tests are selected, and the following status appears next to the "Start Dark Tests" button, indicating that the plugin generating the spreadsheet.
Anchor |
---|
| _Toc488231155 |
---|
| _Toc488231155 |
---|
|
Figure 16 - Running Script ExampleWhen all the tests are completed, the following box is shown. Clicking the link will take you to the results folder.

Anchor |
---|
| _Toc488231156 |
---|
| _Toc488231156 |
---|
|
Figure 17 - Tests Completed Anchor |
---|
| _Toc488231131 |
---|
| _Toc488231131 |
---|
|
Report Summary
...
As mentioned in section 1, the plugin requires Matlab Compiler Runtime and XLSXWriter package for python. The warning messages for these are shown below. Warning is displayed only for the missing packages. 
Anchor |
---|
| _Toc488231157 |
---|
| _Toc488231157 |
---|
|
Figure 18 - Both MCR and XLSXWriter Missing
Anchor |
---|
| _Toc488231158 |
---|
| _Toc488231158 |
---|
|
Figure 19 - MCR Missing
Anchor |
---|
| _Toc488231159 |
---|
| _Toc488231159 |
---|
|
Figure 20 - XLSXWriter MissingIf you have installed MCR version 7.15 but still get the following warning message at the end of the test, you just need to restart DevWare.

Anchor |
---|
| _Toc488231160 |
---|
| _Toc488231160 |
---|
|
Figure 21 - Matlab Warning Anchor |
---|
| _Toc488231137 |
---|
| _Toc488231137 |
---|
|
Start Dark Tests button not enabled
...