Class that copies a region of pixels into a destination image.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.ImageProcessing CogCopyRegion
Namespace: Cognex.VisionPro.ImageProcessing
Assembly: Cognex.VisionPro.ImageProcessing (in Cognex.VisionPro.ImageProcessing.dll) Version: 65.1.0.0
Syntax
The CogCopyRegion type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogCopyRegion | Constructs a new instance of this class. |
| CogCopyRegion(IntPtr) | Constructs a new instance of this class using com pointer. |
| CogCopyRegion(CogCopyRegion) | Constructs a new instance of this class as a deep copy of the given instance. |
Methods
| Name | Description | |
|---|---|---|
 | Clone | Returns a deep copy of this class instance. Derived classes that implement Clone should override this method; other clients who wish to clone this instance should call ICloneable.Clone. See also CogSerializer.DeepCopyObject |
| ComputeDestinationRegion | Computes the SourceClipped, DestinationClipped and DestinationRegion values that would be returned by the Execute method, but does not copy any pixels. |
| 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 | |
| Dispose(Boolean) | |
| Equals | (Inherited from Object.) |
| Execute | Copies a region of the InputImage into the DestinationImage, or into a newly-created OutputImage if no DestinationImage is given. |
| Finalize | (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 | |
| 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.) |
| ResumeAndRaiseChangedEvent | Re-enables raising of the Changed event after SuspendChangedEvent has been called. Also 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. |
| 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. |
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfDefaultOutputImageType | This bit will be set in the EventArgs of a Changed event every time the value returned by DefaultOutputImageType may have changed. |
| SfDestinationImageAlignmentX | This bit will be set in the EventArgs of a Changed event every time the value returned by DestinationImageAlignmentX may have changed. |
| SfDestinationImageAlignmentY | This bit will be set in the EventArgs of a Changed event every time the value returned by DestinationImageAlignmentY may have changed. |
| SfFillBoundingBox | This bit will be set in the EventArgs of a Changed event every time the value returned by FillBoundingBox may have changed. |
| SfFillBoundingBoxPlane0Value | This bit will be set in the EventArgs of a Changed event every time the value returned by FillBoundingBoxPlane0Value may have changed. |
| SfFillBoundingBoxPlane1Value | This bit will be set in the EventArgs of a Changed event every time the value returned by FillBoundingBoxPlane1Value may have changed. |
| SfFillBoundingBoxPlane2Value | This bit will be set in the EventArgs of a Changed event every time the value returned by FillBoundingBoxPlane2Value may have changed. |
| SfFillBoundingBoxValue | This bit will be set in the EventArgs of a Changed event every time the value returned by FillBoundingBoxValue may have changed. |
| SfFillRegion | This bit will be set in the EventArgs of a Changed event every time the value returned by FillRegion may have changed. |
| SfFillRegionPlane0Value | This bit will be set in the EventArgs of a Changed event every time the value returned by FillRegionPlane0Value may have changed. |
| SfFillRegionPlane1Value | This bit will be set in the EventArgs of a Changed event every time the value returned by FillRegionPlane1Value may have changed. |
| SfFillRegionPlane2Value | This bit will be set in the EventArgs of a Changed event every time the value returned by FillRegionPlane2Value may have changed. |
| SfFillRegionValue | This bit will be set in the EventArgs of a Changed event every time the value returned by FillRegionValue may have changed. |
| SfImageAlignmentEnabled | This bit will be set in the EventArgs of a Changed event every time the value returned by ImageAlignmentEnabled may have changed. |
| SfInputImageAlignmentX | This bit will be set in the EventArgs of a Changed event every time the value returned by InputImageAlignmentX may have changed. |
| SfInputImageAlignmentY | This bit will be set in the EventArgs of a Changed event every time the value returned by InputImageAlignmentY may have changed. |
| SfMergedSpaceTreeName | This bit will be set in the EventArgs of a Changed event every time the value returned by MergedSpaceTreeName 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. |
| SfSpaceTreeMode | This bit will be set in the EventArgs of a Changed event every time the value returned by SpaceTreeMode 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. |
| DefaultOutputImageType | Specifies the output image type when no input image is supplied. |
| DestinationImageAlignmentX | Specifies the X coordinate on DestinationImage used to align both images. This coordinate is specified in the same selected space as DestinationImage. It is only used when ImageAlignmentEnabled is true. |
| DestinationImageAlignmentY | Specifies the Y coordinate on DestinationImage used to align both images. This coordinate is specified in the same selected space as DestinationImage. It is only used when ImageAlignmentEnabled is true. |
| FillBoundingBox | Specifies whether to fill the bounding box with FillBoundingBoxValue instead of leaving it unchanged. |
| FillBoundingBoxPlane0Value | Specifies the value to write into Plane 0 of pixels outside of the region and inside of the bounding box, if FillBoundingBox is True and the output image is a CogImage24PlanarColor. |
| FillBoundingBoxPlane1Value | Specifies the value to write into Plane 1 of pixels outside of the region and inside of the bounding box, if FillBoundingBox is True and the output image is a CogImage24PlanarColor. |
| FillBoundingBoxPlane2Value | Specifies the value to write into Plane 2 of pixels outside of the region and inside of the bounding box, if FillBoundingBox is True and the output image is a CogImage24PlanarColor. |
| FillBoundingBoxValue | If FillBoundingBox=True, specifies the value with which to fill the bounding box outside the region. Otherwise, this property is ignored. |
| FillRegion | Specifies whether to fill the destination region with FillRegionValue instead of copying pixels from the source image. |
| FillRegionPlane0Value | Specifies the value with which to fill Plane 0 of the destination region if FillRegion is True and the output image is a CogImage24PlanarColor. |
| FillRegionPlane1Value | Specifies the value with which to fill Plane 1 of the destination region if FillRegion is True and the output image is a CogImage24PlanarColor. |
| FillRegionPlane2Value | Specifies the value with which to fill Plane 2 of the destination region if FillRegion is True and the output image is a CogImage24PlanarColor. |
| FillRegionValue | Specifies the value with which to fill the destination region if FillRegion=True. |
| HasChanged | If true, the serializable state of this object has changed since the last time it was serialized. |
| ImageAlignmentEnabled | Specifies whether or not the alignment coordinates should be used to align the InputImage with the DestinationImage (if given). If not enabled, the upper-left corner of the images will be used for alignment. |
| InputImageAlignmentX | Specifies the X coordinate on InputImage used to align both images. This coordinate is specified in the same selected space as InputImage passed to the Execute method. It is only used when ImageAlignmentEnabled is true. |
| InputImageAlignmentY | Specifies the Y coordinate on InputImage used to align both images. This coordinate is specified in the same selected space as InputImage passed to the Execute method. It is only used when ImageAlignmentEnabled is true. |
| MergedSpaceTreeName | Specifies the name of a coordinate space that bridges the root nodes of the two coordinate space trees if a merged SpaceTreeMode is selected. |
| RegionMode | Specifies whether copying will be performed strictly within the confines of the region specified or within the image aligned bounding box of the region. |
| SpaceTreeMode | Specifies how the coordinate space tree of the DestinationImage should be affected. Ignored if no DestinationImage is given. |
Events
| Name | Description | |
|---|---|---|
 | Changed | Occurs when one or more parts of the object's state may have changed. |
Remarks
Primary interface of the CogCopyRegion class.
See Also