Base |
The BasePluginCamera type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | AdjustBrightnessContrast | Adjusts brightness and contrast of the given source image according to the given brightness and contrast values. |
| AdjustNumberOfChannels | Converts the number of channels of sourceMat to the wanted number of channels. |
| CalcCenteredPicturePositionInCanvas | 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. |
| CalcInterpolatedCenterOffsetCorrection | 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. |
| CalcReducedWidthHeightAndOffsets | 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. |
| CheckCuttingSize | Checks if the given size is less than the camera's hardware sensor size. |
| CheckOnChangedScanHeadParameters | 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. |
| ClearScanFieldImage | Creates a new scan field image Mat object and fills it with empty pixels. |
| Connect |
Connects to the device.
(Inherited from BaseDeviceController) |
| ConvertDmat4ToEmguMat | Converts a dmat4 4x4 matrix object into an Emgu 2x3 Mat object. |
| ConvertMatToSKBitmap | Converts the given Mat object into a SKBitmap. |
| ConvertPixelLengthToWorldLength(Double) | Converts a distance, given in pixel coordinates, into the same distance in world coordinates. The downscale factor is taken into account. |
| ConvertPixelLengthToWorldLength(dvec2) | |
| 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. |
| ConvertWorldToPixel(dvec2) | same functionality as the one above, just using the DownscalFactor from the camera |
| ConvertWorldToPixel(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. |
| ConvertWorldToPixel(dvec3, Double) | |
| CreateAllowedRanges | 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 accaptable result for the upper left cross. |
| CreateBitmapSourceFromMat | Converts a Mat object into a BitmapSource object. |
 | CreateDownscaledTakenPicture | Creates a downscaled, three channel Mat object from the given, one channel takenPictureMat and adds a red cross hair if wanted. |
| CropMatCenter | Returns a cutting of the given srcMat from its center with the given width and height. |
| CropPicture | 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. |
| CutRegionMat | Creates a cutting of the taken scan field image based on the given center point and the given size. |
| 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) |
| EnlargeMat | 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. |
| FieldImageCenterInPixel | return the real center point of Image rect in pixel |
| GetByteMatElement | |
| GetDeviceStatusRepresentation |
Returns the color and description of device state. Useful for UI purpose.
(Inherited from BaseDeviceController) |
| GetFieldAndProcessTrafo | |
| GetFieldSizePixel | Size of one camera image |
| GetFloatMatElement | Gets the value at position row and col in the given float mat object. |
| GetLastScanHeadPositionFieldRectPixel | |
| GetMatElement | Gets the value at position row and col in the given double mat object. |
| GetRectificationCalibrationTilePositions | Creates a list of 9 points being the positions of the center of the tiles that are used during the rectification calibration. |
| GetRegionInPixel | Rectangle in image pixel + rotation for RegionOfInterest |
| GetRegionMat | Image of RegionOfInterest |
| GetScanFieldSizePixel | Gets the field size in pixels with respect to the downscale factor the user has set. |
| GetScanHeadPositionFieldRectPixel | |
| GetUsedScanController | |
| HandleCombinePixelsChanges | Handles wanted binning changes in the camera settings by writing the values to the hardware only if needed. |
| 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. |
| InterpolateCalibrations | 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. |
| InterpolateFromNPoints | 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. |
| InterruptStreaming | |
| 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. |
| OnDevicesChanged | (Inherited from BaseDeviceController) |
| PutIntoMat | 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. |
| PutMatIntoMat |
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) |
| PutPictureCenteredInCanvas | 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. |
| Rectify | 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. |
| ResetCameraFieldSize | Resets the image size to the maximal value, defined by the camera's physical sensor size. |
| ResetCameraSettings | Resets all parameters to the ones stored in the temporary properties. See comment in StoreCurrentCameraSettings() for details. |
| RotateMat | Rotates a Mat object without clipping the edges. See https://stackoverflow.com/questions/22041699/rotate-an-image-without-cropping-in-opencv-in-c. |
| RotateStep90 | Performs an in place rotation in 90° steps of the given picture. |
| SaveCalibration | Saves the properties building the calibration data. |
| SetCameraFieldSize | Sets the camera's field width and height (in pixel). Can be overloaded to set it in the camera's real hardware. |
| SetCurrentParameterValuesOnCamera | Sets the camera parameters in the hardware according to the current parameters in this camera object. |
| SetExposureTime | Sets the camera's exposure time. Can be overloaded to set it in the camera's real hardware. |
| SetExposureTimeOnCamera | |
| SetFieldTrafoScaleAndRotation | |
| SetGain | Sets the camera's gain. Can be overloaded to set it in the camera's real hardware. |
| SetGainOnCamera | |
| SetIsAutoBrightness | Sets whether the gain and exposure time should be set automatically by the camera. |
| SetIsAutoBrightnessOnCamera | |
| SetIsAutoExposure | Sets whether the exposure time should be set automatically by the camera. |
| SetIsAutoExposureOnCamera | |
| SetIsAutoGain | Sets whether the gain should be set automatically by the camera. |
| SetIsAutoGainOnCamera | |
| SetIsCombinePixels | Sets whether pixels should be combined. |
| SetIsCombinePixelsOnCamera | Sets whether pixels should be combined. Can be overloaded to set it in the camera's real hardware. |
| SetMatElement(Mat, Int32, Int32, Byte) | |
| SetMatElement(Mat, Int32, Int32, Double) | Sets in the given Mat object the element at the given row and column to the given double value. |
| SetRectificationCropFactor | 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. |
| SetStandardMeasure | 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. |
| 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(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. |
| TakePicture(Boolean, Boolean, Double, Int32, Color, Double) | Takes a picture with the camera and downscales it if demanded. |
| TakePictureAndPutItIntoScanFieldImage | Takes a picture at the given position and puts it into the untransformed ScanFieldImage at the correct place. |
| TakePictureMat | Takes a picture from the running video stream and does the downscaling. |
| ToString | (Inherited from BasePlugin) |
| TransformScanFieldImage | Transforms the camera's ScanFieldImage according to the current FieldTrafo and ProcessTrafo by applying the inverses. |
| TransformWorldPosAndConvertToPixelPos | 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. |
| UpdateFieldSizeProperties |
See Also