The following table lists the so-called STATE variables implemented in the ApBase library, DevWare, and related software. STATE variables control the operation of the software, mainly the image processing. STATE variables can be set by commands or Python statements in initialization files, and by various APIs supported by the software such as the ApBase API, the DevWare COM interface, and the DevWare plug-in interface. The data type of a variable is either integer or string. (Non-integer numbers are string-valued for the purposes of the APIs.) Most variables have a corresponding control on the DevWare user interface (UI).

The ini file command to set a STATE variable is STATE= variable [(0 | 1)], value. The value is interpreted as an integer or a string according to the name of the variable.
"[(0 | 1)]" is the optional parameter for those STATE variables that on duplicated per-context; see below under "per-Context variables".

The Python functions to get and set STATE variables are apbase.getstate( variable ), and apbase.setstate( variable , value ). The return value from getstate() will be an integer or a string according to the specific variable. The data type of the value passed to setstate() must be int or str according to the variable.

It is possible to set a variable with a name of your choosing. The software will store the value, which can be retrieved later. This is useful with software extensions such as DevWare plug-ins and user-defined toolbars. For example, parameter values used by a plug-in could be set in ini files like native DevWare settings. The STATE= ini command will always create a string-valued variable if the variable is not yet defined. The Python setstate() function can create either a integer-valued or string-valued variable depending on the data type of the value parameter.

Note on per-Context variables; some ColorPipe variables are duplicated per-context - those are noted by "Duplicated per-context." in their description.
Their value can optionally be set per-context only via an INI file version; the format is STATE = variable (0 | 1), value.
For Python functions and through ApBase, the STATE value is set per the sensor's currently active context.

2 Floating-point values

STATE Variable Name, Description	Value
Display Zoom Percent Corresponds to Zoom In/Out buttons on the DevWare toolbar. Value is zoom factor * 100. The following settings are special cases: 12 will be 12.5% (1/8 exactly), 6 will be 6.25% (1/16 exactly) and 3 will be 3.125% (1/32 exactly).	3 to 1600 (default = 100)
Reset Image Fifo Reset the image FIFOs on the demo board.	0 or 1
Filter Corresponds to Filter selection on the Data Interpretation page. Note that the value(s) presented on the Data Interpretation page change depending on the output format in use. For example, Bayer as compared to YCBCR as compared to SuperCell - all will have a different list of possible Filter choices. This in turn changes the corresponding value for the "Filter" state. The method of determining the state value is to use DevWare to set the output format that you're using, and then go to the "Data Interpretation" dialog in the "Control" dialog. Starting at 0, count down until you find the filter that you want to apply. For example, if your output format is Bayer, selecting a Filter state of "Bayer Grayscale" would be 3. Note; the set of Filters can be set via the "CFA Pattern" STATE command, listed below.	0 to n
Subimage Which subimage to display if there are more than one. 0 means main image, 1 means post-view image, 2 means thumbnail image.	0, 1 or 2
Current Subimage Returns subimage is being displayed if there are more than one. 0 means main image, 1 means post-view image, 2 means thumbnail image.	0, 1 or 2
Subimage Merge Whether to inset the subimage in the main image.	0 or 1
X Offset Sets the Bayer pattern horizontal offset. 0 means first column is G1/B, 1 means R/G2. Corresponds to Horizontal skip checkmark on the Data Interpretation page.	0 or 1
Y Offset Sets the Bayer pattern vertical offset. 0 means first row is G1/R, 1 means B/G2. Corresponds to Vertical skip checkmark on the Data Interpretation page.	0 or 1
Auto Offset Set X Offset and Y Offset automatically. Corresponds to Automatic checkmark on the Data Interpretation page.	0 or 1
Gb-B Swap Swap Gb and B pixels in a Bayer image.	0 or 1
Byte Swap Swap adjacent bytes in the input image.	0 or 1
True Black Enable Enable black level (a.k.a. pedestal) subtraction from raw Bayer data. Corresponds to Subtract True Black controls on the Data Interpretation page.	0 , 1 , or 2 (automatic)
True Black Level Black level, as a fraction of the True Black Scale. Normally loaded automatically from sensor registers. Corresponds to True Black value on the Data Interpretation page.	Integer
True Black Scale Usually either 1024 or 4096, indicates whether True Black Level is expressed as a 10-bit or 12-bit value.	Integer
Active True Black Black level scaled to the decompressed image depth.	Integer
ALTM Enable Enable Adaptive Local Tone Mapping algorithm. This intelligently reduces an HDR image of 16 bits or more to 12 bits for the software color pipeline. Note; use "HDR" version of STATE variables when ALTM is enabled. For example, "HDR Black Correct" instead of "Black Correct". Duplicated per-context.	0 or 1
ALTM Min Percent Minimum percentile. Duplicated per-context.	double float
ALTM Peak Percent Maximum percentile. Duplicated per-context.	double float
ALTM Sharp S Sharpening strength. Duplicated per-context.	double float
ALTM Lo Gamma Low light region Gamma. Duplicated per-context.	double float
ALTM Hi Gamma High light region Gamma. Duplicated per-context.	double float
ALTM Min Factor Minimum factor. Duplicated per-context.	double float
ALTM Dark Floor Minimum dark factor. Duplicated per-context.	Integer
ALTM Smooth Level Normally less than 1.0. Duplicated per-context.	double float
BitDepth Decomp The decompressed image depth.	Integer
Compress Image data compression, usually of mono or Bayer data. 0 means no compression, 1 means MIPI compression with simple predictor, 2 means a-Law, 3 means companding, 4 means MIPI compression with advanced predictor, 5 means MIPI packing.	0 to 5
Companding Set the custom companding table. Provide a string with the required format and appropriate values; Bits_in [in_knee_point_1 in_knee_point_2 in_knee_point_n] Bits_out [out_knee_point_1 out_knee_point_2 out_knee_point_n] Bits_out maximum is 24. Max number of knee points is 16. Knee points must be increasing in value. Number of Knee points must be the same for Bits_in and Bits_out. In cases where the original depth is shifted (e.g. 20->16), account for this by shifting the knee point values. Use the STATE command "Compress, 3" to enable companding. Issuing the STATE command with no data will reset/disable the custom companding table. Example: STATE = Companding, 12 [2048 3040 4000] 20 [2048 65536 1048576]	string
Deinterlace Mode Sets de-interlacing method when displaying the output from an interlaced sensor. 0 means don't de-interlace, 1 means top field comes out first, 2 means bottom field comes out first, 3 means automatically determine appropriate mode. Corresponds to De-Interlacing controls on the Data Interpretation page.	0, 1, 2 or 3
Descramble Mode Descramble imager data from AR1011, AR1411.	0 or 1
Special Pixel Mode Remove special pixels from image for AR1011, AR1411.	0 or 1
Trigger Width Set the trigger width for AR1011, AR1411.	Integer
Active Area Crop Crop dark rows and columns on AR1011, AR1411.	0 or 1
AI Repack Arrange image data in to grid of images for array imagers.	0 or 1
Auto Luma Range Enable automatic determination of the range of Y values in the YCbCr output of the sensor. Corresponds to the Automatic checkmark under Luma Range on the Data Interpretation page.	0 or 1
Luma Lo Value to use as the black Y value when automatic luma range is off. Corresponds to the Black value on the Data Interpretation Page.	0 to 255
Luma Hi Value to use as the white Y value when automatic luma range is off. Corresponds to the White value on the Data Interpretation Page.	0 to 255
Dynamic Range LSB The least significant bit of the input data to use when limiting the dynamic range used in the image processing.	Integer
Dynamic Range MSB The most significant bit of the input data to use when limiting the dynamic range used in the image processing.	Integer
Unswizzle Mode Sets the unswizzling operation to be performed on the data coming from the demo board. Swizzling refers to rearrangement of the data bits on most headboards. 0 means no unswizzling, 1 means unswizzle on the camera if possible, 2 means unswizzle in software on the host, and 3 means set the best mode automatically. Corresponds to the Bayer Bit-Unswizzling controls on the Data Interpretation page.	0, 1, 2 or 3
Orientation Re-orient the output image. 0 means do nothing, 1 means horizontal mirror, 2 means vertical flip, 3 means rotate 180°.	0, 1, 2 or 3
Output Channel Strip all but the specified color channel from the final RGB image so the user can see the red, green or blue channels in isolation. 0 means show all channels (normal mode), 1 means show red only, 2 means show green only, 3 means show blue only. Corresponds to Display Color Channel control on Data Interpretation page.	0, 1, 2 or 3
Output BwColor Convert the final RGB image to black & white. Useful when used in conjunction with the Output Channel feature. 0 means color, 1 means black & white. Corresponds to the control on the Data Interpretation page.	0 or 1
Color Correction Enable color correction and gamma correction for Bayer data. This must be enabled for White Balance to work. Corresponds to the Color Correction and White Balance check on the SW Color Correction page. Duplicated per-context.	0 or 1
Gamma Correction Gamma correction value for Bayer data * 100. 45 means 0.45. Corresponds to Gamma control on SW Color Correction page. Note; when ALTM is enabled, "Gamma Correction" is ignored - use "HDR Gamma Correction" instead. Duplicated per-context.	1 to 125 (default = 45)
Black Correct Sets a black correction amount, for Bayer data, that darkens the blacks in the image for a better appearance. Corresponds to Black Correction control on SW Color Correction page. Note; when ALTM is enabled, "Black Correct" is ignored - use "HDR Black Correct" instead. Duplicated per-context.	0 to 20
Gamma Table Reset Reset the custom gamma table.	1
Gamma Table Select Select the custom gamma table or the gamma table generated from Gamma Correction and Black Correct settings. Setting this to 1 selects the custom table, so Gamma Correction and Black Correct have no effect.	0 or 1
Gamma Table Add or change an entry in the custom gamma table. The parameters are two integers, the input value and output value.	Input output
Contrast Sets contrast enhancement factor for Bayer data * 20. A factor of 1.0 (contrast = 20) means no enhancement. 25 means a factor of 1.25. Corresponds to Contrast control on SW Color Correction page. Note; when ALTM is enabled, "Contrast" is ignored - use "HDR Contrast" instead.	20 to 40 (default = 25)
Saturation Set saturation enhancement factor for Bayer data * 10. A factor of 1.0 (saturation = 10) means no saturation boost. 0 means black & white image. Corresponds to Saturation Correction control on SW Color Correction page. Duplicated per-context.	0 to 20
Aperture Enable Enable software aperture correction (sharpening) on Bayer data. Corresponds to Aperture Correction checkmark on SW Color Correction page. Duplicated per-context.	0 or 1
Aperture Set aperture correction (sharpening) amount for Bayer data. Corresponds to Aperture Correction slider on SW Color Correction page. Duplicated per-context.	-4 to 16
All HW Gain Returns a list of all gain values supported by the device. Useful for gain sweeps.	String (read-only)
All Global Gain Returns a list of all gain values supported by the device. Useful for gain sweeps.	String (read-only)
Software Gain Gain applied to Bayer data * 1000. Corresponds to Software Gain control on Exposure page.	1000 to 100000 (default = 1000)
Minimum Global Gain Limit analog gain. Gain * 1000. Corresponds to Analog Gain control on Exposure page.	Default = 1000
Show Min Gain As 1 Show minimum recommended gain as 1.0. This will change the gain values shown below to be relative to the recommended minimum gain.	0 or 1
Gain Table Reset Reset the custom gain table.	1
Gain Table Select Select the custom gain table tuning registers defined by the "Gain Table" STATE setting. Setting this to 1 selects the custom table.	0 or 1
Gain Table Set tuning registers for the gain and the gain register, and optionally up to 12 tuning addresses and tuning data values. You can only set whole registers with that table (not bitfields).	"gain" = double float All others are integers
Master Clock Inform DevWare of the sensor's pixel array clock frequency, in Hz. Setting this variable does not change the actual clock. This value must be set correctly for the frame rate computations, exposure controls and software auto exposure features to work properly. Normally DevWare can detect the clock rate automatically via the DEMO2 board. Corresponds to the Sensor Array Clock Speed value on the Options dialog.	Integer
Detect Master Clock Set to 1 to trigger DevWare to re-detect the sensor array clock frequency, it returns to 0 by itself after the detection. The detection won't work if the sensor is not putting out images, so you may want to set this trigger at the end of the [Demo Initialization] section of an INI file if the sensor was brought out of a standby or non-streaming state. Corresponds to the Detect button on the Options dialog.	1
Pixel Clock Polarity Specify which edge of PIXCLK to sample the data. Corresponds to PIXEL_CLOCK_POLARITY setting from the sensor data (.xsdat or .sdat) file No UI.	0 (falling) or 1 (rising)
Pixel Clock Get and Set the Pixel Out clock, in Hz.	Integer
Input Clock Get and Set the Input clock, in Hz. Corresponds to the XMCLK value in the baseboard (Demo2X or Demo3) value in Sensor Control / Diagnostics.	Integer
Die Temperature Get the temperature value; only applies to sensors that have that feature.	String (read-only)
Die Temperature Calib Get the temperature calibration status; 0 or 1 (fail / pass).	String (read-only)
Auto Exposure Enable software auto exposure algorithm used for Bayer sensors that don't have built-in AE. The following variables control the software AE. This variable corresponds to the Auto Exposure check marks on the Exposure and Auto Exposure pages.	0 or 1
Auto Exposure Target Relative image brightness that auto exposure should "aim for." When auto exposure is on, this is a brightness control. Corresponds to Target control on Auto Exposure page.	1 to 100 (default = 50)
Auto Exposure Stability Hysteresis window around Target. Corresponds to Stability control on Auto Exposure page.	0 to 40 (default = 5)
Auto Exposure Speed Sets how long it should take, in 1/10ths of seconds, for the AE to settle. 30 means three seconds. No UI.	Default = 30
Auto Exposure Minimum FPS Reciprocal of maximum exposure time. 0 means allow any exposure time up to the maximum supported by the sensor. Corresponds to Exposure Limit control on Auto Exposure page.	0 to 30
Auto Exposure Flicker Filter Enable anti-flicker in AE and set frequency. 0 means off. 60 means constrain exposure time to multiples of 1/120 second. 50 means constrain exposure time to multiples of 1/100 second. Corresponds to Flicker Filter control on Auto Exposure page.	0, 50 or 60
Auto Exposure Soft Limit Try to keep exposure time below 1/softlimit (or frame readout time, whichever is greater) unless doing so would require more than Soft Gain Limit gain. No UI.	Integer (default = 33)
Auto Exposure Soft Gain Limit Maximum gain AE should use before slowing down the frame rate * 10. Corresponds to Soft Gain Limit control on Auto Exposure page.	10 to 100 (default = 40)
Auto Exposure Software Gain Limit Set the maximum allowed software gain that the AE will use * 10. Default is 100. Corresponds to Software Gain Limit control on Auto Exposure page.	10 to 150 (default = 100)
Auto Exposure Gain Limit Set the maximum per-channel hardware gain that AE will use * 10. Non-HDR modes.	integer
Auto Exposure Minimum Gain Set the minimum per-channel hardware gain that AE will use * 10. Non-HDR modes.	integer
Auto Exposure Minimum Global Gain Set the minimum global hardware gain that the AE will use * 10. Non-HDR modes.	integer (usually default = 10, meaning 1.0X gain)
Auto Exposure Global Gain Limit Set the maximum global hardware gain that the AE will use * 10. Non-HDR modes.	integer
Auto Exposure Gain Limit HDR Set the maximum per-channel hardware gain that AE will use * 10. HDR modes.	integer
Auto Exposure Minimum Gain HDR Set the minimum per-channel hardware gain that AE will use * 10. HDR modes.	integer
Auto Exposure Minimum Global Gain HDR Set the minimum global hardware gain that the AE will use * 10. HDR modes.	integer
Auto Exposure Global Gain Limit HDR Set the maximum global hardware gain that the AE will use * 10. HDR modes.	integer
Auto Exposure Post HDR Gain Limit Set the the post-HDR gain limit variable that the AE will use * 10. HDR modes.	integer
Auto Exposure Freeze Gains 1 means AE will not change the analog gains. 0 means it may. Corresponds to Freeze Gains checkmark on Exposure page.	0 or 1
Auto Exposure Fade Saturation Automatically reduce saturation in high gain situation to reduce appearance of image noise. Corresponds to Fade Saturation checkmark on Auto Exposure page.	0 or 1
Auto Exposure Fade Aperture Automatically reduce sharpening in high gain situation to reduce appearance of image noise. Corresponds to Fade Aperture Correction checkmark on Auto Exposure page.	0 or 1
Auto Exposure Fade Target Automatically reduce brightness target in high gain situation to prevent excessive gain. Corresponds to Fade Exposure Target checkmark on Auto Exposure page.	0 or 1
Auto Exposure Image Y Read-only. Calculated exposure from embedded histogram.	integer
HDR AE Mode Rule for HDR autoexposure.	0, 1, 2, 3, or 4
HDR Gamma Correction HDR Gamma correction value for Bayer data * 100. 45 means 0.45. For use with HDR tone mapping. Note: when ALTM is disabled, "HDR Gamma Correction" is ignored - use "Gamma Correction" instead. Duplicated per-context.	1 to 125 (default = 45)
HDR Contrast Sets contrast enhancement factor for Bayer data * 20. A factor of 1.0 (contrast = 20) means no enhancement. 25 means a factor of 1.25. For use with HDR tone mapping. Note: when ALTM is disabled, "HDR Contrast" is ignored - use "Contrast" instead. Duplicated per-context.	20 to 40 (default = 25)
HDR Black Correct Sets a black correction amount, for Bayer data, that darkens the blacks in the image for a better appearance. For use with HDR tone mapping. Note: when ALTM is disabled, "HDR Black Correct" is ignored - use "Black Correct" instead. Duplicated per-context.	0 to 20
HDR AE Scene Brightness Coeff A Coeff for controlling HDR scene brightness.	float (default to 1.0)
HDR AE Histogram Y Read-only. Calculated luma from embedded histogram.	float
Num Exposures HDR Manually set the number of interleaved exposures. This is calculated automatically when an supported sensor is detected. Otherwise the STATE variable can be used to set this parameter.	integer
Linearize HDR When the sensor outputs multiple exposures for HDR separately, combine them into a single linear image.	0 or 1
MEC Mode Set the Multiple Exposure Combination (MEC) mode. 0 - Digital Lateral Overflow 1 - Extended Super Exposure 2 - Send Unsaturated Out 3 - Noise Injection DLO 4 - Soft Unbiased Pixel 5 - Soft Unbiased DLO 6 - SC-Max	Mode
MEC Clip 1 MEC Clip 2 MEC Clip 3 MEC Clip 4 Top of range for given exposure (1 thru 4).	integer
MEC T1_S3 MEC T1_S4 MEC T2_S1 MEC T2_S2 MEC T2_S3 MEC T2_S4 MEC T3_S1 MEC T3_S2 MEC T3_S3 MEC T3_S4 MEC T4_S1 MEC T4_S2 Exposure T threshold S.	integer
MEC Linebuffer use line buffer (data from previous row) to get other color pixels.	0 or 1
MEC SC Color Th2 MEC SC Color Th3 MEC SC Color Th4 Smooth Combination region Th threshold.	integer

Lens Correction Enable Enable software lens correction of Bayer data. Corresponds to Enable Lens Correction checkmark on Lens Correction page.	0 or 1
Lens Correction Falloff Set lens correction calibration desired falloff as a percentage of the center brightness 100 means no falloff. Corresponds to Allowed Falloff control on Lens Correction page.	1 to 100 (default = 100)
Lens Correction Coeff Prec Set the bit precision of the floating point polynomial lens correction coefficients when calibrating lens correction for devices that use the polynomial algorithm. Includes a 5-bit exponent and sign bit. Corresponds to Coeff. Precision control on Lens Correction page.	7 to 16 (default = 16)
Lens Correction Center X Lens Correction Center Y Position of lens optical center on the sensor. Normally computed automatically during lens correction calibration.	Pixel coordinate
Lens Center Overlay Show the lens center position on the video display. Corresponds to the Center Overlay checkmark.	0 or 1
Lens Center Red X Lens Center Red Y Lens Center Green1 X Lens Center Green1 Y Lens Center Green2 X Lens Center Green2 Y Lens Center Blue X Lens Center Blue Y Positions of per-channel optical centers. Normally computed automatically during lens correction calibration. No UI.	Pixel coordinates
Lens Sim Sensor When DevWare has an image loaded, it can simulate the hardware lens correction of certain sensors. This selects which sensor to simulate. Corresponds to the selection on the LC Simulation page.	mi_sensor_types (midlib.h) A-2010SOCJ = 16 A-5100 = 22 A-2020SOC = 23 A-3120 = 25 A-2020 = 27 A-8130 = 33
Lens Sim Sensor Rev The rev of the simulated sensor. Corresponds to the selection on the LC Simulation page.	Integer
Lens Sim Enable Pwq Enable simulation of hardware lens correction block for simulations that use the non-polynomial algorithm. Corresponds to Enable Lens Correction checkmark on LC Simulation -> Adjustment page.	0 or 1
Lens Sim Enable Poly Enable simulation of hardware lens correction block for simulations that use the polynomial algorithm. Corresponds to Enable Lens Correction checkmark on LC Simulation -> Polynomial.	0 or 1
Noise Removal Sets software noise reduction algorithm(s). Corresponds to checkmarks on Noise and Defects page.	0, 1, 2, 4, or combination 1 = High/Low 2 = Average-Near 4 = Adapting Average-Near 8 = Flat Region Filter
Noise Removal Level Sets noise removal threshold. Corresponds to Aggressiveness slider on Noise and Defects page.	Integer (default = 25)
Defect Enable Enable defect correction algorithm. Corresponds to Enable checkmark on Noise and Defects page.	0 or 1
Defect Max Maximum number of defects to store. Corresponds to Maximum Defects value on Noise and Defects page.	Integer (default = 1000)
Defect Auto Defect Correction Enable automatic re-evaluation of the defect map. Corresponds to Auto Update Defect Map on Noise and Defects page.	0
Optical Black The software can do black level adjustment if black row and/or black column readout is enabled on the sensor. 1 enables global black level calculation and subtraction. 2 enables column-wise black level correction (based on black rows). 4 enables row-wise black level correction (based on black columns).	0, 1, 2, 4 or combination
Optical Black Level Rect If Optical Black is 1 then use this rectangle to calculate the black level.	Four integers defining a rectangle; x1, y1, x2, y2
Optical Black 1 Row Start Optical Black 1 Row End Optical Black 2 Row Start Optical Black 2 Row End Optical Black 1 Column Start Optical Black 1 Column End Optical Black 2 Column Start Optical Black 2 Column End Identify the optical black rows and black columns in the image, for use by the optical black correction algorithms. Two sets of black rows can be defined (usually at the top and bottom of the image), and two sets of black columns can be defined (usually at the left and right of the image). This only applies if the black rows or black columns readout is enabled on the sensor.	integer
Update Sensor FPS Trigger DevWare to re-compute the sensor FPS. Only needed on SOCs with auto-exposure. No UI.	1
Allow Update Sensor FPS Don't re-compute sensor FPS. Re-computing the FPS requires register access transactions which affect performance. Corresponds to Allow Sensor FPS Polling checkmark on the Options dialog.	0 or 1
Allow FAR Access Let DevWare access registers on attached sensors. May interfere with firmware operation. Corresponds to Allow FAR Access checkmark on the Options dialog. For the mobile ISP products (MT9F311, AP1301, AP1302), it is required to only allow addresses that return an ACK when accessed (known-good addresses). Use a value >1 will add that address to the known-good address list. For all other parts, 0 will disallow all addresses and 1 will allow all addresses.	0 = allow known addresses 1 = allow all addresses >1 = add address to known-good address list
sRGB Color Standard Use sRGB coefficients for converting YCbCr data to RGB. Normally set automatically based on the register settings. No UI.	0 or 1
White Balance Enable software white balance for Bayer data. Color Correction must be on for this to take effect. 0 means off (use identity color correction matrix, CCM), 1 means automatic, 2 means manual adjust based on WB Manual variables below, 3 means full custom CCM. Corresponds to controls on software White Balance page. Duplicated per-context.	0, 1, 2, or 3
WB Speed How long it should take for auto white balance (AWB) to settle, in 1/10ths of seconds. No UI.	Integer
WB Adjust Gains Allow software AWB to adjust analog gains on the sensor. If this is off AWB will only adjust the CCM. Corresponds to Adjust Relative Gain checkmark on the White Balance page.	0 or 1
WB Apply Gains to CCM Merge white balance gains into CCM.	0 or 1
WB Current Returns the current AWB CCM. Duplicated per-context.	9 floating-point values
Relative Red Gain Ratio of red analog gain to green analog gain * 1000. Default depends on sensor, normally around 1000. No UI.	500 to 5000
Relative Blue Gain Ratio of blue analog gain to green analog gain * 1000. Default depends on sensor, normally around 2000. No UI.	500 to 5000
WB Manual Position Interpolation between Left and Right matrices on a scale from 0 to 100, with 0 corresponding to the Left matrix and 100 corresponding to the Right matrix. Corresponds to the Manual slider on the White Balance page. Duplicated per-context.	0 to 100
WB Manual RedGreen Extra red gain * 100. Corresponds to Relative Red control on White Balance page. Duplicated per-context.	1 to 200 (default = 100)
WB Manual BlueGreen Extra blue gain * 100. Corresponds to Relative Blue control on White Balance page. Duplicated per-context.	1 to 200 (default = 100)
WB Custom Color correction matrix to use in Custom white balance mode. Specify all nine values in row major order in floating point. Corresponds to Custom matrix on White Balance page. Duplicated per-context.	Matrix (default = 1.0 0 0 0 1.0 0 0 0 1.0)
AWB Incandescent Color correction matrix corresponding to Incandescent illumination. Specify all nine values in row major order in floating point.	Matrix
AWB Middle Color correction matrix corresponding to intermediate illumination. Specify all nine values in row major order in floating point.	Matrix
AWB Sun Color correction matrix corresponding to solar illumination. Specify all nine values in row major order in floating point.	Matrix
AWB Incandescent Gain Color correction red/green and blue/green gain values corresponding to incandescent illumination. Specify two values in floating point.	Two floating point values
AWB Middle Gain Color correction red/green and blue/green gain values corresponding to intermediate illumination. Specify two values in floating point.	Two floating point values
AWB Sun Gain Color correction red/green and blue/green gain values corresponding to solar illumination. Specify two values in floating point.	Two floating point values
AWB Incandescent Temp Temperature value for the left (incandescent) illumination CCM. Note: no range checking is performed between the 3 AWB Temp states.	Temperature in K
AWB Middle Temp Temperature value for the intermediate illumination CCM. Note: no range checking is performed between the 3 AWB Temp states.	Temperature in K
AWB Sun Temp Temperature value for the right (sun) illumination CCM. Note: no range checking is performed between the 3 AWB Temp states.	Temperature in K
CFA Pattern Tells DevWare what kind of color filter array the sensor has. 0 means monochrome (no CFA), 1 means Bayer, 2 means Paired Bayer (used on MT9V125/A-0345SOC), 3 means RGBC (Bayer with Gr replaced with clear), 4 means Clarity+ (RCCB), 5 means AR0834AI (1/4 Bayer, 3/4 mono), 6 means RCCC (Bayer with only Red and clear), 7 means RGBC infrared 2x2, 8 means RGB-IR 4x4, 9 means SuperCell, 10 means RCCG, 11 means SuperCell 2x1, 12 means RYYCy, 13 means Radar 4x1, 14 means LiDAR Note: once set, the list of individual filters available for the given pattern can be seen in DevWareX's "Data Interpretation" dialog and can be selected via the "Filter" STATE command.	0 to 14
CFA Labels Returns the currently active channel names. Based on CFA and Bayer patterns. See "Filter" and "CFA Pattern" for additional information.	string (read only).
Monochrome Indicates sensor is a monochrome sensor. Corresponds to Monochrome sensor checkmark on Startup Wizard.	0 or 1
Pure Raw JPEG A debug mode that forces DevWare to not try to interpret JPEG data from the sensor. The data is displayed as black&white pixels at one pixel per byte of data. Corresponds to the Pure Raw JPEG checkmark on the JPEG page.	0 or 1
Still Mode Type of still image capture. 0 means use current image coming from sensor, 1 means switch sensor to full resolution mode or use still capture sequence on SOC, 4 means full resolution continuous mode on supported SOCs. Corresponds to Capture control on Still Capture page.	0, 1 or 4
Still Hold Enables a one-click option for still images; immediately goes back to Preview instead of holding the still image and displaying it in the Film Strip.	0 or 1
Num Capture Frames Number of images to capture. Corresponds to Total Frames value on Still Capture page.	1 or more
Still Capture Average Enables averaging all still images into one image. Corresponds to Average into One Frame checkmark on Still Capture page.	0 or 1
Still Capture Timeout Set a timeout to give up if a valid still image frame does not arrive from the sensor, in seconds. Corresponds to Timeout (secs) value on Still Capture page.	Integer
Delay before snap Delay before capturing still image, and between each image if Num Capture Frames is more than 1, in milliseconds. Corresponds to Delay (msec) value on Still Capture page.	Integer
Still Global Reset Set whether to use Global Reset with still image capture. Global Reset exposes all pixels in the sensor simultaneously, instead of row sequentially (electronic rolling shutter, ERS). Normally it's necessary to use a mechanical shutter with Global Reset. Corresponds to Use Global Reset checkmark on Still Capture page.	0 or 1
Still FileName Increment or Capture FileName Increment Set whether to have the integer added to the end of the file name incremented each time a Still or Capture operation is performed.	0 or 1
Still First Number Set the first auto-filename number, and reset the count	Integer
Still File or Capture File A string representing the path and base-name of the file to store a Still or Capture image. It is assumed the path is valid.	string
Still Saved Files Returns a list of filenames from the last grab.	string (read-only)
Still Decompress For the Decompand Checkbox in Image Save Options.	0 or 1
Flash Lamp Set whether to use a flash lamp with still image capture and what type of flash lamp is attached. 0 means no flash, 1 means Xenon flash, 2 means LED flash. Corresponds to Flash Lamp controls on Still Capture page.	0, 1 or 2
WB Custom Xenon Color correction matrix to use when taking a Xenon flash still image. Specify all nine values in row major order in floating point. Only applies to A-0360SOC (MT9V111). Corresponds to controls on Still Capture page.	Matrix
WB Xenon Red Gain WB Xenon Blue Gain Ratios of red gain to green gain and blue gain to green gain to use when taking a Xenon flash still image * 1024. Corresponds to Flash Analog Gain Adj. controls on Still Capture page.	500 to 5000
WB Custom Led Color correction matrix to use when taking an LED flash still image. Specify all nine values in row major order in floating point. Only applies to A-0360SOC (MT9V111). Corresponds to controls on Still Capture page.	Matrix
WB Led Red Gain WB Led Blue Gain Ratios of red gain to green gain and blue gain to green gain to use when taking an LED flash still image * 1024. Corresponds to Flash Analog Gain Adj. controls on Still Capture page.	500 to 5000
Mechanical Shutter Same Set the mechanical shutter time equal to the electronic rolling shutter exposure time when taking a still image. Corresponds to Use Current Electronic Exposure Time control on Mech. Shutter page.	0 or 1
Mechanical Shutter Time Sets the mechanical shutter time, when Mechanical Shutter Same is 0. Corresponds to Exposure Time control on Mech. Shutter page.	microseconds
Mechanical Shutter Delay Value subtracted from Mechanical Shutter Time when computing the sensor register values, to allow for mechanical lag. Corresponds to Mechanical Delay control on Mech. Shutter page.	microseconds
Save RAW Save unprocessed still image data as unformatted binary data. Corresponds to RAW checkmark on Save Options page.	0 or 1
Save RAW TIFF Save unprocessed Bayer still image data in monochrome TIFF format. Corresponds to TIFF (raw) checkmark on Save Options page.	0 or 1
Save ITX Save unprocessed still image data in ITX format, ASCII decimal values with a header. Corresponds to ITX checkmark on Save Options page.	0 or 1
Save CCR Save unprocessed still image data in CCR format. Corresponds to CCR checkmark on Save Options page.	0 or 1
Save DXR Save unprocessed still image data in DXR format. Corresponds to DXR checkmark on Save Options page.	0 or 1
Save RAW JPEG Save JPEG compressed still image data unmodified from the JPEG compression module on the sensor, with a header added by DevWare. Corresponds to JPEG (raw) checkmark on Save Options page.	0 or 1
Save RAW PNG Save unprocessed Bayer still image data in monochrome PNG format. Corresponds to PNG (raw) checkmark on Save Options page.	0 or 1
Save HEX Save unprocessed still image data in ASCII text with tab-separated decimal (in spite of the fact the variable is called Save HEX) values, with a footer at the end. Corresponds to TAB (dec) checkmark on Save Options page.	0 or 1
Save 24bpp BMP Save processed still image in Windows BMP 24 bits/pixel RGB format. Corresponds to BMP (24bpp) checkmark on Save Options page.	0 or 1
Save BMP Info Append additional image information to the end of the BMP file. Not compatible with some applications. Corresponds to w/ Info checkmark on Save Options page.	0 or 1
Save 48bpp COLOR TIFF Save processed still image in RGB TIFF format, 48bpp if original data is Bayer, 24bpp otherwise. Corresponds to TIFF (48bpp) or TIFF (24bpp) checkmark on Save Options page.	0 or 1
ICC Profile Save an ICC profile in the RGB TIFF file. Corresponds to ICC Profile checkmark on Save Options page.	0 or 1
Save PNG Save processed still image in PNG 24 bits/pixel RGB format. Corresponds to PNG (24bpp) checkmark on Save Options page.	0 or 1
Save JPEG Save processed still image in JPEG format. DevWare will convert the processed RGB image to JPEG. Corresponds to JPEG (s/w) checkmark on Save Options page.	0 or 1
JPEG Quality (1-100) Compression quality setting to use when compressing the still image to JPEG. Corresponds to the Quality value on the Save Options page.	0 to 100
Save SS Save the status structure from the end of the image data (ICP-HD, AP1300, etc) in a separate file.	0 or 1
Save Selection Rectangle When saving a still image, whether to save the whole image or just the Mouse Selection Rectangle. 1 means save only the selection rectangle. Corresponds to Save Mouse Selection Rectangle only checkmark on the Save Options page.	0 or 1
Save TXT Save a dump of all registers and DevWare STATE variables. Corresponds to TXT (registers) checkmark on the Save Options page.	0 or 1
VidCap Format Video recording format. 0 = AVI; 1 = RAW; 2 = WMV. Corresponds to the Video File Format choice on the Video Record page.	0, 1, or 2
VidCap Play FPS Playback frame rate for recorded video file. Corresponds to the playback frame rate box on the Video Record page.	fps * 1000
VidCap Auto Play FPS Whether to set the playback frame rate automatically, or use VidCap Play FPS. Corresponds to the playback frame rate check boxk on the Video Record page.	0 or 1
VidCap Packed Save RAW video as packed or not packed.	0 or 1
VidCap Quality Set the compression rate for WMV recording.	0 to 100
Video Screen Capture Whether to switch sensor to video capture mode before recording data. Corresponds to the Screen Capture Only checkmark on the Video Record page.	0 or 1
VidCap File Name of video record file. Corresponds to the filename entry on the Video Record page.	filename
VidCap Filename Increment Whether to add a sequence number to the filename. Corresponds to the Auto File Name Increment checkmark on the Video Record page.	0 or 1
VidCap First Number Set the first auto-filename number, and reset the count	Integer
RAM Capture Whether to record video data to RAM buffers first before writing to a file. Doing so will improve capture performance, but only until the RAM is full. Corresponds to Capture to RAM checkmark on Video page.	0 or 1
RAM Capture MB How many megabytes of RAM to allocate to video capture. Corresponds to RAM buffer size value on Video page.	Integer
RAM Capture Cycle When capturing to RAM and the RAM buffers fill, whether to flush the buffers to disk and continue, flush the buffers to disk and stop recording, or cycle through the buffers again (circular buffer). Corresponds to the radio buttons on the Video page.	0 = flush and continue 1 = flush and stop 2 = circular buffer
Sensor Orientation The orientation of the sensor image. 0 means upright, 1 means horizontally mirrored, 2 means vertically flipped, 3 means rotated 180°.	0, 1, 2 or 3
Pixel Clock Polarity Calls the midlib function setMode() MI_PIXCLK_POLARITY. Overrides the pixel clock polarity setting from the sensor data file. 0 for rising, 1 for falling. Equates to the "Sample data on" field in Sensor Control dialog for the demo headboard.	0 or 1
Sensor Power Calls the midlib function setMode() MI_SENSOR_POWER. Turns off sensor head board power if the camera board supports it.	0 or 1
Sensor Reset Calls the midlib function setMode() MI_SENSOR_RESET. Sets the sensor RESET pin.	0 or 1
Sensor Shutdown Calls the midlib function setMode() MI_SENSOR_SHUTDOWN. Sets the sensor SHUTDOWN pin on headboards with this signal.	0 or 1
SHiP Speed Calls the midlib function setMode() MI_SHIP_SPEED. Sets the I2C bus speed, in KHz.	100, 400, or 1000
Direct VAR Access Calls the midlib function setMode() MI_DIRECT_VAR_ACCESS. Determines whether to use the direct or indirect method of accessing firmware variables on SOC devices that support both methods.	0 or 1
RX Type Calls the midlib function setMode() MI_RX_TYPE. Sets the data connection between the sensor and the main board. Values 0 through 4 are Disabled, Parallel, CCP, MIPI, and HiSPI respectively.	0 to 4
RX Lanes Calls the midlib function setMode() MI_RX_LANES. Sets the number of data lanes between the sensor and the main board.	Integer
RX BitDepth Calls the midlib function setMode() MI_RX_BIT_DEPTH. Sets the serial bit depth between the sensor and the main board.	Integer
RX Mode Calls the midlib function setMode() MI_RX_MODE. Sets the HiSPI mode.	0 to 3
RX Class Calls the midlib function setMode() MI_RX_CLASS. Sets the CCP class.	Integer
RX Sync Code Calls the midlib function setMode() MI_RX_SYNC_CODE. Sets the HiSPI sync codes.	Integer
RX Embedded Data Calls the midlib function setMode() MI_RX_EMBEDDED_DATA. Sets whether embedded data will be sent over the serial link.	0 or 1
RX Virtual Channel Calls the midlib function setMode() MI_RX_VIRTUAL_CHANNEL. Sets the MIPI virtual channel.	Integer
RX MSB First Calls the midlib function setMode() MI_RX_MSB_FIRST. Sets the bit order for HiSPI transmission.	0 or 1
RX CCIR656 Calls the midlib function setMode() MI_RX_CCIR656. Sets whether the main board should interpret CCIR656 sync codes.	0 or 1
Interlaced Image Calls the midlib function setMode() MI_RX_INTERLACED. Set whether the image from the sensor is interlaced.	0 or 1
HW Red Gain Not really a software variable, this sets the gain register on the sensor given a floating point gain value.	Floating-point value
HW Green1 Gain Not really a software variable, this sets the gain register on the sensor given a floating point gain value.	Floating-point value
HW Green2 Gain Not really a software variable, this sets the gain register on the sensor given a floating point gain value.	Floating-point value
HW Blue Gain Not really a software variable, this sets the gain register on the sensor given a floating point gain value.	Floating-point value
HW Gain Not really a software variable, this sets the gain register on the sensor given a floating point gain value.	Floating-point value
HW Global Gain Not really a software variable, this sets the global gain register on the sensor, for those sensors with a separate gain that affects all color channels, given a floating point gain value.	Floating-point value
HW Exposure Time Not really a software variable, this sets the integration time register on the sensor given a floating point time value, in seconds.	Floating-point value
HW Exposure Index If there is an exposure table already defined by STATE= Exposure Table commands, then STATE= Exposure Index writes the register values in the table associated with the given index (the index is the first number in each table entry), or the closest index to the given index. If no exposure table is define or active then the command does nothing.	Integer
Exposure Table Creates a custom exposure table. This structure is used for the user-defined gain table (mapping from gain value to register value). Maximum of 8 tables, each with maximum 64 register/data pairs. STATE= Exposure Table, index; reg0 data0; reg1 data1; ....	Integer
Exposure Table Select Select whether to use the built-in logic for converting exposure register values or use the user-defined exposure table. Table 0 is no table, tables 1 ... 8 are user-defined.	Integer
Exposure Table Reset Reset the exposure table to empty. Table 0 is no table, tables 1 ... 8 are user-defined.	Integer
All Exposure Index Returns a list of all indexes in the table.	String (read-only)
Calculate Focus Disable/Enable the generation of the "Focus Assist" Focus Metric.	0 or 1
Calculate Focus Overlay Disable/Enable the display overlay of the Focus Metric value and the portions of the display being used to generate it.	0 or 1
Focus When Calculate Focus is enabled, the value of the Focus Metric.	Integer
Noise Image Type Which image data to use in the noise measurement. 0 means raw data, treated as Bayer, 1 means raw data treated as monochrome, 2 means processed RGB data, 3 means both raw and RGB data.	0 to 3
Noise Frames How many frames to include in the noise measurement.	Integer
Noise Defects Number of worst rows or worst columns to consider in the deviation of worst rows/columns and noise of worst rows/columns reports.	Integer
Delay Noise Measurement How many frames to skip before beginning noise measurement.	Integer
Begin Noise Measurement Set to 1 to trigger noise measurement. Delay Noise Measurement frames will be skipped, then Noise Frames frames will be used to generate the noise measurement. This variable returns back to 0 automatically when the noise measurement is completed.	0 or 1
Noise Measurement Results After the noise measurement is completed, this is the results as a table of ASCII data.	String (read-only)
Noise Results JSON After the noise measurement is completed, this is the results in JSON format. d = ap_GetStateStr(apbasedev, b'Noise Results JSON') d = json.loads(d)	String (read-only)
Copy to Clipboard When set, the next frame will be copied to the clipboard. Automatically returns to 0.	0 or 1
Send to Viewer When set, the next frame will be sent to Aptina Viewer. Automatically returns to 0.	0 or 1
Product Variant Set the Product Variant string, which shows on the Info dialog. This can be any string value. Also, if the string matches a known "CFA Pattern", that Color Filter Array will be enabled. The "CFA Pattern" value is used with the following strings; "MONO" = 0 "BAYER" = 1 "RGBC" = 3 "RCCB", "ClarityPlus" or "Clarity+" = 4 "RCCC" = 6 "RGBI" = 7 (RGB-IR 2x2) "RGBI4" = 8 (RGB-IR 4x4) "SuperCell" = 9 "RCCG" = 10 "SuperCell2" = 11 "RYYCy" = 12 "RADAR" = 13 "LIDAR" = 14 Note: only use the string value in quotes - the numbers listed after the string are supplied as a cross-reference to their associated "CFA Pattern" STATE command values.	String
VisNIR Control the plug-in via from INI file presets, which in turn can be assigned to shortcut keys.	"invoke" = invoke pipeline "live" = show live images "rgb" = show processed RGB images "nir" = shows processed NIR images
RGBIR Denoise RGB-IR plugin use. You can increase the frame rate substantially by turning off the IR noise filtering. There is some image quality loss, but you can judge the trade-off.	0 or 1
RGBIR Linearized HDR RGB-IR plugin use. Perform IR subtraction when 1. When 0 and subimage is PostView ("Current Subimage" == 1). Default is 0.	0 or 1
RGBIR CCN RGB-IR plugin use. IR Separation Matrix. Can be generated by SensorTune with the "IR Separation Matrix Calculation" option, and via the RGB-IR plug-in GUI.	4 x 4 matrix of floats
RGBIR Denoise RGB-IR plugin use. When 1, perform the Denoise function. When 0, do not. Default 0. Note; this is compute intensive.	0 or 1
RGBIR Sat Pixel Threshold RGB-IR plugin use. Pixel saturation % threshold. Default 85. The plug-in skips the CCN processing where pixels are close to saturation. You can avoid it by setting the saturated pixel threshold to 100 so all pixels are included in CCN processing. A value of 101 is needed if you want to treat all pixels as non-"saturated". 100 still treats fully saturated pixels as "saturated". ("Saturated" pixels don't get the CCN matrix step.)	0 to 101
RGBIR Mask Overlay RGB-IR plugin use. Indicate Saturated Pixels. 0 to disable. 1 to show overlay mask of Saturated Pixels, 2 to show overlay mask of Non-Saturated Pixels. Default 0.	0, 1, or 2
User Text Top Left User Text Top Right User Text Bottom Left User Text Bottom Right The supplied text string is placed at the specified location.	string
Hide Top Data Rows Show/Hide Embedded Data display on the image.	0 or 1
Hide Bottom Data Rows Show/Hide Embedded Stats display on the image.	0 or 1
DLO Noise Filter Set the state of the noise filter.	0 = off 1 = linear formula 2 = quadratic formula
DLO Noise Filter Threshold Set the threshold value; default is 132	Integer
DLO Noise Filter S1 Set Filter S1; default is 4	Integer
DLO Noise Filter S2 Set Filter S1; default is 132	Integer
PDAF Defocus Get the current Defocus number; the lens position relative to in-focus. Zero = in-focus. This signed integer, when added to the current lens actuator value, represents the in-focus lens position. It is normalized by divided by the Phase Difference Coefficient.	Integer
PDAF Defocus Dev Get the current Defocus deviation; low number indicates little deviation. This signed integer represents the range of the defocus value. It is normalized by divided by the Phase Difference Coefficient.	Integer
PDAF Phase Diff Ofs Get/set this tuning parameter offset to bring the defocus value to zero when the image is in-focus. double pdOfs = atof(GetStateStr("PDAF Phase Diff Ofs"));	Integer
PDAF Phase Diff Coef Get/set this tuning parameter offset defocus value which indicates the lens actuator movement needed in actuator 'steps'. double pdCoef = atof(GetStateStr("PDAF Phase Diff Coef"));	Integer
PDAF LPeak GPeak Ratio Get/set this tuning parameter for setting this ratio. double pd = atof(GetStateStr("PDAF LPeak GPeak Ratio")); Default is 1.08.	Floating-point value
PDAF LPeak LMin Ratio Get/set this tuning parameter for setting this ratio. double pdCoef = atof(GetStateStr("PDAF LPeak LMin Ratio")); Default is 1.02.	Floating-point value

Browser not supported