CogPixelMap Class

Cognex VisionPro 9.5

This class represents the operator for the CogPixelMap tool. It holds all the data required to do a PixelMap operation, except for the input image and an optional region.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.PixelMap CogPixelMap

Namespace: Cognex.VisionPro.PixelMap
Assembly: Cognex.VisionPro.PixelMap (in Cognex.VisionPro.PixelMap.dll) Version: 69.0.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogPixelMap : CogSerializableChangedEventBase, 
	IDisposable

[SerializableAttribute]
public class CogPixelMap : CogSerializableChangedEventBase, 
	IDisposable

<SerializableAttribute>
Public Class CogPixelMap 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

<SerializableAttribute>
Public Class CogPixelMap 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

[SerializableAttribute]
public ref class CogPixelMap : public CogSerializableChangedEventBase, 
	IDisposable

[SerializableAttribute]
public ref class CogPixelMap : public CogSerializableChangedEventBase, 
	IDisposable

The CogPixelMap type exposes the following members.

Constructors

	Name	Description
	CogPixelMap	Construct a default CogPixelMap object.
	CogPixelMap(CogPixelMap)	Construct a deep copy of the supplied CogPixelMap object.
	CogPixelMap(SerializationInfo, StreamingContext)	Serialization constructor for CogPixelMap object.

Top

Methods

	Name	Description
	AddReferencePoint	Adds a reference point to the internal list. The new reference point will be inserted so that the input values of all reference points are kept in increasing order. If a reference point with the same input value already exists, the new one will be added immediately before that reference point.
	AddReferencePointAbsolute	Adds a reference point to the internal list. The new reference point will be inserted so that the input values of all reference points are kept in increasing order. If a reference point with the same input value already exists, the new one will be added immediately before that reference point.
	ClearReferencePoints	Deletes all reference points
	ComputeMapping	Computes a set of reference points using the ComputMapParams properties, InputImage and Region and replaces the reference points in the list if necessary.
	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.)
	DeleteReferencePoint	Removes a reference point from the internal list.
	Dispose	Destruct this CogPixelMap.
	Dispose(Boolean)
	EnforceReferencePointsOrder	Sorts the reference points for a monotonically increasing order of their input values.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	Perform pixel mapping on the supplied image.
	Finalize	Finalize this CogPixelMap. (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.)
	GetInputDepth	Gets the input bit depth. The conversion between absolute and relative ReferencePoint input values is based on this value.
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetLookupTable
	GetObjectData	(Overrides CogSerializableObjectBase GetObjectData(SerializationInfo, StreamingContext).)
	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 )	(Overrides CogObjectBase GetProperties( Attribute ).)
	GetPropertyOwner	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetReferencePoint	Gets the relative values of an existing reference point.
	GetReferencePointAbsolute	Gets the absolute values of an existing reference point.
	GetReferencePointInput	Gets the relative input value of an existing reference point.
	GetReferencePointInputAbsolute	Gets the absolute input value of an existing reference point.
	GetReferencePointOutput	Gets the relative output value of an existing reference point.
	GetReferencePointOutputAbsolute	Gets the absolute output value of an existing reference point.
	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.)
	ResetLinear	Initializes the reference points to reflect a linear full range mapping of the input grey value range to the output grey value range. Creates two referene points at relative locations (0,0) and (1,1)
	ResetLinear(Int32)	Initializes the reference points to reflect a linear full range mapping of the input grey value range to the output grey value range. Creates a number of equally spaced reference points.
	ResetQuantized	Initializes the reference points to reflect a quantized full range mapping of the input grey value range to the output grey value range. Creates a stairway function with the specified number of steps.
	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.)
	SetInputDepth	Sets the input bit depth. The conversion between absolute and relative ReferencePoint input values will be based on this value.
	SetReferencePoint	Sets the relative values for an existing reference point.
	SetReferencePointAbsolute	Sets the absolute values for an existing reference point.
	SetReferencePointInput	Sets the relative input value for an existing reference point.
	SetReferencePointInputAbsolute	Sets the absolute input value for an existing reference point.
	SetReferencePointOutput	Sets the relative output value for an existing reference point.
	SetReferencePointOutputAbsolute	Sets the absolute output value for an existing reference point.
	SetupMap	Setup the internal lookup-table for the CogPixelMap object.
	SetupMap16
	SetupMap8
	SetupRange16	Setup a range in the the internal 16 bit lookup-table. The mapped values between the start and the end of the range will be linearly interpolated from outMin to outMax.
	SetupRange8	Setup a range in the the internal 8 bit lookup-table. The mapped values between the start and the end of the range will be linearly interpolated from outMin to outMax.
	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.)
	ValidateReferencePointsOrder	Validates the reference points for a monotonically increasing order of their input values.

Top

Fields

	Name	Description
	SfAutoComputeEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by AutoComputeEnabled may have cahnged.
	SfComputeMapParams	This bit will be set in the EventArgs of a Changed event every time the value returned by ComputeMapParams may have cahnged.
	SfGetInputDepth	This bit will be set in the EventArgs of a Changed event every time the value returned by GetInputDepth may have changed.
	SfGetReferencePointInput	This bit will be set in the EventArgs of a Changed event every time the value returned by GetReferencePointInput may have changed.
	SfGetReferencePointInputAbsolute	This bit will be set in the EventArgs of a Changed event every time the value returned by GetReferencePointInputAbsolute may have changed.
	SfGetReferencePointOutput	This bit will be set in the EventArgs of a Changed event every time the value returned by GetReferencePointOutput may have changed.
	SfGetReferencePointOutputAbsolute	This bit will be set in the EventArgs of a Changed event every time the value returned by GetReferencePointOutputAbsolute may have changed.
	SfNextSf
	SfNonVisiblePixelValue	This bit will be set in the EventArgs of a Changed event every time the value returned by NonVisiblePixelValue may have cahnged.
	SfNumReferencePoints	This bit will be set in the EventArgs of a Changed event every time the value returned by NumReferencePoints may have changed.
	SfOnlyUseRegionToComputeRefPoints	This bit will be set in the EventArgs of a Changed event every time the value returned by OnlyUseRegionToComputeRefPoints may have cahnged.
	SfOutputDepth	This bit will be set in the EventArgs of a Changed event every time the value returned by OutputDepth may have changed.
	SfOutputInverted	This bit will be set in the EventArgs of a Changed event every time the value returned by OutputInverted may have changed.
	SfOutputOffset	This bit will be set in the EventArgs of a Changed event every time the value returned by OutOffset may have changed.
	SfOutputScale	This bit will be set in the EventArgs of a Changed event every time the value returned by OutScale may have changed.
	SfUseDefaultNonVisiblePixelValue	This bit will be set in the EventArgs of a Changed event every time the value returned by UseDefaultNonVisiblePixelValue may have cahnged.

Top

Properties

	Name	Description
	AutoComputeEnabled	Gets or sets the AutoComputeEnabled value. Compute with each run
	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.)
	ComputeMapParams	Gets or sets the ComputeMapParams
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	NonVisiblePixelValue	Gets or sets the NonVisiblePixelValue.
	NumReferencePoints	Gets the number of configured reference points.
	OnlyUseRegionToComputeRefPoints	Gets or sets the OnlyUseRegionToComputeRefPoints value. This property applies only when AutoComputeEnabled is true.
	OutputDepth	Gets or sets the bit depth of the output image.
	OutputInverted	Gets or sets the OutputInverted value used for lookup table creation.
	OutputOffset	Gets or sets the OutputOffset value used for lookup table creation.
	OutputScale	Gets or sets the OutputScale value used for lookup table creation.
	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.)
	UseDefaultNonVisiblePixelValue	Gets or sets the UseDefaultNonVisiblePixelValue.

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