System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.EdgeInspect CogBeadInspectRunParams
Namespace: Cognex.VisionPro.EdgeInspect
Assembly: Cognex.VisionPro.EdgeInspect (in Cognex.VisionPro.EdgeInspect.dll) Version: 75.1.0.0
The CogBeadInspectRunParams type exposes the following members.
| Name | Description | |
|---|---|---|
| CogBeadInspectRunParams |
Constructs a default CogBeadInspectRunParams object.
| |
| CogBeadInspectRunParams(CogBeadInspectRunParams) |
Constructs a deep copy of the supplied CogBeadInspectRunParams object.
| |
| CogBeadInspectRunParams(SerializationInfo, StreamingContext) |
Serialization constructor for CogBeadInspectRunParams object.
|
| Name | Description | |
|---|---|---|
| CopyMaskAndFillLists |
Copies the MaskList, the RightFillList, and the LeftFillList from
the given
CogBeadInspectRunParams,
without changing the size of the existing lists in this object.
The lists from the given
CogBeadInspectRunParams
are truncated, or extended with "false" values, to fit within
the existing lists.
| |
| CreateAndCopyMaskAndFillLists(CogBeadInspectRunParams) |
Creates and initializes the MaskList, the RightFillList, and the
LeftFillList. This method gets the desired length of the lists from the
MaskList
property of the given
CogBeadInspectRunParams.
The lists are then copied from the given
CogBeadInspectRunParams.
| |
| CreateAndCopyMaskAndFillLists(CogBeadInspectTrainResult) |
Creates and initializes the MaskList, the RightFillList, and the
LeftFillList. This method gets the desired length of the lists from the
NumTrainedCalipers
property of the given
CogBeadInspectTrainResult.
The lists are copied from the suggested run params of the given
CogBeadInspectTrainResult.
| |
| CreateMaskAndFillLists(CogBeadInspectRunParams) |
Creates and initializes the MaskList, the RightFillList, and the
LeftFillList. This method gets the desired length of the lists from the
MaskList
property of the given
CogBeadInspectRunParams.
The lists are filled with the Boolean value "false".
| |
| CreateMaskAndFillLists(CogBeadInspectTrainResult) |
Creates and initializes the MaskList, the RightFillList, and the
LeftFillList. This method gets the desired length of the lists from the
NumTrainedCalipers
property of the given
CogBeadInspectTrainResult.
The lists are filled with the Boolean value "false".
| |
| 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.) | |
| DestroyMaskAndFillLists |
Destroys the existing MaskList, RightFillList, and LeftFillList.
After this call, the three properties will return null.
| |
| Dispose |
Releases all resources used by this CogBeadInspectRunParams object.
| |
| Dispose(Boolean) | ||
| Equals | (Inherited from Object.) | |
| Finalize |
Releases all unmanaged resources used by this CogBeadInspectRunParams object.
(Overrides Object Finalize .) | |
| 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 |
Populates the provided SerializationInfo with the data needed to
serialize the object.
(Overrides CogSerializableObjectBase GetObjectData(SerializationInfo, StreamingContext).) | |
| 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.) |
| Name | Description | |
|---|---|---|
| SfAbsoluteDistanceThreshold |
This bit will be set in the EventArgs of a Changed event every time
the value returned by AbsoluteDistanceThreshold may have changed.
| |
| SfConsecutiveFailingCalipersMin |
This bit will be set in the EventArgs of a Changed event every time
the value returned by ConsecutiveFailingCalipersMin may have changed.
| |
| SfContrastThreshold |
This bit will be set in the EventArgs of a Changed event every time
the value returned by ContrastThreshold may have changed.
| |
| SfCoverageMax |
This bit will be set in the EventArgs of a Changed event every time
the value returned by CoverageMax may have changed.
| |
| SfCoverageMaxEnabled |
This bit will be set in the EventArgs of a Changed event every time
the value returned by CoverageMaxEnabled may have changed.
| |
| SfCoverageMin |
This bit will be set in the EventArgs of a Changed event every time
the value returned by CoverageMin may have changed.
| |
| SfCoverageMinEnabled |
This bit will be set in the EventArgs of a Changed event every time
the value returned by CoverageMinEnabled may have changed.
| |
| SfLeftFillList |
This bit will be set in the EventArgs of a Changed event every time
the value returned by LeftFillList may have changed.
| |
| SfMaskList |
This bit will be set in the EventArgs of a Changed event every time
the value returned by MaskList may have changed.
| |
| SfNextSf | ||
| SfRightFillList |
This bit will be set in the EventArgs of a Changed event every time
the value returned by RightFillList may have changed.
| |
| SfStepThreshold |
This bit will be set in the EventArgs of a Changed event every time
the value returned by StepThreshold may have changed.
| |
| SfStepThresholdEnabled |
This bit will be set in the EventArgs of a Changed event every time
the value returned by StepThresholdEnabled may have changed.
| |
| SfWidthMax |
This bit will be set in the EventArgs of a Changed event every time
the value returned by WidthMax may have changed.
| |
| SfWidthMaxEnabled |
This bit will be set in the EventArgs of a Changed event every time
the value returned by WidthMaxEnabled may have changed.
| |
| SfWidthMin |
This bit will be set in the EventArgs of a Changed event every time
the value returned by WidthMin may have changed.
| |
| SfWidthMinEnabled |
This bit will be set in the EventArgs of a Changed event every time
the value returned by WidthMinEnabled may have changed.
|
| Name | Description | |
|---|---|---|
| AbsoluteDistanceThreshold |
Gets or sets the maximum absolute amount an edge position can deviate from a trained edge position.
It is specified as a fraction of the average bead width.
| |
| 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.) | |
| ConsecutiveFailingCalipersMin |
Gets or sets the minimum number of consecutive failing calipers for a defect to be reported.
Indirectly this property determines the length (along the bead) of the smallest reported defect.
| |
| ContrastThreshold |
Gets or sets the minimum contrast required for detecting the edges of the bead.
| |
| CoverageMax |
Gets or sets the maximum acceptable coverage, any coverage above this value can be a defect.
| |
| CoverageMaxEnabled |
Gets or sets a flag to indicate whether the CoverageMax tolerance is enabled.
If true, CoverageMax will be used at runtime to report defects of type Overfill.
| |
| CoverageMin |
Gets or sets the minimum acceptable coverage, any coverage below this value can be a defect.
| |
| CoverageMinEnabled |
Gets or sets a flag to indicate whether the CoverageMin tolerance is enabled.
If true, CoverageMin will be used at runtime to report defects of type Underfill.
| |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) | |
| LeftFillList |
Gets an ICogBoolList whose Boolean elements indicate which calipers
along the trained bead path should insert a "fill edge" if no edge is found on the left side
(relative to the path direction) of the bead at runtime.
| |
| MaskList |
Gets an ICogBoolList whose Boolean elements indicate which calipers
along the trained bead path should be ignored at runtime when searching for defects.
| |
| RightFillList |
Gets an ICogBoolList whose Boolean elements indicate which calipers
along the trained bead path should insert a "fill edge" if no edge is found on the right side
(relative to the path direction) of the bead at runtime.
| |
| 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.) | |
| StepThreshold |
Gets or sets the maximum relative amount an edge position can deviate from neighboring edges.
It is specified as a fraction of average bead width at that location.
A low value means a closer match and a high value means more tolerance.
| |
| StepThresholdEnabled |
Gets or sets a flag to indicate whether the StepThreshold tolerance is enabled.
If true, StepThreshold will be used at runtime to report defects of type AboveStepThreshold.
| |
| WidthMax |
Gets or sets the maximum acceptable width ratio, any ratio above this value can be a defect.
The ratio is computed using the bead width at runtime to the average bead width at train time.
| |
| WidthMaxEnabled | ||
| WidthMin |
Gets or sets the minimum acceptable width ratio, any ratio below this value can be a defect.
The ratio is computed using the bead width at runtime to the average width at train time.
| |
| WidthMinEnabled |
| Name | Description | |
|---|---|---|
| Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
The parameters in this class define the acceptable tolerances for a bead. The tolerances can be enabled or disabled, and a defect will be reported if the bead is outside any enabled tolerance.
The bead inspect tool process the image in 2 phases: the first phase is all about calipers, and the second phase is all about defects.
Caliper processing consists of the following:
- Lay down the calipers to detect edge pairs. This step uses the ContrastThreshold and AbsoluteDistanceThreshold to determine which edges are considered for scoring.
-
Then the scoring procedure chooses the best pair of edges based on:
- Pair width
- Edge positions
- Consistency with neighboring edge positions
A defect is reported for any sequence of ConsecutiveFailingCalipersMin (or more) calipers where all of the individual calipers are deemed out of tolerance
An instance of this class must be provided as an argument to the Execute(ICogVisionData, CogBeadInspectRunParams) method of the CogBeadInspectPattern class. The Execute() method is called automatically every time you call the Run method of the CogBeadInspectTool class, causing the tool to inspect the bead path in the InputImage for defects.
For more information on the definition of a bead and bead path in this context, please refer to the remarks section of the CogBeadInspectPattern class.