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.20.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 propertyBigPictureMat The "big picture" used as source image in case the camera is an emulator. Is null otherwise.
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 propertyCalibrationDataSetTmp 
Public propertyCalibrationInfo 
Public propertyCalibrationInfoBackground 
Public propertyCameraID The ID to identify the camera in a list of available cameras.
Public propertyCameraState The state the camera is currently in. Needed for synchronizing the different modules.
Public propertyCenterOffsetPixel 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.
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.
Public propertyCenterOffsetWorldTmp Temporary CenterOffset to restore the original value in case the Cancel button is pressed.
Protected propertyConfigurationManager
(Inherited from BasePlugin)
Public propertyCorrectedWaveLengthScaleFactor The wave length scale factor, but corrected by the field and process transformation.
Public propertyCorrectionFileHash The hash of the correction file the calibration is done for.
Public propertyDownscaleFactor A taken picture is downscaled by this factor [0.01 .. 1.0] before the Bitmap is returned.
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 propertyExposureTimeMax The maximal exposure time the camera can be set to in ms. Used to control the allowed range in the settings dialog.
Public propertyExposureTimeMin The minimal exposure time the camera can be set to in ms. Used to control the allowed range in the settings dialog.
Public propertyFieldHeightMaxPixel The maximal camera height in pixel as allowed by the camera model. May depend on the current binning state.
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 propertyFieldHeightWorldTmp Temporary FieldHeightWorld to restore the original value in case the Cancel button is pressed.
Public propertyFieldTrafo The field transformation currently used. Relevant only in case of a camera emulator.
Public propertyFieldWidthMaxPixel The maximal camera width in pixel as allowed by the camera model. May depend on the current binning state.
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 propertyFieldWidthWorldTmp Temporary FieldWidthWorld to restore the original value in case the Cancel button is pressed.
Public propertyFocusBiasTmp Temporary focus bias to restore the original value in case the Cancel button is pressed.
Public propertyFocusLevel The focus level in micrometers currently set. Used for communication with the Click&Teach panel.
Public propertyGain The current gain value set in the camera.
Public propertyGainMax The maximal gain value allowed by the camera model. Used to control the allowed range in the settings dialog.
Public propertyGainMin The minimal gain value allowed by the camera model. Used to control the allowed range in the settings dialog.
Public propertyHardwareTriggerWaitPortAutomation In case of hardware triggering the wait port automation object used for waiting for the camera's response.
Public propertyHardwareTriggerWritePortAutomation In case of hardware triggering the write port automation object used to trigger 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 propertyHasScanHeadLensMountedTmp Temporary flag for connected theta lens in case the Cancel button is pressed.
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 propertyIsAutoCalibration Flag to indicate that the dialog is in auto calibration mode rather than in manual calibration mode.
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 propertyIsCalibrated Flag to indicate if the camera is calibrated already, i. e. FieldWidthWorldFromCalib and FieldHeightWorldFromCalib are > 0.
Public propertyIsCalibrationInProgress 
Public propertyIsCameraFieldSizeReduced 
Public propertyIsCombinePixels Flag to indicate if binning is active.
Public propertyIsConnected
(Overrides BaseDeviceControllerIsConnected)
Public propertyIsDirty Flag to indicate that some parameters have been changed.
Public propertyIsEmulator Flag to indicate if this camera is an emulated one.
Public propertyIsFocusShifter Our definition for a focus shifter scan head: There is a z axis but no sensor axis.
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 propertyIsRectificationCalibrationInProgress 
Public propertyIsSettingsDialogOpen Flag is set to true if the settings dialog is open.
Public propertyIsStreaming If true, the camera is currently streaming.
Public propertyIsToFlip If true the camera picture will be flipped horizontally.
Public propertyIsUsedByGUI 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).
Public propertyLastPickedPointWorld The point where the user has picked the last time. Used to show the cross hairs in the renderer.
Public propertyLastPickedRegionWorld 
Public propertyLastRawTakenImage The last taken image without any modifications as equalization or downscaling.
Public propertyLastTakenImage The last taken image with possibly done modifications as equalization or downscaling.
Public propertyLeftFieldWidthCalibrationMarkRatio The position of the left calibration guide line, set during resolution calibration, given es ratio of the FieldWidth (0..1).
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 propertyLowerRightCornerWorldTmp Temporary LowerRightCorner to restore the original value in case the Cancel button is pressed.
Public propertyStatic memberMarkerAPI RAYGUIDE's MarkerAPI object; needs to be set before GetPointInScanfield() ff. are called.
Public propertyNumberOfChannels 
Public propertyPenNumber The pen used when creating the calibration jobs.
Public propertyPens A dictionary to assign a color and name to a pen for displaying it in the camera settings dialog.
Public propertyPixelHeightWorld The height of the area in the scan field a pixel is covering in micrometers when visible light is used.
Public propertyPixelWidthWorld The width of the area in the scan field a pixel is covering in micrometers when visible light is used.
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 propertyPointerFocusBiasTmp Temporary preview focus bias to restore the original value in case the Cancel button is pressed.
Public propertyProcessTrafo The process transformation currently used. Relevant only in case of a camera emulator.
Public propertyStatic memberRectificationCalibrationCrossRatio 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.
Public propertyRectificationCropFactor A tile will be cropped by this percentage if a F-Theta lens is mounted and equalization is activated.
Public propertyRectificationCropFactorTmp Temporary rectification crop factor, stored in case the Cancel button is pressed.
Public propertyRectificationDataSet The currently used rectification data set; interpolated values depending on the focus level.
Public propertyScanFieldImage 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.
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 propertyScanHeadTmp Temporary scan head to restore the original value in case the Cancel button is pressed.
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 propertyStandardMeasureTmp Temporary StandardMeasure to restore the original value in case the Cancel button is pressed.
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 propertyTransformedScanFieldImage This is the ScanFieldImage, but transformed by the inverse field and process transformation.
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 propertyUpperLeftCornerWorldTmp Temporary UpperLeftCorner to restore the original value in case the Cancel button is pressed.
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
Public methodStatic memberAdjustBrightnessContrast Adjusts brightness and contrast of the given source image according to the given brightness and contrast values.
Public methodStatic memberAdjustNumberOfChannels Converts the number of channels of sourceMat to the wanted number of channels.
Public methodStatic memberCalcCenteredPicturePositionInCanvas Given are two rectangles, representing a (bigger) canvas and a (smaller) picture; the last one has to be put centered into the canvas and needs to be scaled to fit into the canvas, but without changing its aspect ratio.
Public methodCalcInterpolatedCenterOffsetCorrection During camera calibration we create a set of RectificationData objects (8 or 16, dependent on quadratic or cubic interpolation) at some positions in the scan field. For other positions we need interpolated ones.
Public methodCalcReducedWidthHeightAndOffsets Calculates to the wanted width and height valid width, height and offset values fulfilling the conditions the camera's hardware demands when reducing its image size (e. g. width must be a multiple of 16 or something like that). If the image size is reduced, offsets are calculated to have the effective image in the center.
Public methodCheckCuttingSize Checks if the given size is less than the camera's hardware sensor size.
Public methodCheckOnChangedScanHeadParameters Checks if some scan head parameters has changed after the camera has been calibrated. A re-calibration is necessary when the scan head, its correction file or the scan field size has changed.
Public methodClearScanFieldImage Creates a new scan field image Mat object and fills it with empty pixels.
Public methodConnect Connects to the device.
(Inherited from BaseDeviceController)
Public methodStatic memberConvertDmat4ToEmguMat Converts a dmat4 4x4 matrix object into an Emgu 2x3 Mat object.
Public methodStatic memberConvertMatToSKBitmap Converts the given Mat object into a SKBitmap.
Public methodConvertPixelLengthToWorldLength(Double) Converts a distance, given in pixel coordinates, into the same distance in world coordinates. The downscale factor is taken into account.
Public methodConvertPixelLengthToWorldLength(dvec2) 
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 methodConvertWorldToPixel(dvec2) same functionality as the one above, just using the DownscalFactor from the camera
Public methodConvertWorldToPixel(dvec2, Double) Converts a point in world coordinates into pixel coordinates using the field sizes in world and pixel coordinates and the downscale factor. In difference to ConvertWorldPosToPixelPos() the origin in world coordinates is not expected to be in the center of the field. The origin of the pixel coordinates is expected to be in the upper left corner.
Public methodConvertWorldToPixel(dvec3, Double) 
Public methodCopyScanHeadData Copies the data needed for checking the scan head parameters into the ones of the camera. Used when the scan head parameters has been changed but the warning to recalibrate the camera should be ignored.
Public methodStatic memberCreateAllowedRanges When doing the rectification calibration the expected crosses are at the position ratios (0.1; 0.1), (0.9; 0.1), (0.5; 0.5), (0.1, 0.9) and (0.9; 0.9). To detect if a found cross is valid the deviation to these expected positions must not be too big. These allowed deviations are defined here by the value allowedRatioDelta. For example, a cross at position (0.02, 0.18) may be an acceptable result for the upper left cross.
Public methodStatic memberCreateBitmapSourceFromMat Converts a Mat object into a BitmapSource object.
Protected methodCreateDownscaledTakenPicture Creates a downscaled, three channel Mat object from the given, one channel takenPictureMat and adds a red cross hair if wanted.
Public methodStatic memberCropMatCenter Returns a cutting of the given srcMat from its center with the given width and height.
Public methodCropPicture Crops the given srcMat according to the rectification crop factor, needed to avoid black artifact stripes caused by the rectification on F-Theta lens systems.
Public methodCutRegionMat Creates a cutting of the taken scan field image based on the given center point and the given size.
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 methodStatic memberEnlargeMat Enlarges the given Mat object by the given percentage of its width and height. Example: If the width is 200 pixel and percentage is 10, the width of the new Mat object is 220 pixels. The source Mat is put centered into the new Mat object, and the empty regions are filled with the border pixels.
Public methodFieldImageCenterInPixel return the real center point of Image rect in pixel
Public methodStatic memberGetByteMatElement 
Public methodGetDeviceStatusRepresentation Returns the color and description of device state. Useful for UI purpose.
(Inherited from BaseDeviceController)
Public methodGetFieldAndProcessTrafo 
Public methodGetFieldSizePixel Size of one camera image
Public methodStatic memberGetFloatMatElement Gets the value at position row and col in the given float mat object.
Public methodGetLastScanHeadPositionFieldRectPixel 
Public methodStatic memberGetMatElement Gets the value at position row and col in the given double mat object.
Public methodGetRectificationCalibrationTilePositions Creates a list of 9 points being the positions of the center of the tiles that are used during the rectification calibration.
Public methodGetRegionInPixel Rectangle in image pixel + rotation for RegionOfInterest
Public methodGetRegionMat Image of RegionOfInterest
Public methodGetScanFieldSizePixel Gets the field size in pixels with respect to the downscale factor the user has set.
Public methodGetScanHeadPositionFieldRectPixel 
Public methodGetUsedScanController 
Public methodHandleCombinePixelsChanges Handles wanted binning changes in the camera settings by writing the values to the hardware only if needed.
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.
Public methodInterpolateCalibrations Interpolates to a given z value between the two nearest calibration sets. The dictionary _calibrationDataSet contains an arbitrary number of calibrations (at least one), each calibrated at a specific z value. To get the calibration at an arbitrary z value, the nearest two calibrations are searched and all calibration data is interpolated between these two according to the arbitrary z value.
Public methodStatic memberInterpolateFromNPoints Calculates a value y to the given value x by performing a polynomial interpolation between the given points. In case of four points a cubic interpolation is done: y = f(x) = a*x^3 + b*x^2 + c*x + d.
Public methodInterruptStreaming 
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 methodOnDevicesChanged
(Inherited from BaseDeviceController)
Public methodPutIntoMat Puts a smaller inMat object into a bigger outMat object at the given point. In case of picking, centerWorldPoint is the position where the user has clicked into the workspace, without any transformations. To get the pixel position where inMat has to be put, the center offset and other transformations must be applied, before the point is transformed from world into pixel coordinates. Because of the center offset the given point is *not* the center of inMat. This method is also used when taking pictures of a ROI. In this case the given point should be the center of the inMat. Therefore the given point must be adjusted by the center offset before to compensate the transformation.
Public methodStatic memberPutMatIntoMat Puts a small source picture at the given xy position into a larger destination picture; the origin is the upper left corner of the destination picture, and the xy position is the upper left corner of the source where it will be placed. If an out of bounds situation occurs, the source image is clipped to fit into the destination.
(0,0)
    +----------------------------+
    |                   dest     |
    |   (x,y)                    |
    |       +------+             |
    |       |source|             |
    |       +------+         +---+--+  out of bounds:
  +-+----+                   |   |  |  source will be clipped
  | |    |                   +---+--+  to fit into dest
  +-+----+                       |
    +----------------------------+
                                 (width-1, height-1)
Public methodStatic memberPutPictureCenteredInCanvas Given are two Mat objects, representing a (bigger) canvas and a (smaller) picture; the last one has to be put centered into the canvas and needs to be scaled to fit into the canvas, but without changing its aspect ratio.
Public methodRectify Rectifies the image in srcMat according to its center point in the workspace. The rectification data points are interpolated first according to the center point.
Public methodResetCameraFieldSize Resets the image size to the maximal value, defined by the camera's physical sensor size.
Public methodResetCameraSettings Resets all parameters to the ones stored in the temporary properties. See comment in StoreCurrentCameraSettings() for details.
Public methodStatic memberRotateMat Rotates a Mat object without clipping the edges. See https://stackoverflow.com/questions/22041699/rotate-an-image-without-cropping-in-opencv-in-c.
Public methodStatic memberRotateStep90 Performs an in place rotation in 90° steps of the given picture.
Public methodSaveCalibration Saves the properties building the calibration data.
Public methodSendReadySignal 
Public methodSetCameraFieldSize Sets the camera's field width and height (in pixel). Can be overloaded to set it in the camera's real hardware.
Protected methodSetCurrentParameterValuesOnCamera Sets the camera parameters in the hardware according to the current parameters in this camera object.
Public methodSetExposureTime Sets the camera's exposure time. Can be overloaded to set it in the camera's real hardware.
Protected methodSetExposureTimeOnCamera 
Public methodSetFieldTrafoScaleAndRotation 
Public methodSetGain Sets the camera's gain. Can be overloaded to set it in the camera's real hardware.
Protected methodSetGainOnCamera 
Public methodSetIsAutoBrightness Sets whether the gain and exposure time should be set automatically by the camera.
Protected methodSetIsAutoBrightnessOnCamera 
Public methodSetIsAutoExposure Sets whether the exposure time should be set automatically by the camera.
Protected methodSetIsAutoExposureOnCamera 
Public methodSetIsAutoGain Sets whether the gain should be set automatically by the camera.
Protected methodSetIsAutoGainOnCamera 
Public methodSetIsCombinePixels Sets whether pixels should be combined.
Protected methodSetIsCombinePixelsOnCamera Sets whether pixels should be combined. Can be overloaded to set it in the camera's real hardware.
Public methodStatic memberSetMatElement(Mat, Int32, Int32, Byte) 
Public methodStatic memberSetMatElement(Mat, Int32, Int32, Double) Sets in the given Mat object the element at the given row and column to the given double value.
Public methodSetRectificationCropFactor Sets the crop factor needed in case of F-Theta lens systems to reduce the tile size. Must be virtual to have access to the settings dialog for updating the value there.
Public methodSetStandardMeasure Sets the standard measure in the camera's settings dialog. Must be virtual to have access to the settings dialog for updating the value there.
Protected methodSetTriggerMode Sets or resets the camera's trigger mode. Setting the trigger mode is only allowed if a suitable port mapping is found. If this check fails, hardware triggering is disabled.
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(Boolean, Boolean, Double, Int32, Double) Takes a picture with the camera and downscales it if demanded. The default color (red) is used for the cross hairs.
Public methodTakePicture(Boolean, Boolean, Double, Int32, Color, Double) Takes a picture with the camera and downscales it if demanded.
Public methodTakePictureAndPutItIntoScanFieldImage Takes a picture at the given position and puts it into the untransformed ScanFieldImage at the correct place.
Public methodTakePictureMat Takes a picture from the running video stream and does the downscaling.
Public methodTakePictureMatHardwareTriggered Does the same as TakePictureMat() but triggers the camera not by software but by writing to the trigger port. If hardware triggering is not active normal software triggering is used.
Public methodToString
(Inherited from BasePlugin)
Public methodTransformScanFieldImage Transforms the camera's ScanFieldImage according to the current FieldTrafo and ProcessTrafo by applying the inverses.
Public methodTransformWorldPosAndConvertToPixelPos Transforms the given point (in world coordinates) according to the field and process trafo, subtracts the center offset if demanded and converts it to the same point in pixel coordinates of the big scan field image.
Protected methodUpdateFieldSizeProperties 
Top
Events
 NameDescription
Public eventCalibFocusEvent 
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 eventHandleCalibrationEvent 
Public eventHandleHardwareTriggeredPictureEvent 
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)
Public eventUpdateFocusEvent 
Top
Fields
 NameDescription
Protected field_bigPictureMat In case the camera is an emulator: the built-in background image.
Protected field_bigPictureMatSize 
Protected field_deviceManager 
Public fieldStatic member_numOfRectificationTiles 
Protected field_oldFieldHeightWorld 
Protected field_oldFieldWidthWorld 
Public fieldpointPosBottomLeft The ratio where the bottom left rectification point has been measured relative to the camera field. Not a property because x and y must be set separately.
Public fieldpointPosBottomRight The ratio where the bottom right rectification point has been measured relative to the camera field. Not a property because x and y must be set separately.
Public fieldpointPosMiddle The ratio where the middle rectification point has been measured relative to the camera field. Not a property because x and y must be set separately.
Public fieldpointPosTopLeft The ratio where the top left rectification point has been measured relative to the camera field. Not a property because x and y must be set separately.
Public fieldpointPosTopRight The ratio where the top right rectification point has been measured relative to the camera field. Not a property because x and y must be set separately.
Top
See Also