Field |
Contains the parameters to define a field.
Inheritance HierarchySystemObject
RAYLASE.Marker.CorrectionsFieldParameter
RAYLASE.Marker.CorrectionsFieldParameter
Namespace: RAYLASE.Marker.Corrections
Assembly: RAYLASE.Marker.Corrections (in RAYLASE.Marker.Corrections.dll) Version: 2.31.0
SyntaxC#
public sealed class FieldParameter : ICloneable, INotifyPropertyChanged
The FieldParameter type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FieldParameter | Initializes a new instance of the FieldParameter class |
Properties| Name | Description | |
|---|---|---|
 | BottomLeft | Gets the resulting bottom left corner of the (sub)field. |
| Columns | Gets or sets the number of columns. |
| Dimensions | Returns the dimensions separated by ' x '. |
| FieldSizes | Returns the field sizes separated by ' x ' in mm. |
| FieldSizeX | Gets or sets the field size in X direction. |
| FieldSizeY | Gets or sets the field size in Y direction in. |
| FieldSizeZ | Gets the field size in Z direction. For setting Call SetDefaultsFrom(FieldCorrection)./> |
| IsCircularField | Gets or sets a value that defines whether the sub field is circular. |
| IsCustomField | Returns true if a subfield is defined that is different to the main field. |
| IsCustomMaxAngle | Returns true if max angle for x or y is different to the standard max angle. |
| IsStandardField | Returns true if no subfield is defined, or the sub field is equal to the main field. |
| IsStandardMaxAngle | Returns true if max angle for x or y is equal to the standard max angle. |
| Layers | Gets or sets the number of layers. |
| Magnifications | Gets or sets the number of magnifications. |
| MaxAngleX | Gets or sets the custom angle in X direction [°]. |
| MaxAngleY | Gets or sets the custom angle in Y direction. |
| OffsetX | Gets or sets the offset of the sub field in X direction. |
| OffsetY | Gets or sets the offset of the sub field in Y direction. |
| Rows | Gets or sets the number of rows. |
 | StandardMaxAngle | Gets the standard maximal deflection angle |
| SubFieldSizeX | Gets or sets the sub field size in X direction. |
| SubFieldSizeY | Gets or sets the sub field size in Y direction. |
| TopRight | Gets the resulting top right corner of the (sub)field. |
| UseCustomMaxAngle | Gets or sets a value that enables or disables the use of the custom angle. |
| UseSubField | Gets or sets a value that enables or disables the use of the sub field. |
Methods| Name | Description | |
|---|---|---|
| ApplyTo | Apply the field size and max angle to a field correction. |
| Clone | Creates a shallow copy of the field parameter instance. |
| CopyFrom | Copies all properties. |
| CopySubfieldFrom | |
| FieldEquals | Returns true if all fixed field parameters are the same, ignoring user settings like subfield and custom angles. |
| GetTruncatedGridPointCount(ivec2) | Returns the size of the truncated table. All rows and columns that are outside the subfield will be omitted. |
| GetTruncatedGridPointCount(Int32, Int32, ivec2) | Returns the size of the truncated table. All rows and columns that are outside the subfield will be omitted. |
| GetXBounds | Returns the min and max x at the given y position. |
| GetYBounds | Returns the min and max y at the given x position. |
| IsInsideField(Int32, Int32) | Returns true if the provided cell is inside the resulting field. |
| IsInsideField(Int32, Int32, Int32, Int32) | Returns true if the provided cell is inside the resulting field. |
| ResetSubfield | Resets all properties related to subfield and galvo angles. |
| SetDefaultsFrom | Sets the field size, sub field size / offset, max angle and dimensions from the field correction. |
Events| Name | Description | |
|---|---|---|
 | PropertyChanged | Occurs when a property value changes. |
See Also