Click or drag to resize

Algorithm Class

Base class for high-level OpenCV algorithms
Inheritance Hierarchy

Namespace:  OpenCvSharp
Assembly:  OpenCvSharp (in OpenCvSharp.dll) Version: 1.0.0
Syntax
public abstract class Algorithm : DisposableCvObject

The Algorithm type exposes the following members.

Constructors
  NameDescription
Protected methodAlgorithm
Initializes a new instance of the Algorithm class
Top
Properties
  NameDescription
Protected propertyAllocatedMemory
Gets or sets a memory address allocated by AllocMemory.
(Inherited from DisposableObject.)
Protected propertyAllocatedMemorySize
Gets or sets the byte length of the allocated memory
(Inherited from DisposableObject.)
Public propertyCvPtr
Native pointer of OpenCV structure
(Inherited from DisposableCvObject.)
Protected propertyDataHandle
Gets or sets a handle which allocates using cvSetData.
(Inherited from DisposableObject.)
Public propertyEmpty
Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read
Public propertyIsDisposed
Gets a value indicating whether this instance has been disposed.
(Inherited from DisposableObject.)
Public propertyIsEnabledDispose
Gets or sets a value indicating whether you permit disposing this instance.
(Inherited from DisposableObject.)
Top
Methods
  NameDescription
Protected methodAllocGCHandle
Pins the object to be allocated by cvSetData.
(Inherited from DisposableObject.)
Protected methodAllocMemory
Allocates the specified size of memory.
(Inherited from DisposableObject.)
Public methodDispose
Releases the resources
(Inherited from DisposableObject.)
Protected methodDispose(Boolean)
Releases the resources
(Inherited from DisposableObject.)
Protected methodDisposeManaged
Releases managed resources
(Inherited from DisposableObject.)
Protected methodDisposeUnmanaged
releases unmanaged resources
(Inherited from DisposableCvObject.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Destructor
(Inherited from DisposableObject.)
Public methodGetDefaultName
Returns the algorithm string identifier. This string is used as top level xml/yml node tag when the object is saved to a file or string.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodNotifyMemoryPressure
Notifies the allocated size of memory.
(Inherited from DisposableObject.)
Public methodRead
Reads algorithm parameters from a file storage
Public methodSave
Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage fs).
Public methodThrowIfDisposed
If this object is disposed, then ObjectDisposedException is thrown.
(Inherited from DisposableObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWrite
Stores algorithm parameters in a file storage
Top
Fields
  NameDescription
Protected fieldptr
Data pointer
(Inherited from DisposableCvObject.)
Top
See Also
Inheritance Hierarchy
SystemObject
  OpenCvSharpDisposableObject
    OpenCvSharpDisposableCvObject
      OpenCvSharpAlgorithm
        OpenCvSharpBackgroundSubtractor
        OpenCvSharpCalibrateCRF
        OpenCvSharpCLAHE
        OpenCvSharpDenseOpticalFlowExt
        OpenCvSharpDescriptorMatcher
        OpenCvSharpEM
        OpenCvSharp.FaceFacemark
        OpenCvSharp.FaceFaceRecognizer
        OpenCvSharpFeature2D
        OpenCvSharpGeneralizedHough
        OpenCvSharp.ImgHashImgHashBase
        OpenCvSharpMergeExposures
        OpenCvSharp.MLStatModel
        OpenCvSharp.QualityQualityBase
        OpenCvSharpShapeDistanceExtractor
        OpenCvSharpStereoMatcher
        OpenCvSharpSuperResolution
        OpenCvSharpTonemap
        OpenCvSharp.TrackingMultiTracker
        OpenCvSharp.TrackingTracker
        OpenCvSharp.XImgProcAdaptiveManifoldFilter
        OpenCvSharp.XImgProcDTFilter
        OpenCvSharp.XImgProcEdgeBoxes
        OpenCvSharp.XImgProcFastBilateralSolverFilter
        OpenCvSharp.XImgProcFastGlobalSmootherFilter
        OpenCvSharp.XImgProcFastLineDetector
        OpenCvSharp.XImgProcGuidedFilter
        OpenCvSharp.XImgProcRFFeatureGetter
        OpenCvSharp.XImgProc.SegmentationGraphSegmentation
        OpenCvSharp.XImgProc.SegmentationSelectiveSearchSegmentation
        OpenCvSharp.XImgProc.SegmentationSelectiveSearchSegmentationStrategy
        OpenCvSharp.XImgProcStructuredEdgeDetection
        OpenCvSharp.XImgProcSuperpixelLSC
        OpenCvSharp.XImgProcSuperpixelSEEDS
        OpenCvSharp.XImgProcSuperpixelSLIC
        OpenCvSharp.XPhotoWhiteBalancer