cv::Size_< _Tp > Class Template Reference

Template class for specifying the size of an image or rectangle. More...

#include <opencv2/core/types.hpp>

Collaboration diagram for cv::Size_< _Tp >:

Public Types
typedef _Tp	value_type

Public Member Functions
	Size_ ()
	default constructor
	Size_ (_Tp _width, _Tp _height)
	Size_ (const Point_< _Tp > &pt)
	Size_ (const Size_ &sz)=default
	Size_ (Size_ &&sz) CV_NOEXCEPT=default
_Tp	area () const
	the area (width*height)
double	aspectRatio () const
	aspect ratio (width/height)
bool	empty () const
	true if empty
template<typename _Tp2 >
	operator Size_< _Tp2 > () const
	conversion of another data type.
Size_ &	operator= (const Size_ &sz)=default
Size_ &	operator= (Size_ &&sz) CV_NOEXCEPT=default

Public Attributes
_Tp	height
	the height
_Tp	width
	the width

Detailed Description

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

Template class for specifying the size of an image or rectangle.

The class includes two members called width and height. The same set of arithmetic and comparison operations as for Point_ is available.

For a 1d matrix, the size is (width, 1) and for a 0d matrix, it is (1, 1).

For an empty matrix, it is (0, 0).

OpenCV defines the following Size_<> aliases:

typedef Size_<int> Size2i;
typedef Size2i Size;
typedef Size_<float> Size2f;

Examples

modules/shape/samples/shape_example.cpp, samples/cpp/image_alignment.cpp, samples/cpp/lkdemo.cpp, samples/cpp/snippets/chromatic_aberration_correction.cpp, samples/cpp/snippets/edge.cpp, samples/cpp/snippets/epipolar_lines.cpp, samples/cpp/snippets/falsecolor.cpp, samples/cpp/snippets/laplace.cpp, samples/cpp/snippets/warpPerspective_demo.cpp, samples/cpp/stitching_detailed.cpp, samples/cpp/tutorial_code/ImgProc/Morphology_1.cpp, samples/cpp/tutorial_code/ImgProc/Morphology_2.cpp, samples/cpp/tutorial_code/ImgProc/Pyramids/Pyramids.cpp, samples/cpp/tutorial_code/ImgProc/Smoothing/Smoothing.cpp, samples/cpp/tutorial_code/ImgProc/basic_drawing/Drawing_1.cpp, samples/cpp/tutorial_code/ImgProc/basic_drawing/Drawing_2.cpp, samples/cpp/tutorial_code/ImgTrans/Sobel_Demo.cpp, samples/cpp/tutorial_code/features/Homography/decompose_homography.cpp, samples/cpp/tutorial_code/features/Homography/homography_from_camera_displacement.cpp, samples/cpp/tutorial_code/features/Homography/pose_from_homography.cpp, samples/cpp/tutorial_code/videoio/video-write/video-write.cpp, samples/cpp/videowriter.cpp, samples/dnn/classification.cpp, samples/dnn/colorization.cpp, samples/dnn/object_detection.cpp, samples/dnn/openpose.cpp, samples/dnn/segmentation.cpp, samples/dnn/text_detection.cpp, samples/facedetect.cpp, samples/hog_tapi.cpp, and samples/peopledetect.cpp.

Member Typedef Documentation

value_type

template<typename _Tp >

_Tp cv::Size_< _Tp >::value_type

Constructor & Destructor Documentation

Size_() [1/5]

template<typename _Tp >

cv::Size_< _Tp >::Size_

(

)

default constructor

Size_() [2/5]

template<typename _Tp >

cv::Size_< _Tp >::Size_	(	_Tp	_width,
		_Tp	_height )

Size_() [3/5]

template<typename _Tp >

cv::Size_< _Tp >::Size_ ( const Size_< _Tp > & sz )

default

Size_() [4/5]

template<typename _Tp >

cv::Size_< _Tp >::Size_ ( Size_< _Tp > && sz )

default

Size_() [5/5]

template<typename _Tp >

cv::Size_< _Tp >::Size_

(

const Point_< _Tp > &

pt

)

Member Function Documentation

area()

template<typename _Tp >

_Tp cv::Size_< _Tp >::area

(

)

const

the area (width*height)

Examples

samples/cpp/stitching_detailed.cpp.

aspectRatio()

template<typename _Tp >

double cv::Size_< _Tp >::aspectRatio

(

)

const

aspect ratio (width/height)

empty()

template<typename _Tp >

bool cv::Size_< _Tp >::empty

(

)

const

true if empty

operator Size_< _Tp2 >()

template<typename _Tp >

template<typename _Tp2 >

cv::Size_< _Tp >::operator Size_< _Tp2 >

(

)

const

conversion of another data type.

operator=() [1/2]

template<typename _Tp >

Size_ & cv::Size_< _Tp >::operator= ( const Size_< _Tp > & sz )

default

operator=() [2/2]

template<typename _Tp >

Size_ & cv::Size_< _Tp >::operator= ( Size_< _Tp > && sz )

default

Member Data Documentation

height

template<typename _Tp >

_Tp cv::Size_< _Tp >::height

the height

Examples

samples/cpp/stitching_detailed.cpp, samples/cpp/tutorial_code/ImgProc/basic_drawing/Drawing_2.cpp, samples/cpp/tutorial_code/features/Homography/decompose_homography.cpp, samples/cpp/tutorial_code/features/Homography/homography_from_camera_displacement.cpp, samples/cpp/tutorial_code/features/Homography/pose_from_homography.cpp, samples/cpp/tutorial_code/videoio/video-write/video-write.cpp, samples/cpp/videowriter.cpp, samples/dnn/object_detection.cpp, and samples/dnn/text_detection.cpp.

width

template<typename _Tp >

_Tp cv::Size_< _Tp >::width

the width

Examples

samples/cpp/stitching_detailed.cpp, samples/cpp/tutorial_code/ImgProc/basic_drawing/Drawing_2.cpp, samples/cpp/tutorial_code/features/Homography/decompose_homography.cpp, samples/cpp/tutorial_code/features/Homography/homography_from_camera_displacement.cpp, samples/cpp/tutorial_code/features/Homography/pose_from_homography.cpp, samples/cpp/tutorial_code/videoio/video-write/video-write.cpp, samples/cpp/videowriter.cpp, samples/dnn/object_detection.cpp, and samples/dnn/text_detection.cpp.

---

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

• opencv2/core/types.hpp