Base |
public abstract class BaseDistanceSensor : BaseDeviceController
The BaseDistanceSensor type exposes the following members.
Name | Description | |
---|---|---|
![]() | BaseDistanceSensor | Initializes a new instance of the BaseDistanceSensor class |
Name | Description | |
---|---|---|
![]() | ActivatedChainableFeatures |
Gets the activated chainable features.
(Inherited from BaseDeviceController) |
![]() | Averaging | Number of measurements to run on OCT base unit in order to get one measurement. A value of 1 means no averages are taken; higher values reduce the frame rate proportionally. |
![]() | ConfigurationManager | (Inherited from BasePlugin) |
![]() | DeviceState | The state of the device. |
![]() | EnableChainableFeature |
Gets or sets the flag to enable chainable features.
(Inherited from BaseDeviceController) |
![]() | FieldCorrection | A valid field correction containing an Aux axis. |
![]() | FieldParameter | Parameters of the calibration field. |
![]() | HasConnectedStatus |
Is true if the device supports the IsConnected status.
(Overrides BaseDeviceControllerHasConnectedStatus) |
![]() | InvertMeasuredDistance | Flag to invert the distance measurement for alignment with Rayguide. By default, a positive distance in Z direction is further away from the deflection unit while a negative value indicates a closer position to the deflection unit |
![]() | IPAddress | IP address of the distance sensor device. |
![]() | IsAutoConnect | (Inherited from BaseDeviceController) |
![]() | IsConnected |
Is true if the device is connected.
(Inherited from BaseDeviceController) |
![]() | IsHWTrigger | Flag to switch between hardware- and software trigger. Set to true to activate hardware triggered measurement; False otherwise and by default. |
![]() | IsInError | The flag to indicate that the device is in error state. |
![]() | IsInitialized |
Is true if the device is initialized.
(Overrides BaseDeviceControllerIsInitialized) |
![]() | IsLaserOn | True if the measurement SLD is turned on, false otherwise. |
![]() | JumpDelay | (Max) Time in ms after a jump, before a measurement takes place in µs. |
![]() | JumpSpeed | Speed to jump to the next measure position. Only used for measurements, not globally. |
![]() | LogDirectory |
The directory of the log file.
(Inherited from BasePlugin) |
![]() | Logger |
The common logger.
(Inherited from BasePlugin) |
![]() | MeasurementBeamOffsetXY | Offset of the measurement positions to the actual XY position of the scan head. |
![]() | MeasurementValidation | |
![]() | PeakZeroOffset | Offset of the measured RAYDIME METER peak which will be seen as corrected zero position. By moving the measured zero position artificially besides actual zero, interferences by overlapping signals at the zero position can be avoided. |
![]() | 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) |
![]() | SanityCheckThreshold | Threshold µm within which all measurements at the same checked measure position must lie. |
![]() | ScanController | The scan controller with the distance sensor is attached to. |
![]() | ScanControllerID | The ID to identify the scan controller in a list of available scan controllers. |
![]() | ScanHead | The scan head the distance sensor is attached to. |
![]() | ScanHeadID | The ID to identify the scan head in a list of available scan heads. |
![]() | SerialNumber |
Serial number of the device.
(Inherited from BaseDeviceController) |
![]() | 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) |
![]() | UsableRange | Usable measurement range before the returned signal gets too weak in µm +/- current Z height. |
Name | Description | |
---|---|---|
![]() | Calibrate | Calibrates the distance sensor device, if the device can be calibrated. |
![]() | ClearBuffer | Clear all incoming data from the TCP buffer. |
![]() | Connect |
Connects to the device.
(Inherited from BaseDeviceController) |
![]() | Connect(ActionBoolean) | Connect to a device non-blocking and update UI on success. |
![]() | CreateScanHeadList | Lists all available scan heads with distance sensors other than the current distance sensor. |
![]() | Disconnect |
Disconnects from the device.
(Inherited from BaseDeviceController) |
![]() | Dispose | (Inherited from BasePlugin) |
![]() | Dispose(Boolean) | Releases the unmanaged resources used by the BaseDistanceSensor and optionally releases the managed resources (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) |
![]() | GetCheckedHeightDeviationAt | Gets the same measurement value as GetCorrectedRaydimeMeasurementsAt(IListdvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken) but might measure multiple times at the same location and adds sanity checks. |
![]() | GetCorrectedRaydimeMeasurementsAt(dvec2, Double, NullableDouble, NullableDouble, NullableCancellationToken) | GetCorrectedRaydimeMeasurementsAt(dvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken) for a XY position at measure distance. Requires the distance sensor to be calibrated beforehand so that the z height of 0 is the calibrated distance. |
![]() | GetCorrectedRaydimeMeasurementsAt(dvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken) | GetCorrectedRaydimeMeasurementsAt(IListdvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken) for a single position. |
![]() | GetCorrectedRaydimeMeasurementsAt(IListdvec2, Double, NullableDouble, NullableDouble, NullableCancellationToken) | GetCorrectedRaydimeMeasurementsAt(IListdvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken) for a XY position at measure distance. Requires the distance sensor to be calibrated beforehand so that the z height of 0 is the calibrated distance. |
![]() | GetCorrectedRaydimeMeasurementsAt(IListdvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken) | Use the distance sensor to measure the distance in µm and apply angle error to measured value. Measuring at 0,0,0 will obtain the same result as GetRaydimeMeasurementAt(Nullabledvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken). Measuring e.g. at the corner will result in a smaller distance difference than measured when the beam angle is taken into account. |
![]() | GetDeviceStatusRepresentation |
Returns the color and description of device state. Useful for UI purpose.
(Inherited from BaseDeviceController) |
![]() | GetMovableRange | Gets the X, Y and Z min/max values which are in the movable range. |
![]() | GetRaydimeMeasurementAt | Same as GetRaydimeMeasurementsAt(IListdvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken) but measures on a single position only. |
![]() | GetRaydimeMeasurementsAt | Use the distance sensor to measure the distance in µm at a given position. |
![]() | GoToAndTrigger | Moves to a position and sends a hardware trigger or does nothing else in case of software trigger. |
![]() | 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) |
![]() | InternalGetRaydimeMeasurementsAt | |
![]() | InvokeConnected |
Invokes Connected event.
(Inherited from BaseDeviceController) |
![]() | InvokeDeviceUIRequested | Callback method to show the nested scan head settings dialog. |
![]() | InvokeDisconnected |
Invokes Disconnected event.
(Inherited from BaseDeviceController) |
![]() | InvokeInitialized |
Invokes Initialized event.
(Inherited from BaseDeviceController) |
![]() | InvokeStatusChanged |
Invokes StatusChanged event.
(Inherited from BaseDeviceController) |
![]() | InvokeUninitialized | Invokes Uninitialized event. |
![]() | OnDevicesChanged | (Inherited from BaseDeviceController) |
![]() | ReEvaluateMeasurements | Re-evaluates measurements and re-measures invalid locations to make sure the position can either not be measured or the measurement is correct. Sets the average Peak and RawPeak values to the original results. |
![]() | ResolveAngleError(BaseDistanceSensorResult) | ResolveAngleError(dvec3, Double) from a BaseDistanceSensorResult. |
![]() | ResolveAngleError(dvec3, Double) | Takes the measurement angle into account and treats the measured distance error as hypotenuse to get the actual object height difference to the expected value. |
![]() ![]() | SanityCheckMeasurements | Check if measurements at a position are sensible. At least two measurements are needed for the check. It is checked that the measurements are not exactly the same value and that the values are within the sanityCheckThreshold from each other (measurements must be very close but not the same). |
![]() | SendClientHardwareTrigger | Toggles the scan controller's DistanceSensorTriggerOut port with approx. one ms pulse width using the client API. |
![]() | SendSoftwareTrigger | Send a software trigger to the distance sensor device. |
![]() | 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) |
![]() | ToString | (Inherited from BasePlugin) |
![]() | TriggerChanged | Implements a trigger change and must set the configuration on the remote RAYDIME METER accordingly. |
![]() | TurnLaserOn | Turns the measurement laser on or off. |
![]() | UpdateScanController | Updates the scan controller after a scan head change. |
![]() | UpdateScanHead | |
![]() | WaitForCorrectedRaydimeMeasurement | Get a measurement at current position. In case of a hardware trigger, the data must be made available through an independent trigger. In software trigger mode, a software trigger will be sent first. |
![]() | WaitForRaydimeMeasurement | Device specific implementation of a height deviation distance measurement. The result is expected to be 0. Due to errors in the physical domain, a delta could be measured. It does not return the whole distance but the deviation from the expected distance. To trigger the measurement, either set up the RDM I/O ports on the SPICE card, for plain trigger without movement implement SendClientHardwareTrigger or implement SendSoftwareTrigger for a software trigger on the distance sensor device. |
Name | Description | |
---|---|---|
![]() | Connected |
An event that is triggered when the device is connected.
(Inherited from BaseDeviceController) |
![]() | DeviceUIRequested | Getting called when the scan head UI gets requested. |
![]() | 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) |
![]() | Uninitialized | An event that is triggered when the device is uninitialized. |
Name | Description | |
---|---|---|
![]() ![]() | TriggerInBit | Pin on the I/O connector to receive the movement trigger from the OCT which indicates that the next position can be moved to. |
![]() ![]() | TriggerInPolarity | Polarity of the I/O connector for TriggerInBit. |
![]() ![]() | TriggerOutBit | Pin in the I/O connector to send a hardware trigger to the OCT which indicates that the next measurement can be started. |
![]() ![]() | TriggerOutPolarity | Polarity of the I/O connector for TriggerOutBit. |