| OpenCV 5.0.0alpha Open Source Computer Vision

Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
cv::Scalar_< _Tp > Class Template Reference
Core functionality » Basic structures

Template class for a 4-element vector derived from Vec. More...

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

Collaboration diagram for cv::Scalar_< _Tp >:

## Public Member Functions
| Scalar_ ()
| default constructor
| Scalar_ (_Tp v0)
| Scalar_ (_Tp v0, _Tp v1, _Tp v2=0, _Tp v3=0)
| Scalar_ (const Scalar_ &s)
template<typename _Tp2 , int cn>
| Scalar_ (const Vec< _Tp2, cn > &v)
| Scalar_ (Scalar_ &&s) CV_NOEXCEPT
Scalar_< _Tp > | conj () const
| returns (v0, -v1, -v2, -v3)
bool | isReal () const
| returns true iff v1 == v2 == v3 == 0
Scalar_< _Tp > | mul (const Scalar_< _Tp > &a, double scale=1) const
| per-element product
template<typename T2 >
| operator Scalar_< T2 > () const
| conversion to another data type
Scalar_ & | operator= (const Scalar_ &s)
Scalar_ & | operator= (Scalar_ &&s) CV_NOEXCEPT
Public Member Functions inherited from cv::Vec< _Tp, 4 >
| Vec ()
| default constructor
| Vec (_Tp v0)
| 1-element vector constructor
| Vec (_Tp v0, _Tp v1)
| 2-element vector constructor
| Vec (_Tp v0, _Tp v1, _Tp v2)
| 3-element vector constructor
| Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3)
| 4-element vector constructor
| Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4)
| 5-element vector constructor
| Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5)
| 6-element vector constructor
| Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6)
| 7-element vector constructor
| Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7)
| 8-element vector constructor
| Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8)
| 9-element vector constructor
| Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8, _Tp v9)
| 10-element vector constructor
| Vec (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8, _Tp v9, _Tp v10, _Tp v11, _Tp v12, _Tp v13)
| 14-element vector constructor
| Vec (const _Tp *values)
| Vec (const Matx< _Tp, cn, 1 > &a, _T2 alpha, Matx_ScaleOp)
| Vec (const Matx< _Tp, cn, 1 > &a, const Matx< _Tp, cn, 1 > &b, Matx_AddOp)
| Vec (const Matx< _Tp, cn, 1 > &a, const Matx< _Tp, cn, 1 > &b, Matx_SubOp)
| Vec (const Vec< _Tp, cn > &v)
| Vec (std::initializer_list< _Tp >)
Vec | conj () const
| conjugation (makes sense for complex numbers and quaternions)
Vec | cross (const Vec &v) const
Vec | mul (const Vec< _Tp, cn > &v) const
| per-element multiplication
| operator Vec< T2, cn > () const
| conversion to another data type
_Tp & | operator() (int i)
const _Tp & | operator() (int i) const
Vec< _Tp, cn > & | operator= (const Vec< _Tp, cn > &rhs)=default
_Tp & | operator[] (int i)
const _Tp & | operator[] (int i) const
Public Member Functions inherited from cv::Matx< _Tp, cn, 1 >
| Matx ()
| default constructor
| Matx (_Tp v0)
| 1x1 matrix
| Matx (_Tp v0, _Tp v1)
| 1x2 or 2x1 matrix
| Matx (_Tp v0, _Tp v1, _Tp v2)
| 1x3 or 3x1 matrix
| Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3)
| 1x4, 2x2 or 4x1 matrix
| Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4)
| 1x5 or 5x1 matrix
| Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5)
| 1x6, 2x3, 3x2 or 6x1 matrix
| Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6)
| 1x7 or 7x1 matrix
| Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7)
| 1x8, 2x4, 4x2 or 8x1 matrix
| Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8)
| 1x9, 3x3 or 9x1 matrix
| Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8, _Tp v9)
| 1x10, 2x5 or 5x2 or 10x1 matrix
| Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8, _Tp v9, _Tp v10, _Tp v11)
| 1x12, 2x6, 3x4, 4x3, 6x2 or 12x1 matrix
| Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8, _Tp v9, _Tp v10, _Tp v11, _Tp v12, _Tp v13)
| 1x14, 2x7, 7x2 or 14x1 matrix
| Matx (_Tp v0, _Tp v1, _Tp v2, _Tp v3, _Tp v4, _Tp v5, _Tp v6, _Tp v7, _Tp v8, _Tp v9, _Tp v10, _Tp v11, _Tp v12, _Tp v13, _Tp v14, _Tp v15)
| 1x16, 4x4 or 16x1 matrix
| Matx (const _Tp *vals)
| initialize from a plain array
| Matx (const Matx< _Tp, m, l > &a, const Matx< _Tp, l, n > &b, Matx_MatMulOp)
| Matx (const Matx< _Tp, m, n > &a, _T2 alpha, Matx_ScaleOp)
| Matx (const Matx< _Tp, m, n > &a, const Matx< _Tp, m, n > &b, Matx_AddOp)
| Matx (const Matx< _Tp, m, n > &a, const Matx< _Tp, m, n > &b, Matx_DivOp)
| Matx (const Matx< _Tp, m, n > &a, const Matx< _Tp, m, n > &b, Matx_MulOp)
| Matx (const Matx< _Tp, m, n > &a, const Matx< _Tp, m, n > &b, Matx_SubOp)
| Matx (const Matx< _Tp, n, m > &a, Matx_TOp)
| Matx (std::initializer_list< _Tp >)
| initialize from an initializer list
Matx< _Tp, m, 1 > | col (int i) const
| extract the matrix column
void | convertTo (const _OutputArray &dst, int type, double scale=1., double shift=0.) const
void | copyTo (const _OutputArray &dst) const
| copy & convert
double | ddot (const Matx< _Tp, m, n > &v) const
| dot product computed in double-precision arithmetics
diag_type | diag () const
| extract the matrix diagonal
Matx< _Tp, m, n > | div (const Matx< _Tp, m, n > &a) const
| divide two matrices element-wise
_Tp | dot (const Matx< _Tp, m, n > &v) const
| dot product computed with the default precision
Matx< _Tp, m1, n1 > | get_minor (int base_row, int base_col) const
| extract part of the matrix
Matx< _Tp, n, m > | inv (int method=DECOMP_LU, bool *p_is_ok=NULL) const
| invert the matrix
Matx< _Tp, m, n > | mul (const Matx< _Tp, m, n > &a) const
| multiply two matrices element-wise
| operator Matx< T2, m, n > () const
| conversion to another data type
_Tp & | operator() (int i)
const _Tp & | operator() (int i) const
| 1D element access
_Tp & | operator() (int row, int col)
const _Tp & | operator() (int row, int col) const
| element access
Matx< _Tp, m1, n1 > | reshape () const
| change the matrix shape
Matx< _Tp, 1, n > | row (int i) const
| extract the matrix row
Matx< _Tp, n, l > | solve (const Matx< _Tp, m, l > &rhs, int flags=DECOMP_LU) const
| solve linear system
Vec< _Tp, n > | solve (const Vec< _Tp, m > &rhs, int method) const
Matx< _Tp, n, m > | t () const
| transpose the matrix

## Static Public Member Functions
static Scalar_< _Tp > | all (_Tp v0)
| returns a scalar with all elements set to v0
Static Public Member Functions inherited from cv::Vec< _Tp, 4 >
static Vec | all (_Tp alpha)
static Vec | diag (_Tp alpha)=delete
static Vec | eye ()=delete
static Vec | ones ()
static Vec | randn (_Tp a, _Tp b)
static Vec | randu (_Tp a, _Tp b)
static Vec | zeros ()
Static Public Member Functions inherited from cv::Matx< _Tp, cn, 1 >
static CV_NODISCARD_STD Matx | all (_Tp alpha)
static CV_NODISCARD_STD Matx | diag (const diag_type &d)
static CV_NODISCARD_STD Matx | eye ()
static CV_NODISCARD_STD Matx | ones ()
static CV_NODISCARD_STD Matx | randn (_Tp a, _Tp b)
| Generates normally distributed random numbers.
static CV_NODISCARD_STD Matx | randu (_Tp a, _Tp b)
| Generates uniformly distributed random numbers.
static CV_NODISCARD_STD Matx | zeros ()

## Additional Inherited Members
Public Types inherited from cv::Vec< _Tp, 4 >
enum |
typedef _Tp | value_type
Public Types inherited from cv::Matx< _Tp, cn, 1 >
enum |
typedef Matx< _Tp, shortdim, 1 > | diag_type
typedef Matx< _Tp, m, n > | mat_type
typedef _Tp | value_type
Public Attributes inherited from cv::Matx< _Tp, cn, 1 >
_Tp | val [m *n]
| matrix elements

## Detailed Description

template<typename _Tp>
class cv::Scalar_< _Tp >

Template class for a 4-element vector derived from Vec.

Being derived from Vec<_Tp, 4> , Scalar_ and Scalar can be used just as typical 4-element vectors. In addition, they can be converted to/from CvScalar . The type Scalar is widely used in OpenCV to pass pixel values.

## Constructor & Destructor Documentation

## ◆ Scalar_() [1/6]

template<typename _Tp >

cv::Scalar_< _Tp >::Scalar_ | ( |  | ) |

default constructor

## ◆ Scalar_() [2/6]

template<typename _Tp >

cv::Scalar_< _Tp >::Scalar_ | ( | _Tp | v0,
|  | _Tp | v1,
|  | _Tp | v2 = 0,
|  | _Tp | v3 = 0 )

## ◆ Scalar_() [3/6]

template<typename _Tp >

cv::Scalar_< _Tp >::Scalar_ | ( | _Tp | v0 | ) |

## ◆ Scalar_() [4/6]

template<typename _Tp >

cv::Scalar_< _Tp >::Scalar_ | ( | const Scalar_< _Tp > & | s | ) |

## ◆ Scalar_() [5/6]

template<typename _Tp >

cv::Scalar_< _Tp >::Scalar_ | ( | Scalar_< _Tp > && | s | ) |

## ◆ Scalar_() [6/6]

template<typename _Tp >
template<typename _Tp2 , int cn>

cv::Scalar_< _Tp >::Scalar_ | ( | const Vec< _Tp2, cn > & | v | ) |

## Member Function Documentation

## ◆ all()

template<typename _Tp >

static Scalar_< _Tp > cv::Scalar_< _Tp >::all | ( | _Tp | v0 | ) |
| static

returns a scalar with all elements set to v0

## ◆ conj()

template<typename _Tp >

Scalar_< _Tp > cv::Scalar_< _Tp >::conj | ( |  | ) | const

returns (v0, -v1, -v2, -v3)

## ◆ isReal()

template<typename _Tp >

bool cv::Scalar_< _Tp >::isReal | ( |  | ) | const

returns true iff v1 == v2 == v3 == 0

## ◆ mul()

template<typename _Tp >

Scalar_< _Tp > cv::Scalar_< _Tp >::mul | ( | const Scalar_< _Tp > & | a,
|  | double | scale = 1 ) const

per-element product

## ◆ operator Scalar_< T2 >()

template<typename _Tp >
template<typename T2 >

cv::Scalar_< _Tp >::operator Scalar_< T2 > | ( |  | ) | const

conversion to another data type

## ◆ operator=() [1/2]

template<typename _Tp >

Scalar_ & cv::Scalar_< _Tp >::operator= | ( | const Scalar_< _Tp > & | s | ) |

## ◆ operator=() [2/2]

template<typename _Tp >

Scalar_ & cv::Scalar_< _Tp >::operator= | ( | Scalar_< _Tp > && | s | ) |

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

- opencv2/core/types.hpp