JAICamera Class |
This class encapsulates the API of JAI cameras.
Inheritance HierarchySystemObject
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.DeviceBaseDeviceController
RAYLASE.Marker.Device.CameraBaseCamera
RAYLASE.Marker.CamerasPluginBasePluginCamera
RAYLASE.Marker.CamerasPlugin.JAICameraJAICamera
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.DeviceBaseDeviceController
RAYLASE.Marker.Device.CameraBaseCamera
RAYLASE.Marker.CamerasPluginBasePluginCamera
RAYLASE.Marker.CamerasPlugin.JAICameraJAICamera
Namespace: RAYLASE.Marker.CamerasPlugin.JAICamera
Assembly: RAYLASE.Marker.CamerasPlugin (in RAYLASE.Marker.CamerasPlugin.dll) Version: 2.49.0
SyntaxC#
public class JAICamera : BasePluginCamera
The JAICamera type exposes the following members.
ConstructorsProperties| 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.
(Inherited from BasePluginCamera) |
| 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.
(Inherited from BasePluginCamera) |
| CalibrationInfo | (Inherited from BasePluginCamera) |
| CalibrationInfoBackground | (Inherited from BasePluginCamera) |
| CameraID |
The ID to identify the camera in a list of available cameras.
(Inherited from BasePluginCamera) |
| 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.
(Inherited from BasePluginCamera) |
 | ConfigurationManager | (Inherited from BasePlugin) |
| DarkImageFfcFileName |
The path and file name of the dark image for flat field correction.
(Inherited from BasePluginCamera) |
| DownscaleFactor |
A taken picture is downscaled by this factor [0.01 .. 1.0] before
the Bitmap is returned.
(Inherited from BasePluginCamera) |
| DriverVersionMismatchWarning | (Inherited from BasePluginCamera) |
| EnableChainableFeature |
Gets or sets the flag to enable chainable features.
(Inherited from BaseDeviceController) |
| ExposureTime |
The time a single frame will be exposed in ms.
(Inherited from BasePluginCamera) |
| FieldHeightPixel |
The height of the camera image in pixel.
(Inherited from BasePluginCamera) |
| 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.
(Inherited from BasePluginCamera) |
| 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.
(Inherited from BasePluginCamera) |
| FieldWidthPixel |
The width of the camera image in pixel.
(Inherited from BasePluginCamera) |
| 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.
(Inherited from BasePluginCamera) |
| 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.
(Inherited from BasePluginCamera) |
| Gain |
The current gain value set in the camera.
(Inherited from BasePluginCamera) |
| HasConnectedStatus | (Overrides BaseDeviceControllerHasConnectedStatus) |
| 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.
(Inherited from BasePluginCamera) |
| 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.
(Inherited from BasePluginCamera) |
| IsAutoConnect | (Inherited from BaseDeviceController) |
| IsAutoExposure |
If true the exposure time is set automatically by the camera.
(Inherited from BasePluginCamera) |
| IsAutoGain |
If true the gain is set automatically by the camera.
(Inherited from BasePluginCamera) |
| IsAveragePixels |
Flag to indicate if - in case of binning - the pixels will be
averaged.
(Inherited from BasePluginCamera) |
| IsCombinePixels |
Flag to indicate if binning is active.
(Inherited from BasePluginCamera) |
| IsConnected | (Inherited from BasePluginCamera) |
| IsEmulator |
Flag to indicate if this camera is an emulated one.
(Inherited from BasePluginCamera) |
| IsFlatFieldCorrection |
If true, flat field correction will be done.
(Inherited from BasePluginCamera) |
| IsHardwareTrigger |
If true, the camera is triggered by a hardware signal instead via software.
(Inherited from BasePluginCamera) |
| IsHardwareTriggerWait |
If true, the camera waits for a hardware pulse signaling that image
transfer is done instead for software event.
(Inherited from BasePluginCamera) |
| 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().
(Inherited from BasePluginCamera) |
| IsToFlip |
If true the camera picture will be flipped horizontally.
(Inherited from BasePluginCamera) |
| 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.
(Inherited from BasePluginCamera) |
| LowerRightCornerWorld |
When calibrating the wave length correction: The lower right corner
of the calibrating rectangle where it should be in world
coordinates in micrometers.
(Inherited from BasePluginCamera) |
| PenNumber |
The pen used when creating the calibration jobs.
(Inherited from BasePluginCamera) |
| 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.
(Inherited from BasePluginCamera) |
| ScanFieldSizeWorld |
The size of the scan field in world coordinates the calibration is done for.
(Inherited from BasePluginCamera) |
| 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.
(Inherited from BasePluginCamera) |
| ScanHeadShortLabel |
The short label of the scan head the calibration is done for.
(Inherited from BasePluginCamera) |
| SelectedFocusLevel |
The last selected focus level in the GUI in micrometers.
(Inherited from BasePluginCamera) |
| SerialNumber |
Serial number of the device.
(Inherited from BaseDeviceController) |
| StandardMeasure |
The standard distance to be used when calibrating the camera in micrometers.
(Inherited from BasePluginCamera) |
| 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.
(Inherited from BasePluginCamera) |
| UpperLeftCornerWorld |
When calibrating the wave length correction: The upper left corner
of the calibrating rectangle where it should be in world
coordinates in micrometers.
(Inherited from BasePluginCamera) |
| 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.
(Inherited from BasePluginCamera) |
| WorkspaceConfiguration |
The workspace configuration which is used during calibration.
(Inherited from BaseCamera) |
Methods| Name | Description | |
|---|---|---|
 | CheckDriverAndShowNotification | (Inherited from BasePluginCamera) |
| CheckOnCameraDriver |
Checks for a JAI driver's registry entry and the version of the
file "PvDotNet.dll".
(Overrides BasePluginCameraCheckOnCameraDriver) |
 | Connect |
Tries to connect with the camera whose ID is stored in property
CameraID. Called by RAYGUIDE's DeviceControllerService, e.g. at
program start.
(Overrides BaseDeviceControllerConnect) |
| Connect(String) | Tries to connect with the camera with the given ID. Called by the settings dialog when pressing the connect button. |
| ConvertPixelLengthToWorldLength |
Converts a distance, given in pixel coordinates, into the same
distance in world coordinates. The downscale factor is taken into
account.
(Inherited from BasePluginCamera) |
| ConvertPixelPosToWorldPos |
Inversion method of ConvertWorldPosToPixelPos().
(Inherited from BasePluginCamera) |
| 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
(Inherited from BasePluginCamera) |
| ConvertScanFieldWorldToPixel |
converts scan field or world coordinates to pixel
(Inherited from BasePluginCamera) |
| ConvertWorldLengthToPixelLength |
Converts a distance, given in world coordinates, into the same
distance in pixel coordinates. The downscale factor is taken into
account.
(Inherited from BasePluginCamera) |
| 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.
(Inherited from BasePluginCamera) |
| Disconnect |
Disconnects the camera. Called by RAYGUIDE's
DeviceControllerService, e.g. at program end.
(Overrides BaseDeviceControllerDisconnect) |
| Dispose | (Inherited from BasePlugin) |
| Dispose(Boolean) |
Stops the streaming and disconnects the camera.
(Inherited from BasePluginCamera) |
| DisposeUI |
Disposes the given setting view.
(Inherited from BaseDeviceController) |
| DoDisposeUI | (Inherited from BasePlugin) |
| DoShowUI |
Opens the camera's configuration dialog. Called by RAYGUIDE's
dialog service.
(Overrides BasePluginDoShowUI(String)) |
| DoShowUICallback |
Callback method to get modified data out of the camera settings
dialog.
(Overrides BasePluginDoShowUICallback(PluginSettingsView)) |
| GetDeviceStatusRepresentation | (Inherited from BasePluginCamera) |
| GetFieldSizePixel |
Size of one camera image
(Inherited from BasePluginCamera) |
| GetLastScanHeadPositionFieldRectPixel | (Inherited from BasePluginCamera) |
| GetScanFieldSizePixel |
Gets the field size in pixels with respect to the downscale factor
the user has set.
(Inherited from BasePluginCamera) |
| HandleExternalDeviceRequestAsync | (Overrides BaseDeviceControllerHandleExternalDeviceRequestAsync(IListTupleChainableFeatureType, ExpandoObject, CancellationToken)) |
| Initialize |
Retrieves the scan head from the device list whose short label
matches the serialized ScanHeadID property.
(Overrides BasePluginInitialize) |
| 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.
(Inherited from BasePluginCamera) |
| 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.
(Inherited from BasePluginCamera) |
| LoadFlatFieldCorrectionFiles |
Loads the bright and dark images for flat field correction.
(Inherited from BasePluginCamera) |
| OnDevicesChanged | (Inherited from BaseDeviceController) |
| SaveCalibration |
Saves the properties building the calibration data.
(Inherited from BasePluginCamera) |
| SetCurrentParameterValuesOnCamera | (Overrides BasePluginCameraSetCurrentParameterValuesOnCamera) |
| SetExposureTimeOnCamera | (Overrides BasePluginCameraSetExposureTimeOnCamera(Double)) |
| SetGainOnCamera | (Overrides BasePluginCameraSetGainOnCamera(Double)) |
| SetIsAutoBrightnessOnCamera | (Overrides BasePluginCameraSetIsAutoBrightnessOnCamera(Boolean)) |
| SetIsAutoExposureOnCamera | (Overrides BasePluginCameraSetIsAutoExposureOnCamera(Boolean)) |
| SetIsAutoGainOnCamera | (Overrides BasePluginCameraSetIsAutoGainOnCamera(Boolean)) |
| SetIsCombinePixelsOnCamera | (Overrides BasePluginCameraSetIsCombinePixelsOnCamera(Boolean, Boolean)) |
| 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 the video stream. Based on JAI's ImageProcessing sample
project.
(Overrides BasePluginCameraStartStreaming) |
| StopStreaming |
Stops the image stream. Basically copied from JAI's ImageProcessing
sample.
Attention: Closing the stream should be done here and not when
disconnecting as done in the sample project, because setting new
values for the image width and height results in corrupted buffers
otherwise.
(Overrides BasePluginCameraStopStreaming) |
| 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.
(Inherited from BasePluginCamera) |
| TakePicture |
Takes a picture with the camera and downscales it if demanded.
The default color (red) is used for the cross hairs.
(Inherited from BasePluginCamera) |
| ToString | (Inherited from BasePlugin) |
| UpdateFieldSizeProperties | (Inherited from BasePluginCamera) |
Events| 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) |
Fields| Name | Description | |
|---|---|---|
 | _deviceManager | (Inherited from BasePluginCamera) |
| _isTakeWorkspaceCalibrationIntoAccount | (Inherited from BasePluginCamera) |
| _oldFieldHeightWorld | (Inherited from BasePluginCamera) |
| _oldFieldWidthWorld | (Inherited from BasePluginCamera) |
See Also