STATE Variables
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 | 3 to 1600 (default = 100) |
Reset Image Fifo | 0 or 1 |
Filter 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. 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. 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 | 0, 1 or 2 |
Current Subimage | 0, 1 or 2 |
Subimage Merge | 0 or 1 |
X Offset | 0 or 1 |
Y Offset | 0 or 1 |
Auto Offset | 0 or 1 |
Gb-B Swap | 0 or 1 |
Byte Swap | 0 or 1 |
True Black Enable | 0 |
True Black Level | Integer |
True Black Scale | Integer |
Active True Black | Integer |
ALTM Enable 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 |
What do I do if I want to set a value for pixel integration time like you can on the DevWare application if you turn off auto exposure?