CogIPOneImagePelSet Class

Cognex VisionPro

Class that performs the Pixel Set processing on an image.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.ImageProcessing CogIPOneImagePelSet

Namespace: Cognex.VisionPro.ImageProcessing
Assembly: Cognex.VisionPro.ImageProcessing (in Cognex.VisionPro.ImageProcessing.dll) Version: 65.1.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogIPOneImagePelSet : CogObjectBase, 
	ICogNetInternal, IDisposable, ICogIPOneImageOperator, ICogIPOneImageOperatorParams, ICloneable, 
	ISerializable, ICogHasChanged, ICogChangedEvent

[SerializableAttribute]
public class CogIPOneImagePelSet : CogObjectBase, 
	ICogNetInternal, IDisposable, ICogIPOneImageOperator, ICogIPOneImageOperatorParams, ICloneable, 
	ISerializable, ICogHasChanged, ICogChangedEvent

<SerializableAttribute>
Public Class CogIPOneImagePelSet 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICogIPOneImageOperator, ICogIPOneImageOperatorParams, 
	ICloneable, ISerializable, ICogHasChanged, ICogChangedEvent

<SerializableAttribute>
Public Class CogIPOneImagePelSet 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICogIPOneImageOperator, ICogIPOneImageOperatorParams, 
	ICloneable, ISerializable, ICogHasChanged, ICogChangedEvent

[SerializableAttribute]
public ref class CogIPOneImagePelSet : public CogObjectBase, 
	ICogNetInternal, IDisposable, ICogIPOneImageOperator, ICogIPOneImageOperatorParams, ICloneable, 
	ISerializable, ICogHasChanged, ICogChangedEvent

[SerializableAttribute]
public ref class CogIPOneImagePelSet : public CogObjectBase, 
	ICogNetInternal, IDisposable, ICogIPOneImageOperator, ICogIPOneImageOperatorParams, ICloneable, 
	ISerializable, ICogHasChanged, ICogChangedEvent

The CogIPOneImagePelSet type exposes the following members.

Constructors

	Name	Description
	CogIPOneImagePelSet	Constructs a new instance of this class.
	CogIPOneImagePelSet(IntPtr)	Constructs a new instance of this class using com pointer.
	CogIPOneImagePelSet(CogIPOneImagePelSet)	Constructs a new instance of this class as a deep copy of the given instance.

Top

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
	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	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	Perform a single image operation using the input image and region to produce the output image.
	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	Returns a String that represents the current Object. (Inherited from Object.)

Top

Fields

	Name	Description
	SfEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by Enabled may have changed.
	SfInputImageMask	This bit wil be set in the EventArgs of a Changed event every time the value returned by InputImageMask may have changed.
	SfInputImageMaskOffsetX	This bit wil be set in the EventArgs of a Changed event every time the value returned by InputImageMaskOffsetX may have changed.
	SfInputImageMaskOffsetY	This bit wil be set in the EventArgs of a Changed event every time the value returned by InputImageMaskOffsetY may have changed.
	SfOperation	This bit will be set in the EventArgs of a Changed event every time the value returned by Operation may have changed.
	SfOperatorName	This bit will be set in the EventArgs of a Changed event every time the value returned by OperatorName may have changed.
	SfPelValue	This bit will be set in the EventArgs of a Changed event every time the value returned by PelValue may have changed.

Top

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.
	Enabled	Whether this one image operator will be used to compute the output image.
	HasChanged	If true, the serializable state of this object has changed since the last time it was serialized.
	InputImageMask	Mask indicating areas of Care (255) and Don't Care (Zero). The mask is aligned to the InputImage using the InputImageMaskOffsetX & Y values. It is an undefined behavior if the mask pixels are not 0 or 255.
	InputImageMaskOffsetX	X offset value in pixels. The X & Y offset values measure the offset from the upper-left corner of the InputImage to the upper-left corner of the InputImageMask, in pixel coordinates of the InputImage.
	InputImageMaskOffsetY	Y offset value in pixels. The X & Y offset values measure the offset from the upper-left corner of the InputImage to the upper-left corner of the InputImageMask, in pixel coordinates of the InputImage.
	Operation	Get or set the operation to be performed at runtime. Possible choices include: set the care pels, or set the don't care pels.
	OperatorName	Returns/sets a displayable operator name.
	PelValue	Get or set the value used at runtime. Depending on the operation, the value is applied to care pels or don't care pels. This value is validated at runtime for the image type used. For CogImage8Grey the value cannot exceed 255.

Top

Events

	Name	Description
	Changed	Occurs when one or more parts of the object's state may have changed.

Top

Remarks

The input image pixels and the output image pixels are classified as care-pixels and don't-care pixels as follows:

First start with the full image as care-pixels
Next write-in the don't care pixel from the user specified mask
Next If the region mode is set to Pixel Aligned Bounding Box Adjust Mask, write-in the don't care pixels found outside the region but within the bounding box of the region,

Now all input image pixels have been classified, the output image will be limited to the bounding box of the region - only pixels within the bounding box of the region will be operated on.

The execute method will either write the care-pixels or the don't-care pixels based on the Opertion selected by the user.