Click or drag to resize

FieldParameter Class

Contains the parameters to define a field.
Inheritance Hierarchy
SystemObject
  RAYLASE.Marker.CorrectionsFieldParameter

Namespace: RAYLASE.Marker.Corrections
Assembly: RAYLASE.Marker.Corrections (in RAYLASE.Marker.Corrections.dll) Version: 2.19.0
Syntax
C#
public sealed class FieldParameter : ICloneable, 
	INotifyPropertyChanged

The FieldParameter type exposes the following members.

Constructors
 NameDescription
Public methodFieldParameterInitializes a new instance of the FieldParameter class
Top
Properties
 NameDescription
Public propertyBottomLeft Gets the resulting bottom left corner of the (sub)field.
Public propertyColumns Gets or sets the number of columns.
Public propertyDimensions Returns the dimensions separated by ' x '.
Public propertyFieldSizes Returns the field sizes separated by ' x ' in mm.
Public propertyFieldSizeX Gets or sets the field size in X direction.
Public propertyFieldSizeY Gets or sets the field size in Y direction in.
Public propertyFieldSizeZ Gets the field size in Z direction. For setting Call SetDefaultsFrom(FieldCorrection)./>
Public propertyIsCircularField Gets or sets a value that defines whether the sub field is circular.
Public propertyIsCustomField Returns true if a subfield is defined that is different to the main field.
Public propertyIsCustomMaxAngle Returns true if max angle for x or y is different to the standard max angle.
Public propertyIsStandardField Returns true if no subfield is defined, or the sub field is equal to the main field.
Public propertyIsStandardMaxAngle Returns true if max angle for x or y is equal to the standard max angle.
Public propertyLayers Gets or sets the number of layers.
Public propertyMagnifications Gets or sets the number of magnifications.
Public propertyMaxAngleX Gets or sets the custom angle in X direction [°].
Public propertyMaxAngleY Gets or sets the custom angle in Y direction.
Public propertyOffsetX Gets or sets the offset of the sub field in X direction.
Public propertyOffsetY Gets or sets the offset of the sub field in Y direction.
Public propertyRows Gets or sets the number of rows.
Public propertyStatic memberStandardMaxAngle Gets the standard maximal deflection angle
Public propertySubFieldSizeX Gets or sets the sub field size in X direction.
Public propertySubFieldSizeY Gets or sets the sub field size in Y direction.
Public propertyTopRight Gets the resulting top right corner of the (sub)field.
Public propertyUseCustomMaxAngle Gets or sets a value that enables or disables the use of the custom angle.
Public propertyUseSubField Gets or sets a value that enables or disables the use of the sub field.
Top
Methods
 NameDescription
Public methodApplyTo Apply the field size and max angle to a field correction.
Public methodClone Creates a shallow copy of the field parameter instance.
Public methodCopyFrom Copies all properties.
Public methodCopySubfieldFrom 
Public methodGetTruncatedGridPointCount(ivec2) Returns the size of the truncated table. All rows and columns that are outside the subfield will be omitted.
Public methodGetTruncatedGridPointCount(Int32, Int32, ivec2) Returns the size of the truncated table. All rows and columns that are outside the subfield will be omitted.
Public methodGetXBounds Returns the min and max x at the given y position.
Public methodGetYBounds Returns the min and max y at the given x position.
Public methodIsInsideField(Int32, Int32) Returns true if the provided cell is inside the resulting field.
Public methodIsInsideField(Int32, Int32, Int32, Int32) Returns true if the provided cell is inside the resulting field.
Public methodResetSubfield Resets all properties related to subfield and galvo angles.
Public methodSetDefaultsFrom Sets the field size, sub field size / offset, max angle and dimensions from the field correction.
Top
Events
 NameDescription
Public eventPropertyChangedOccurs when a property value changes.
Top
See Also