cv::viz::Color Class Reference

This class represents color in BGR order. More...

#include "types.hpp"

Inheritance diagram for cv::viz::Color:

Collaboration diagram for cv::viz::Color:

Public Types
enum
enum
typedef Matx< _Tp, shortdim, 1 >	diag_type
typedef Matx< _Tp, m, n >	mat_type
typedef _Tp	value_type

Public Member Functions
	Color ()
	Color (double gray)
	The three channels will have the same value equal to gray. More...
	Color (double blue, double green, double red)
	Color (const Scalar &color)
Matx< _Tp, m, 1 >	col (int i) const
	extract the matrix column More...
Scalar_< _Tp >	conj () const
	returns (v0, -v1, -v2, -v3) More...
Vec	cross (const Vec &v) const
	cross product of the two 3D vectors. More...
double	ddot (const Matx< _Tp, m, n > &v) const
	dot product computed in double-precision arithmetics More...
diag_type	diag () const
	extract the matrix diagonal More...
Matx< _Tp, m, n >	div (const Matx< _Tp, m, n > &a) const
	divide two matrices element-wise More...
_Tp	dot (const Matx< _Tp, m, n > &v) const
	dot product computed with the default precision More...
Matx< _Tp, m1, n1 >	get_minor (int i, int j) const
	extract part of the matrix More...
Matx< _Tp, n, m >	inv (int method=DECOMP_LU, bool *p_is_ok=NULL) const
	invert the matrix More...
bool	isReal () const
	returns true iff v1 == v2 == v3 == 0 More...
Matx< _Tp, m, n >	mul (const Matx< _Tp, m, n > &a) const
	multiply two matrices element-wise More...
Vec	mul (const Vec< _Tp, cn > &v) const
	per-element multiplication More...
Scalar_< _Tp >	mul (const Scalar_< _Tp > &a, double scale=1) const
	per-element product More...
	operator Matx< T2, m, n > () const
	conversion to another data type More...
template<typename T2 >
	operator Scalar_< T2 > () const
	conversion to another data type More...
	operator Vec3b () const
	operator Vec< T2, cn > () const
	conversion to another data type More...
const _Tp &	operator() (int i, int j) const
	element access More...
_Tp &	operator() (int i, int j)
const _Tp &	operator() (int i) const
_Tp &	operator() (int i)
const _Tp &	operator[] (int i) const
	element access More...
_Tp &	operator[] (int i)
Matx< _Tp, m1, n1 >	reshape () const
	change the matrix shape More...
Matx< _Tp, 1, n >	row (int i) const
	extract the matrix row More...
Matx< _Tp, n, l >	solve (const Matx< _Tp, m, l > &rhs, int flags=DECOMP_LU) const
	solve linear system More...
Vec< _Tp, n >	solve (const Vec< _Tp, m > &rhs, int method) const
Matx< _Tp, n, m >	t () const
	transpose the matrix More...

Static Public Member Functions
static Scalar_< _Tp >	all (_Tp v0)
	returns a scalar with all elements set to v0 More...
static Color	amethyst ()
static Color	apricot ()
static Color	azure ()
static Color	black ()
static Color	bluberry ()
static Color	blue ()
static Color	brown ()
static Color	celestial_blue ()
static Color	chartreuse ()
static Color	cherry ()
static Color	cyan ()
static Matx	diag (const diag_type &d)
static Matx	eye ()
static Color	gold ()
static Color	gray ()
static Color	green ()
static Color	indigo ()
static Color	lime ()
static Color	magenta ()
static Color	maroon ()
static Color	mlab ()
static Color	navy ()
static Color	not_set ()
static Color	olive ()
static Matx	ones ()
static Color	orange ()
static Color	orange_red ()
static Color	pink ()
static Color	purple ()
static Matx	randn (_Tp a, _Tp b)
static Matx	randu (_Tp a, _Tp b)
static Color	raspberry ()
static Color	red ()
static Color	rose ()
static Color	silver ()
static Color	teal ()
static Color	turquoise ()
static Color	violet ()
static Color	white ()
static Color	yellow ()
static Matx	zeros ()

Public Attributes
_Tp	val [m *n]

Related Functions
(Note that these are not member functions.)
static Vec< _Tp1, cn > &	operator+= (Vec< _Tp1, cn > &a, const Vec< _Tp2, cn > &b)
static Vec< _Tp1, cn > &	operator-= (Vec< _Tp1, cn > &a, const Vec< _Tp2, cn > &b)
static Vec< _Tp, cn >	operator+ (const Vec< _Tp, cn > &a, const Vec< _Tp, cn > &b)
static Vec< _Tp, cn >	operator- (const Vec< _Tp, cn > &a, const Vec< _Tp, cn > &b)
static Vec< _Tp, cn >	operator- (const Vec< _Tp, cn > &a)
static Vec< _Tp, cn > &	operator*= (Vec< _Tp, cn > &a, int alpha)
static Vec< _Tp, cn > &	operator*= (Vec< _Tp, cn > &a, float alpha)
static Vec< _Tp, cn > &	operator*= (Vec< _Tp, cn > &a, double alpha)
Vec< _Tp, 4 > &	operator*= (Vec< _Tp, 4 > &v1, const Vec< _Tp, 4 > &v2)
static Vec< _Tp, cn > &	operator/= (Vec< _Tp, cn > &a, int alpha)
static Vec< _Tp, cn > &	operator/= (Vec< _Tp, cn > &a, float alpha)
static Vec< _Tp, cn > &	operator/= (Vec< _Tp, cn > &a, double alpha)
static Vec< _Tp, cn >	operator* (const Vec< _Tp, cn > &a, int alpha)
static Vec< _Tp, cn >	operator* (int alpha, const Vec< _Tp, cn > &a)
static Vec< _Tp, cn >	operator* (const Vec< _Tp, cn > &a, float alpha)
static Vec< _Tp, cn >	operator* (float alpha, const Vec< _Tp, cn > &a)
static Vec< _Tp, cn >	operator* (const Vec< _Tp, cn > &a, double alpha)
static Vec< _Tp, cn >	operator* (double alpha, const Vec< _Tp, cn > &a)
Vec< _Tp, 4 >	operator* (const Vec< _Tp, 4 > &v1, const Vec< _Tp, 4 > &v2)
static Vec< _Tp, cn >	operator/ (const Vec< _Tp, cn > &a, int alpha)
static Vec< _Tp, cn >	operator/ (const Vec< _Tp, cn > &a, float alpha)
static Vec< _Tp, cn >	operator/ (const Vec< _Tp, cn > &a, double alpha)
static Matx< _Tp1, m, n > &	operator+= (Matx< _Tp1, m, n > &a, const Matx< _Tp2, m, n > &b)
static Matx< _Tp1, m, n > &	operator-= (Matx< _Tp1, m, n > &a, const Matx< _Tp2, m, n > &b)
static Matx< _Tp, m, n >	operator+ (const Matx< _Tp, m, n > &a, const Matx< _Tp, m, n > &b)
static Matx< _Tp, m, n >	operator- (const Matx< _Tp, m, n > &a, const Matx< _Tp, m, n > &b)
static Matx< _Tp, m, n >	operator- (const Matx< _Tp, m, n > &a)
static Matx< _Tp, m, n > &	operator*= (Matx< _Tp, m, n > &a, int alpha)
static Matx< _Tp, m, n > &	operator*= (Matx< _Tp, m, n > &a, float alpha)
static Matx< _Tp, m, n > &	operator*= (Matx< _Tp, m, n > &a, double alpha)
static Matx< _Tp, m, n >	operator* (const Matx< _Tp, m, n > &a, int alpha)
static Matx< _Tp, m, n >	operator* (const Matx< _Tp, m, n > &a, float alpha)
static Matx< _Tp, m, n >	operator* (const Matx< _Tp, m, n > &a, double alpha)
static Matx< _Tp, m, n >	operator* (int alpha, const Matx< _Tp, m, n > &a)
static Matx< _Tp, m, n >	operator* (float alpha, const Matx< _Tp, m, n > &a)
static Matx< _Tp, m, n >	operator* (double alpha, const Matx< _Tp, m, n > &a)
static Matx< _Tp, m, n >	operator* (const Matx< _Tp, m, l > &a, const Matx< _Tp, l, n > &b)
static Vec< _Tp, m >	operator* (const Matx< _Tp, m, n > &a, const Vec< _Tp, n > &b)
static bool	operator== (const Matx< _Tp, m, n > &a, const Matx< _Tp, m, n > &b)
static bool	operator!= (const Matx< _Tp, m, n > &a, const Matx< _Tp, m, n > &b)

Detailed Description

This class represents color in BGR order.

Member Typedef Documentation

diag_type

typedef Matx<_Tp, shortdim, 1> cv::Matx< _Tp, m, n >::diag_type

inherited

mat_type

typedef Matx<_Tp, m, n> cv::Matx< _Tp, m, n >::mat_type

inherited

value_type

typedef _Tp cv::Vec< _Tp, cn >::value_type

inherited

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

anonymous enum

anonymous enum

inherited

Constructor & Destructor Documentation

Color() [1/4]

cv::viz::Color::Color

(

)

Color() [2/4]

cv::viz::Color::Color

(

double

gray

)

The three channels will have the same value equal to gray.

Color() [3/4]

cv::viz::Color::Color	(	double	blue,
		double	green,
		double	red
	)

Color() [4/4]

cv::viz::Color::Color

(

const Scalar &

color

)

Member Function Documentation

all()

template<typename _Tp>

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

staticinherited

returns a scalar with all elements set to v0

amethyst()

static Color cv::viz::Color::amethyst ( )

static

apricot()

static Color cv::viz::Color::apricot ( )

static

azure()

static Color cv::viz::Color::azure ( )

static

black()

static Color cv::viz::Color::black ( )

static

bluberry()

static Color cv::viz::Color::bluberry ( )

static

blue()

static Color cv::viz::Color::blue ( )

static

brown()

static Color cv::viz::Color::brown ( )

static

celestial_blue()

static Color cv::viz::Color::celestial_blue ( )

static

chartreuse()

static Color cv::viz::Color::chartreuse ( )

static

cherry()

static Color cv::viz::Color::cherry ( )

static

col()

Matx<_Tp, m, 1> cv::Matx< _Tp, m, n >::col ( int  i ) const

inherited

extract the matrix column

conj()

template<typename _Tp>

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

inherited

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

cross()

Vec cv::Vec< _Tp, cn >::cross ( const Vec< _Tp, 4 > &  v ) const

inherited

cross product of the two 3D vectors.

For other dimensionalities the exception is raised

cyan()

static Color cv::viz::Color::cyan ( )

static

ddot()

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

inherited

dot product computed in double-precision arithmetics

diag() [1/2]

static Matx cv::Matx< _Tp, m, n >::diag ( const diag_type &  d )

staticinherited

diag() [2/2]

diag_type cv::Matx< _Tp, m, n >::diag ( ) const

inherited

extract the matrix diagonal

div()

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

inherited

divide two matrices element-wise

dot()

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

inherited

dot product computed with the default precision

eye()

static Matx cv::Matx< _Tp, m, n >::eye ( )

staticinherited

get_minor()

Matx<_Tp, m1, n1> cv::Matx< _Tp, m, n >::get_minor ( int  i, int  j  ) const

inherited

extract part of the matrix

gold()

static Color cv::viz::Color::gold ( )

static

gray()

static Color cv::viz::Color::gray ( )

static

green()

static Color cv::viz::Color::green ( )

static

indigo()

static Color cv::viz::Color::indigo ( )

static

inv()

Matx<_Tp, n, m> cv::Matx< _Tp, m, n >::inv ( int  method = DECOMP_LU, bool *  p_is_ok = NULL  ) const

inherited

invert the matrix

isReal()

template<typename _Tp>

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

inherited

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

lime()

static Color cv::viz::Color::lime ( )

static

magenta()

static Color cv::viz::Color::magenta ( )

static

maroon()

static Color cv::viz::Color::maroon ( )

static

mlab()

static Color cv::viz::Color::mlab ( )

static

mul() [1/3]

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

inherited

multiply two matrices element-wise

mul() [2/3]

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

inherited

per-element multiplication

mul() [3/3]

template<typename _Tp>

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

inherited

per-element product

navy()

static Color cv::viz::Color::navy ( )

static

not_set()

static Color cv::viz::Color::not_set ( )

static

olive()

static Color cv::viz::Color::olive ( )

static

ones()

static Matx cv::Matx< _Tp, m, n >::ones ( )

staticinherited

operator Matx< T2, m, n >()

cv::Matx< _Tp, m, n >::operator Matx< T2, m, n > ( ) const

inherited

conversion to another data type

operator Scalar_< T2 >()

template<typename _Tp>

template<typename T2 >

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

inherited

conversion to another data type

operator Vec3b()

cv::viz::Color::operator Vec3b

(

)

const

operator Vec< T2, cn >()

cv::Vec< _Tp, cn >::operator Vec< T2, cn > ( ) const

inherited

conversion to another data type

operator()() [1/4]

const _Tp& cv::Matx< _Tp, m, n >::operator() ( int  i, int  j  ) const

inherited

element access

operator()() [2/4]

_Tp& cv::Matx< _Tp, m, n >::operator() ( int  i, int  j  )

inherited

operator()() [3/4]

const _Tp& cv::Vec< _Tp, cn >::operator() ( int  i ) const

inherited

operator()() [4/4]

_Tp& cv::Vec< _Tp, cn >::operator() ( int  i )

inherited

operator[]() [1/2]

const _Tp& cv::Vec< _Tp, cn >::operator[] ( int  i ) const

inherited

element access

operator[]() [2/2]

_Tp& cv::Vec< _Tp, cn >::operator[] ( int  i )

inherited

orange()

static Color cv::viz::Color::orange ( )

static

orange_red()

static Color cv::viz::Color::orange_red ( )

static

pink()

static Color cv::viz::Color::pink ( )

static

purple()

static Color cv::viz::Color::purple ( )

static

randn()

static Matx cv::Matx< _Tp, m, n >::randn ( _Tp  a, _Tp  b  )

staticinherited

randu()

static Matx cv::Matx< _Tp, m, n >::randu ( _Tp  a, _Tp  b  )

staticinherited

raspberry()

static Color cv::viz::Color::raspberry ( )

static

red()

static Color cv::viz::Color::red ( )

static

reshape()

Matx<_Tp, m1, n1> cv::Matx< _Tp, m, n >::reshape ( ) const

inherited

change the matrix shape

rose()

static Color cv::viz::Color::rose ( )

static

row()

Matx<_Tp, 1, n> cv::Matx< _Tp, m, n >::row ( int  i ) const

inherited

extract the matrix row

silver()

static Color cv::viz::Color::silver ( )

static

solve() [1/2]

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

inherited

solve linear system

solve() [2/2]

Vec<_Tp, n> cv::Matx< _Tp, m, n >::solve ( const Vec< _Tp, m > &  rhs, int  method  ) const

inherited

t()

Matx<_Tp, n, m> cv::Matx< _Tp, m, n >::t ( ) const

inherited

transpose the matrix

teal()

static Color cv::viz::Color::teal ( )

static

turquoise()

static Color cv::viz::Color::turquoise ( )

static

violet()

static Color cv::viz::Color::violet ( )

static

white()

static Color cv::viz::Color::white ( )

static

yellow()

static Color cv::viz::Color::yellow ( )

static

zeros()

static Matx cv::Matx< _Tp, m, n >::zeros ( )

staticinherited

Friends And Related Function Documentation

operator!=()

static bool operator!= ( const Matx< _Tp, m, n > &  a, const Matx< _Tp, m, n > &  b  )

related

operator*() [1/15]

static Matx< _Tp, m, n > operator* ( const Matx< _Tp, m, n > &  a, int  alpha  )

related

operator*() [2/15]

static Matx< _Tp, m, n > operator* ( const Matx< _Tp, m, n > &  a, float  alpha  )

related

operator*() [3/15]

static Matx< _Tp, m, n > operator* ( const Matx< _Tp, m, n > &  a, double  alpha  )

related

operator*() [4/15]

static Matx< _Tp, m, n > operator* ( int  alpha, const Matx< _Tp, m, n > &  a  )

related

operator*() [5/15]

static Matx< _Tp, m, n > operator* ( float  alpha, const Matx< _Tp, m, n > &  a  )

related

operator*() [6/15]

static Matx< _Tp, m, n > operator* ( double  alpha, const Matx< _Tp, m, n > &  a  )

related

operator*() [7/15]

static Matx< _Tp, m, n > operator* ( const Matx< _Tp, m, l > &  a, const Matx< _Tp, l, n > &  b  )

related

operator*() [8/15]

static Vec< _Tp, m > operator* ( const Matx< _Tp, m, n > &  a, const Vec< _Tp, n > &  b  )

related

operator*() [9/15]

static Vec< _Tp, cn > operator* ( const Vec< _Tp, cn > &  a, int  alpha  )

related

operator*() [10/15]

static Vec< _Tp, cn > operator* ( int  alpha, const Vec< _Tp, cn > &  a  )

related

operator*() [11/15]

static Vec< _Tp, cn > operator* ( const Vec< _Tp, cn > &  a, float  alpha  )

related

operator*() [12/15]

static Vec< _Tp, cn > operator* ( float  alpha, const Vec< _Tp, cn > &  a  )

related

operator*() [13/15]

static Vec< _Tp, cn > operator* ( const Vec< _Tp, cn > &  a, double  alpha  )

related

operator*() [14/15]

static Vec< _Tp, cn > operator* ( double  alpha, const Vec< _Tp, cn > &  a  )

related

operator*() [15/15]

Vec< _Tp, 4 > operator* ( const Vec< _Tp, 4 > &  v1, const Vec< _Tp, 4 > &  v2  )

related

References cv::saturate_cast().

operator*=() [1/7]

static Matx< _Tp, m, n > & operator*= ( Matx< _Tp, m, n > &  a, int  alpha  )

related

operator*=() [2/7]

static Matx< _Tp, m, n > & operator*= ( Matx< _Tp, m, n > &  a, float  alpha  )

related

operator*=() [3/7]

static Matx< _Tp, m, n > & operator*= ( Matx< _Tp, m, n > &  a, double  alpha  )

related

operator*=() [4/7]

static Vec< _Tp, cn > & operator*= ( Vec< _Tp, cn > &  a, int  alpha  )

related

operator*=() [5/7]

static Vec< _Tp, cn > & operator*= ( Vec< _Tp, cn > &  a, float  alpha  )

related

operator*=() [6/7]

static Vec< _Tp, cn > & operator*= ( Vec< _Tp, cn > &  a, double  alpha  )

related

operator*=() [7/7]

Vec< _Tp, 4 > & operator*= ( Vec< _Tp, 4 > &  v1, const Vec< _Tp, 4 > &  v2  )

related

operator+() [1/2]

static Matx< _Tp, m, n > operator+ ( const Matx< _Tp, m, n > &  a, const Matx< _Tp, m, n > &  b  )

related

operator+() [2/2]

static Vec< _Tp, cn > operator+ ( const Vec< _Tp, cn > &  a, const Vec< _Tp, cn > &  b  )

related

operator+=() [1/2]

static Matx< _Tp1, m, n > & operator+= ( Matx< _Tp1, m, n > &  a, const Matx< _Tp2, m, n > &  b  )

related

operator+=() [2/2]

static Vec< _Tp1, cn > & operator+= ( Vec< _Tp1, cn > &  a, const Vec< _Tp2, cn > &  b  )

related

References cv::Matx< _Tp, cn, 1 >::val.

operator-() [1/4]

static Matx< _Tp, m, n > operator- ( const Matx< _Tp, m, n > &  a, const Matx< _Tp, m, n > &  b  )

related

operator-() [2/4]

static Matx< _Tp, m, n > operator- ( const Matx< _Tp, m, n > &  a )

related

operator-() [3/4]

static Vec< _Tp, cn > operator- ( const Vec< _Tp, cn > &  a, const Vec< _Tp, cn > &  b  )

related

operator-() [4/4]

static Vec< _Tp, cn > operator- ( const Vec< _Tp, cn > &  a )

related

References cv::Matx< _Tp, cn, 1 >::val.

operator-=() [1/2]

static Matx< _Tp1, m, n > & operator-= ( Matx< _Tp1, m, n > &  a, const Matx< _Tp2, m, n > &  b  )

related

operator-=() [2/2]

static Vec< _Tp1, cn > & operator-= ( Vec< _Tp1, cn > &  a, const Vec< _Tp2, cn > &  b  )

related

References cv::Matx< _Tp, cn, 1 >::val.

operator/() [1/3]

static Vec< _Tp, cn > operator/ ( const Vec< _Tp, cn > &  a, int  alpha  )

related

operator/() [2/3]

static Vec< _Tp, cn > operator/ ( const Vec< _Tp, cn > &  a, float  alpha  )

related

operator/() [3/3]

static Vec< _Tp, cn > operator/ ( const Vec< _Tp, cn > &  a, double  alpha  )

related

operator/=() [1/3]

static Vec< _Tp, cn > & operator/= ( Vec< _Tp, cn > &  a, int  alpha  )

related

operator/=() [2/3]

static Vec< _Tp, cn > & operator/= ( Vec< _Tp, cn > &  a, float  alpha  )

related

operator/=() [3/3]

static Vec< _Tp, cn > & operator/= ( Vec< _Tp, cn > &  a, double  alpha  )

related

operator==()

static bool operator== ( const Matx< _Tp, m, n > &  a, const Matx< _Tp, m, n > &  b  )

related

Member Data Documentation

val

_Tp cv::Matx< _Tp, m, n >::val[m *n]

inherited

Referenced by CvScalar::CvScalar(), cv::viz::isNan(), cv::Vec< _Tp, 4 >::operator+=(), cv::Vec< _Tp, 4 >::operator-(), cv::Vec< _Tp, 4 >::operator-=(), and cv::FileStorage::write().

---

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

• viz/include/opencv2/viz/types.hpp