Base |
public abstract class BasePluginCamera : BaseCamera
The BasePluginCamera type exposes the following members.
| Name | Description | |
|---|---|---|
| BasePluginCamera | The constructor initializes the camera. |
| Name | Description | |
|---|---|---|
| ActivatedChainableFeatures |
Gets the activated chainable features.
(Inherited from BaseDeviceController) | |
| BrightImageFfcFileName | The path and file name of the bright image for flat field correction. | |
| 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. | |
| CalibrationInfo | ||
| CalibrationInfoBackground | ||
| CameraID | The ID to identify the camera in a list of available cameras. | |
| 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. | |
| ConfigurationManager | (Inherited from BasePlugin) | |
| DarkImageFfcFileName | The path and file name of the dark image for flat field correction. | |
| DownscaleFactor | A taken picture is downscaled by this factor [0.01 .. 1.0] before the Bitmap is returned. | |
| DriverVersionMismatchWarning | ||
| EnableChainableFeature |
Gets or sets the flag to enable chainable features.
(Inherited from BaseDeviceController) | |
| ExposureTime | The time a single frame will be exposed in ms. | |
| 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. | |
| 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. | |
| Gain | The current gain value set in the camera. | |
| 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. | |
| 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. | |
| 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. | |
| IsCombinePixels | Flag to indicate if binning is active. | |
| IsConnected | (Overrides BaseDeviceControllerIsConnected) | |
| IsEmulator | Flag to indicate if this camera is an emulated one. | |
| IsFlatFieldCorrection | If true, flat field correction will be done. | |
| IsHardwareTrigger | If true, the camera is triggered by a hardware signal instead via software. | |
| IsHardwareTriggerWait | If true, the camera waits for a hardware pulse signaling that image transfer is done instead for software event. | |
| IsInitialized |
Is true if the device is initialized.
(Inherited from BaseDeviceController) | |
| IsManualTriggerLoop | If true, the camera will be triggered by TakePictureMat by using a WritePortAutomation object. Otherwise the camera will be triggered by Click and Teach after setting the mirror positions using BaseScanController.GoToAndTrigger(). | |
| IsToFlip | If true the camera picture will be flipped horizontally. | |
| 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. | |
| PenNumber | The pen used when creating the calibration jobs. | |
| 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) | |
| RectificationCropFactor | A tile will be cropped by this percentage if a F-Theta lens is mounted and equalization is activated. | |
| 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. | |
| 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. | |
| 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) | |
| 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. | |
| 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) |
| Name | Description | |
|---|---|---|
| CheckDriverAndShowNotification | ||
| CheckOnCameraDriver | ||
| Connect |
Connects to the device.
(Inherited from BaseDeviceController) | |
| ConvertPixelLengthToWorldLength | Converts a distance, given in pixel coordinates, into the same distance in world coordinates. The downscale factor is taken into account. | |
| ConvertPixelPosToWorldPos | Inversion method of ConvertWorldPosToPixelPos(). | |
| ConvertScanFieldPixelToWorld | converts scan field pixel point to the scan field or world coordinates (µm) pixel coordinate system: left top 0/0 right bottom w/h | |
| ConvertScanFieldWorldToPixel | converts scan field or world coordinates to pixel | |
| ConvertWorldLengthToPixelLength | Converts a distance, given in world coordinates, into the same distance in pixel coordinates. The downscale factor is taken into account. | |
| ConvertWorldPosToPixelPos | Converts a point in world coordinates into pixel coordinates. The current size in world coordinates and the current pixel size of the scan field is taken into account. The origin in world coordinates is expected to be in the middle of the field. Attention: Field and process transformations are not considered. | |
| Disconnect |
Disconnects from the device.
(Inherited from BaseDeviceController) | |
| Dispose | (Inherited from BasePlugin) | |
| Dispose(Boolean) |
Stops the streaming and disconnects the camera.
(Overrides BaseDeviceControllerDispose(Boolean)) | |
| DisposeUI |
Disposes the given setting view.
(Inherited from BaseDeviceController) | |
| DoDisposeUI | (Inherited from BasePlugin) | |
| DoShowUI |
Shows the specific UI embedded in the plug-in instance. The content will be wrapped by a preset view.
(Inherited from BasePlugin) | |
| DoShowUICallback |
Invokes the callback that can be used when the DoShowUI method is done.
(Inherited from BasePlugin) | |
| GetDeviceStatusRepresentation | (Overrides BaseDeviceControllerGetDeviceStatusRepresentation) | |
| GetFieldSizePixel | Size of one camera image | |
| GetLastScanHeadPositionFieldRectPixel | ||
| GetScanFieldSizePixel | Gets the field size in pixels with respect to the downscale factor the user has set. | |
| HandleExternalDeviceRequestAsync |
Handles a chained request for a given list of features.
(Inherited from BaseDeviceController) | |
| Initialize |
Plug-in specific initialization can be done here if necessary.
(Inherited from BasePlugin) | |
| InitializeCalibrationDataSet | Initializes the calibration data set based on the scan head's configuration file. If there are no entries in the dictionary, two entries are created with the top and bottom z-values. Otherwise the min and max focus levels are read from the dictionary's min and max levels. The remaining data must be filled later with the calibration data. | |
| InvokeConnected |
Invokes Connected event.
(Inherited from BaseDeviceController) | |
| InvokeDeviceUIRequested |
Callback method to show the nested scan head settings dialog.
(Inherited from BaseCamera) | |
| InvokeDisconnected |
Invokes Disconnected event.
(Inherited from BaseDeviceController) | |
| InvokeInitialized |
Invokes Initialized event.
(Inherited from BaseDeviceController) | |
| InvokeStatusChanged |
Invokes StatusChanged event.
(Inherited from BaseDeviceController) | |
| LoadCalibration | Loads the properties building the calibration data. | |
| LoadFlatFieldCorrectionFiles | Loads the bright and dark images for flat field correction. | |
| OnDevicesChanged | (Inherited from BaseDeviceController) | |
| SaveCalibration | Saves the properties building the calibration data. | |
| SetCurrentParameterValuesOnCamera | Sets the camera parameters in the hardware according to the current parameters in this camera object. | |
| SetExposureTimeOnCamera | ||
| SetGainOnCamera | ||
| SetIsAutoBrightnessOnCamera | ||
| SetIsAutoExposureOnCamera | ||
| SetIsAutoGainOnCamera | ||
| SetIsCombinePixelsOnCamera | Sets whether pixels should be combined. Can be overloaded to set it in the camera's real hardware. | |
| ShowUI |
Shows the specific UI embedded in the plugin instance.
(Inherited from BaseDeviceController) | |
| ShowUICallback |
Invokes the callback that can be used when the ShowUI method is done.
(Inherited from BaseDeviceController) | |
| ShowUICancelCallback |
Invokes the callback that can be used when the ShowUI method is done and the user pressed the cancel button
(Inherited from BasePlugin) | |
| StartStreaming | Starts streaming of video data. | |
| StopStreaming | Stops streaming of video data. | |
| StoreCurrentCameraSettings | Stores all current camera settings in the temporary properties. This is needed to allow the cancel button in the settings dialog to work: When the dialog is opened all current settings are stored here. The user can now change all parameters as he wants it, and they can be used immediately internally e. g. for the calibration process (using the possibly changed StandardMeasure e. g.). If the dialog is canceled afterwards all parameters can be restored from temporary values. | |
| TakePicture | Takes a picture with the camera and downscales it if demanded. The default color (red) is used for the cross hairs. | |
| ToString | (Inherited from BasePlugin) | |
| UpdateFieldSizeProperties |
| Name | Description | |
|---|---|---|
| Connected |
An event that is triggered when the device is connected.
(Inherited from BaseDeviceController) | |
| DeviceUIRequested |
Getting called when the camera UI gets requested.
(Inherited from BaseCamera) | |
| Disconnected |
An event that is triggered when the device is disconnected.
(Inherited from BaseDeviceController) | |
| Initialized |
An event that is triggered when the device is initialized.
(Inherited from BaseDeviceController) | |
| StatusChanged |
An event that is triggered when the status of the device is changed.
(Inherited from BaseDeviceController) |
| Name | Description | |
|---|---|---|
| _deviceManager | ||
| _isTakeWorkspaceCalibrationIntoAccount | ||
| _oldFieldHeightWorld | ||
| _oldFieldWidthWorld |