OpenCV  4.1.1-pre
Open Source Computer Vision
Looking for a C++ dev who knows OpenCV?
I'm looking for work. Hire me!
cv::BaseCascadeClassifier Class Referenceabstract

#include <opencv2/objdetect.hpp>

Inheritance diagram for cv::BaseCascadeClassifier:
Collaboration diagram for cv::BaseCascadeClassifier:

Classes

class  MaskGenerator
 

Public Member Functions

virtual ~BaseCascadeClassifier ()
 
virtual void clear ()
 Clears the algorithm state. More...
 
virtual void detectMultiScale (InputArray image, std::vector< Rect > &objects, double scaleFactor, int minNeighbors, int flags, Size minSize, Size maxSize)=0
 
virtual void detectMultiScale (InputArray image, std::vector< Rect > &objects, std::vector< int > &numDetections, double scaleFactor, int minNeighbors, int flags, Size minSize, Size maxSize)=0
 
virtual void detectMultiScale (InputArray image, std::vector< Rect > &objects, std::vector< int > &rejectLevels, std::vector< double > &levelWeights, double scaleFactor, int minNeighbors, int flags, Size minSize, Size maxSize, bool outputRejectLevels)=0
 
virtual bool empty () const CV_OVERRIDE=0
 Returns true if the Algorithm is empty (e.g. More...
 
virtual String getDefaultName () const
 Returns the algorithm string identifier. More...
 
virtual int getFeatureType () const =0
 
virtual Ptr< MaskGeneratorgetMaskGenerator ()=0
 
virtual void * getOldCascade ()=0
 
virtual Size getOriginalWindowSize () const =0
 
virtual bool isOldFormatCascade () const =0
 
virtual bool load (const String &filename)=0
 
virtual void read (const FileNode &fn)
 Reads algorithm parameters from a file storage. More...
 
virtual void save (const String &filename) const
 Saves the algorithm to a file. More...
 
virtual void setMaskGenerator (const Ptr< MaskGenerator > &maskGenerator)=0
 
virtual void write (FileStorage &fs) const
 Stores algorithm parameters in a file storage. More...
 
void write (const Ptr< FileStorage > &fs, const String &name=String()) const
 simplified API for language bindings This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 

Static Public Member Functions

template<typename _Tp >
static Ptr< _Tp > load (const String &filename, const String &objname=String())
 Loads algorithm from the file. More...
 
template<typename _Tp >
static Ptr< _Tp > loadFromString (const String &strModel, const String &objname=String())
 Loads algorithm from a String. More...
 
template<typename _Tp >
static Ptr< _Tp > read (const FileNode &fn)
 Reads algorithm from the file node. More...
 

Protected Member Functions

void writeFormat (FileStorage &fs) const
 

Constructor & Destructor Documentation

◆ ~BaseCascadeClassifier()

virtual cv::BaseCascadeClassifier::~BaseCascadeClassifier ( )
virtual

Member Function Documentation

◆ clear()

virtual void cv::Algorithm::clear ( )
inlinevirtualinherited

Clears the algorithm state.

Reimplemented in cv::FlannBasedMatcher, and cv::DescriptorMatcher.

◆ detectMultiScale() [1/3]

virtual void cv::BaseCascadeClassifier::detectMultiScale ( InputArray  image,
std::vector< Rect > &  objects,
double  scaleFactor,
int  minNeighbors,
int  flags,
Size  minSize,
Size  maxSize 
)
pure virtual

◆ detectMultiScale() [2/3]

virtual void cv::BaseCascadeClassifier::detectMultiScale ( InputArray  image,
std::vector< Rect > &  objects,
std::vector< int > &  numDetections,
double  scaleFactor,
int  minNeighbors,
int  flags,
Size  minSize,
Size  maxSize 
)
pure virtual

◆ detectMultiScale() [3/3]

virtual void cv::BaseCascadeClassifier::detectMultiScale ( InputArray  image,
std::vector< Rect > &  objects,
std::vector< int > &  rejectLevels,
std::vector< double > &  levelWeights,
double  scaleFactor,
int  minNeighbors,
int  flags,
Size  minSize,
Size  maxSize,
bool  outputRejectLevels 
)
pure virtual

◆ empty()

virtual bool cv::BaseCascadeClassifier::empty ( ) const
pure virtual

Returns true if the Algorithm is empty (e.g.

in the very beginning or after unsuccessful read

Reimplemented from cv::Algorithm.

◆ getDefaultName()

virtual String cv::Algorithm::getDefaultName ( ) const
virtualinherited

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 cv::AKAZE, cv::KAZE, cv::SimpleBlobDetector, cv::GFTTDetector, cv::AgastFeatureDetector, cv::FastFeatureDetector, cv::MSER, cv::ORB, cv::BRISK, and cv::Feature2D.

◆ getFeatureType()

virtual int cv::BaseCascadeClassifier::getFeatureType ( ) const
pure virtual

◆ getMaskGenerator()

virtual Ptr<MaskGenerator> cv::BaseCascadeClassifier::getMaskGenerator ( )
pure virtual

◆ getOldCascade()

virtual void* cv::BaseCascadeClassifier::getOldCascade ( )
pure virtual

◆ getOriginalWindowSize()

virtual Size cv::BaseCascadeClassifier::getOriginalWindowSize ( ) const
pure virtual

◆ isOldFormatCascade()

virtual bool cv::BaseCascadeClassifier::isOldFormatCascade ( ) const
pure virtual

◆ load() [1/2]

virtual bool cv::BaseCascadeClassifier::load ( const String filename)
pure virtual

◆ load() [2/2]

template<typename _Tp >
static Ptr<_Tp> cv::Algorithm::load ( const String filename,
const String objname = String() 
)
inlinestaticinherited

Loads algorithm from the file.

Parameters
filenameName of the file to read.
objnameThe optional name of the node to read (if empty, the first top-level node will be used)

This is static template method of Algorithm. It's usage is following (in the case of SVM):

Ptr<SVM> svm = Algorithm::load<SVM>("my_svm_model.xml");

In order to make this method work, the derived class must overwrite Algorithm::read(const FileNode& fn).

References CV_Assert, cv::FileNode::empty(), cv::FileStorage::getFirstTopLevelNode(), cv::FileStorage::isOpened(), and cv::FileStorage::READ.

Here is the call graph for this function:

◆ loadFromString()

template<typename _Tp >
static Ptr<_Tp> cv::Algorithm::loadFromString ( const String strModel,
const String objname = String() 
)
inlinestaticinherited

Loads algorithm from a String.

Parameters
strModelThe string variable containing the model you want to load.
objnameThe optional name of the node to read (if empty, the first top-level node will be used)

This is static template method of Algorithm. It's usage is following (in the case of SVM):

Ptr<SVM> svm = Algorithm::loadFromString<SVM>(myStringModel);

References CV_WRAP, cv::FileNode::empty(), cv::FileStorage::getFirstTopLevelNode(), cv::FileStorage::MEMORY, and cv::FileStorage::READ.

Here is the call graph for this function:

◆ read() [1/2]

virtual void cv::Algorithm::read ( const FileNode fn)
inlinevirtualinherited

Reads algorithm parameters from a file storage.

Reimplemented in cv::FlannBasedMatcher, cv::DescriptorMatcher, and cv::Feature2D.

◆ read() [2/2]

template<typename _Tp >
static Ptr<_Tp> cv::Algorithm::read ( const FileNode fn)
inlinestaticinherited

Reads algorithm from the file node.

This is static template method of Algorithm. It's usage is following (in the case of SVM):

cv::FileStorage fsRead("example.xml", FileStorage::READ);
Ptr<SVM> svm = Algorithm::read<SVM>(fsRead.root());

In order to make this method work, the derived class must overwrite Algorithm::read(const FileNode& fn) and also have static create() method without parameters (or with all the optional parameters)

◆ save()

virtual void cv::Algorithm::save ( const String filename) const
virtualinherited

Saves the algorithm to a file.

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

◆ setMaskGenerator()

virtual void cv::BaseCascadeClassifier::setMaskGenerator ( const Ptr< MaskGenerator > &  maskGenerator)
pure virtual

◆ write() [1/2]

virtual void cv::Algorithm::write ( FileStorage fs) const
inlinevirtualinherited

Stores algorithm parameters in a file storage.

Reimplemented in cv::FlannBasedMatcher, cv::DescriptorMatcher, and cv::Feature2D.

References CV_WRAP.

Referenced by cv::Feature2D::write(), and cv::DescriptorMatcher::write().

Here is the caller graph for this function:

◆ write() [2/2]

void cv::Algorithm::write ( const Ptr< FileStorage > &  fs,
const String name = String() 
) const
inherited

simplified API for language bindings This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ writeFormat()

void cv::Algorithm::writeFormat ( FileStorage fs) const
protectedinherited

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