Renesas / opencv-lib

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   RZ_A2M_Mbed_samples

Embed: (wiki syntax)

« Back to documentation index

SuperResolution Class Reference
Public Member Functions | Static Public Member Functions

SuperResolution Class Reference
[Super Resolution]

Base class for Super Resolution algorithms. More...

#include <superres.hpp>

Inherits cv::Algorithm, and cv::superres::FrameSource.

Public Member Functions

void setInput (const Ptr< FrameSource > &frameSource)
 Set input frame source for Super Resolution algorithm.
void nextFrame (OutputArray frame)
 Process next frame from input and return output result.
virtual void collectGarbage ()
 Clear all inner buffers.
virtual int getScale () const =0
 Scale factor.
virtual void setScale (int val)=0
 

Scale factor.


virtual int getIterations () const =0
 Iterations count.
virtual void setIterations (int val)=0
 

Iterations count.


virtual double getTau () const =0
 Asymptotic value of steepest descent method.
virtual void setTau (double val)=0
 

Asymptotic value of steepest descent method.


virtual double getLabmda () const =0
 Weight parameter to balance data term and smoothness term.
virtual void setLabmda (double val)=0
 

Weight parameter to balance data term and smoothness term.


virtual double getAlpha () const =0
 Parameter of spacial distribution in Bilateral-TV.
virtual void setAlpha (double val)=0
 

Parameter of spacial distribution in Bilateral-TV.


virtual int getKernelSize () const =0
 Kernel size of Bilateral-TV filter.
virtual void setKernelSize (int val)=0
 

Kernel size of Bilateral-TV filter.


virtual int getBlurKernelSize () const =0
 Gaussian blur kernel size.
virtual void setBlurKernelSize (int val)=0
 

Gaussian blur kernel size.


virtual double getBlurSigma () const =0
 Gaussian blur sigma.
virtual void setBlurSigma (double val)=0
 

Gaussian blur sigma.


virtual int getTemporalAreaRadius () const =0
 Radius of the temporal search area.
virtual void setTemporalAreaRadius (int val)=0
 

Radius of the temporal search area.


virtual Ptr
< cv::superres::DenseOpticalFlowExt > 		getOpticalFlow () const =0
 Dense optical flow algorithm.
virtual void setOpticalFlow (const Ptr< cv::superres::DenseOpticalFlowExt > &val)=0
 

Dense optical flow algorithm.


virtual CV_WRAP void clear ()
 Clears the algorithm state.
virtual void write (FileStorage &fs) const
 Stores algorithm parameters in a file storage.
virtual void read (const FileNode &fn)
 Reads algorithm parameters from a file storage.
virtual bool empty () const
 Returns true if the Algorithm is empty (e.g.
virtual CV_WRAP void save (const String &filename) const
 Saves the algorithm to a file.
virtual CV_WRAP String getDefaultName () const
 Returns the algorithm string identifier.

Static Public Member Functions

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

Detailed Description

Base class for Super Resolution algorithms.

The class is only used to define the common interface for the whole family of Super Resolution algorithms.

Definition at line 87 of file superres.hpp.

Member Function Documentation

virtual CV_WRAP void clear (  ) [virtual, inherited]

Clears the algorithm state.

Reimplemented in DescriptorMatcher, and FlannBasedMatcher.

Definition at line 3030 of file core.hpp.

virtual void collectGarbage (  ) [virtual]

Clear all inner buffers.

virtual bool empty (  ) const [virtual, inherited]

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

in the very beginning or after unsuccessful read

Reimplemented in Feature2D, DescriptorMatcher, and StatModel.

Definition at line 3042 of file core.hpp.

virtual double getAlpha (  ) const [pure virtual]

Parameter of spacial distribution in Bilateral-TV.

See also:
setAlpha
virtual int getBlurKernelSize (  ) const [pure virtual]

Gaussian blur kernel size.

See also:
setBlurKernelSize
virtual double getBlurSigma (  ) const [pure virtual]

Gaussian blur sigma.

See also:
setBlurSigma
virtual CV_WRAP String getDefaultName (  ) const [virtual, inherited]

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.

virtual int getIterations (  ) const [pure virtual]

Iterations count.

See also:
setIterations
virtual int getKernelSize (  ) const [pure virtual]

Kernel size of Bilateral-TV filter.

See also:
setKernelSize
virtual double getLabmda (  ) const [pure virtual]

Weight parameter to balance data term and smoothness term.

See also:
setLabmda
virtual Ptr<cv::superres::DenseOpticalFlowExt> getOpticalFlow (  ) const [pure virtual]

Dense optical flow algorithm.

See also:
setOpticalFlow
virtual int getScale (  ) const [pure virtual]

Scale factor.

See also:
setScale
virtual double getTau (  ) const [pure virtual]

Asymptotic value of steepest descent method.

See also:
setTau
virtual int getTemporalAreaRadius (  ) const [pure virtual]

Radius of the temporal search area.

See also:
setTemporalAreaRadius
static Ptr<_Tp> load ( const String &  filename,
const String &  objname = String() 
) [static, inherited]

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).

Definition at line 3074 of file core.hpp.

static Ptr<_Tp> loadFromString ( const String &  strModel,
const String &  objname = String() 
) [static, inherited]

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);

Definition at line 3094 of file core.hpp.

void nextFrame ( OutputArray  frame )

Process next frame from input and return output result.

Parameters:
frameOutput result
virtual void read ( const FileNode &  fn ) [virtual, inherited]

Reads algorithm parameters from a file storage.

Reimplemented in Feature2D, DescriptorMatcher, and FlannBasedMatcher.

Definition at line 3038 of file core.hpp.

static Ptr<_Tp> read ( const FileNode &  fn ) [static, inherited]

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)

Reimplemented in Feature2D, DescriptorMatcher, and FlannBasedMatcher.

Definition at line 3055 of file core.hpp.

virtual CV_WRAP void save ( const String &  filename ) const [virtual, inherited]

Saves the algorithm to a file.

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

virtual void setAlpha ( double  val ) [pure virtual]

Parameter of spacial distribution in Bilateral-TV.

See also:
getAlpha
virtual void setBlurKernelSize ( int  val ) [pure virtual]

Gaussian blur kernel size.

See also:
getBlurKernelSize
virtual void setBlurSigma ( double  val ) [pure virtual]

Gaussian blur sigma.

See also:
getBlurSigma
void setInput ( const Ptr< FrameSource > &  frameSource )

Set input frame source for Super Resolution algorithm.

Parameters:
frameSourceInput frame source
virtual void setIterations ( int  val ) [pure virtual]

Iterations count.

See also:
getIterations
virtual void setKernelSize ( int  val ) [pure virtual]

Kernel size of Bilateral-TV filter.

See also:
getKernelSize
virtual void setLabmda ( double  val ) [pure virtual]

Weight parameter to balance data term and smoothness term.

See also:
getLabmda
virtual void setOpticalFlow ( const Ptr< cv::superres::DenseOpticalFlowExt > &  val ) [pure virtual]

Dense optical flow algorithm.

See also:
getOpticalFlow
virtual void setScale ( int  val ) [pure virtual]

Scale factor.

See also:
getScale
virtual void setTau ( double  val ) [pure virtual]

Asymptotic value of steepest descent method.

See also:
getTau
virtual void setTemporalAreaRadius ( int  val ) [pure virtual]

Radius of the temporal search area.

See also:
getTemporalAreaRadius
virtual void write ( FileStorage &  fs ) const [virtual, inherited]

Stores algorithm parameters in a file storage.

Reimplemented in Feature2D, DescriptorMatcher, and FlannBasedMatcher.

Definition at line 3034 of file core.hpp.

Generated on Tue Jul 12 2022 18:20:24 by  doxygen 1.7.2