This class represents the operator for the CogPixelMap tool.
It holds all the data required to do a PixelMap operationwhen Auto mode is used.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.PixelMap CogPixelMapComputeParams
Namespace: Cognex.VisionPro.PixelMap
Assembly: Cognex.VisionPro.PixelMap (in Cognex.VisionPro.PixelMap.dll) Version: 83.0.0.0
Syntax
The CogPixelMapComputeParams type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogPixelMapComputeParams |
Construct a default CogPixelMapComputeParams object.
|
| CogPixelMapComputeParams(CogPixelMapComputeParams) |
Construct a deep copy of the supplied CogPixelMapComputeParams 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.) |
| Dispose |
Destruct this CogPixelMapComputeParams.
|
 | Dispose(Boolean) | |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| Finalize |
Finalize this CogPixelMapComputeParams.
(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 |
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 | Returns a String that represents the current Object. (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfAlgorithm |
This bit will be set in the EventArgs of a Changed event every time
the value returned by Algorithm may have changed.
|
| SfHighPadFraction |
This bit will be set in the EventArgs of a Changed event every time
the value returned by HighPadFraction may have changed.
|
| SfHighStdDevMultiplier |
This bit will be set in the EventArgs of a Changed event every time
the value returned by HightTailFraction may have changed.
|
| SfHighTailFraction |
This bit will be set in the EventArgs of a Changed event every time
the value returned by HightTailFraction may have changed.
|
| SfLowPadFraction |
This bit will be set in the EventArgs of a Changed event every time
the value returned by LowPadFraction may have changed.
|
| SfLowStdDevMultiplier |
This bit will be set in the EventArgs of a Changed event every time
the value returned by HightTailFraction may have changed.
|
| SfLowTailFraction |
This bit will be set in the EventArgs of a Changed event every time
the value returned by LowTailFraction may have changed.
|
| SfMaxRangeMultiplier |
This bit will be set in the EventArgs of a Changed event every time
the value returned by MaxRangeMultiplier may have changed.
|
 | SfNextSf | |
| SfOutput1Fraction |
This bit will be set in the EventArgs of a Changed event every time
the value returned by Output1Fraction may have changed.
|
| SfOutput2Fraction |
This bit will be set in the EventArgs of a Changed event every time
the value returned by Output2Fraction may have changed.
|
| SfOutputRange |
This bit will be set in the EventArgs of a Changed event every time
the value returned by OutputRange may have changed.
|
Properties
| Name | Description | |
|---|---|---|
 | Algorithm |
Gets or sets the algorithm value used to compute the pixel map. Specifies the algorithm used to compute the input range that will be mapped to the output range.
|
| 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.) |
| HighPadFraction |
Gets or sets HighPadFraction.
The fraction of the initially-computed input range added to the initially-computed value of second map value. This value is typically positive
|
| HighStdDevMultiplier |
Gets or sets HighStdDevMultiplier.
The High standard deviation multiplier, in the range of (0, +HUGE_VAL). Used only if Algorithm is MeanStdDev
|
| HighTailFraction |
Gets or sets HighTailFraction. The High tail fraction is in the range [0, 1]. Used only if algorithm is Tails
|
| LowPadFraction |
Gets or sets LowPadFraction.
The fraction of the initially-computed input range added to the initially-computed value of first map value. This value is typically negative.
|
| LowStdDevMultiplier |
Gets or sets LowStdDevMultiplier.
The Low standard deviation multiplier in the range of (-HUGE_VAL, 0). Used only if the Algorithm is MeanStdDev.
|
| LowTailFraction |
Gets or sets LowTailFraction. The Low tail fraction is in the range [0, 1]. Used only if algorithm is Tails.
It is the fraction of the sum of all the histogram bins that should be contained in the histogram range [0, LowTailFraction]
|
| MaxRangeMultiplier |
Gets or sets MaxRangeMultiplier.
The maximum rangle multiplier that will be used to convert input pixels to
output pixels. The maximum pixel value is clipped to the maximum allowed for the image type.
|
| Output1Fraction |
Gets or sets Output1Fraction.
Specifies the first relative output pixel value used in the mapping. Used only if OutputRange is SpecifiedRelative
|
| Output2Fraction |
Gets or sets Output2Fraction.
Specifies the second relative output pixel value used in the mapping. Used only if OutputRange is SpecifiedRelative
|
| OutputRange |
Gets or sets the OutputRange. Specifies the output range used in the mapping.
|
| 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