Cog3DRangeImageCrossSectionOperatorsParams ClassCognex VisionPro
the Cross Section operators collection class.
Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.Implementation CogSerializableCollectionBase Cog3DRangeImageCrossSectionOperatorBase 
            Cognex.VisionPro3D Cog3DRangeImageCrossSectionOperatorsParams

Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D (in Cognex.VisionPro3D.dll) Version: 65.1.0.0
Syntax

[SerializableAttribute]
public class Cog3DRangeImageCrossSectionOperatorsParams : CogSerializableCollectionBase<Cog3DRangeImageCrossSectionOperatorBase>, 
	IDeserializationCallback, IDisposable

The Cog3DRangeImageCrossSectionOperatorsParams type exposes the following members.

Constructors

  NameDescription
Public methodCog3DRangeImageCrossSectionOperatorsParams 
Construct a default Cog3DRangeImageCrossSectionOperatorsParams object.
Public methodCog3DRangeImageCrossSectionOperatorsParams(Cog3DRangeImageCrossSectionOperatorsParams)
Construct a deep copy of the supplied Cog3DRangeImageCrossSectionOperatorsParams object.
Protected methodCog3DRangeImageCrossSectionOperatorsParams(SerializationInfo, StreamingContext)
Serialization constructor for Cog3DRangeImageCrossSectionProfileParams object.
Top
Methods

  NameDescription
Public methodAdd
Adds value to the end of the collection.
(Inherited from CogSerializableCollectionBase T .)
Public methodClear
Removes all objects from the collection.
(Inherited from CogSerializableCollectionBase T .)
Public methodContains
Returns true if value is in the collection
(Inherited from CogSerializableCollectionBase T .)
Public methodCopyTo
Copies the collection to an array
(Inherited from CogSerializableCollectionBase T .)
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodDispose 
Destruct this Cog3DRangeImageCrossSectionOperatorsParams.
Protected methodDispose(Boolean)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExecute
The execute method in this class is responsible for:
  • Fixturing the profile: adding a user defined space to the profile space tree in the output profile (optional)
  • Running the operators. The operators are run in the resulting profile space. The operators interpret their regions in that space and produce results in that space.
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetAttributes
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetClassName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetComponentName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetConverter
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetDefaultEvent
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetDefaultProperty
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEditor
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEvents 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEvents( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodGetObjectData
Implements the GetObjectData method of the ISerializable interface.
(Inherited from CogSerializableObjectBase.)
Protected methodGetProperties 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetProperties( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetPropertyOwner
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf
Returns the index of value in the collection, or -1 if value is not in the collection.
(Inherited from CogSerializableCollectionBase T .)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodInsert
Inserts the value at the specified index of the collection
(Inherited from CogSerializableCollectionBase T .)
Public methodIsNameUnique
Checks if the name is unique within the collection. Return true if unique, false otherwise.
Protected methodMemberwiseClone 
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Public methodMove
Moves an item from one position to another.
(Inherited from CogSerializableCollectionBase T .)
Protected methodOnChanged(Int64)
This method should be called internally whenever the object's state may have changed.
(Inherited from CogSerializableChangedEventBase.)
Protected methodOnChanged(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.)
Protected methodOnCleared
Raises the Cleared event.
(Inherited from CogSerializableCollectionBase T .)
Protected methodOnClearing
Raises the Clearing event.
(Inherited from CogSerializableCollectionBase T .)
Public methodOnDeserialization
Internal Cognex use only.
Protected methodOnInsertedItem
Raises the InsertedItem event.
(Inherited from CogSerializableCollectionBase T .)
Protected methodOnInsertingItem
Raises the InsertingItem event.
(Inherited from CogSerializableCollectionBase T .)
Protected methodOnMovedItem
Raises the MovedItem event.
(Inherited from CogSerializableCollectionBase T .)
Protected methodOnMovingItem
Raises the MovingItem event.
(Inherited from CogSerializableCollectionBase T .)
Protected methodOnRemovedItem
Raises the RemovedItem event.
(Inherited from CogSerializableCollectionBase T .)
Protected methodOnRemovingItem
Raises the RemovingItem event.
(Inherited from CogSerializableCollectionBase T .)
Protected methodOnReplacedItem
Raises the ReplacedItem event.
(Inherited from CogSerializableCollectionBase T .)
Protected methodOnReplacingItem
Raises the ReplacingItem event.
(Inherited from CogSerializableCollectionBase T .)
Public methodRemove
Removes value from the collection
(Inherited from CogSerializableCollectionBase T .)
Public methodRemoveAt
Removes the element at the specified index.
(Inherited from CogSerializableCollectionBase T .)
Public methodResumeAndRaiseChangedEvent
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.)
Public methodSuspendChangedEvent
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.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Fields

  NameDescription
Public fieldStatic memberSfDefautFromNewTransform
This bit will be set in the EventArgs of a Changed event every time the value returned by DefaultFromNewTransform may have changed.
Public fieldStatic memberSfInternalProfile
This bit will be set in the EventArgs of a Changed event every time the value returned by InternalProfile may have changed.
Protected fieldStatic memberSfNextSf
NextSf state flag.
Public fieldStatic memberSfPinRegions
This bit will be set in the EventArgs of a Changed event every time the value returned by PinRegions may have changed.
Public fieldStatic memberSfProfileExistingSpaceName
This bit will be set in the EventArgs of a Changed event every time the value returned by ProfileExistingSpaceName may have changed.
Public fieldStatic memberSfProfileNewSpaceName
This bit will be set in the EventArgs of a Changed event every time the value returned by ProfileNewSpaceName may have changed.
Public fieldStatic memberSfProfileSpaceSelection
This bit will be set in the EventArgs of a Changed event every time the value returned by ProfileSpaceSelection may have changed.
Public fieldStatic memberSfSelectedOperatorIndex
This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedOperatorIndex may have changed.
Public fieldStatic memberSfStatus
This bit will be set in the EventArgs of a Changed event every time the value returned by Status may have changed.
Top
Properties

  NameDescription
Public propertyChangedEventSuspended
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.)
Public propertyCount
Gets the number of elements contained in the collection.
(Inherited from CogSerializableCollectionBase T .)
Public propertyDefautFromNewTransform
Gets or sets the DefaultFromNewTransform.
Public propertyHasChanged (Inherited from CogSerializableChangedEventBase.)
Protected propertyInnerList
Gets the internal List containing the list of elements.
(Inherited from CogSerializableCollectionBase T .)
Public propertyInternalProfile
Internal Cognex use only.
Public propertyIsFixedSize
returns false
(Inherited from CogSerializableCollectionBase T .)
Public propertyIsReadOnly
Returns true if this collection is ReadOnly
(Inherited from CogSerializableCollectionBase T .)
Public propertyIsSynchronized (Inherited from CogSerializableCollectionBase T .)
Public propertyItem
Returns the T at index
(Inherited from CogSerializableCollectionBase T .)
Protected propertyList
Gets an the IList interface of this collection.
(Inherited from CogSerializableCollectionBase T .)
Public propertyPinRegions
Gets or sets the PinRegions.
Public propertyProfileExistingSpaceName
Gets or sets the ProfileExistingSpaceName.
Public propertyProfileNewSpaceName
Gets or sets the ProfileNewSpaceName.
Public propertyProfileSpaceSelection
Gets or sets the ProfileSpaceSelection.
Public propertySelectedOperatorIndex
Gets or sets the SelectedOperatorIndex.
Public propertyStateFlags
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.)
Public propertyStatus
Gets the status.
Public propertySyncRoot (Inherited from CogSerializableCollectionBase T .)
Top
Events

  NameDescription
Public eventChanged
This event is raised when one or more parts of the object's state may have changed.
(Inherited from CogSerializableChangedEventBase.)
Public eventCleared
Raised after the collection is cleared.
(Inherited from CogSerializableCollectionBase T .)
Public eventClearing
Raised before the collection is cleared.
(Inherited from CogSerializableCollectionBase T .)
Public eventInsertedItem
Raised after an item is inserted.
(Inherited from CogSerializableCollectionBase T .)
Public eventInsertingItem
Raised before an item is inserted.
(Inherited from CogSerializableCollectionBase T .)
Public eventMovedItem
Raised after an item is moved to a new index.
(Inherited from CogSerializableCollectionBase T .)
Public eventMovingItem
Raised before an item is moved to a new index.
(Inherited from CogSerializableCollectionBase T .)
Public eventRemovedItem
Raised after an item is removed.
(Inherited from CogSerializableCollectionBase T .)
Public eventRemovingItem
Raised before an item is removed.
(Inherited from CogSerializableCollectionBase T .)
Public eventReplacedItem
Raised after an item is replaced.
(Inherited from CogSerializableCollectionBase T .)
Public eventReplacingItem
Raised before an item is replaced.
(Inherited from CogSerializableCollectionBase T .)
Top
Remarks

The operators collection is responsible for optionally fixturing the profile and managing all the operators.

The operators are the methods for extracting features from the profile, computing features based on other features, and making measurements. Each operator will produce either a single feature (like a point, or a line segment) or a single measurement (like a distance, or an angle).

Operators that extract a feature from the profile data typically require the user to provide one or more regions (in the selected profile space). These regions identify the subset of the profile data that should be used during feature extraction. The extracted feature can then be used by other operators for additional computation or measurement.

Operators that make computations or measurements using extracted features never take the features themselves as inputs. Instead, these operators accept a reference to the operator that produces the feature. The concept of referencing operators is similar to linking a property from one tool to the next. This concept fits nicely here because we execute the operators in sequence and each operator produce a single object so there is no ambiguity.

The operators are not meant to be used standalone. It is recommended that the operator is added to the collection and then configured. This sequence is very important for the operators that reference other operators. The paradigm of the operators is closely aligned with a tool group, for example you cannot link the properties of a tool to other tools without adding the tool first to the tool group. The operators that reference other operators are linking the operators together.

The overall status of executing all the operators is set in the status property. The status type is Boolean. True indicates that all the operators passed. False indicates at least one operator failed.

The operator can be added only to one collection. The operator internal unique id within a collection is set at the time the operator is added. Once the id is set, adding the operator to another collection will not be allowed.

See Also