An operator for stitching together three dimensional vision data into
a single result in a user-specified space.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro3D Cog3DVisionDataStitch
Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D (in Cognex.VisionPro3D.dll) Version: 75.0.0.0
Syntax
The Cog3DVisionDataStitch type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Cog3DVisionDataStitch |
Constructs a new instance of this class.
|
| Cog3DVisionDataStitch(Cog3DVisionDataStitch) |
Constructs a new instance of this class as a deep copy of
the given instance.
|
 | Cog3DVisionDataStitch(SerializationInfo, StreamingContext) |
Serialization constructor for Cog3DVisionDataStitch object.
|
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 |
Perform stitching on the supplied vision data.
|
| 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 | |
|---|---|---|
  | SfNextSf | |
 | SfOutputEnable |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputEnable
may have changed.
|
| SfOutputImageOverlapMode |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputImageOverlapMode
may have changed.
|
| SfOutputImageOverlapPriorities |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputImageOverlapPriorities
may have changed.
|
| SfOutputImageScaleMode |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputImageScaleMode
may have changed.
|
| SfOutputImageXMax |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputImageXMax
may have changed.
|
| SfOutputImageXMin |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputImageXMin
may have changed.
|
| SfOutputImageXScale |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputImageXScale
may have changed.
|
| SfOutputImageXYMode |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputImageXYMode
may have changed.
|
| SfOutputImageYMax |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputImageYMax
may have changed.
|
| SfOutputImageYMin |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputImageYMin
may have changed.
|
| SfOutputImageYScale |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputImageYScale
may have changed.
|
| SfOutputImageZConsistencyDistance |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputImageZConsistencyDistance
may have changed.
|
| SfOutputImageZContinuityThreshold |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputImageZContinuityThreshold
may have changed.
|
| SfOutputImageZContinuityThresholdEnabled |
This bit will be set in the EventArgs of a Changed event
every time the value returned by
OutputImageZContinuityThresholdEnabled may have
changed.
|
| SfOutputImageZMin |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputImageZMin
may have changed.
|
| SfOutputImageZMode |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputImageZMode
may have changed.
|
| SfOutputImageZScale |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputImageZScale
may have changed.
|
| SfOutputSpaceName3D |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputSpaceName3D
may have changed.
|
| SfOutputSpaceSource |
This bit will be set in the EventArgs of a Changed event
every time the value returned by OutputSpaceSource
may have changed.
|
| SfSharedSpaceName3D |
This bit will be set in the EventArgs of a Changed event
every time the value returned by SharedSpaceName3D
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.) |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| OutputEnable |
Specify the desired ouputput by bitwise ORing the appropriate
Cog3DVisionDataStitchOutputConstants.
|
| OutputImageOverlapMode |
How input pixels that overlap in X and Y will be processed to produce
an output pixel value.
|
| OutputImageOverlapPriorities |
When
OutputImageOverlapMode
is
Priority,
this is how we select an output pixel value from more than one
overlapping input pixel. In such a case, the overlapping input
image with the numerically lowest priority value is chosen.
|
| OutputImageScaleMode |
How to scale the output range image. This controls the resolution
of the output range image. There are three defined modes:
UseXYZScales and
UseInputImageScales and
UseFirstInputImageScales.
|
| OutputImageXMax |
Client space
(OutputSpaceName3D)
maximum X bounds for the output range image. Ignored if
OutputImageXYMode
is not
Limit.
Note that setting this value to less than the current
OutputImageXMin
will cause OutputImageXMin to be set to the new value as well.
|
| OutputImageXMin |
Client space
(OutputSpaceName3D)
minimum X bounds for the output range image. Ignored if
OutputImageXYMode
is not
Limit.
Note that setting this value to greater than the current
OutputImageXMax
will cause OutputImageXMax to be set to the new value as well.
|
| OutputImageXScale |
The X scale factor to use when generating the output range image.
Ignored when
OutputImageScaleMode
is
UseInputImageScales or
UseFirstInputImageScales.
|
| OutputImageXYMode | |
| OutputImageYMax |
Client space
(OutputSpaceName3D)
maximum Y bounds for the output range image. Ignored if
OutputImageXYMode
is not
Limit.
Note that setting this value to less than the current
OutputImageYMin
will cause OutputImageYMin to be set to the new value as well.
|
| OutputImageYMin |
Client space
(OutputSpaceName3D)
minimum Y bounds for the output range image. Ignored if
OutputImageXYMode
is not
Limit.
Note that setting this value to greater than the current
OutputImageYMax
will cause OutputImageYMax to be set to the new value as well.
|
| OutputImageYScale |
The Y scale factor to use when generating the output range image.
Ignored when
OutputImageScaleMode
is
UseInputImageScales or
UseFirstInputImageScales.
|
| OutputImageZConsistencyDistance |
The maximum Z difference in client space over which overlapping pixel
values will be averaged. If
OverlapMode
is
MaxZ, then overlapping pixels whose height is within this distance
of the maximum height at that location will be averaged. And if
OverlapMode
is
MinZ, then overlapping pixels whose height is within this distance of
the minimum height at that location will be averaged. Overlapping pixel
height values that are outside the specified range will be ignored.
Finally, if
OverlapMode
is any other value, this parameter is ignored.
|
| OutputImageZContinuityThreshold |
The maximum allowable Z difference in client space
(OutputSpaceName3D)
between adjacent source data positions, between which range image voxels
will be interpolated. Adjacencies whose Z difference exceeds this value
will be disconnected. If
OutputImageZContinuityThresholdEnabled
is false then this property is ignored and processing is
performed as if this value were set to
MaxValue).
|
| OutputImageZContinuityThresholdEnabled |
Controls whether
OutputImageZContinuityThreshold
is used during processing. If false, processing is performed
as if the threshold were set to
MaxValue).
|
| OutputImageZMin |
Client space
(OutputSpaceName3D)
minimum Z. If
OutputImageZMode
is
UseZMin, then this parameter will be the output space Z that
corresponds to a minimum output pixel value. This parameter is ignored if
OutputImageZMode
is not
UseZMin.
|
| OutputImageZMode | |
| OutputImageZScale |
The Z scale factor to use when generating the output range image.
Ignored when
OutputImageScaleMode
is
UseInputImageScales or
UseFirstInputImageScales.
|
| OutputSpaceName3D |
The name of the 3D space in which the output range image will be
rendered. The
Execute
method will throw an ArgumentException if this space name does not
exist within the 3D coordinate space tree of the specified
range image.
|
| OutputSpaceSource | The dictionary key of the input range image whose 3D coordinate space tree holds the desired output space. In the case of input range / greyscale image pairs, this is the key of the nested container that in turn holds the range image whose 3D coordinate space tree holds the desired output space. The Execute method will throw an ArgumentException if this dictionary key does not exist within the input CogVisionDataContainer. When set to an empty string, this parameter is treated specially. An empty string is interpreted to mean that we will use an arbitrarily chosen input range image as the source of the output space. This may be usefull when the output space is defined in all input images. |
| SharedSpaceName3D |
The name of the 3D space shared by all input range images. The
Execute
method will throw an ArgumentException if this space name
does not exist in the 3D coordinate space tree of every input
range 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.) |
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