CogBlobSegmentationParams Class

Cognex VisionPro

Class which holds image segmentation parameters. Blob analysis provides numerous methods of segmenting an image into object and background pixels. The primary interface of this class allows the user to select and configure the method of segmentation.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.Blob CogBlobSegmentationParams

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

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogBlobSegmentationParams : CogSerializableChangedEventBase, 
	IDisposable, ICloneable

[SerializableAttribute]
public class CogBlobSegmentationParams : CogSerializableChangedEventBase, 
	IDisposable, ICloneable

<SerializableAttribute>
Public Class CogBlobSegmentationParams 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable, ICloneable

<SerializableAttribute>
Public Class CogBlobSegmentationParams 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable, ICloneable

[SerializableAttribute]
public ref class CogBlobSegmentationParams : public CogSerializableChangedEventBase, 
	IDisposable, ICloneable

[SerializableAttribute]
public ref class CogBlobSegmentationParams : public CogSerializableChangedEventBase, 
	IDisposable, ICloneable

The CogBlobSegmentationParams type exposes the following members.

Constructors

	Name	Description
	CogBlobSegmentationParams	Constructs a new instance of this class.
	CogBlobSegmentationParams(CogBlobSegmentationParams)	Constructs a new instance of this class as a deep copy of the given instance.
	CogBlobSegmentationParams(SerializationInfo, StreamingContext)	Serialization constructor for CogBlobSegmentationParams object.

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.
	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	Destruct this CogBlobSegmentationParams.
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Finalize this CogBlobSegmentationParams. (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.)
	GetMap	Pixel map that is to be applied to the InputImage when using the Map segmentation mode. Each pixel in the input image is replaced by the value within the pixel map at the index equal to the input image pixel value.
	GetObjectData	Implements the GetObjectData method of the ISerializable interface. (Inherited from CogSerializableObjectBase.)
	GetPostMap	Pixel map that is to be applied to the image that resulted from subtracting the SubtractionImage from the InputImage. The value resulting from the subtraction is used as an index into PostMap and is replaced with the value at that index in PostMap.
	GetPreMap	Pixel map that is to be applied to the InputImage when using subtraction image as the segmentation mode. Each pixel in the InputImage is used as an index into PreMap. The input pixel value is replaced with the value from PreMap.
	GetPreMap16	Pixel map that is to be applied to the 16 bit InputImage when using subtraction image as the segmentation mode. Each pixel in the InputImage is used as an index into PreMap16. The input pixel value is replaced with the value from PreMap16.
	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.)
	SetMap	Pixel map that is to be applied to the InputImage when using the Map segmentation mode. Each pixel in the input image is replaced by the value within the pixel map at the index equal to the input image pixel value.
	SetPostMap	Pixel map that is to be applied to the image that resulted from subtracting the SubtractionImage from the InputImage. The value resulting from the subtraction is used as an index into PostMap and is replaced with the value at that index in PostMap.
	SetPreMap	Pixel map that is to be applied to the InputImage when using subtraction image as the segmentation mode. Each pixel in the InputImage is used as an index into PreMap. The input pixel value is replaced with the value from PreMap.
	SetPreMap16	Pixel map that is to be applied to the 16 bit InputImage when using subtraction image as the segmentation mode. Each pixel in the InputImage is used as an index into PreMap16. The input pixel value is replaced with the value from PreMap16.
	SetSegmentationHardDynamicThreshold	Sets the segmentation Mode to HardDynamicThreshold and sets the TailLow, TailHigh, and Polarity properties to the values supplied.
	SetSegmentationHardFixedThreshold	Sets the segmentation Mode to HardFixedThreshold and sets the HardFixedThreshold & Polarity properties to the values supplied.
	SetSegmentationHardRelativeThreshold	Sets the segmentation Mode to HardRelativeThreshold and sets the TailLow, TailHigh, HardRelativeThreshold, & Polarity properties to the values supplied.
	SetSegmentationMap	Sets the segmentation Mode to Map and sets the Map & ScalingValue properties to the values supplied.
	SetSegmentationNone	Sets the segmentation Mode to None and sets the ScalingValue property to the value supplied.
	SetSegmentationSoftFixedThreshold	Sets the segmentation Mode to SoftFixedThreshold and sets the SoftRelativeThresholdLow, SoftRelativeThresholdHigh, Softness, & Polarity properties to the values supplied.
	SetSegmentationSoftRelativeThreshold	Sets the segmentation Mode to SoftRelativeThreshold and sets the TailLow, TailHigh, SoftRelativeThresholdLow, SoftRelativeThresholdHigh, Softness, & Polarity properties to the values supplied.
	SetSegmentationSubtractionImage( Byte , CogImage8Grey, Byte , Int32, Int32, Int32)	Sets the segmentation Mode to SubtractionImage and sets the PreMap, SubtractionImage, PostMap, ScalingValue, SubtractionImageOffsetX, & SubtractionImageOffsetY properties to the values supplied.
	SetSegmentationSubtractionImage( UInt16 , CogImage16Grey, Byte , Int32, Int32, Int32)
	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.)

Top

Fields

	Name	Description
	SfGetMap	This bit will be set in the EventArgs of a Changed event every time the value returned by GetMap may have changed.
	SfGetPostMap	This bit will be set in the EventArgs of a Changed event every time the value returned by GetPostMap may have changed.
	SfGetPreMap	This bit will be set in the EventArgs of a Changed event every time the value returned by GetPreMap may have changed.
	SfGetPreMap16	This bit will be set in the EventArgs of a Changed event every time the value returned by GetPreMap16 may have changed.
	SfHardFixedThreshold	This bit will be set in the EventArgs of a Changed event every time the value returned by HardFixedThreshold may have changed.
	SfHardRelativeThreshold	This bit will be set in the EventArgs of a Changed event every time the value returned by HardRelativeThreshold may have changed.
	SfMode	This bit will be set in the EventArgs of a Changed event every time the value returned by Mode may have changed.
	SfNextSf
	SfPolarity	This bit will be set in the EventArgs of a Changed event every time the value returned by Polarity may have changed.
	SfScalingValue	This bit will be set in the EventArgs of a Changed event every time the value returned by ScalingValue may have changed.
	SfSoftFixedThresholdHigh	This bit will be set in the EventArgs of a Changed event every time the value returned by SoftFixedThresholdHigh may have changed.
	SfSoftFixedThresholdLow	This bit will be set in the EventArgs of a Changed event every time the value returned by SoftFixedThresholdLow may have changed.
	SfSoftness	This bit will be set in the EventArgs of a Changed event every time the value returned by Softness may have changed.
	SfSoftRelativeThresholdHigh	This bit will be set in the EventArgs of a Changed event every time the value returned by SoftRelativeThresholdHigh may have changed.
	SfSoftRelativeThresholdLow	This bit will be set in the EventArgs of a Changed event every time the value returned by SoftRelativeThresholdLow may have changed.
	SfSubtractionImage	This bit will be set in the EventArgs of a Changed event every time the value returned by SubtractionImage may have changed.
	SfSubtractionImageOffsetX	This bit will be set in the EventArgs of a Changed event every time the value returned by SubtractionImageOffsetX may have changed.
	SfSubtractionImageOffsetY	This bit will be set in the EventArgs of a Changed event every time the value returned by SubtractionImageOffsetY may have changed.
	SfTailHigh	This bit will be set in the EventArgs of a Changed event every time the value returned by TailHigh may have changed.
	SfTailLow	This bit will be set in the EventArgs of a Changed event every time the value returned by TailLow 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. (Inherited from CogSerializableChangedEventBase.)
	HardFixedThreshold	If Polarity is light blobs then pixels values that are greater than or equal to this threshold are part of the blob(s); pixel values that are less than this threshold are part of the background. If polarity is dark blobs then the ranges are inverted.
	HardRelativeThreshold	A fixed threshold is computed by determining the pixel value which lies at the specified percentage of the distance between the low tail pixel value and the high tail pixel value. This computed threshold is then used to perform Hard-Fixed segmentation.
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	Mode	The method used to segment an input image into pixels that make up the blob(s) and pixels that are part of the background.
	Polarity	Blob polarity used for image segmentation with either soft or hard thresholding. Indicates either dark blobs on a light background or light blobs on a dark background.
	ScalingValue	Pixel value that represents a blob weight of 1.0, all other pixel values are interpreted on a linear scale relative to ScalingValue.
	SoftFixedThresholdHigh	Pixel values above(>=) the high threshold are background (weight 0) or full-weight blob (weight 1) depending on the Polarity. Values between the low and high thresholds are considered fractional blob (weight between 0 and 1, exclusive). See Softness.
	SoftFixedThresholdLow	Pixel values below the low threshold are background (weight 0) or full-weight blob (weight 1.0) depending on the Polarity. Values between the low and high thresholds are considered fractional blob (weight between 0 and 1, exclusive). See Softness.
	Softness	The maximum number of fractional weights between background pixels (whose weight is 0.0) and full-weight blob pixels (whose weight is 1.0). The fractional weights are represented in the segmentation image by pixel values between 1 and softness.
	SoftRelativeThresholdHigh	This relative threshold specifies a percentage of the distance between the low and high tail grey scale pixel values. The grey scale pixel value determined by this relative percentage is then used as a soft, fixed threshold.
	SoftRelativeThresholdLow	This relative threshold specifies a percentage of the distance between the low and high tail grey scale pixel values. The grey scale pixel value determined by this relative percentage is then used as a soft, fixed threshold.
	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.)
	SubtractionImage	The subtraction image used when the segmentation mode is SubtractionImage. The SubtractionImageOffsetX & SubtractionImageOffsetY specify the pixel alignment of this image with the blob analysis InputImage.
	SubtractionImageOffsetX	X offset value in pixels. The X & Y offset values measure the offset from the upper-left corner of the run-time input image to the upper-left corner of the SubtractionImage in image coordinates of the input image.
	SubtractionImageOffsetY	Y offset value in pixels. The X & Y offset values measure the offset from the upper-left corner of the run-time input image to the upper-left corner of the SubtractionImage in image coordinates of the input image.
	TailHigh	The percentage of high tail pixels to discard before computing either a hard relative, hard dynamic, or soft relative threshold.
	TailLow	The percentage of low tail pixels to discard before computing either a hard relative, hard dynamic, or soft relative threshold.

Top

Events

	Name	Description
	Changed	This event is raised when one or more parts of the object's state may have changed. (Inherited from CogSerializableChangedEventBase.)

Top

Remarks

Blob analysis provides numerous methods of segmenting an image into object pixels and background pixels. This interface lets you control exactly how the image is segmented.