1.12. DummyGrabber
Summary: |
A virtual white noise grabber |
Type: |
DataIO |
License: |
Licensed under LPGL. |
Platforms: |
Windows, Linux |
Devices: |
Virtual camera providing random noise images |
Author: |
C. Kohler, W. Lyda, ITO, University Stuttgart |
1.12.1. Overview
The DummyGrabber is a virtual camera which emulates a camera with white noise.
The camera is initialized with a maximum width and height of the simulated camera chip (both need to be a multiple of 4). You can choose between different image types (noise, GaussianSpot). The value range is always scaled in the range between 0 and the current bitdepth (bpp - bit per pixel). The gaussianSpot has some random noise for the position and amplitude to move around a bit. The real size of the camera image is controlled using the parameter ‘roi’ if the sizes stay within the limits given by the size of the camera chip.
You can initialize this camera either as a 2D sensor with a width and height >= 4 or as line camera whose height is equal to 1.
This plugin can also be used as template for other grabber.
1.12.2. Initialization
The following parameters are mandatory or optional for initializing an instance of this plugin:
- maxXSize: int, optional
Width of virtual sensor chip
Value range: [4:4:4096], Default: 640
- maxYSize: int, optional
Height of virtual sensor chip, please set this value to 1 (line camera) or a value dividable by 4 for a 2D camera.
Value range: [1, 4096], Default: 480
- bpp: int, optional
Bits per Pixel, usually 8-16bit grayvalues
Value range: [8:2:30], Default: 8
- imageType: str, optional
Available dummy image types: noise (default), gaussianSpot
Match: [“noise”, “gaussianSpot”, “gaussianSpotArray”], Default: “noise”
1.12.3. Parameters
An instance of this plugin has the following parameters:
- binning: int
Binning of different pixel, binning = x-factor * 100 + y-factor
Value range: [101, 404], Default: 101
- bpp: int
bitdepth of images
Value range: [8:2:30], Default: 8
- demoArbitraryString: str
any string allowed
Match: <no pattern given>, Default: “any string”
- demoEnumString: str
enumeration string (mode 1, mode 2, mode 3)
Match: [“mode 1”, “mode 2”, “mode 3”], Default: “mode 1”
- demoEnumStringList: Sequence[str]
one or two options allowed.
Allowed number of values: 1 - 2, Value rules: Match: [“option1”, “option2”, “option3”], Default: [option1, option3]
- demoRegexpString: str
matches strings without whitespaces
RegExp: “^S+$”, Default: <empty str>
- demoWildcardString: str
dummy filename of a bmp file, pattern: *.bmp
Wildcard: “.bmp”, Default: “test.bmp”*
- frame_time: float
Minimum time between the start of two consecutive acquisitions [s], default: 0.0.
Value range: [0, 60], Unit: s, Default: 0
- gain: float
Virtual gain
Value range: [0, 1], Default: 1
- integration_time: float
Minimum integration time for an acquisition [s], default: 0.0 (as fast as possible).
Value range: [0, 60], Unit: s, Default: 0
- name: str, read-only
GrabberName
Match: “General”, Default: “DummyGrabber”
- offset: float
Virtual offset
Value range: [0, 1], Default: 0
- roi: Tuple[int,int,int,int] (rect [x0,y0,width,height])
ROI (x,y,width,height) [this replaces the values x0,x1,y0,y1]
Height: Value range: [0:4:479], Default: [0, 0, 640, 480]
- sizex: int, read-only
size in x (cols) [px]
Value range: [4:4:640], Default: 640
- sizey: int, read-only
size in y (rows) [px]
Value range: [4:4:480], Default: 480