Class that holds the Trevista run parameters. These parameters
are used by the
Execute(ICogVisionData)
method and control how the Trevista algorithm will generate the
output images.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.Trevista CogTrevista
Namespace: Cognex.VisionPro.Trevista
Assembly: Cognex.VisionPro.Trevista (in Cognex.VisionPro.Trevista.dll) Version: 83.0.0.0
Syntax
The CogTrevista type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogTrevista |
Constructs a default CogTrevista object.
|
| CogTrevista(CogTrevista) |
Constructs a deep copy of the supplied CogTrevista object.
|
 | CogTrevista(SerializationInfo, StreamingContext) |
Serialization constructor for CogTrevista object.
|
Methods
| Name | Description | |
|---|---|---|
| CreateFloatHistogram |
Creates a histogram of the internal floating point values for the
image that you specify.
|
| 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.) |
| Dispose |
Releases all resources used by this CogTrevista object.
|
| Dispose(Boolean) | |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| Execute |
Take the input CogImage8Interlaced and
unpack its 8 bit pixels into four "shading" images. Process those to
produce the requested output images.
|
| Finalize |
Releases all unmanaged resources used by this
CogTrevista 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 |
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 | Returns a String that represents the current Object. (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfContourImageParams |
This bit will be set in the EventArgs of a Changed event every time the
value returned by ContourImageParams may have changed.
|
| SfCpuProcessingThreadCountMax |
This bit will be set in the EventArgs of a Changed event every time the
value returned by CpuProcessingThreadCountMax may have changed.
|
| SfCreateFloatHistogram |
This bit will be set in the EventArgs of a Changed event every time the
value returned by CreateFloatHistogram() may have changed.
|
| SfDepthImageParams |
This bit will be set in the EventArgs of a Changed event every time the
value returned by DepthImageParams may have changed.
|
| SfDomeDiameter |
This bit will be set in the EventArgs of a Changed event every time the
value returned by DomeDiameter may have changed.
|
| SfGPUDeviceIndex |
This bit will be set in the EventArgs of a Changed event every time the
value returned by GPUDeviceIndex may have changed.
|
| SfGreyscaleImageParams |
This bit will be set in the EventArgs of a Changed event every time the
value returned by GreyscaleImageParams may have changed.
|
| SfMotionAccuracy |
This bit will be set in the EventArgs of a Changed event every time the
value returned by MotionAccuracy may have changed.
|
| SfMotionFilterSize |
This bit will be set in the EventArgs of a Changed event every time the
value returned by MotionFilterSize may have changed.
|
| SfMotionType |
This bit will be set in the EventArgs of a Changed event every time the
value returned by MotionType may have changed.
|
 | SfNextSf | |
| SfProcessorType |
This bit will be set in the EventArgs of a Changed event every time the
value returned by ProcessorType may have changed.
|
| SfSensorCompensationModifier |
This bit will be set in the EventArgs of a Changed event every time the
value returned by SensorCompensationModifier may have changed.
|
| SfSensorCorrectionEnabled |
This bit will be set in the EventArgs of a Changed event every time the
value returned by SensorCorrectionEnabled may have changed.
|
| SfSensorPixelSize |
This bit will be set in the EventArgs of a Changed event every time the
value returned by SensorPixelSize may have changed.
|
| SfShadingImage1Params |
This bit will be set in the EventArgs of a Changed event every time the
value returned by ShadingImage1Params may have changed.
|
| SfShadingImage2Params |
This bit will be set in the EventArgs of a Changed event every time the
value returned by ShadingImage2Params may have changed.
|
| SfShadingImage3Params |
This bit will be set in the EventArgs of a Changed event every time the
value returned by ShadingImage3Params may have changed.
|
| SfShadingImage4Params |
This bit will be set in the EventArgs of a Changed event every time the
value returned by ShadingImage4Params may have changed.
|
| SfShapeHorizontalImageParams |
This bit will be set in the EventArgs of a Changed event every time the
value returned by ShapeHorizontalImageParams may have changed.
|
| SfShapeVerticalImageParams |
This bit will be set in the EventArgs of a Changed event every time the
value returned by ShapeVerticalImageParams 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.) |
| ContourImageParams |
Gets or sets the parameters controlling the output
ContourImage.
|
| CpuProcessingThreadCountMax |
Gets or sets the maximum number of threads to use when processing with a CPU
|
| DepthImageParams |
Gets or sets the parameters controlling the output
DepthImage.
|
| DomeDiameter |
Gets or sets the diameter of the dome illumination unit in millimeters.
|
| GPUDeviceIndex |
Cognex Internal Use Only
Gets or sets the GPU device to use when ProcessorType is set to GpuIfAvailable
|
| GreyscaleImageParams |
Gets or sets the parameters controlling the output
GreyscaleImage.
|
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| IsGpuAvailable |
Returns true if a supported GPU is currently available.
|
| MotionAccuracy |
Cognex Internal Use Only.
Gets or sets the motion compensation accuracy.
|
| MotionFilterSize |
Cognex Internal Use Only.
Gets or sets the filter size of the matching algorithm, in pixels, to be
used when including motion compensation in the processing of output
images.
|
| MotionType |
Cognex Internal Use Only.
Gets or sets what type of motion compensation will be included
in the processing of output images.
|
| ProcessorType |
Gets or sets the preferred mechanism for the processing of results.
|
| SensorCompensationModifier |
Gets or sets the modifier to apply to sensor correction in order to account for distortion
from reflectance, sensor position, or other factors (no units, see remarks for details).
|
| SensorCorrectionEnabled |
Gets or sets whether gradient correction is performed as part of the
calculation of
ShapeHorizontalImage
and
ShapeVerticalImage |
| SensorPixelSize |
Gets or sets the SensorPixelSize in millimeters.
|
| ShadingImage1Params |
Gets or sets the parameters controlling the output
ShadingImage1.
|
| ShadingImage2Params |
Gets or sets the parameters controlling the output
ShadingImage2.
|
| ShadingImage3Params |
Gets or sets the parameters controlling the output
ShadingImage3.
|
| ShadingImage4Params |
Gets or sets the parameters controlling the output
ShadingImage4.
|
| ShapeHorizontalImageParams |
Gets or sets the main parameters controlling the output
ShapeHorizontalImage.
|
| ShapeVerticalImageParams |
Gets or sets the main parameters controlling the output
ShapeVerticalImage.
|
| 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.) |
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