Click or drag to resize

BasePluginCamera Class

This class is the base for all kinds of cameras realized as plug-ins.
Inheritance Hierarchy

Namespace: RAYLASE.Marker.CamerasPlugin
Assembly: RAYLASE.Marker.CamerasPlugin (in RAYLASE.Marker.CamerasPlugin.dll) Version: 2.49.0
Syntax
C#
public abstract class BasePluginCamera : BaseCamera

The BasePluginCamera type exposes the following members.

Constructors
 NameDescription
Protected methodBasePluginCamera The constructor initializes the camera.
Top
Properties
 NameDescription
Public propertyActivatedChainableFeatures Gets the activated chainable features.
(Inherited from BaseDeviceController)
Public propertyBrightImageFfcFileName The path and file name of the bright image for flat field correction.
Public propertyCalibrationDataSet 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.
Public propertyCalibrationInfo 
Public propertyCalibrationInfoBackground 
Public propertyCameraID The ID to identify the camera in a list of available cameras.
Public propertyCenterOffsetWorld The offset in x and y direction needed to let the camera view at the origin when the scan head points at the origin.
Protected propertyConfigurationManager
(Inherited from BasePlugin)
Public propertyDarkImageFfcFileName The path and file name of the dark image for flat field correction.
Public propertyDownscaleFactor A taken picture is downscaled by this factor [0.01 .. 1.0] before the Bitmap is returned.
Protected propertyDriverVersionMismatchWarning 
Public propertyEnableChainableFeature Gets or sets the flag to enable chainable features.
(Inherited from BaseDeviceController)
Public propertyExposureTime The time a single frame will be exposed in ms.
Public propertyFieldHeightPixel The height of the camera image in pixel.
Public propertyFieldHeightWorld 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.
Public propertyFieldHeightWorldFromCalib 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.
Public propertyFieldWidthPixel The width of the camera image in pixel.
Public propertyFieldWidthWorld 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.
Public propertyFieldWidthWorldFromCalib 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.
Public propertyGain The current gain value set in the camera.
Public propertyHasConnectedStatus Is true if the device supports the IsConnected status.
(Inherited from BaseDeviceController)
Public propertyHasScanHeadLensMounted 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.
Public propertyIsAutoBrightness 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.
Public propertyIsAutoConnect
(Inherited from BaseDeviceController)
Public propertyIsAutoExposure If true the exposure time is set automatically by the camera.
Public propertyIsAutoGain If true the gain is set automatically by the camera.
Public propertyIsAveragePixels Flag to indicate if - in case of binning - the pixels will be averaged.
Public propertyIsCombinePixels Flag to indicate if binning is active.
Public propertyIsConnected
(Overrides BaseDeviceControllerIsConnected)
Public propertyIsEmulator Flag to indicate if this camera is an emulated one.
Public propertyIsFlatFieldCorrection If true, flat field correction will be done.
Public propertyIsHardwareTrigger If true, the camera is triggered by a hardware signal instead via software.
Public propertyIsHardwareTriggerWait If true, the camera waits for a hardware pulse signaling that image transfer is done instead for software event.
Public propertyIsInitialized Is true if the device is initialized.
(Inherited from BaseDeviceController)
Public propertyIsManualTriggerLoop 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().
Public propertyIsToFlip If true the camera picture will be flipped horizontally.
Protected propertyLogDirectory The directory of the log file.
(Inherited from BasePlugin)
Public propertyLogger The common logger.
(Inherited from BasePlugin)
Public propertyLowerRightCornerCalibrationMarkRatio The position of the marked lower right corner in the wave length calibration stage; given as ratio of the field width.
Public propertyLowerRightCornerWorld When calibrating the wave length correction: The lower right corner of the calibrating rectangle where it should be in world coordinates in micrometers.
Public propertyPenNumber The pen used when creating the calibration jobs.
Public propertyPluginMetadata 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)
Public propertyRectificationCropFactor A tile will be cropped by this percentage if a F-Theta lens is mounted and equalization is activated.
Public propertyScanFieldSizeWorld The size of the scan field in world coordinates the calibration is done for.
Public propertyScanHead The scan head the camera is attached to in on-axis setups or null if it is an off-axis camera.
(Inherited from BaseCamera)
Public propertyScanHeadPosition The current scan head position in world coordinates, i. e. the point where the camera currently looks at.
Public propertyScanHeadShortLabel The short label of the scan head the calibration is done for.
Public propertySelectedFocusLevel The last selected focus level in the GUI in micrometers.
Public propertySerialNumber Serial number of the device.
(Inherited from BaseDeviceController)
Public propertyStandardMeasure The standard distance to be used when calibrating the camera in micrometers.
Public propertyStatuses
(Inherited from BaseDeviceController)
Public propertySupportedChainableFeatureMap 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)
Public propertyUpperLeftCornerCalibrationMarkRatio The position of the marked upper left corner in the wave length calibration stage; given as ratio of the field width.
Public propertyUpperLeftCornerWorld When calibrating the wave length correction: The upper left corner of the calibrating rectangle where it should be in world coordinates in micrometers.
Public propertyWaveLengthScaleFactor 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.
Public propertyWorkspaceConfiguration The workspace configuration which is used during calibration.
(Inherited from BaseCamera)
Top
Methods
 NameDescription
Protected methodCheckDriverAndShowNotification 
Protected methodCheckOnCameraDriver 
Public methodConnect Connects to the device.
(Inherited from BaseDeviceController)
Public methodConvertPixelLengthToWorldLength Converts a distance, given in pixel coordinates, into the same distance in world coordinates. The downscale factor is taken into account.
Public methodConvertPixelPosToWorldPos Inversion method of ConvertWorldPosToPixelPos().
Public methodConvertScanFieldPixelToWorld converts scan field pixel point to the scan field or world coordinates (µm) pixel coordinate system: left top 0/0 right bottom w/h
Public methodConvertScanFieldWorldToPixel converts scan field or world coordinates to pixel
Public methodConvertWorldLengthToPixelLength Converts a distance, given in world coordinates, into the same distance in pixel coordinates. The downscale factor is taken into account.
Public methodConvertWorldPosToPixelPos 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.
Public methodDisconnect Disconnects from the device.
(Inherited from BaseDeviceController)
Public methodDispose
(Inherited from BasePlugin)
Protected methodDispose(Boolean) Stops the streaming and disconnects the camera.
(Overrides BaseDeviceControllerDispose(Boolean))
Public methodDisposeUI Disposes the given setting view.
(Inherited from BaseDeviceController)
Protected methodDoDisposeUI
(Inherited from BasePlugin)
Protected methodDoShowUI Shows the specific UI embedded in the plug-in instance. The content will be wrapped by a preset view.
(Inherited from BasePlugin)
Protected methodDoShowUICallback Invokes the callback that can be used when the DoShowUI method is done.
(Inherited from BasePlugin)
Public methodGetDeviceStatusRepresentation
(Overrides BaseDeviceControllerGetDeviceStatusRepresentation)
Public methodGetFieldSizePixel Size of one camera image
Public methodGetLastScanHeadPositionFieldRectPixel 
Public methodGetScanFieldSizePixel Gets the field size in pixels with respect to the downscale factor the user has set.
Public methodHandleExternalDeviceRequestAsync Handles a chained request for a given list of features.
(Inherited from BaseDeviceController)
Public methodInitialize Plug-in specific initialization can be done here if necessary.
(Inherited from BasePlugin)
Public methodInitializeCalibrationDataSet 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.
Protected methodInvokeConnected Invokes Connected event.
(Inherited from BaseDeviceController)
Protected methodInvokeDeviceUIRequested Callback method to show the nested scan head settings dialog.
(Inherited from BaseCamera)
Protected methodInvokeDisconnected Invokes Disconnected event.
(Inherited from BaseDeviceController)
Protected methodInvokeInitialized Invokes Initialized event.
(Inherited from BaseDeviceController)
Protected methodInvokeStatusChanged Invokes StatusChanged event.
(Inherited from BaseDeviceController)
Public methodLoadCalibration Loads the properties building the calibration data.
Protected methodLoadFlatFieldCorrectionFiles Loads the bright and dark images for flat field correction.
Protected methodOnDevicesChanged
(Inherited from BaseDeviceController)
Public methodSaveCalibration Saves the properties building the calibration data.
Protected methodSetCurrentParameterValuesOnCamera Sets the camera parameters in the hardware according to the current parameters in this camera object.
Protected methodSetExposureTimeOnCamera 
Protected methodSetGainOnCamera 
Protected methodSetIsAutoBrightnessOnCamera 
Protected methodSetIsAutoExposureOnCamera 
Protected methodSetIsAutoGainOnCamera 
Protected methodSetIsCombinePixelsOnCamera Sets whether pixels should be combined. Can be overloaded to set it in the camera's real hardware.
Public methodShowUI Shows the specific UI embedded in the plugin instance.
(Inherited from BaseDeviceController)
Public methodShowUICallback Invokes the callback that can be used when the ShowUI method is done.
(Inherited from BaseDeviceController)
Public methodShowUICancelCallback Invokes the callback that can be used when the ShowUI method is done and the user pressed the cancel button
(Inherited from BasePlugin)
Public methodStartStreaming Starts streaming of video data.
Public methodStopStreaming Stops streaming of video data.
Protected methodStoreCurrentCameraSettings 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.
Public methodTakePicture Takes a picture with the camera and downscales it if demanded. The default color (red) is used for the cross hairs.
Public methodToString
(Inherited from BasePlugin)
Protected methodUpdateFieldSizeProperties 
Top
Events
 NameDescription
Public eventConnected An event that is triggered when the device is connected.
(Inherited from BaseDeviceController)
Public eventDeviceUIRequested Getting called when the camera UI gets requested.
(Inherited from BaseCamera)
Public eventDisconnected An event that is triggered when the device is disconnected.
(Inherited from BaseDeviceController)
Public eventInitialized An event that is triggered when the device is initialized.
(Inherited from BaseDeviceController)
Public eventStatusChanged An event that is triggered when the status of the device is changed.
(Inherited from BaseDeviceController)
Top
Fields
See Also