The height calculator tool operator.
Holds the run parameters used by the height tool.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro3D Cog3DRangeImageHeightCalculator
Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D (in Cognex.VisionPro3D.dll) Version: 65.1.0.0
Syntax
The Cog3DRangeImageHeightCalculator type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Cog3DRangeImageHeightCalculator |
Constructs a new instance of this class
|
| Cog3DRangeImageHeightCalculator(Cog3DRangeImageHeightCalculator) |
Constructs a new instance of this class as a deep copy of the
given instance.
|
 | Cog3DRangeImageHeightCalculator(SerializationInfo, StreamingContext) |
Serialization Constructor
|
Methods
| Name | Description | |
|---|---|---|
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| Equals | (Inherited from Object.) |
| Execute(CogImage16Range, ICogRegion, Cog3DPlane) |
Computes the height between the surface defined by the range image
pixels and the specified base plane.
|
| Execute(CogImage16Range, ICogRegion, Double) |
Computes the height of the range image surface relative to
a horizontal base plane with a user specified Z height.
The base plane has a 3D selected space coordinate normal vector (0, 0, 1), i.e. oriented along the positive z axis. |
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetAttributes |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetClassName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetComponentName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetConverter |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultEvent |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultProperty |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEditor |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEvents |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEvents( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetObjectData |
Implements the GetObjectData method of the ISerializable interface.
(Inherited from CogSerializableObjectBase.) |
| GetProperties |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetProperties( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetPropertyOwner |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| OnChanged(Int64) |
This method should be called internally whenever the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
| OnChanged(CogChangedEventArgs) |
This method may be called internally whenever a derived object's state
may have changed and the derived object expresses this change via a
derived CogChangedEventArgs class.
(Inherited from CogSerializableChangedEventBase.) |
| ResumeAndRaiseChangedEvent |
Re-enables raising of the Changed event after SuspendChangedEvent
has been called, and raises the Changed event if the
ChangedEventSuspended count is reduced to zero and any changes were
made while events were suspended. Must be called once for each call to
SuspendChangedEvent.
(Inherited from CogSerializableChangedEventBase.) |
| SuspendChangedEvent |
Temporarily suspends the raising of the Changed event. May be called
more than once, and a corresponding call to ResumeAndRaiseChangedEvent
must be made for each call to SuspendChangedEvent.
(Inherited from CogSerializableChangedEventBase.) |
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfComputePixelCountsDiagImage |
This bit will be set in the EventArgs of a Changed event every time the
value returned by ComputePixelCountsDiagImage may have changed.
|
| SfHeightRangeFilterEnabled |
This bit will be set in the EventArgs of a Chagned event every time the
value returned by HeightRangeFilterEnabled may have changed.
|
| SfHeightRangeFilterHigh |
This bit will be set in the EventArgs of a Changed event every time the
value returned by HeightThresholdHigh may have changed.
|
| SfHeightRangeFilterLow |
This bit will be set in the EventArgs of a Changed event every time the
value returned by HeightRangeFilterLow may have changed.
|
| SfHeightRangeFilterMode |
This bit will be set in the EventArgs of a Changed event every time the
value returned by HeightRangeFilterMode may have changed.
|
| SfHighTailFrac |
This bit will be set in the EventArgs of a Chagned event every time the
value returned by HighTailFrac may have changed.
|
| SfIncludeHistogramInResult |
This bit will be set in the EventArgs of a Chagned event every time the
value returned by IncludeHistogramInResult may have changed.
|
| SfInputImageMask |
This bit will be set in the EventArgs of a Changed event every time the
value returned by InputImageMask may have changed.
|
| SfInputImageMaskOffsetX |
This bit will be set in the EventArgs of a Changed event every time the
value returned by InputImageMaskOffsetX may have changed.
|
| SfInputImageMaskOffsetY |
This bit will be set in the EventArgs of a Changed event every time the
value returned by InputImageMaskOffsetX may have changed.
|
| SfLowTailFrac |
This bit will be set in the EventArgs of a Chagned event every time the
value returned by LowTailFrac may have changed.
|
 | SfNextSf | |
| SfPlaneSide |
This bit will be set in the EventArgs of a Changed event every time the
value returned by PlaneSide may have changed.
|
| SfRegionMode |
This bit will be set in the EventArgs of a Changed event every time the
value returned by RegionMode may have changed.
|
| SfStdDevMult |
This bit will be set in the EventArgs of a Chagned event every time the
value returned by StdDevMult may have changed.
|
Properties
| Name | Description | |
|---|---|---|
 | ChangedEventSuspended |
If nonzero, indicates that the raising of the Changed event has been
suspended. This value is incremented when SuspendChangedEvent is called
and decremented when ResumeAndRaiseChangedEvent is called.
(Inherited from CogSerializableChangedEventBase.) |
| ComputePixelCountsDiagImage |
Specifies whether or not to include a pixel counts diagnostics
image in the result. The pixel counts diagnostics image indicates
which pixels in the range image were used by the height calculation.
|
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| HeightRangeFilterEnabled |
Enables or disables the height range filter.
The height range filter allows the user to exclude pixels which do not fall within a user selected range of height values. |
| HeightRangeFilterHigh |
The largest height value to be included or excluded by the height range filter.
|
| HeightRangeFilterLow |
The smallest height value to be included or excluded by the height range filter.
|
| HeightRangeFilterMode |
Controls whether the height range filter includes or excludes the
values between the HeightRangeFilterLow and the HeightRangeFilterHigh.
|
| HighTailFrac |
Gets or sets a value which controls how the
HighTail
property of the result is calculated.
|
| IncludeHistogramInResult |
Specifies whether or not to include the histogram data
in the result.
|
| InputImageMask |
Gets or sets the input image mask.
The input image mask allows you to ignore regions
of the range image by masking them out.
|
| InputImageMaskOffsetX |
Gets or sets the 2D InputImageMask X offset value in pixels.
|
| InputImageMaskOffsetY |
Gets or sets the 2D InputImageMask Y offset value in pixels.
|
| LowTailFrac |
Gets or sets a value which controls how the
LowTail
property of the result is calculated.
|
| PlaneSide |
Specifies which side of the plane to consider the positive height
direction when computing the height.
|
| RegionMode |
Gets or sets the region mode. This controls how the optional run time
region is applied to the input image.
|
| StateFlags |
Returns the complete set of state flags supported on this object. The
flags may be indexed by name as shown in the following C# code snippet:
if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... }
(Inherited from CogSerializableChangedEventBase.) |
| StdDevMult |
Gets or sets a value that controls how the
MeanPlusStdDevMult
property of the result is calculated.
|
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
Remarks
See Also