The class is the base class for every CrossSectionTool operator that performs area measurement
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro3D Cog3DRangeImageCrossSectionOperatorBase
Cognex.VisionPro3D Cog3DRangeImageCrossSectionAreaOperatorBase
Cognex.VisionPro3D Cog3DRangeImageCrossSectionAreaLineSegments
Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D (in Cognex.VisionPro3D.dll) Version: 91.0.0.0
Syntax
The Cog3DRangeImageCrossSectionAreaOperatorBase type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Cog3DRangeImageCrossSectionAreaOperatorBase(Cog3DRangeImageCrossSectionAreaOperatorBase) |
Construct a deep copy of the supplied
Cog3DRangeImageCrossSectionAreaOperatorBase object.
|
 | Cog3DRangeImageCrossSectionAreaOperatorBase(SerializationInfo, StreamingContext) |
Serialization constructor for Cog3DRangeImageCrossSectionAreaOperatorBase
object.
|
| Cog3DRangeImageCrossSectionAreaOperatorBase(String, Cog3DRangeImageCrossSectionAreaInputOperatorTypeConstants) |
Construct a default Cog3DRangeImageCrossSectionAreaOperatorBase object.
|
Methods
| Name | Description | |
|---|---|---|
| AddDefaultRegion |
Adds a new region to the operator with a default location
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| ClearResults |
Clear the results' properties of this class.
(Overrides Cog3DRangeImageCrossSectionOperatorBase ClearResults .) |
| 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.) |
| CreateResultGraphics |
Create the graphics and add them to the graphicCollection provided.
(Overrides Cog3DRangeImageCrossSectionOperatorBase CreateResultGraphics(CogGraphicCollection, Boolean).) |
| CreateResultInputGraphics |
Create the input graphics and add them to the provided graphicCollection
|
| Dispose |
Destruct this Cog3DRangeImageCrossSectionOperatorBase.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| Dispose(Boolean) | (Overrides Cog3DRangeImageCrossSectionOperatorBase Dispose(Boolean).) |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| Execute |
Compute the area between the input profile and the reference profile.
(Overrides Cog3DRangeImageCrossSectionOperatorBase Execute(Cog3DRangeImageCrossSectionProfile).) |
| ExecuteMeasureArea |
This method needs to be overridden in the inherited class to perform the
conrecte operator specific area measurement
|
| 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.) |
| GetNamesOfOperatorsByType |
Gets the names of the operators by output type from the OperatorsParams
collection.
It returns only the operators that are listed prior to this operator
in the OperatorsParams collection.
Returns null if no operator was found.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| 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.) |
| InitializeName | (Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| InitializeRegions | (Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| InitializeToleranceCollection | (Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| InputAvailable |
Called at the beginning of the Execute method to check if the result of the input operator is available or not
If not it does not even try to execute the operator and returns with InputFeatureMissing
|
| 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.) |
| SetRegionToDefaultLocation |
Sets the region with the given index to the default region location
Cognex Internal Use Only.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| 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 | Returns a String that represents the current Object. (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfArea |
This bit will be set in the EventArgs of a Changed event every time
the value returned by Area may have changed.
|
| SfAreaResult |
This bit will be set in the EventArgs of a Changed event every time
the value returned by AreaResult may have changed.
|
| SfDrawAreaBackgroundGraphics |
This bit will be set in the EventArgs of a Changed event every time
the value returned by DrawAreaBackgroundGraphics may have changed.
|
| SfDrawClosestPointAboveReferenceProfileGraphics |
This bit will be set in the EventArgs of a Changed event every time
the value returned by DrawClosestPointAboveReferenceProfileGraphics may have changed.
|
| SfDrawClosestPointBelowReferenceProfileGraphics |
This bit will be set in the EventArgs of a Changed event every time
the value returned by DrawClosestPointBelowReferenceProfileGraphics may have changed.
|
| SfDrawFarthestPointAboveReferenceProfileGraphics |
This bit will be set in the EventArgs of a Changed event every time
the value returned by DrawFarthestPointAboveReferenceProfileGraphics may have changed.
|
| SfDrawFarthestPointBelowReferenceProfileGraphics |
This bit will be set in the EventArgs of a Changed event every time
the value returned by DrawFarthestPointBelowReferenceProfileGraphics may have changed.
|
| SfDrawLeftPointGraphics |
This bit will be set in the EventArgs of a Changed event every time
the value returned by DrawLeftPointGraphics may have changed.
|
| SfDrawRightPointGraphics |
This bit will be set in the EventArgs of a Changed event every time
the value returned by DrawRightPointGraphics may have changed.
|
| SfDrawThresholdGraphics |
This bit will be set in the EventArgs of a Changed event every time
the value returned by DrawThresholdGraphics may have changed.
|
| SfHeightThreshold |
This bit will be set in the EventArgs of a Changed event every time
the value returned by HeightThreshold may have changed.
|
| SfInputOperator |
This bit will be set in the EventArgs of a Changed event every time
the value returned by InputOperator may have changed.
|
| SfMaxFillLength |
This bit will be set in the EventArgs of a Changed event every time
the value returned by MaxFillLength may have changed.
|
| SfMeasurementPosition |
This bit will be set in the EventArgs of a Changed event every time
the value returned by MeasurementPosition may have changed.
|
 | SfNextSf |
NextSf state flag.
|
Properties
| Name | Description | |
|---|---|---|
 | Area |
Gets or sets what area is being measured: abover or below the reference profile or both of those
and if both, how they are combined
|
| AreaResult |
Gets the result computed by the execute method.
Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
|
| AreaTolerance |
Gets the Cog3DRangeImageCrossSectionTolerance object to tolerance
the area.
|
| 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.) |
| ClosestPointAboveReferenceProfileXTolerance |
Gets the Cog3DRangeImageCrossSectionTolerance object to tolerance
the point's X coordinate that is above the reference profile and closest to it.
|
| ClosestPointAboveReferenceProfileYTolerance |
Gets the Cog3DRangeImageCrossSectionTolerance object to tolerance
the point's Y coordinate that is above the reference profile and closes to it.
|
| ClosestPointBelowReferenceProfileXTolerance |
Gets the Cog3DRangeImageCrossSectionTolerance object to tolerance
the point's X coordinate that is below the reference profile and closest to it.
|
| ClosestPointBelowReferenceProfileYTolerance |
Gets the Cog3DRangeImageCrossSectionTolerance object to tolerance
the point's Y coordinate that is below the reference profile and closest to it.
|
| CombineGraphicsEnabled |
Gets or sets the CombineGraphicsEnabled.
When true, the combined graphics will be displayed in the last run record.
Combined graphics usually are the features or measurements produced by an
operator.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| DrawAreaBackgroundGraphics |
Gets or sets whether the computed area's background will be painted or not
|
| DrawClosestPointAboveReferenceProfileGraphics |
Gets or sets whether the closest point above the reference profile will be drawn or not
|
| DrawClosestPointBelowReferenceProfileGraphics |
Gets or sets whether the closest point below the reference profile will be drawn or not
|
| DrawFarthestPointAboveReferenceProfileGraphics |
Gets or sets whether the Farthest point Above the reference profile will be drawn or not
|
| DrawFarthestPointBelowReferenceProfileGraphics |
Gets or sets whether the Farthest point below the reference profile will be drawn or not
|
| DrawLeftPointGraphics |
Gets or sets whether the leftmost point of the computed area will be drawn or not
|
| DrawRightPointGraphics |
Gets or sets whether the rightmost point of the computed area will be drawn or not
|
| DrawThresholdGraphics |
Gets or sets whether the threshold graphics will be drawn or not
|
| FarthestPointAboveReferenceProfileXTolerance |
Gets the Cog3DRangeImageCrossSectionTolerance object to tolerance
the point's X coordinate that is above the reference profile and farthest from it.
|
| FarthestPointAboveReferenceProfileYTolerance |
Gets the Cog3DRangeImageCrossSectionTolerance object to tolerance
the point's Y coordinate that is above the reference profile and farthest from it.
|
| FarthestPointBelowReferenceProfileXTolerance |
Gets the Cog3DRangeImageCrossSectionTolerance object to tolerance
the point's X coordinate that is below the reference profile and farthest from it.
|
| FarthestPointBelowReferenceProfileYTolerance |
Gets the Cog3DRangeImageCrossSectionTolerance object to tolerance
the point's Y coordinate that is below the reference profile and farthest from it.
|
| FeatureInImage |
If the operator produces a feature, the feature is returned
in the range image SelectedSpaceName stored in the profile.
The FeatureInImage is available after the operator was run.
The FeatureInImage is set to null at the beginning of the tool run.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| FeatureInImage3D |
If the operator produces a feature, the feature is returned
in the range image SelectedSpaceName3D stored in the profile.
The FeatureInImage3D is available after the operator was run.
The FeatureInImage3D is set to null at the beginning of the tool run.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| HeightThreshold |
Gets or sets the height threshold.
Points with heights below this threshold are treated as noise
and are thus excluded from the computations. Note that 'height'
in this context means the difference in height between the cross
section and the lines. The heights are measured in
ProfileSelectedSpaceName units along the Image Y axis.
|
| ImageUsedForProfileDisplay |
Cognex Internal Use Only.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| InputGraphicsEnabled |
Gets or sets the InputGraphicsEnabled.
When true, the input graphics will be displayed in the current record.
Input graphics usually are the regions.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
 | InputOperatorType |
Returns the type of the input operator of this operator
|
| LeftPointXTolerance |
Gets the Cog3DRangeImageCrossSectionTolerance object to tolerance
the left point's X coordinate.
|
| LeftPointYTolerance |
Gets the Cog3DRangeImageCrossSectionTolerance object to tolerance
the the left point's Y coordinate.
|
| MaxFillLength |
Gets or sets max length of a missing stretch to fill along x-axis in ProfileSelectedSpaceName.
|
| Name |
Gets or sets the name of the operator.
When the operator is within a collection, the name is checked for uniqueness.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| OutputGraphicsEnabled |
Gets or sets the OutputGraphicsEnabled.
When true, the output graphics will be displayed in the current record.
Output graphics usually are the features or measurements produced by an
operator.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| OutputType |
Gets the OutputType of the operator.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| Regions |
Gets the Regions. The regions property is a collection of ICogRegion.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| ResultObject |
Gets the ResultObject of the operator.
The ResultObject is available after the operator was run.
The ResultObject is set to null at the beginning of the tool run.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| RightPointXTolerance |
Gets the Cog3DRangeImageCrossSectionTolerance object to tolerance
the right point's X coordinate.
|
| RightPointYTolerance |
Gets the Cog3DRangeImageCrossSectionTolerance object to tolerance
the right point's Y coordinate.
|
| SelectedRegionIndex |
Cognex Internal Use Only.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| 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.) |
| Status |
Gets the status.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| ToleranceCollection |
Gets the ToleranceCollection. The ToleranceCollection is initialiazed by the operator and the user
will not be able to delete or add to it. Each operator adds a pre-defined set based on the operator
result object. By default, all tolerances are disabled.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| Tolerances |
Gets the Tolerance object of an item specified by name.
if name is not found, the return is null.
(Inherited from Cog3DRangeImageCrossSectionOperatorBase.) |
| WeightThreshold |
Gets the weight threshold. Always returns 0.
In VisionPro if a profile data has a weight higher than 0 it counts
|
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
See Also