OpenCV  3.2.0-dev
Open Source Computer Vision
Modules | Namespaces | Classes | Macros | Typedefs | Enumerations | Functions
Utility and system functions and macros
Core functionality
Collaboration diagram for Utility and system functions and macros:

Modules

 SSE utilities
 
 NEON utilities
 

Namespaces

 cv::Error
 

Classes

class  cv::Allocator< _Tp >
 The STL-compilant memory Allocator based on cv::fastMalloc() and cv::fastFree() More...
 
class  cv::AutoBuffer< _Tp, fixed_size >
 Automatically Allocated Buffer Class. More...
 
class  cv::AutoLock
 
class  cv::CommandLineParser
 Designed for command line parsing. More...
 
union  Cv16suf
 
union  Cv32suf
 
union  Cv64suf
 
class  cv::Exception
 Class passed to an error. More...
 
struct  cv::Hamming
 
class  cv::Mutex
 
class  cv::ParallelLoopBody
 Base class for parallel data processors. More...
 
class  cv::TickMeter
 a Class to measure passing time. More...
 
class  cv::TLSData< T >
 
class  cv::TLSDataContainer
 

Macros

#define CV_2PI   6.283185307179586476925286766559
 
#define CV_Assert(expr)   if(!!(expr)) ; else cv::error( cv::Error::StsAssert, #expr, CV_Func, __FILE__, __LINE__ )
 Checks a condition at runtime and throws exception if it fails. More...
 
#define CV_AVX   0
 
#define CV_AVX2   0
 
#define CV_AVX_512BW   0
 
#define CV_AVX_512CD   0
 
#define CV_AVX_512DQ   0
 
#define CV_AVX_512ER   0
 
#define CV_AVX_512F   0
 
#define CV_AVX_512IFMA512   0
 
#define CV_AVX_512PF   0
 
#define CV_AVX_512VBMI   0
 
#define CV_AVX_512VL   0
 
#define CV_CPU_AVX   10
 
#define CV_CPU_AVX2   11
 
#define CV_CPU_AVX_512BW   14
 
#define CV_CPU_AVX_512CD   15
 
#define CV_CPU_AVX_512DQ   16
 
#define CV_CPU_AVX_512ER   17
 
#define CV_CPU_AVX_512F   13
 
#define CV_CPU_AVX_512IFMA512   18
 
#define CV_CPU_AVX_512PF   19
 
#define CV_CPU_AVX_512VBMI   20
 
#define CV_CPU_AVX_512VL   21
 
#define CV_CPU_FMA3   12
 
#define CV_CPU_FP16   9
 
#define CV_CPU_MMX   1
 
#define CV_CPU_NEON   100
 
#define CV_CPU_NONE   0
 
#define CV_CPU_POPCNT   8
 
#define CV_CPU_SSE   2
 
#define CV_CPU_SSE2   3
 
#define CV_CPU_SSE3   4
 
#define CV_CPU_SSE4_1   6
 
#define CV_CPU_SSE4_2   7
 
#define CV_CPU_SSSE3   5
 
#define CV_DbgAssert(expr)
 replaced with CV_Assert(expr) in Debug configuration More...
 
#define CV_DECL_ALIGNED(x)
 
#define CV_ELEM_SIZE(type)   (CV_MAT_CN(type) << ((((sizeof(size_t)/4+1)*16384|0x3a50) >> CV_MAT_DEPTH(type)*2) & 3))
 0x3a50 = 11 10 10 01 01 00 00 ~ array of log2(sizeof(arr_type_elem)) More...
 
#define CV_ELEM_SIZE1(type)   ((((sizeof(size_t)<<28)|0x8442211) >> CV_MAT_DEPTH(type)*4) & 15)
 Size of each channel item, 0x124489 = 1000 0100 0100 0010 0010 0001 0001 ~ array of sizeof(arr_type_elem) More...
 
#define CV_ENABLE_UNROLLED   1
 
#define CV_Error(code, msg)   cv::error( code, msg, CV_Func, __FILE__, __LINE__ )
 Call the error handler. More...
 
#define CV_Error_(code, args)   cv::error( code, cv::format args, CV_Func, __FILE__, __LINE__ )
 Call the error handler. More...
 
#define CV_ErrorNoReturn(code, msg)   cv::errorNoReturn( code, msg, CV_Func, __FILE__, __LINE__ )
 same as CV_Error(code,msg), but does not return More...
 
#define CV_ErrorNoReturn_(code, args)   cv::errorNoReturn( code, cv::format args, CV_Func, __FILE__, __LINE__ )
 same as CV_Error_(code,args), but does not return More...
 
#define CV_EXPORTS
 
#define CV_EXPORTS_AS(synonym)   CV_EXPORTS
 
#define CV_EXPORTS_W   CV_EXPORTS
 
#define CV_EXPORTS_W_MAP   CV_EXPORTS
 
#define CV_EXPORTS_W_SIMPLE   CV_EXPORTS
 
#define CV_EXTERN_C   extern "C"
 
#define CV_FMA3   0
 
#define CV_FP16_TYPE   0
 
#define CV_Func   ""
 
#define CV_HARDWARE_MAX_FEATURE   255
 
#define CV_IN_OUT
 
#define CV_IS_CONT_MAT   CV_IS_MAT_CONT
 
#define CV_IS_MAT_CONT(flags)   ((flags) & CV_MAT_CONT_FLAG)
 
#define CV_IS_SUBMAT(flags)   ((flags) & CV_MAT_SUBMAT_FLAG)
 
#define CV_LOG2   0.69314718055994530941723212145818
 
#define CV_MAT_CN(flags)   ((((flags) & CV_MAT_CN_MASK) >> CV_CN_SHIFT) + 1)
 
#define CV_MAT_CN_MASK   ((CV_CN_MAX - 1) << CV_CN_SHIFT)
 
#define CV_MAT_CONT_FLAG   (1 << CV_MAT_CONT_FLAG_SHIFT)
 
#define CV_MAT_CONT_FLAG_SHIFT   14
 
#define CV_MAT_TYPE(flags)   ((flags) & CV_MAT_TYPE_MASK)
 
#define CV_MAT_TYPE_MASK   (CV_DEPTH_MAX*CV_CN_MAX - 1)
 
#define CV_MMX   0
 
#define CV_OUT
 
#define CV_PI   3.1415926535897932384626433832795
 
#define CV_POPCNT   0
 
#define CV_PROP
 
#define CV_PROP_RW
 
#define CV_SSE   0
 
#define CV_SSE3   0
 
#define CV_SSE4_1   0
 
#define CV_SSE4_2   0
 
#define CV_SSSE3   0
 
#define CV_SUBMAT_FLAG   (1 << CV_SUBMAT_FLAG_SHIFT)
 
#define CV_SUBMAT_FLAG_SHIFT   15
 
#define CV_VFP   0
 
#define CV_WRAP
 
#define CV_WRAP_AS(synonym)
 
#define MAX(a, b)   ((a) < (b) ? (b) : (a))
 
#define MIN(a, b)   ((a) > (b) ? (b) : (a))
 
#define OPENCV_ABI_COMPATIBILITY   300
 

Typedefs

typedef int(* cv::ErrorCallback) (int status, const char *func_name, const char *err_msg, const char *file_name, int line, void *userdata)
 
typedef Hamming cv::HammingLUT
 

Enumerations

enum  CpuFeatures {
  CPU_MMX = 1,
  CPU_SSE = 2,
  CPU_SSE2 = 3,
  CPU_SSE3 = 4,
  CPU_SSSE3 = 5,
  CPU_SSE4_1 = 6,
  CPU_SSE4_2 = 7,
  CPU_POPCNT = 8,
  CPU_FP16 = 9,
  CPU_AVX = 10,
  CPU_AVX2 = 11,
  CPU_FMA3 = 12,
  CPU_AVX_512F = 13,
  CPU_AVX_512BW = 14,
  CPU_AVX_512CD = 15,
  CPU_AVX_512DQ = 16,
  CPU_AVX_512ER = 17,
  CPU_AVX_512IFMA512 = 18,
  CPU_AVX_512PF = 19,
  CPU_AVX_512VBMI = 20,
  CPU_AVX_512VL = 21,
  CPU_NEON = 100
}
 Available CPU features. More...
 
enum  cv::SortFlags {
  cv::SORT_EVERY_ROW = 0,
  cv::SORT_EVERY_COLUMN = 1,
  cv::SORT_ASCENDING = 0,
  cv::SORT_DESCENDING = 16
}
 

Functions

template<typename _Tp >
static _Tp * cv::alignPtr (_Tp *ptr, int n=(int) sizeof(_Tp))
 Aligns a pointer to the specified number of bytes. More...
 
static size_t cv::alignSize (size_t sz, int n)
 Aligns a buffer size to the specified number of bytes. More...
 
bool cv::checkHardwareSupport (int feature)
 Returns true if the specified feature is supported by the host hardware. More...
 
bool cv::Cholesky (float *A, size_t astep, int m, float *b, size_t bstep, int n)
 proxy for hal::Cholesky More...
 
bool cv::Cholesky (double *A, size_t astep, int m, double *b, size_t bstep, int n)
 proxy for hal::Cholesky More...
 
float cv::cubeRoot (float val)
 Computes the cube root of an argument. More...
 
template<typename _Tp >
_Tp cv::cv_abs (_Tp x)
 
int cv::cv_abs (uchar x)
 
int cv::cv_abs (schar x)
 
int cv::cv_abs (ushort x)
 
int cv::cv_abs (short x)
 
 CV_XADD (int *addr, int delta)
 
int cvCeil (double value)
 Rounds floating-point number to the nearest integer not smaller than the original. More...
 
int cvCeil (float value)
 
int cvCeil (int value)
 
int cvFloor (double value)
 Rounds floating-point number to the nearest integer not larger than the original. More...
 
int cvFloor (float value)
 
int cvFloor (int value)
 
int cvIsInf (double value)
 Determines if the argument is Infinity. More...
 
int cvIsInf (float value)
 
int cvIsNaN (double value)
 Determines if the argument is Not A Number. More...
 
int cvIsNaN (float value)
 
int cvRound (double value)
 Rounds floating-point number to the nearest integer. More...
 
int cvRound (float value)
 
int cvRound (int value)
 
void cv::error (const Exception &exc)
 Signals an error and raises the exception. More...
 
void cv::error (int _code, const String &_err, const char *_func, const char *_file, int _line)
 Signals an error and raises the exception. More...
 
void cv::errorNoReturn (int _code, const String &_err, const char *_func, const char *_file, int _line)
 same as cv::error, but does not return More...
 
float cv::fastAtan2 (float y, float x)
 Calculates the angle of a 2D vector in degrees. More...
 
void cv::fastFree (void *ptr)
 Deallocates a memory buffer. More...
 
void * cv::fastMalloc (size_t bufSize)
 Allocates an aligned memory buffer. More...
 
template<typename _Tp , typename Functor >
void cv::Mat::forEach_impl (const Functor &operation)
 
String cv::format (const char *fmt,...)
 Returns a text string formatted using the printf-like expression. More...
 
const String & cv::getBuildInformation ()
 Returns full configuration time cmake output. More...
 
int64 cv::getCPUTickCount ()
 Returns the number of CPU ticks. More...
 
static size_t cv::getElemSize (int type)
 
int cv::getNumberOfCPUs ()
 Returns the number of logical CPUs available for the process. More...
 
int cv::getNumThreads ()
 Returns the number of threads used by OpenCV for parallel regions. More...
 
int cv::getThreadNum ()
 Returns the index of the currently executed thread within the current parallel region. More...
 
int64 cv::getTickCount ()
 Returns the number of ticks. More...
 
double cv::getTickFrequency ()
 Returns the number of ticks per second. More...
 
void cv::glob (String pattern, std::vector< String > &result, bool recursive=false)
 
int cv::LU (float *A, size_t astep, int m, float *b, size_t bstep, int n)
 proxy for hal::LU More...
 
int cv::LU (double *A, size_t astep, int m, double *b, size_t bstep, int n)
 proxy for hal::LU More...
 
template<typename _Tp , typename _AccTp >
static _AccTp cv::normInf (const _Tp *a, int n)
 
template<typename _Tp , typename _AccTp >
static _AccTp cv::normInf (const _Tp *a, const _Tp *b, int n)
 
template<typename _Tp , typename _AccTp >
static _AccTp cv::normL1 (const _Tp *a, int n)
 
template<typename _Tp , typename _AccTp >
static _AccTp cv::normL1 (const _Tp *a, const _Tp *b, int n)
 
float cv::normL1 (const float *a, const float *b, int n)
 
int cv::normL1 (const uchar *a, const uchar *b, int n)
 
template<typename _Tp , typename _AccTp >
static _AccTp cv::normL2Sqr (const _Tp *a, int n)
 
template<typename _Tp , typename _AccTp >
static _AccTp cv::normL2Sqr (const _Tp *a, const _Tp *b, int n)
 
static float cv::normL2Sqr (const float *a, const float *b, int n)
 
static std::ostream & cv::operator<< (std::ostream &out, const TickMeter &tm)
 output operator More...
 
void cv::parallel_for_ (const Range &range, const ParallelLoopBody &body, double nstripes=-1.)
 Parallel data processor. More...
 
ErrorCallback cv::redirectError (ErrorCallback errCallback, void *userdata=0, void **prevUserdata=0)
 Sets the new error handler and the optional user data. More...
 
template<typename _Tp >
static _Tp cv::saturate_cast (uchar v)
 Template function for accurate conversion from one primitive type to another. More...
 
template<typename _Tp >
static _Tp cv::saturate_cast (schar v)
 
template<typename _Tp >
static _Tp cv::saturate_cast (ushort v)
 
template<typename _Tp >
static _Tp cv::saturate_cast (short v)
 
template<typename _Tp >
static _Tp cv::saturate_cast (unsigned v)
 
template<typename _Tp >
static _Tp cv::saturate_cast (int v)
 
template<typename _Tp >
static _Tp cv::saturate_cast (float v)
 
template<typename _Tp >
static _Tp cv::saturate_cast (double v)
 
template<typename _Tp >
static _Tp cv::saturate_cast (int64 v)
 
template<typename _Tp >
static _Tp cv::saturate_cast (uint64 v)
 
template<>
schar cv::saturate_cast< schar > (uchar v)
 
template<>
schar cv::saturate_cast< schar > (ushort v)
 
template<>
schar cv::saturate_cast< schar > (int v)
 
template<>
schar cv::saturate_cast< schar > (short v)
 
template<>
schar cv::saturate_cast< schar > (unsigned v)
 
template<>
schar cv::saturate_cast< schar > (float v)
 
template<>
schar cv::saturate_cast< schar > (double v)
 
template<>
schar cv::saturate_cast< schar > (int64 v)
 
template<>
schar cv::saturate_cast< schar > (uint64 v)
 
template<>
short cv::saturate_cast< short > (ushort v)
 
template<>
short cv::saturate_cast< short > (int v)
 
template<>
short cv::saturate_cast< short > (unsigned v)
 
template<>
short cv::saturate_cast< short > (float v)
 
template<>
short cv::saturate_cast< short > (double v)
 
template<>
short cv::saturate_cast< short > (int64 v)
 
template<>
short cv::saturate_cast< short > (uint64 v)
 
template<>
uchar cv::saturate_cast< uchar > (schar v)
 
template<>
uchar cv::saturate_cast< uchar > (ushort v)
 
template<>
uchar cv::saturate_cast< uchar > (int v)
 
template<>
uchar cv::saturate_cast< uchar > (short v)
 
template<>
uchar cv::saturate_cast< uchar > (unsigned v)
 
template<>
uchar cv::saturate_cast< uchar > (float v)
 
template<>
uchar cv::saturate_cast< uchar > (double v)
 
template<>
uchar cv::saturate_cast< uchar > (int64 v)
 
template<>
uchar cv::saturate_cast< uchar > (uint64 v)
 
template<>
unsigned cv::saturate_cast< unsigned > (float v)
 
template<>
unsigned cv::saturate_cast< unsigned > (double v)
 
template<>
ushort cv::saturate_cast< ushort > (schar v)
 
template<>
ushort cv::saturate_cast< ushort > (short v)
 
template<>
ushort cv::saturate_cast< ushort > (int v)
 
template<>
ushort cv::saturate_cast< ushort > (unsigned v)
 
template<>
ushort cv::saturate_cast< ushort > (float v)
 
template<>
ushort cv::saturate_cast< ushort > (double v)
 
template<>
ushort cv::saturate_cast< ushort > (int64 v)
 
template<>
ushort cv::saturate_cast< ushort > (uint64 v)
 
bool cv::setBreakOnError (bool flag)
 Sets/resets the break-on-error mode. More...
 
void cv::setNumThreads (int nthreads)
 OpenCV will try to set the number of threads for the next parallel region. More...
 
void cv::setUseOptimized (bool onoff)
 Enables or disables the optimized code. More...
 
String cv::tempfile (const char *suffix=0)
 
bool cv::useOptimized ()
 Returns the status of optimized code usage. More...
 

Detailed Description

Macro Definition Documentation

#define CV_2PI   6.283185307179586476925286766559

#include <core/include/opencv2/core/cvdef.h>

#define CV_Assert (   expr)    if(!!(expr)) ; else cv::error( cv::Error::StsAssert, #expr, CV_Func, __FILE__, __LINE__ )

#include <core/include/opencv2/core/base.hpp>

Checks a condition at runtime and throws exception if it fails.

The macros CV_Assert (and CV_DbgAssert(expr)) evaluate the specified expression. If it is 0, the macros raise an error (see cv::error). The macro CV_Assert checks the condition in both Debug and Release configurations while CV_DbgAssert is only retained in the Debug configuration.

Examples:
grabcut.cpp.

Referenced by cv::Node< OBJECT >::addChild(), cv::cudev::affineMap(), cv::hpp::copyHppToMat(), cv::cv2eigen(), cv::videostab::RansacParams::default2dMotion(), cv::Mat::forEach_impl(), cv::hpp::getHpp(), cv::flann::GenericIndex< Distance >::getIndexParameters(), cv::cudev::gridCalcSum_(), cv::cudev::gridCopy_(), cv::cudev::gridCountNonZero_(), cv::cudev::gridFindMaxVal_(), cv::cudev::gridFindMinMaxVal_(), cv::cudev::gridFindMinVal_(), cv::cudev::gridHistogram_(), cv::cudev::gridMerge_(), cv::cudev::gridMinMaxLoc_(), cv::cudev::gridReduceToColumn_(), cv::cudev::gridReduceToRow(), cv::cudev::gridSplit_(), cv::cudev::gridTransformBinary_(), cv::cudev::gridTransformTuple_(), cv::cudev::gridTransformUnary_(), cv::cudev::gridTranspose_(), cv::flann::hierarchicalClustering(), cv::flann::Index_< T >::Index_(), cv::flann::Index_< T >::knnSearch(), cv::makeAgastOffsets(), partition(), cv::cudev::perspectiveMap(), cv::flann::Index_< T >::radiusSearch(), cv::cudev::remapPtr(), cv::videostab::FastMarchingMethod::run(), cv::Seq< _Tp >::Seq(), cv::Stitcher::setMatchingMask(), cv::detail::BundleAdjusterBase::setRefinementMask(), cv::cudev::Texture< T >::Texture(), cv::hpp::toCvType(), cv::hpp::toHppType(), cv::cudev::transformPtr(), and cv::cudev::zipPtr().

#define CV_AVX   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_AVX2   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_AVX_512BW   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_AVX_512CD   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_AVX_512DQ   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_AVX_512ER   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_AVX_512F   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_AVX_512IFMA512   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_AVX_512PF   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_AVX_512VBMI   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_AVX_512VL   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_AVX   10

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_AVX2   11

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_AVX_512BW   14

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_AVX_512CD   15

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_AVX_512DQ   16

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_AVX_512ER   17

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_AVX_512F   13

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_AVX_512IFMA512   18

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_AVX_512PF   19

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_AVX_512VBMI   20

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_AVX_512VL   21

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_FMA3   12

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_FP16   9

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_MMX   1

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_NEON   100

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_NONE   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_POPCNT   8

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_SSE   2

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_SSE2   3

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_SSE3   4

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_SSE4_1   6

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_SSE4_2   7

#include <core/include/opencv2/core/cvdef.h>

#define CV_CPU_SSSE3   5

#include <core/include/opencv2/core/cvdef.h>

#define CV_DbgAssert (   expr)

#include <core/include/opencv2/core/base.hpp>

replaced with CV_Assert(expr) in Debug configuration

Referenced by cv::alignSize(), cv::cv2eigen(), and CvMat::CvMat().

#define CV_DECL_ALIGNED (   x)

#include <core/include/opencv2/core/cvdef.h>

#define CV_ELEM_SIZE (   type)    (CV_MAT_CN(type) << ((((sizeof(size_t)/4+1)*16384|0x3a50) >> CV_MAT_DEPTH(type)*2) & 3))

#include <core/include/opencv2/core/cvdef.h>

0x3a50 = 11 10 10 01 01 00 00 ~ array of log2(sizeof(arr_type_elem))

Referenced by cvMat(), and cv::getElemSize().

#define CV_ELEM_SIZE1 (   type)    ((((sizeof(size_t)<<28)|0x8442211) >> CV_MAT_DEPTH(type)*4) & 15)

#include <core/include/opencv2/core/cvdef.h>

Size of each channel item, 0x124489 = 1000 0100 0100 0010 0010 0001 0001 ~ array of sizeof(arr_type_elem)

Referenced by cvIplDepth().

#define CV_ENABLE_UNROLLED   1

#include <core/include/opencv2/core/cvdef.h>

#define CV_Error (   code,
  msg 
)    cv::error( code, msg, CV_Func, __FILE__, __LINE__ )

#include <core/include/opencv2/core/base.hpp>

Call the error handler.

Currently, the error handler prints the error code and the error message to the standard error stream stderr. In the Debug configuration, it then provokes memory access violation, so that the execution stack and all the parameters can be analyzed by the debugger. In the Release configuration, the exception is thrown.

Parameters
codeone of Error::Code
msgerror message
Examples:
grabcut.cpp, and pca.cpp.

Referenced by cv::AgastFeatureDetector_Impl::get(), cvflann::lsh::LshTable< ElementType >::getKey(), cv::FileStorage::operator<<(), and cv::AgastFeatureDetector_Impl::set().

#define CV_Error_ (   code,
  args 
)    cv::error( code, cv::format args, CV_Func, __FILE__, __LINE__ )

#include <core/include/opencv2/core/base.hpp>

Call the error handler.

This macro can be used to construct an error message on-fly to include some dynamic information, for example:

1 // note the extra parentheses around the formatted text message
2 CV_Error_( CV_StsOutOfRange,
3 ("the value at (%d, %d)=%g is out of range", badPt.x, badPt.y, badValue));
Parameters
codeone of Error::Code
argsprintf-like formatted error message in parentheses
#define CV_ErrorNoReturn (   code,
  msg 
)    cv::errorNoReturn( code, msg, CV_Func, __FILE__, __LINE__ )

#include <core/include/opencv2/core/base.hpp>

same as CV_Error(code,msg), but does not return

#define CV_ErrorNoReturn_ (   code,
  args 
)    cv::errorNoReturn( code, cv::format args, CV_Func, __FILE__, __LINE__ )

#include <core/include/opencv2/core/base.hpp>

same as CV_Error_(code,args), but does not return

#define CV_EXPORTS

#include <core/include/opencv2/core/cvdef.h>

Referenced by cv::abs(), cv::videostab::ColorInpainter::ColorInpainter(), cv::cvarrToMatND(), NCVMatrixReuse< T >::isMemReused(), cv::viz::isNan(), cv::morphologyDefaultBorderValue(), cv::normInf(), cv::detail::Graph::numVertices(), cv::FileNodeIterator::operator<(), cv::operator<<(), cv::videostab::KeypointBasedMotionEstimator::outlierRejector(), cv::FileNode::read(), cv::cuda::scaleAdd(), cv::instr::setFlags(), cv::detail::MultiBandBlender::setNumBands(), cv::videostab::LpMotionStabilizer::weight4(), cv::hal::DCT2D::~DCT2D(), cv::hal::Morph::~Morph(), cv::cudacodec::RawVideoSource::~RawVideoSource(), and cv::cudacodec::VideoWriter::~VideoWriter().

#define CV_EXPORTS_AS (   synonym)    CV_EXPORTS

#include <core/include/opencv2/core/cvdef.h>

Referenced by cv::morphologyDefaultBorderValue().

#define CV_EXPORTS_W   CV_EXPORTS

#include <core/include/opencv2/core/cvdef.h>

Referenced by cv::alignSize(), cv::morphologyDefaultBorderValue(), cv::normInf(), cv::operator<<(), cv::Stitcher::workScale(), and cv::LineSegmentDetector::~LineSegmentDetector().

#define CV_EXPORTS_W_MAP   CV_EXPORTS

#include <core/include/opencv2/core/cvdef.h>

#define CV_EXPORTS_W_SIMPLE   CV_EXPORTS

#include <core/include/opencv2/core/cvdef.h>

#define CV_EXTERN_C   extern "C"

#include <core/include/opencv2/core/cvdef.h>

#define CV_FMA3   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_FP16_TYPE   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_Func   ""

#include <core/include/opencv2/core/base.hpp>

#define CV_HARDWARE_MAX_FEATURE   255

#include <core/include/opencv2/core/cvdef.h>

#define CV_IN_OUT

#include <core/include/opencv2/core/cvdef.h>

#define CV_IS_CONT_MAT   CV_IS_MAT_CONT

#include <core/include/opencv2/core/cvdef.h>

#define CV_IS_MAT_CONT (   flags)    ((flags) & CV_MAT_CONT_FLAG)

#include <core/include/opencv2/core/cvdef.h>

#define CV_IS_SUBMAT (   flags)    ((flags) & CV_MAT_SUBMAT_FLAG)

#include <core/include/opencv2/core/cvdef.h>

#define CV_LOG2   0.69314718055994530941723212145818

#include <core/include/opencv2/core/cvdef.h>

#define CV_MAT_CN (   flags)    ((((flags) & CV_MAT_CN_MASK) >> CV_CN_SHIFT) + 1)

#include <core/include/opencv2/core/cvdef.h>

Referenced by cv::Seq< _Tp >::channels().

#define CV_MAT_CN_MASK   ((CV_CN_MAX - 1) << CV_CN_SHIFT)

#include <core/include/opencv2/core/cvdef.h>

#define CV_MAT_CONT_FLAG   (1 << CV_MAT_CONT_FLAG_SHIFT)

#include <core/include/opencv2/core/cvdef.h>

Referenced by cvMat().

#define CV_MAT_CONT_FLAG_SHIFT   14

#include <core/include/opencv2/core/cvdef.h>

#define CV_MAT_TYPE (   flags)    ((flags) & CV_MAT_TYPE_MASK)

#include <core/include/opencv2/core/cvdef.h>

Referenced by cvMat(), cvmGet(), cvmSet(), and cv::Seq< _Tp >::type().

#define CV_MAT_TYPE_MASK   (CV_DEPTH_MAX*CV_CN_MAX - 1)

#include <core/include/opencv2/core/cvdef.h>

#define CV_MMX   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_OUT

#include <core/include/opencv2/core/cvdef.h>

Referenced by cv::morphologyDefaultBorderValue(), and cv::HOGDescriptor::~HOGDescriptor().

#define CV_PI   3.1415926535897932384626433832795

#include <core/include/opencv2/core/cvdef.h>

Examples:
contours2.cpp, cout_mat.cpp, filestorage.cpp, and houghlines.cpp.

Referenced by cv::morphologyDefaultBorderValue(), and cv::LineSegmentDetector::~LineSegmentDetector().

#define CV_POPCNT   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_PROP

#include <core/include/opencv2/core/cvdef.h>

#define CV_PROP_RW

#include <core/include/opencv2/core/cvdef.h>

#define CV_SSE   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_SSE3   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_SSE4_1   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_SSE4_2   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_SSSE3   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_SUBMAT_FLAG   (1 << CV_SUBMAT_FLAG_SHIFT)

#include <core/include/opencv2/core/cvdef.h>

#define CV_SUBMAT_FLAG_SHIFT   15

#include <core/include/opencv2/core/cvdef.h>

#define CV_VFP   0

#include <core/include/opencv2/core/cvdef.h>

#define CV_WRAP

#include <core/include/opencv2/core/cvdef.h>

Referenced by cv::BOWImgDescriptorExtractor::compute2(), cv::BFMatcher::isMaskSupported(), cv::Algorithm::loadFromString(), cv::ml::TrainData::missingValue(), cv::FileStorage::operator*(), cv::DescriptorMatcher::read(), cv::Stitcher::setBlender(), and cv::HOGDescriptor::~HOGDescriptor().

#define CV_WRAP_AS (   synonym)

#include <core/include/opencv2/core/cvdef.h>

#define MAX (   a,
  b 
)    ((a) < (b) ? (b) : (a))

#include <core/include/opencv2/core/cvdef.h>

Examples:
fitellipse.cpp.
#define MIN (   a,
  b 
)    ((a) > (b) ? (b) : (a))

#include <core/include/opencv2/core/cvdef.h>

Examples:
fitellipse.cpp, and kmeans.cpp.
#define OPENCV_ABI_COMPATIBILITY   300

#include <core/include/opencv2/core/cvdef.h>

Typedef Documentation

typedef int(* cv::ErrorCallback) (int status, const char *func_name, const char *err_msg, const char *file_name, int line, void *userdata)

#include <core/include/opencv2/core/utility.hpp>

typedef Hamming cv::HammingLUT

#include <core/include/opencv2/core/base.hpp>

Enumeration Type Documentation

enum CpuFeatures

#include <core/include/opencv2/core/cvdef.h>

Available CPU features.

Enumerator
CPU_MMX 
CPU_SSE 
CPU_SSE2 
CPU_SSE3 
CPU_SSSE3 
CPU_SSE4_1 
CPU_SSE4_2 
CPU_POPCNT 
CPU_FP16 
CPU_AVX 
CPU_AVX2 
CPU_FMA3 
CPU_AVX_512F 
CPU_AVX_512BW 
CPU_AVX_512CD 
CPU_AVX_512DQ 
CPU_AVX_512ER 
CPU_AVX_512IFMA512 
CPU_AVX_512PF 
CPU_AVX_512VBMI 
CPU_AVX_512VL 
CPU_NEON 
enum cv::SortFlags

#include <core/include/opencv2/core.hpp>

Enumerator
SORT_EVERY_ROW 

each matrix row is sorted independently

SORT_EVERY_COLUMN 

each matrix column is sorted independently; this flag and the previous one are mutually exclusive.

SORT_ASCENDING 

each matrix row is sorted in the ascending order.

SORT_DESCENDING 

each matrix row is sorted in the descending order; this flag and the previous one are also mutually exclusive.

Function Documentation

template<typename _Tp >
static _Tp* cv::alignPtr ( _Tp *  ptr,
int  n = (int)sizeof(_Tp) 
)
inlinestatic

#include <core/include/opencv2/core/utility.hpp>

Aligns a pointer to the specified number of bytes.

The function returns the aligned pointer of the same type as the input pointer:

\[\texttt{(_Tp*)(((size_t)ptr + n-1) & -n)}\]

Parameters
ptrAligned pointer.
nAlignment size that must be a power of two.
static size_t cv::alignSize ( size_t  sz,
int  n 
)
inlinestatic

#include <core/include/opencv2/core/utility.hpp>

Aligns a buffer size to the specified number of bytes.

The function returns the minimum number that is greater or equal to sz and is divisible by n :

\[\texttt{(sz + n-1) & -n}\]

Parameters
szBuffer size to align.
nAlignment size that must be a power of two.

References CV_DbgAssert, CV_EXPORTS_W, cv::setUseOptimized(), and cv::useOptimized().

Here is the call graph for this function:

bool cv::checkHardwareSupport ( int  feature)

#include <core/include/opencv2/core/utility.hpp>

Returns true if the specified feature is supported by the host hardware.

The function returns true if the host hardware supports the specified feature. When user calls setUseOptimized(false), the subsequent calls to checkHardwareSupport() will return false until setUseOptimized(true) is called. This way user can dynamically switch on and off the optimized code in OpenCV.

Parameters
featureThe feature of interest, one of cv::CpuFeatures

Referenced by cv::operator<<().

Here is the caller graph for this function:

bool cv::Cholesky ( float *  A,
size_t  astep,
int  m,
float *  b,
size_t  bstep,
int  n 
)

#include <core/include/opencv2/core/base.hpp>

proxy for hal::Cholesky

Referenced by cv::normInf(), and cv::hal::DCT2D::~DCT2D().

Here is the caller graph for this function:

bool cv::Cholesky ( double *  A,
size_t  astep,
int  m,
double *  b,
size_t  bstep,
int  n 
)

#include <core/include/opencv2/core/base.hpp>

proxy for hal::Cholesky

float cv::cubeRoot ( float  val)

#include <core/include/opencv2/core/base.hpp>

Computes the cube root of an argument.

The function cubeRoot computes \(\sqrt[3]{\texttt{val}}\). Negative arguments are handled correctly. NaN and Inf are not handled. The accuracy approaches the maximum possible accuracy for single-precision data.

Parameters
valA function argument.

Referenced by cv::normInf().

Here is the caller graph for this function:

template<typename _Tp >
_Tp cv::cv_abs ( _Tp  x)
inline

#include <core/include/opencv2/core/base.hpp>

References cv::cuda::abs().

Referenced by cv::normInf(), and cv::normL1().

Here is the call graph for this function:

Here is the caller graph for this function:

int cv::cv_abs ( uchar  x)
inline

#include <core/include/opencv2/core/base.hpp>

int cv::cv_abs ( schar  x)
inline

#include <core/include/opencv2/core/base.hpp>

References cv::cuda::abs().

Here is the call graph for this function:

int cv::cv_abs ( ushort  x)
inline

#include <core/include/opencv2/core/base.hpp>

int cv::cv_abs ( short  x)
inline

#include <core/include/opencv2/core/base.hpp>

References cv::cuda::abs().

Here is the call graph for this function:

CV_XADD ( int *  addr,
int  delta 
)

#include <core/include/opencv2/core/cvdef.h>

int cvCeil ( double  value)

#include <core/include/opencv2/core/fast_math.hpp>

Rounds floating-point number to the nearest integer not smaller than the original.

The function computes an integer i such that:

\[i \le \texttt{value} < i+1\]

Parameters
valuefloating-point number. If the value is outside of INT_MIN ... INT_MAX range, the result is not defined.

References cvRound().

Referenced by cv::v_ceil(), and cv::v_trunc().

Here is the call graph for this function:

Here is the caller graph for this function:

int cvCeil ( float  value)

#include <core/include/opencv2/core/fast_math.hpp>

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

References cvRound().

Here is the call graph for this function:

int cvCeil ( int  value)

#include <core/include/opencv2/core/fast_math.hpp>

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

int cvFloor ( double  value)

#include <core/include/opencv2/core/fast_math.hpp>

Rounds floating-point number to the nearest integer not larger than the original.

The function computes an integer i such that:

\[i \le \texttt{value} < i+1\]

Parameters
valuefloating-point number. If the value is outside of INT_MIN ... INT_MAX range, the result is not defined.

References cvRound().

Referenced by cv::v_floor().

Here is the call graph for this function:

Here is the caller graph for this function:

int cvFloor ( float  value)

#include <core/include/opencv2/core/fast_math.hpp>

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

References cvRound().

Here is the call graph for this function:

int cvFloor ( int  value)

#include <core/include/opencv2/core/fast_math.hpp>

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

int cvIsInf ( double  value)

#include <core/include/opencv2/core/fast_math.hpp>

Determines if the argument is Infinity.

Parameters
valueThe input floating-point value

The function returns 1 if the argument is a plus or minus infinity (as defined by IEEE754 standard) and 0 otherwise.

References Cv64suf::f, and Cv64suf::u.

int cvIsInf ( float  value)

#include <core/include/opencv2/core/fast_math.hpp>

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

References Cv32suf::f, and Cv32suf::u.

int cvIsNaN ( double  value)

#include <core/include/opencv2/core/fast_math.hpp>

Determines if the argument is Not A Number.

Parameters
valueThe input floating-point value

The function returns 1 if the argument is Not A Number (as defined by IEEE754 standard), 0 otherwise.

References Cv64suf::f, and Cv64suf::u.

int cvIsNaN ( float  value)

#include <core/include/opencv2/core/fast_math.hpp>

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

References Cv32suf::f, and Cv32suf::u.

int cvRound ( double  value)

#include <core/include/opencv2/core/fast_math.hpp>

Rounds floating-point number to the nearest integer.

Parameters
valuefloating-point number. If the value is outside of INT_MIN ... INT_MAX range, the result is not defined.
Examples:
contours2.cpp, demhist.cpp, distrans.cpp, and minarea.cpp.

Referenced by cvCeil(), cvEllipseBox(), cvFloor(), cvPointFrom32f(), cvReadInt(), cv::saturate_cast< schar >(), cv::saturate_cast< short >(), cv::saturate_cast< uchar >(), cv::saturate_cast< unsigned >(), cv::saturate_cast< ushort >(), cv::AgastFeatureDetector_Impl::set(), and cv::v_round().

Here is the caller graph for this function:

int cvRound ( float  value)

#include <core/include/opencv2/core/fast_math.hpp>

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

int cvRound ( int  value)

#include <core/include/opencv2/core/fast_math.hpp>

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

void cv::error ( const Exception &  exc)

#include <core/include/opencv2/core.hpp>

Signals an error and raises the exception.

By default the function prints information about the error to stderr, then it either stops if cv::setBreakOnError() had been called before or raises the exception. It is possible to alternate error processing by using cv::redirectError().

Parameters
excthe exception raisen.
Deprecated:
drop this version
void cv::error ( int  _code,
const String &  _err,
const char *  _func,
const char *  _file,
int  _line 
)

#include <core/include/opencv2/core/base.hpp>

Signals an error and raises the exception.

By default the function prints information about the error to stderr, then it either stops if setBreakOnError() had been called before or raises the exception. It is possible to alternate error processing by using redirectError().

Parameters
_code- error code (Error::Code)
_err- error description
_func- function name. Available only when the compiler supports getting it
_file- source file name where the error has occurred
_line- line number in the source file where the error has occurred
See also
CV_Error, CV_Error_, CV_ErrorNoReturn, CV_ErrorNoReturn_, CV_Assert, CV_DbgAssert

Referenced by cv::cudev::checkCudaError(), and cv::errorNoReturn().

Here is the caller graph for this function:

void cv::errorNoReturn ( int  _code,
const String &  _err,
const char *  _func,
const char *  _file,
int  _line 
)

#include <core/include/opencv2/core/base.hpp>

same as cv::error, but does not return

References cv::error().

Here is the call graph for this function:

float cv::fastAtan2 ( float  y,
float  x 
)

#include <core/include/opencv2/core/base.hpp>

Calculates the angle of a 2D vector in degrees.

The function fastAtan2 calculates the full-range angle of an input 2D vector. The angle is measured in degrees and varies from 0 to 360 degrees. The accuracy is about 0.3 degrees.

Parameters
xx-coordinate of the vector.
yy-coordinate of the vector.

Referenced by cv::normInf(), and cv::hal::DCT2D::~DCT2D().

Here is the caller graph for this function:

void cv::fastFree ( void *  ptr)

#include <core/include/opencv2/core/cvstd.hpp>

Deallocates a memory buffer.

The function deallocates the buffer allocated with fastMalloc . If NULL pointer is passed, the function does nothing. C version of the function clears the pointer pptr to avoid problems with double memory deallocation.

Parameters
ptrPointer to the allocated buffer.

Referenced by cv::abs(), and cv::Allocator< _Tp >::deallocate().

Here is the caller graph for this function:

void* cv::fastMalloc ( size_t  bufSize)

#include <core/include/opencv2/core/cvstd.hpp>

Allocates an aligned memory buffer.

The function allocates the buffer of the specified size and returns it. When the buffer size is 16 bytes or more, the returned buffer is aligned to 16 bytes.

Parameters
bufSizeAllocated buffer size.

Referenced by cv::abs(), and cv::Allocator< _Tp >::allocate().

Here is the caller graph for this function:

template<typename _Tp , typename Functor >
void cv::Mat::forEach_impl ( const Functor &  operation)
inlineprotected

#include <core/include/opencv2/core/mat.hpp>

idx is modified in this->rowCall

References CV_Assert, cv::Range::end, cv::ogl::LINES, cv::parallel_for_(), and cv::Range::start.

Here is the call graph for this function:

String cv::format ( const char *  fmt,
  ... 
)

#include <core/include/opencv2/core/utility.hpp>

Returns a text string formatted using the printf-like expression.

The function acts like sprintf but forms and returns an STL string. It can be used to form an error message in the Exception constructor.

Parameters
fmtprintf-compatible formatting specifiers.
Examples:
cout_mat.cpp.

Referenced by cvflann::lsh::LshTable< ElementType >::getKey(), cv::videostab::ILog::~ILog(), cv::cudacodec::RawVideoSource::~RawVideoSource(), cv::cudacodec::VideoReader::~VideoReader(), and cv::cudacodec::VideoWriter::~VideoWriter().

Here is the caller graph for this function:

const String& cv::getBuildInformation ( )

#include <core/include/opencv2/core/utility.hpp>

Returns full configuration time cmake output.

Returned value is raw cmake output including version control system revision, compiler version, compiler flags, enabled modules and third party libraries, etc. Output format depends on target architecture.

int64 cv::getCPUTickCount ( )

#include <core/include/opencv2/core/utility.hpp>

Returns the number of CPU ticks.

The function returns the current number of CPU ticks on some architectures (such as x86, x64, PowerPC). On other platforms the function is equivalent to getTickCount. It can also be used for very accurate time measurements, as well as for RNG initialization. Note that in case of multi-CPU systems a thread, from which getCPUTickCount is called, can be suspended and resumed at another CPU with its own counter. So, theoretically (and practically) the subsequent calls to the function do not necessary return the monotonously increasing values. Also, since a modern CPU varies the CPU frequency depending on the load, the number of CPU clocks spent in some code cannot be directly converted to time units. Therefore, getTickCount is generally a preferable solution for measuring execution time.

Referenced by cv::operator<<().

Here is the caller graph for this function:

static size_t cv::getElemSize ( int  type)
inlinestatic

#include <core/include/opencv2/core/utility.hpp>

References CV_ELEM_SIZE.

int cv::getNumberOfCPUs ( )

#include <core/include/opencv2/core/utility.hpp>

Returns the number of logical CPUs available for the process.

Referenced by cv::operator<<().

Here is the caller graph for this function:

int cv::getNumThreads ( )

#include <core/include/opencv2/core/utility.hpp>

Returns the number of threads used by OpenCV for parallel regions.

Always returns 1 if OpenCV is built without threading support.

The exact meaning of return value depends on the threading framework used by OpenCV library:

  • TBB – The number of threads, that OpenCV will try to use for parallel regions. If there is any tbb::thread_scheduler_init in user code conflicting with OpenCV, then function returns default number of threads used by TBB library.
  • OpenMP – An upper bound on the number of threads that could be used to form a new team.
  • Concurrency – The number of threads, that OpenCV will try to use for parallel regions.
  • GCD – Unsupported; returns the GCD thread pool limit (512) for compatibility.
  • C= – The number of threads, that OpenCV will try to use for parallel regions, if before called setNumThreads with threads > 0, otherwise returns the number of logical CPUs, available for the process.
    See also
    setNumThreads, getThreadNum
int cv::getThreadNum ( )

#include <core/include/opencv2/core/utility.hpp>

Returns the index of the currently executed thread within the current parallel region.

Always returns 0 if called outside of parallel region.

The exact meaning of return value depends on the threading framework used by OpenCV library:

  • TBB – Unsupported with current 4.1 TBB release. May be will be supported in future.
  • OpenMP – The thread number, within the current team, of the calling thread.
  • Concurrency – An ID for the virtual processor that the current context is executing on (0 for master thread and unique number for others, but not necessary 1,2,3,...).
  • GCD – System calling thread's ID. Never returns 0 inside parallel region.
  • C= – The index of the current parallel task.
    See also
    setNumThreads, getNumThreads
int64 cv::getTickCount ( )

#include <core/include/opencv2/core/utility.hpp>

Returns the number of ticks.

The function returns the number of ticks after the certain event (for example, when the machine was turned on). It can be used to initialize RNG or to measure a function execution time by reading the tick count before and after the function call.

See also
getTickFrequency, TickMeter
Examples:
houghlines.cpp, lsd_lines.cpp, and watershed.cpp.

Referenced by cvflann::StartStopTimer::start(), cv::TickMeter::start(), cvflann::StartStopTimer::stop(), and cv::TickMeter::stop().

Here is the caller graph for this function:

double cv::getTickFrequency ( )

#include <core/include/opencv2/core/utility.hpp>

Returns the number of ticks per second.

The function returns the number of ticks per second. That is, the following code computes the execution time in seconds:

double t = (double)getTickCount();
// do something ...
t = ((double)getTickCount() - t)/getTickFrequency();
See also
getTickCount, TickMeter
Examples:
houghlines.cpp, lsd_lines.cpp, and watershed.cpp.

Referenced by cv::instr::NodeData::getMeanMs(), cv::TickMeter::getTimeSec(), cv::instr::NodeData::getTotalMs(), and cvflann::StartStopTimer::stop().

Here is the caller graph for this function:

void cv::glob ( String  pattern,
std::vector< String > &  result,
bool  recursive = false 
)

#include <core/include/opencv2/core/utility.hpp>

int cv::LU ( float *  A,
size_t  astep,
int  m,
float *  b,
size_t  bstep,
int  n 
)

#include <core/include/opencv2/core/base.hpp>

proxy for hal::LU

Referenced by cv::normInf(), and cv::hal::DCT2D::~DCT2D().

Here is the caller graph for this function:

int cv::LU ( double *  A,
size_t  astep,
int  m,
double *  b,
size_t  bstep,
int  n 
)

#include <core/include/opencv2/core/base.hpp>

proxy for hal::LU

template<typename _Tp , typename _AccTp >
static _AccTp cv::normInf ( const _Tp *  a,
int  n 
)
inlinestatic

#include <core/include/opencv2/core/base.hpp>

References cv::cv_abs(), and cv::max().

Here is the call graph for this function:

template<typename _Tp , typename _AccTp >
static _AccTp cv::normInf ( const _Tp *  a,
const _Tp *  b,
int  n 
)
inlinestatic

#include <core/include/opencv2/core/base.hpp>

References cv::cuda::abs(), cv::Cholesky(), cv::cubeRoot(), CV_EXPORTS, CV_EXPORTS_W, cv::fastAtan2(), cv::line(), cv::LU(), and cv::max().

Here is the call graph for this function:

template<typename _Tp , typename _AccTp >
static _AccTp cv::normL1 ( const _Tp *  a,
int  n 
)
inlinestatic

#include <core/include/opencv2/core/base.hpp>

References cv::cv_abs().

Here is the call graph for this function:

template<typename _Tp , typename _AccTp >
static _AccTp cv::normL1 ( const _Tp *  a,
const _Tp *  b,
int  n 
)
inlinestatic

#include <core/include/opencv2/core/base.hpp>

References cv::cuda::abs().

Here is the call graph for this function:

float cv::normL1 ( const float *  a,
const float *  b,
int  n 
)
inline

#include <core/include/opencv2/core/base.hpp>

References cv::cuda::abs().

Here is the call graph for this function:

int cv::normL1 ( const uchar *  a,
const uchar *  b,
int  n 
)
inline

#include <core/include/opencv2/core/base.hpp>

References cv::cuda::abs().

Here is the call graph for this function:

template<typename _Tp , typename _AccTp >
static _AccTp cv::normL2Sqr ( const _Tp *  a,
int  n 
)
inlinestatic

#include <core/include/opencv2/core/base.hpp>

template<typename _Tp , typename _AccTp >
static _AccTp cv::normL2Sqr ( const _Tp *  a,
const _Tp *  b,
int  n 
)
inlinestatic

#include <core/include/opencv2/core/base.hpp>

static float cv::normL2Sqr ( const float *  a,
const float *  b,
int  n 
)
inlinestatic

#include <core/include/opencv2/core/base.hpp>

static std::ostream& cv::operator<< ( std::ostream &  out,
const TickMeter &  tm 
)
inlinestatic

#include <core/include/opencv2/core/utility.hpp>

output operator

TickMeter tm;
tm.start();
// do something ...
tm.stop();
std::cout << tm;

References cv::checkHardwareSupport(), CV_EXPORTS_W, cv::getCPUTickCount(), cv::getNumberOfCPUs(), and cv::TickMeter::getTimeSec().

Here is the call graph for this function:

void cv::parallel_for_ ( const Range &  range,
const ParallelLoopBody &  body,
double  nstripes = -1. 
)

#include <core/include/opencv2/core/utility.hpp>

Parallel data processor.

Referenced by cv::Mat::forEach_impl(), and cvflann::KMeansIndex< Distance >::getParameters().

Here is the caller graph for this function:

ErrorCallback cv::redirectError ( ErrorCallback  errCallback,
void *  userdata = 0,
void **  prevUserdata = 0 
)

#include <core/include/opencv2/core/utility.hpp>

Sets the new error handler and the optional user data.

The function sets the new error handler, called from cv::error().

Parameters
errCallbackthe new error handler. If NULL, the default error handler is used.
userdatathe optional user data pointer, passed to the callback.
prevUserdatathe optional output parameter where the previous user data pointer is stored
Returns
the previous error handler
template<typename _Tp >
static _Tp cv::saturate_cast ( uchar  v)
inlinestatic

#include <core/include/opencv2/core/saturate.hpp>

Template function for accurate conversion from one primitive type to another.

The functions saturate_cast resemble the standard C++ cast operations, such as static_cast<T>() and others. They perform an efficient and accurate conversion from one primitive type to another (see the introduction chapter). saturate in the name means that when the input value v is out of the range of the target type, the result is not formed just by taking low bits of the input, but instead the value is clipped. For example:

uchar a = saturate_cast<uchar>(-100); // a = 0 (UCHAR_MIN)
short b = saturate_cast<short>(33333.33333); // b = 32767 (SHRT_MAX)

Such clipping is done when the target type is unsigned char , signed char , unsigned short or signed short . For 32-bit integers, no clipping is done.

When the parameter is a floating-point value and the target type is an integer (8-, 16- or 32-bit), the floating-point value is first rounded to the nearest integer and then clipped if needed (when the target type is 8- or 16-bit).

This operation is used in the simplest or most complex image processing functions in OpenCV.

Parameters
vFunction parameter.
See also
add, subtract, multiply, divide, Mat::convertTo

Referenced by CvPoint3D32f::operator cv::Point3_< _Tp >(), CvPoint::operator cv::Point_< _Tp >(), CvPoint2D32f::operator cv::Point_< _Tp >(), CvScalar::operator cv::Scalar_< _Tp >(), CvSize::operator cv::Size_< _Tp >(), CvSize2D32f::operator cv::Size_< _Tp >(), cv::Vec< _Tp, cn >::operator*(), cv::FileNode::read(), cv::cudev::resizePtr(), cv::saturate_cast< schar >(), cv::saturate_cast< short >(), cv::saturate_cast< uchar >(), and cv::saturate_cast< ushort >().

Here is the caller graph for this function:

template<typename _Tp >
static _Tp cv::saturate_cast ( schar  v)
inlinestatic

#include <core/include/opencv2/core/saturate.hpp>

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

template<typename _Tp >
static _Tp cv::saturate_cast ( ushort  v)
inlinestatic

#include <core/include/opencv2/core/saturate.hpp>

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

template<typename _Tp >
static _Tp cv::saturate_cast ( short  v)
inlinestatic

#include <core/include/opencv2/core/saturate.hpp>

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

template<typename _Tp >
static _Tp cv::saturate_cast ( unsigned  v)
inlinestatic

#include <core/include/opencv2/core/saturate.hpp>

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

template<typename _Tp >
static _Tp cv::saturate_cast ( int  v)
inlinestatic

#include <core/include/opencv2/core/saturate.hpp>

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

template<typename _Tp >
static _Tp cv::saturate_cast ( float  v)
inlinestatic

#include <core/include/opencv2/core/saturate.hpp>

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

template<typename _Tp >
static _Tp cv::saturate_cast ( double  v)
inlinestatic

#include <core/include/opencv2/core/saturate.hpp>

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

template<typename _Tp >
static _Tp cv::saturate_cast ( int64  v)
inlinestatic

#include <core/include/opencv2/core/saturate.hpp>

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

template<typename _Tp >
static _Tp cv::saturate_cast ( uint64  v)
inlinestatic

#include <core/include/opencv2/core/saturate.hpp>

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

template<>
schar cv::saturate_cast< schar > ( uchar  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::min().

Here is the call graph for this function:

template<>
schar cv::saturate_cast< schar > ( ushort  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::min().

Here is the call graph for this function:

template<>
schar cv::saturate_cast< schar > ( int  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

template<>
schar cv::saturate_cast< schar > ( short  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::saturate_cast().

Here is the call graph for this function:

template<>
schar cv::saturate_cast< schar > ( unsigned  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::min().

Here is the call graph for this function:

template<>
schar cv::saturate_cast< schar > ( float  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cvRound(), and cv::saturate_cast().

Here is the call graph for this function:

template<>
schar cv::saturate_cast< schar > ( double  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cvRound(), and cv::saturate_cast().

Here is the call graph for this function:

template<>
schar cv::saturate_cast< schar > ( int64  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

template<>
schar cv::saturate_cast< schar > ( uint64  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::min().

Here is the call graph for this function:

template<>
short cv::saturate_cast< short > ( ushort  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::min().

Here is the call graph for this function:

template<>
short cv::saturate_cast< short > ( int  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

template<>
short cv::saturate_cast< short > ( unsigned  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::min().

Here is the call graph for this function:

template<>
short cv::saturate_cast< short > ( float  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cvRound(), and cv::saturate_cast().

Here is the call graph for this function:

template<>
short cv::saturate_cast< short > ( double  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cvRound(), and cv::saturate_cast().

Here is the call graph for this function:

template<>
short cv::saturate_cast< short > ( int64  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

template<>
short cv::saturate_cast< short > ( uint64  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cvRound(), cv::min(), and cv::saturate_cast().

Here is the call graph for this function:

template<>
uchar cv::saturate_cast< uchar > ( schar  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::max().

Here is the call graph for this function:

template<>
uchar cv::saturate_cast< uchar > ( ushort  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::min().

Here is the call graph for this function:

template<>
uchar cv::saturate_cast< uchar > ( int  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

template<>
uchar cv::saturate_cast< uchar > ( short  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::saturate_cast().

Here is the call graph for this function:

template<>
uchar cv::saturate_cast< uchar > ( unsigned  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::min().

Here is the call graph for this function:

template<>
uchar cv::saturate_cast< uchar > ( float  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cvRound(), and cv::saturate_cast().

Here is the call graph for this function:

template<>
uchar cv::saturate_cast< uchar > ( double  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cvRound(), and cv::saturate_cast().

Here is the call graph for this function:

template<>
uchar cv::saturate_cast< uchar > ( int64  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

template<>
uchar cv::saturate_cast< uchar > ( uint64  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::min().

Here is the call graph for this function:

template<>
unsigned cv::saturate_cast< unsigned > ( float  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cvRound().

Here is the call graph for this function:

template<>
unsigned cv::saturate_cast< unsigned > ( double  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cvRound().

Here is the call graph for this function:

template<>
ushort cv::saturate_cast< ushort > ( schar  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::max().

Here is the call graph for this function:

template<>
ushort cv::saturate_cast< ushort > ( short  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::max().

Here is the call graph for this function:

template<>
ushort cv::saturate_cast< ushort > ( int  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

template<>
ushort cv::saturate_cast< ushort > ( unsigned  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::min().

Here is the call graph for this function:

template<>
ushort cv::saturate_cast< ushort > ( float  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cvRound(), and cv::saturate_cast().

Here is the call graph for this function:

template<>
ushort cv::saturate_cast< ushort > ( double  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cvRound(), and cv::saturate_cast().

Here is the call graph for this function:

template<>
ushort cv::saturate_cast< ushort > ( int64  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

template<>
ushort cv::saturate_cast< ushort > ( uint64  v)
inline

#include <core/include/opencv2/core/saturate.hpp>

References cv::min().

Here is the call graph for this function:

bool cv::setBreakOnError ( bool  flag)

#include <core/include/opencv2/core/utility.hpp>

Sets/resets the break-on-error mode.

When the break-on-error mode is set, the default error handler issues a hardware exception, which can make debugging more convenient.

Returns
the previous state
void cv::setNumThreads ( int  nthreads)

#include <core/include/opencv2/core/utility.hpp>

OpenCV will try to set the number of threads for the next parallel region.

If threads == 0, OpenCV will disable threading optimizations and run all it's functions sequentially. Passing threads < 0 will reset threads number to system default. This function must be called outside of parallel region.

OpenCV will try to run it's functions with specified threads number, but some behaviour differs from framework:

  • TBB – User-defined parallel constructions will run with the same threads number, if another does not specified. If late on user creates own scheduler, OpenCV will be use it.
  • OpenMP – No special defined behaviour.
  • Concurrency – If threads == 1, OpenCV will disable threading optimizations and run it's functions sequentially.
  • GCD – Supports only values <= 0.
  • C= – No special defined behaviour.
    Parameters
    nthreadsNumber of threads used by OpenCV.
    See also
    getNumThreads, getThreadNum
void cv::setUseOptimized ( bool  onoff)

#include <core/include/opencv2/core/utility.hpp>

Enables or disables the optimized code.

The function can be used to dynamically turn on and off optimized code (code that uses SSE2, AVX, and other instructions on the platforms that support it). It sets a global flag that is further checked by OpenCV functions. Since the flag is not checked in the inner OpenCV loops, it is only safe to call the function on the very top level in your application where you can be sure that no other OpenCV function is currently executed.

By default, the optimized code is enabled unless you disable it in CMake. The current status can be retrieved using useOptimized.

Parameters
onoffThe boolean flag specifying whether the optimized code should be used (onoff=true) or not (onoff=false).

Referenced by cv::alignSize().

Here is the caller graph for this function:

String cv::tempfile ( const char *  suffix = 0)

#include <core/include/opencv2/core/utility.hpp>

bool cv::useOptimized ( )

#include <core/include/opencv2/core/utility.hpp>

Returns the status of optimized code usage.

The function returns true if the optimized code is enabled. Otherwise, it returns false.

Referenced by cv::alignSize().

Here is the caller graph for this function: