Base |
The BasePluginCamera type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ActivatedChainableFeatures |
Gets the activated chainable features.
(Inherited from BaseDeviceController) |
| BigPictureMat | The "big picture" used as source image in case the camera is an emulator. Is null otherwise. |
| CalibrationDataSet | The set of all defined calibrations. A user can add a new calibration for a specific focus level. The current level is stored in property FocusLevel. |
| CalibrationDataSetTmp | |
| CalibrationInfo | |
| CalibrationInfoBackground | |
| CameraID | The ID to identify the camera in a list of available cameras. |
| CameraState | The state the camera is currently in. Needed for synchronizing the different modules. |
| CenterOffsetPixel | The offset in pixel x and y direction needed to let the camera view at the origin when the scan head points at the origin. |
| CenterOffsetWorld | The offset in x and y direction needed to let the camera view at the origin when the scan head points at the origin. |
| CenterOffsetWorldTmp | Temporary CenterOffset to restore the original value in case the Cancel button is pressed. |
 | ConfigurationManager | (Inherited from BasePlugin) |
| CorrectedWaveLengthScaleFactor | The wave length scale factor, but corrected by the field and process transformation. |
| CorrectionFileHash | The hash of the correction file the calibration is done for. |
| DownscaleFactor | A taken picture is downscaled by this factor [0.01 .. 1.0] before the Bitmap is returned. |
| EnableChainableFeature |
Gets or sets the flag to enable chainable features.
(Inherited from BaseDeviceController) |
| ExposureTime | The time a single frame will be exposed in ms. |
| ExposureTimeMax | The maximal exposure time the camera can be set to in ms. Used to control the allowed range in the settings dialog. |
| ExposureTimeMin | The minimal exposure time the camera can be set to in ms. Used to control the allowed range in the settings dialog. |
| FieldHeightMaxPixel | The maximal camera height in pixel as allowed by the camera model. May depend on the current binning state. |
| FieldHeightPixel | The height of the camera image in pixel. |
| FieldHeightWorld | The height of the area (camera image) in the scan field the camera looks on in micrometers when visible light is used; changes when the pixel height of the camera is changed. |
| FieldHeightWorldFromCalib | The height of the area (camera image) in the scan field the camera looks on in micrometers as measured during calibration using the full camera resolution. In case of a z-range there will be two values, one for the upper and one for the lower working distance. |
| FieldHeightWorldTmp | Temporary FieldHeightWorld to restore the original value in case the Cancel button is pressed. |
| FieldTrafo | The field transformation currently used. Relevant only in case of a camera emulator. |
| FieldWidthMaxPixel | The maximal camera width in pixel as allowed by the camera model. May depend on the current binning state. |
| FieldWidthPixel | The width of the camera image in pixel. |
| FieldWidthWorld | The current width of the area (camera image) in the scan field the camera looks on in micrometers when visible light is used; changes when the pixel width of the camera is changed. |
| FieldWidthWorldFromCalib | The width of the area (camera image) in the scan field the camera looks on in micrometers as measured during calibration using the full camera resolution. In case of a z-range there will be two values, one for the upper and one for the lower working distance. |
| FieldWidthWorldTmp | Temporary FieldWidthWorld to restore the original value in case the Cancel button is pressed. |
| FocusBiasTmp | Temporary focus bias to restore the original value in case the Cancel button is pressed. |
| FocusLevel | The focus level in micrometers currently set. Used for communication with the Click&Teach panel. |
| Gain | The current gain value set in the camera. |
| GainMax | The maximal gain value allowed by the camera model. Used to control the allowed range in the settings dialog. |
| GainMin | The minimal gain value allowed by the camera model. Used to control the allowed range in the settings dialog. |
| HasConnectedStatus |
Is true if the device supports the IsConnected status.
(Inherited from BaseDeviceController) |
| HasScanHeadLensMounted | Should be set to true if a lens is mounted to the scan head. The information is needed when using Click&Teach in the distortion correction process to cut the tiles accordingly. |
| HasScanHeadLensMountedTmp | Temporary flag for connected theta lens in case the Cancel button is pressed. |
| IsAutoBrightness | If true the brightness may be set automatically by the camera. Depends on if auto gain and/or auto exposure is set additionally. Only used if the parameter is available in the camera settings. |
| IsAutoCalibration | Flag to indicate that the dialog is in auto calibration mode rather than in manual calibration mode. |
| IsAutoConnect | (Inherited from BaseDeviceController) |
| IsAutoExposure | If true the exposure time is set automatically by the camera. |
| IsAutoGain | If true the gain is set automatically by the camera. |
| IsAveragePixels | Flag to indicate if - in case of binning - the pixels will be averaged. |
| IsCalibrated | Flag to indicate if the camera is calibrated already, i. e. FieldWidthWorldFromCalib and FieldHeightWorldFromCalib are > 0. |
| IsCalibrationInProgress | |
| IsCameraFieldSizeReduced | |
| IsCombinePixels | Flag to indicate if binning is active. |
| IsConnected | (Overrides BaseDeviceControllerIsConnected) |
| IsDirty | Flag to indicate that some parameters have been changed. |
| IsEmulator | Flag to indicate if this camera is an emulated one. |
| IsFocusShifter | Our definition for a focus shifter scan head: There is a z axis but no sensor axis. |
| IsInitialized |
Is true if the device is initialized.
(Inherited from BaseDeviceController) |
| IsRectificationCalibrationInProgress | |
| IsSettingsDialogOpen | Flag is set to true if the settings dialog is open. |
| IsStreaming | If true, the camera is currently streaming. |
| IsToFlip | If true the camera picture will be flipped horizontally. |
| IsUsedByGUI | If the camera has access to RAYGUIDE's GUI there are more services available, e. g. the JobDefinitionService. If the GUI is not available the value must be set to false (true is the default value). |
| LastPickedPointWorld | The point where the user has picked the last time. Used to show the cross hairs in the renderer. |
| LastPickedRegionWorld | |
| LastRawTakenImage | The last taken image without any modifications as equalization or downscaling. |
| LastTakenImage | The last taken image with possibly done modifications as equalization or downscaling. |
| LeftFieldWidthCalibrationMarkRatio | The position of the left calibration guide line, set during resolution calibration, given es ratio of the FieldWidth (0..1). |
| LogDirectory |
The directory of the log file.
(Inherited from BasePlugin) |
| Logger |
The common logger.
(Inherited from BasePlugin) |
| LowerRightCornerCalibrationMarkRatio | The position of the marked lower right corner in the wave length calibration stage; given as ratio of the field width. |
| LowerRightCornerWorld | When calibrating the wave length correction: The lower right corner of the calibrating rectangle where it should be in world coordinates in micrometers. |
| LowerRightCornerWorldTmp | Temporary LowerRightCorner to restore the original value in case the Cancel button is pressed. |
 | MarkerAPI | RAYGUIDE's MarkerAPI object; needs to be set before GetPointInScanfield() ff. are called. |
| NumberOfChannels | |
| PenNumber | The pen used when creating the calibration jobs. |
| Pens | A dictionary to assign a color and name to a pen for displaying it in the camera settings dialog. |
| PixelHeightWorld | The height of the area in the scan field a pixel is covering in micrometers when visible light is used. |
| PixelWidthWorld | The width of the area in the scan field a pixel is covering in micrometers when visible light is used. |
| PluginMetadata |
The metadata of the plugin instances. If the concrete class inherits from the BasePluginSetup interface, the metadata of the BasePluginSetup will be prefilled.
(Inherited from BasePlugin) |
| PointerFocusBiasTmp | Temporary preview focus bias to restore the original value in case the Cancel button is pressed. |
| ProcessTrafo | The process transformation currently used. Relevant only in case of a camera emulator. |
| RectificationCalibrationCrossRatio | The position where the crosses in the rectification calibration job will be created in a calibration tile as percentage of the camera's field width. The formula for calculating the offsets compared to the camera field's mid point is Camera.FieldWidthWorld * 0.8 / 2. Example: If the camera's field width is 30 mm the crosses will be at the x positions -12 and 12; i. e. their distance is 80 percent of the camera's field width. |
| RectificationCropFactor | A tile will be cropped by this percentage if a F-Theta lens is mounted and equalization is activated. |
| RectificationCropFactorTmp | Temporary rectification crop factor, stored in case the Cancel button is pressed. |
| RectificationDataSet | The currently used rectification data set; interpolated values depending on the focus level. |
| ScanFieldImage | The whole scan field the camera is looking at as image in form of an OpenCV Mat object. Its size depends on the scan field size in world coordinates, the size a pixel of the camera represents in the real world plane (depends on the DownscaleFactor) and the camera's FieldWidthPixel and FieldHeightPixel. In this (untransformed) image all tiles are gathered. The transformation according to field and process transformation must be done with method TransformScanFieldImage() before putting it into the workspace's background. |
| ScanFieldSizeWorld | The size of the scan field in world coordinates the calibration is done for. |
| ScanHead |
The scan head the camera is attached to in on-axis setups or
null if it is an off-axis camera.
(Inherited from BaseCamera) |
| ScanHeadPosition | The current scan head position in world coordinates, i. e. the point where the camera currently looks at. |
| ScanHeadShortLabel | The short label of the scan head the calibration is done for. |
| ScanHeadTmp | Temporary scan head to restore the original value in case the Cancel button is pressed. |
| SelectedFocusLevel | The last selected focus level in the GUI in micrometers. |
| SerialNumber |
Serial number of the device.
(Inherited from BaseDeviceController) |
| StandardMeasure | The standard distance to be used when calibrating the camera in micrometers. |
| StandardMeasureTmp | Temporary StandardMeasure to restore the original value in case the Cancel button is pressed. |
| Statuses | (Inherited from BaseDeviceController) |
| SupportedChainableFeatureMap |
The map of chainable feature types supported by this device. The value indicates whether the feature is a transmitter or a receiver.
(Inherited from BaseDeviceController) |
| TransformedScanFieldImage | This is the ScanFieldImage, but transformed by the inverse field and process transformation. |
| UpperLeftCornerCalibrationMarkRatio | The position of the marked upper left corner in the wave length calibration stage; given as ratio of the field width. |
| UpperLeftCornerWorld | When calibrating the wave length correction: The upper left corner of the calibrating rectangle where it should be in world coordinates in micrometers. |
| UpperLeftCornerWorldTmp | Temporary UpperLeftCorner to restore the original value in case the Cancel button is pressed. |
| WaveLengthScaleFactor | The scale factor needed to correct the deviation between the laser wave length and the visible light's wave length recorded by the camera. This is the value retrieved from the calibration; field rotation is not taken into account. |
| WorkspaceConfiguration |
The workspace configuration which is used during calibration.
(Inherited from BaseCamera) |
See Also