Class cv::Scalar_#

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

Collaboration diagram for cv::Scalar_:

Public Types#

Public Types inherited from cv::Vec

Return

Name

Description

``

_Tp

value_type

Public Types inherited from cv::Matx

Return

Name

Description

``

Matx< _Tp, shortdim, 1 >

diag_type

Matx< _Tp, m, n >

mat_type

_Tp

value_type

Public Member Functions#

Public Member Functions inherited from cv::Vec

Return

Name

Description

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

conjugation (makes sense for complex numbers and quaternions)

Vec

cross(const Vec & v)

Vec

mul(const Vec< _Tp, cn > & v)

per-element multiplication

operator Vec< T2, cn >()

conversion to another data type

_Tp &

operator()(int i)

const _Tp &

operator()(int i)

_Tp &

operator[](int i)

const _Tp &

operator[](int i)

Public Member Functions inherited from cv::Matx

Return

Name

Description

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)

extract the matrix column

void

convertTo(
    const _OutputArray & dst,
    int type,
    double scale = 1.,
    double shift = 0. )

void

copyTo(const _OutputArray & dst)

copy & convert

double

ddot(const Matx< _Tp, m, n > & v)

dot product computed in double-precision arithmetics

diag_type

diag()

extract the matrix diagonal

Matx< _Tp, m, n >

div(const Matx< _Tp, m, n > & a)

divide two matrices element-wise

_Tp

dot(const Matx< _Tp, m, n > & v)

dot product computed with the default precision

Matx< _Tp, m1, n1 >

get_minor(
    int base_row,
    int base_col )

extract part of the matrix

Matx< _Tp, n, m >

inv(
    int method = DECOMP_LU,
    bool * p_is_ok = NULL )

invert the matrix

Matx< _Tp, m, n >

mul(const Matx< _Tp, m, n > & a)

multiply two matrices element-wise

operator Matx< T2, m, n >()

conversion to another data type

_Tp &

operator()(int i)

const _Tp &

operator()(int i)

1D element access

_Tp &

operator()(
    int row,
    int col )

const _Tp &

operator()(
    int row,
    int col )

element access

Matx< _Tp, m1, n1 >

reshape()

change the matrix shape

Matx< _Tp, 1, n >

row(int i)

extract the matrix row

Matx< _Tp, n, l >

solve(
    const Matx< _Tp, m, l > & rhs,
    int flags = DECOMP_LU )

solve linear system

Vec< _Tp, n >

solve(
    const Vec< _Tp, m > & rhs,
    int method )

Matx< _Tp, n, m >

t()

transpose the matrix

Static Public Member Functions#

Static Public Member Functions inherited from cv::Vec
Static Public Member Functions inherited from cv::Matx

Return

Name

Description

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

Public Attributes#

Public Attributes inherited from cv::Matx

Return

Name

Description

_Tp

val[m *n]

matrix elements

Detailed Description#

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_()#

cv::Scalar_::Scalar_()

default constructor

Scalar_()#

cv::Scalar_::Scalar_(_Tp v0)

Scalar_()#

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

Scalar_()#

cv::Scalar_::Scalar_(const Scalar_ & s)

Scalar_()#

template<typename _Tp2, int cn>
cv::Scalar_::Scalar_(const Vec< _Tp2, cn > & v)

Scalar_()#

cv::Scalar_::Scalar_(Scalar_ && s)

Member Function Documentation#

conj()#

Scalar_< Tp > cv::Scalar::conj()

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

isReal()#

bool cv::Scalar_::isReal()

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

mul()#

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

per-element product

operator Scalar_< T2 >()#

template<typename T2>
cv::Scalar_::operator Scalar_< T2 >()

conversion to another data type

operator=()#

Scalar_ & cv::Scalar_::operator=(const Scalar_ & s)

operator=()#

Scalar_ & cv::Scalar_::operator=(Scalar_ && s)

all()#

static Scalar_< Tp > cv::Scalar::all(_Tp v0)

returns a scalar with all elements set to v0

Source file#

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