OpenCVForUnity.CoreModule.Algorithm Class Reference

This is a base class for all more or less complex algorithms in OpenCV. More...

Public Member Functions
virtual void	clear ()
	Clears the algorithm state.
virtual bool	empty ()
	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.
virtual string	getDefaultName ()
IntPtr	getNativeObjAddr ()
void	save (string filename)
Public Member Functions inherited from OpenCVForUnity.DisposableObject
void	Dispose ()
void	ThrowIfDisposed ()

Static Public Member Functions
static Algorithm	__fromPtr__ (IntPtr addr)
Static Public Member Functions inherited from OpenCVForUnity.DisposableObject
static IntPtr	ThrowIfNullIntPtr (IntPtr ptr)

Protected Member Functions
override void	Dispose (bool disposing)
Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
	DisposableOpenCVObject ()
	DisposableOpenCVObject (bool isEnabledDispose)
	DisposableOpenCVObject (IntPtr ptr)
	DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)
override void	Dispose (bool disposing)
Protected Member Functions inherited from OpenCVForUnity.DisposableObject
	DisposableObject ()
	DisposableObject (bool isEnabledDispose)

Additional Inherited Members
Package Attributes inherited from OpenCVForUnity.DisposableOpenCVObject
Properties inherited from OpenCVForUnity.DisposableObject
bool	IsDisposed [get, protected set]
bool	IsEnabledDispose [get, set]

Detailed Description

This is a base class for all more or less complex algorithms in OpenCV.

especially for classes of algorithms, for which there can be multiple implementations. The examples are stereo correspondence (for which there are algorithms like block matching, semi-global block matching, graph-cut etc.), background subtraction (which can be done using mixture-of-gaussians models, codebook-based algorithm etc.), optical flow (block matching, Lucas-Kanade, Horn-Schunck etc.).

Here is example of SimpleBlobDetector use in your application via Algorithm interface:

Member Function Documentation

__fromPtr__()

static Algorithm OpenCVForUnity.CoreModule.Algorithm.__fromPtr__ ( IntPtr addr )

static

clear()

virtual void OpenCVForUnity.CoreModule.Algorithm.clear ( )

virtual

Clears the algorithm state.

Reimplemented in OpenCVForUnity.Features2dModule.DescriptorMatcher.

Dispose()

override void OpenCVForUnity.CoreModule.Algorithm.Dispose ( bool disposing )

protectedvirtual

Reimplemented from OpenCVForUnity.DisposableObject.

Reimplemented in OpenCVForUnity.BgsegmModule.BackgroundSubtractorCNT, OpenCVForUnity.BgsegmModule.BackgroundSubtractorGMG, OpenCVForUnity.BgsegmModule.BackgroundSubtractorGSOC, OpenCVForUnity.BgsegmModule.BackgroundSubtractorLSBP, OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG, OpenCVForUnity.BgsegmModule.SyntheticSequenceGenerator, OpenCVForUnity.BioinspiredModule.Retina, OpenCVForUnity.BioinspiredModule.RetinaFastToneMapping, OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule, OpenCVForUnity.Calib3dModule.StereoBM, OpenCVForUnity.Calib3dModule.StereoMatcher, OpenCVForUnity.Calib3dModule.StereoSGBM, OpenCVForUnity.DnnModule.Layer, OpenCVForUnity.FaceModule.BasicFaceRecognizer, OpenCVForUnity.FaceModule.BIF, OpenCVForUnity.FaceModule.EigenFaceRecognizer, OpenCVForUnity.FaceModule.Facemark, OpenCVForUnity.FaceModule.FacemarkAAM, OpenCVForUnity.FaceModule.FacemarkKazemi, OpenCVForUnity.FaceModule.FacemarkLBF, OpenCVForUnity.FaceModule.FacemarkTrain, OpenCVForUnity.FaceModule.FaceRecognizer, OpenCVForUnity.FaceModule.FisherFaceRecognizer, OpenCVForUnity.FaceModule.LBPHFaceRecognizer, OpenCVForUnity.FaceModule.MACE, OpenCVForUnity.Features2dModule.BFMatcher, OpenCVForUnity.Features2dModule.BRISK, OpenCVForUnity.Features2dModule.DescriptorMatcher, OpenCVForUnity.Features2dModule.FastFeatureDetector, OpenCVForUnity.Features2dModule.Feature2D, OpenCVForUnity.Features2dModule.FlannBasedMatcher, OpenCVForUnity.Features2dModule.GFTTDetector, OpenCVForUnity.Features2dModule.KAZE, OpenCVForUnity.Features2dModule.MSER, OpenCVForUnity.Features2dModule.ORB, OpenCVForUnity.Features2dModule.SIFT, OpenCVForUnity.Features2dModule.SimpleBlobDetector, OpenCVForUnity.Img_hashModule.AverageHash, OpenCVForUnity.Img_hashModule.BlockMeanHash, OpenCVForUnity.Img_hashModule.ColorMomentHash, OpenCVForUnity.Img_hashModule.ImgHashBase, OpenCVForUnity.Img_hashModule.MarrHildrethHash, OpenCVForUnity.Img_hashModule.PHash, OpenCVForUnity.Img_hashModule.RadialVarianceHash, OpenCVForUnity.ImgprocModule.CLAHE, OpenCVForUnity.ImgprocModule.GeneralizedHough, OpenCVForUnity.ImgprocModule.GeneralizedHoughBallard, OpenCVForUnity.ImgprocModule.GeneralizedHoughGuil, OpenCVForUnity.ImgprocModule.LineSegmentDetector, OpenCVForUnity.MlModule.ANN_MLP, OpenCVForUnity.MlModule.Boost, OpenCVForUnity.MlModule.DTrees, OpenCVForUnity.MlModule.EM, OpenCVForUnity.MlModule.KNearest, OpenCVForUnity.MlModule.LogisticRegression, OpenCVForUnity.MlModule.NormalBayesClassifier, OpenCVForUnity.MlModule.RTrees, OpenCVForUnity.MlModule.StatModel, OpenCVForUnity.MlModule.SVM, OpenCVForUnity.MlModule.SVMSGD, OpenCVForUnity.ObjdetectModule.ArucoDetector, OpenCVForUnity.ObjdetectModule.BaseCascadeClassifier, OpenCVForUnity.ObjdetectModule.CharucoDetector, OpenCVForUnity.Phase_unwrappingModule.HistogramPhaseUnwrapping, OpenCVForUnity.Phase_unwrappingModule.PhaseUnwrapping, OpenCVForUnity.PhotoModule.AlignExposures, OpenCVForUnity.PhotoModule.AlignMTB, OpenCVForUnity.PhotoModule.CalibrateCRF, OpenCVForUnity.PhotoModule.CalibrateDebevec, OpenCVForUnity.PhotoModule.CalibrateRobertson, OpenCVForUnity.PhotoModule.MergeDebevec, OpenCVForUnity.PhotoModule.MergeExposures, OpenCVForUnity.PhotoModule.MergeMertens, OpenCVForUnity.PhotoModule.MergeRobertson, OpenCVForUnity.PhotoModule.Tonemap, OpenCVForUnity.PhotoModule.TonemapDrago, OpenCVForUnity.PhotoModule.TonemapMantiuk, OpenCVForUnity.PhotoModule.TonemapReinhard, OpenCVForUnity.PlotModule.Plot2d, OpenCVForUnity.Structured_lightModule.GrayCodePattern, OpenCVForUnity.Structured_lightModule.SinusoidalPattern, OpenCVForUnity.Structured_lightModule.StructuredLightPattern, OpenCVForUnity.TextModule.ERFilter, OpenCVForUnity.TrackingModule.legacy_MultiTracker, OpenCVForUnity.TrackingModule.legacy_Tracker, OpenCVForUnity.TrackingModule.legacy_TrackerBoosting, OpenCVForUnity.TrackingModule.legacy_TrackerCSRT, OpenCVForUnity.TrackingModule.legacy_TrackerKCF, OpenCVForUnity.TrackingModule.legacy_TrackerMedianFlow, OpenCVForUnity.TrackingModule.legacy_TrackerMIL, OpenCVForUnity.TrackingModule.legacy_TrackerMOSSE, OpenCVForUnity.TrackingModule.legacy_TrackerTLD, OpenCVForUnity.VideoModule.BackgroundSubtractor, OpenCVForUnity.VideoModule.BackgroundSubtractorKNN, OpenCVForUnity.VideoModule.BackgroundSubtractorMOG2, OpenCVForUnity.VideoModule.DenseOpticalFlow, OpenCVForUnity.VideoModule.DISOpticalFlow, OpenCVForUnity.VideoModule.FarnebackOpticalFlow, OpenCVForUnity.VideoModule.SparseOpticalFlow, OpenCVForUnity.VideoModule.SparsePyrLKOpticalFlow, OpenCVForUnity.VideoModule.VariationalRefinement, OpenCVForUnity.Xfeatures2dModule.BEBLID, OpenCVForUnity.Xfeatures2dModule.BoostDesc, OpenCVForUnity.Xfeatures2dModule.BriefDescriptorExtractor, OpenCVForUnity.Xfeatures2dModule.DAISY, OpenCVForUnity.Xfeatures2dModule.FREAK, OpenCVForUnity.Xfeatures2dModule.HarrisLaplaceFeatureDetector, OpenCVForUnity.Xfeatures2dModule.LATCH, OpenCVForUnity.Xfeatures2dModule.LUCID, OpenCVForUnity.Xfeatures2dModule.MSDDetector, OpenCVForUnity.Xfeatures2dModule.PCTSignatures, OpenCVForUnity.Xfeatures2dModule.PCTSignaturesSQFD, OpenCVForUnity.Xfeatures2dModule.StarDetector, OpenCVForUnity.Xfeatures2dModule.TBMR, OpenCVForUnity.Xfeatures2dModule.TEBLID, OpenCVForUnity.Xfeatures2dModule.VGG, OpenCVForUnity.XimgprocModule.ContourFitting, OpenCVForUnity.XimgprocModule.DisparityFilter, OpenCVForUnity.XimgprocModule.DisparityWLSFilter, OpenCVForUnity.XimgprocModule.DTFilter, OpenCVForUnity.XimgprocModule.EdgeAwareInterpolator, OpenCVForUnity.XimgprocModule.EdgeBoxes, OpenCVForUnity.XimgprocModule.EdgeDrawing, OpenCVForUnity.XimgprocModule.FastBilateralSolverFilter, OpenCVForUnity.XimgprocModule.FastGlobalSmootherFilter, OpenCVForUnity.XimgprocModule.FastLineDetector, OpenCVForUnity.XimgprocModule.GraphSegmentation, OpenCVForUnity.XimgprocModule.GuidedFilter, OpenCVForUnity.XimgprocModule.RFFeatureGetter, OpenCVForUnity.XimgprocModule.RICInterpolator, OpenCVForUnity.XimgprocModule.RidgeDetectionFilter, OpenCVForUnity.XimgprocModule.ScanSegment, OpenCVForUnity.XimgprocModule.SelectiveSearchSegmentation, OpenCVForUnity.XimgprocModule.SelectiveSearchSegmentationStrategy, OpenCVForUnity.XimgprocModule.SelectiveSearchSegmentationStrategyColor, OpenCVForUnity.XimgprocModule.SelectiveSearchSegmentationStrategyFill, OpenCVForUnity.XimgprocModule.SelectiveSearchSegmentationStrategyMultiple, OpenCVForUnity.XimgprocModule.SelectiveSearchSegmentationStrategySize, OpenCVForUnity.XimgprocModule.SelectiveSearchSegmentationStrategyTexture, OpenCVForUnity.XimgprocModule.SparseMatchInterpolator, OpenCVForUnity.XimgprocModule.StructuredEdgeDetection, OpenCVForUnity.XimgprocModule.SuperpixelLSC, OpenCVForUnity.XimgprocModule.SuperpixelSEEDS, OpenCVForUnity.XimgprocModule.SuperpixelSLIC, OpenCVForUnity.XphotoModule.GrayworldWB, OpenCVForUnity.XphotoModule.LearningBasedWB, OpenCVForUnity.XphotoModule.SimpleWB, OpenCVForUnity.XphotoModule.TonemapDurand, and OpenCVForUnity.XphotoModule.WhiteBalancer.

empty()

virtual bool OpenCVForUnity.CoreModule.Algorithm.empty ( )

virtual

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.

Reimplemented in OpenCVForUnity.Features2dModule.DescriptorMatcher, OpenCVForUnity.Features2dModule.Feature2D, and OpenCVForUnity.MlModule.StatModel.

getDefaultName()

virtual string OpenCVForUnity.CoreModule.Algorithm.getDefaultName ( )

virtual

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.

Reimplemented in OpenCVForUnity.Features2dModule.AffineFeature, OpenCVForUnity.Features2dModule.AgastFeatureDetector, OpenCVForUnity.Features2dModule.AKAZE, OpenCVForUnity.Features2dModule.BRISK, OpenCVForUnity.Features2dModule.FastFeatureDetector, OpenCVForUnity.Features2dModule.Feature2D, OpenCVForUnity.Features2dModule.GFTTDetector, OpenCVForUnity.Features2dModule.KAZE, OpenCVForUnity.Features2dModule.MSER, OpenCVForUnity.Features2dModule.ORB, OpenCVForUnity.Features2dModule.SIFT, OpenCVForUnity.Features2dModule.SimpleBlobDetector, OpenCVForUnity.Xfeatures2dModule.BEBLID, OpenCVForUnity.Xfeatures2dModule.BoostDesc, OpenCVForUnity.Xfeatures2dModule.BriefDescriptorExtractor, OpenCVForUnity.Xfeatures2dModule.DAISY, OpenCVForUnity.Xfeatures2dModule.FREAK, OpenCVForUnity.Xfeatures2dModule.HarrisLaplaceFeatureDetector, OpenCVForUnity.Xfeatures2dModule.LATCH, OpenCVForUnity.Xfeatures2dModule.LUCID, OpenCVForUnity.Xfeatures2dModule.MSDDetector, OpenCVForUnity.Xfeatures2dModule.StarDetector, OpenCVForUnity.Xfeatures2dModule.TEBLID, and OpenCVForUnity.Xfeatures2dModule.VGG.

getNativeObjAddr()

IntPtr OpenCVForUnity.CoreModule.Algorithm.getNativeObjAddr

(

)

save()

void OpenCVForUnity.CoreModule.Algorithm.save

(

string

filename

)

Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).

---

The documentation for this class was generated from the following file:

• OpenCVForUnity/Assets/OpenCVForUnity/org/opencv/core/Algorithm.cs