Field |
Provides methods to load and save correction files, and modify the field correction data.
Inheritance HierarchySystemObject
RAYLASE.Marker.CorrectionsFieldCorrection
RAYLASE.Marker.CorrectionsFieldCorrection
Namespace: RAYLASE.Marker.Corrections
Assembly: RAYLASE.Marker.Corrections (in RAYLASE.Marker.Corrections.dll) Version: 2.31.0
SyntaxC#
public class FieldCorrection
The FieldCorrection type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FieldCorrection(CorrectionType) | Initializes a new instance in the specified correction format. |
| FieldCorrection(String) | Initializes a new instance that uses the specified filename to determine the correction format and load this file |
Properties| Name | Description | |
|---|---|---|
 | ActiveLayer | Gets or sets the active layer. When using commands that don't specify the layer, the active layer is used instead. |
| ActiveMagnification | Gets or sets the active magnification. When using commands that don't specify the magnification, the active magnification is used instead. |
| Axes | Gets the number of axes of the field correction table. |
| AxisAuxiliary | Gets the index of the aux axis. |
| AxisMagnification | Gets the index of the axis used by the zoom. |
| AxisSensor | Gets the index of the axis used by the sensor (eg Camera). |
| CalFactor | Gets or sets the calibration factor, in bits/um, of the field correction. The calibration factor assumes a 16-bit large field. |
| Columns | Gets the number of columns of the field correction table. |
| CorrectionType | Gets the correction type that is associated with this field correction. This value will be used to load or save in the appropriate format. |
| ExtraInfo | Additional information stored for fc3 files. |
| FieldSizeX | Gets or sets the field size in the X dimension. |
| FieldSizeY | Gets or sets the field size in the Y dimension. |
| FieldSizeZ | Gets or sets the field size in the Z dimension. |
| HasAuxiliaryAxis | Returns true if a auxiliary table is present. |
| HasMagnificationAxis | Returns true if the correction table is four dimensional. |
| HasSensorAxis | Returns true if a camera table is present. |
| HasValidCorrections | Returns true if the correction data is set. |
| ItemInt32, Int32 | |
| ItemInt32, Int32, Int32 | Gets or sets the correction value of the specified axis at the specified row and column. |
| ItemInt32, Int32, Int32, Int32 | Gets or sets the correction value of the specified axis at the specified layer, row and column. |
| ItemInt32, Int32, Int32, Int32, Int32 | Gets or sets the correction value of the specified axis at the specified magnification, layer, row and column. |
| Layers | Gets the number of layers of the field correction table. |
| Magnifications | Gets the number of magnifications of the field correction table. |
| MaxAngleX | Gets or sets, the maximum deflection angle, in (mechanical) degrees, of the X axis. |
| MaxAngleY | Gets or sets, the maximum deflection angle, in (mechanical) degrees, of the Y axis. |
| MaxLensTravel | Gets or sets the maximal lens travel from OpticalParam |
| Metadata | Metadata for display purposes. |
| OpticalParam | The optical parameters define the structure of the correction file and the physical properties of the scan head |
| Rows | Gets the number of rows of the field correction table. |
| UseCubicInterpolation | If true, cubic interpolation is used calculating new correction values. Otherwise it's liniear. |
Methods| Name | Description | |
|---|---|---|
| ApplyBarrel(Double, Double, Double, Double) | Adjusts the correction table to equalize a barrel/pincushion distortion. |
| ApplyBarrel(Double, Double, Double, Double, Double, Double) | Adjusts the correction table to equalize a barrel/pincushion distortion. |
| ApplyBarrel(dvec2, dvec2, Double, Double, Double, Double, Double, Double) | Adjusts the correction table to equalize a barrel/pincushion distortion. |
| ApplyBitErrors | Interpolates the bit errors to the size of the measurement table and adds the values to the correction table. |
| ApplyErrors(Double, Double, Double) | Adjusts the field correction table based on the three-dimensional array of XYZ errors. |
| ApplyErrors(NullableDouble, Double, Double) | Adjusts the field correction table based on the three-dimensional array of XYZ errors. |
| ApplyErrors(dvec2, dvec2, NullableDouble, Double, Double) | Adjusts the field correction table based on the three-dimensional array of XYZ errors. |
| ApplyOffset | Adjusts the correction table so that the beam field is moved in both X and Y. |
| ApplyPowerErrors(Double) | Interpolates the measurement table to the dimensions of the correction table then multiplies the correction with the interpolated values. |
| ApplyPowerErrors(NullableDouble) | Interpolates the measurement table to the dimensions of the correction table then multiplies the correction with the interpolated values. |
| ApplyRotation(Double) | Rotates the field correction around the center of the field. |
| ApplyRotation(Double, dvec2) | Rotates the field correction around the center of the field. |
| ApplyScale | Adjusts the correction table so that the beam field is scaled in both X and Y. |
| ApplyTransformation | Applies the transformation to the field correction. |
| ApplyTrapezoid(Double, Double, Int32) | Adjusts the correction table so that the beam field is scaled like a trapezoid. |
| ApplyTrapezoid(dvec2, dvec2, Double, Double, Int32) | Adjusts the correction table so that the beam field is scaled like a trapezoid. |
| BeginUpdate | Defines the beginning of an update block, which temporarily suppresses all change notifications. |
| ChangeSize(dvec3, dvec3, Boolean) | Truncates the correction to the provided subfield. |
| ChangeSize(dvec3, dvec3, Int32, Int32, Int32, Boolean) | Truncates the correction to the provided subfield. |
| ClipCorrections | Clips the correction data that exceed the limit. |
| ConvertTo2D | Removes all layers but the provided one. Header will be adjusted accordingly. |
 | Create(FieldCorrection) | Creates a new field correction instance with the same correction data as the referenced one. |
| Create(CorrectionType, OpticalParameters) | Creates a new instance with a correction table in the specified format. |
| Create(CorrectionType, Int32, Int32, Int32, Int32, Int32) | Creates a new instance with a correction table in the specified format and size. |
| EndUpdate | Defines the ending of an update block. |
| ExceedsLimit | Returns true if at least one correction value exceeds the limit. |
| GetApproximateConversionFactorZ | Returns the conversion factor from z focus to bits [bit/µm]. |
| GetCommandAt(dvec3) | Gets the commands for a field position. ATTENTION: This method always takes the field position centered in the middle! |
| GetCommandAt(Double, dvec3) | Gets the commands for a field position. ATTENTION: This method always takes the field position centered in the middle! |
| GetCommandAt(Double, dvec4) | Gets the commands for a field position. ATTENTION: This method always takes the field position centered in the middle! |
| GetHorizontalSpeedLimit | Returns the maximal speed in x/y-direction, where the axes are not physically limited. |
| GetLineZRange | Returns the minimum and maximum control value of the z axis for the provided line. |
| GetMagnificationSpeedLimt | Returns the maximal magnification speed, where the magnification axes are not physically limited. |
| GetVerticalSpeedLimit | Returns the maximal speed in z-direction, where the z axes are not physically limited. |
| Import | Imports from a text-based TXZ file, and generates a new correction table. |
| Interpolate(Int32, Int32) | Interpolates the correction data. |
| Interpolate(Int32, Int32, Int32) | Interpolates the correction data. |
| Interpolate(Int32, Int32, Int32, Int32) | Interpolates the correction data. Currently the magnifications are only copied, not interpolated. |
| InterpolateErrors | Interpolates the error table, which contains fewer grid points than the correction table, over the entire beam field. |
| Load | Loads the correction file from disk, and updates the correction table. |
| LoadInfo | Loads the "info" text file of a *.gcd file, and extracts the calibration factor (CalFactor). |
| Save | Saves the correction table to disk. If the file already exists it will be overwritten. |
| SetCommands | Sets the correction values directly. |
| ToArray | Extracts all the correction values of the specified axis, and converts them to a two-dimensional array. |
| ToGrid | Calculates the row and column at the specified position. |
| ToPosition(Int32, Int32) | Calculates the XY position of the associated grid point. |
| ToPosition(Int32, Int32, Int32, Int32) | Calculates the XYZM position of the associated grid point. |
| ToString |
Returns a string containing a short description of the instance's chief parameters.
(Overrides ObjectToString) |
Events| Name | Description | |
|---|---|---|
 | FieldCorrectionChanged | Occurs when any field correction value has changed. |
| ParameterChanged | Occurs when any configuration parameter has changed. |
Fields| Name | Description | |
|---|---|---|
 | MinCorrection |
RemarksThe field correction is associated with an immutable correction format, which is required to convert correction values from real-world units into the binary format saved in the correction file, and vice versa.
The field correction consists of a grid that divides the entire field into equi-spaced rows and columns. Accessing the correction table is in the order row, column - similar to accessing a mathematical matrix.
Row 0 and column 0 are mapped to the bottom-most row and left-most column, respectively.
See Also