CVBpy 15.0
Area2D Class Reference

Structure that represents an area of interest in the image. More...

Inherits object.

Public Member Functions

cvb.Area2D create ()
 Default constructor for an empty area. More...
 
cvb.Area2D create (cvb.Point2D p0, cvb.Point2D p1, cvb.Point2D p2)
 Constructor for an area from points. More...
 
cvb.Area2D create (cvb.Rect rect, Optional[cvb.AffineMatrix2D] affine_matrix)
 Creates an area from the given rectangle using a transformation. More...
 
cvb.Area2D create (float radius)
 Constructor for Area2D from a radius. More...
 
None swap_orientation (self)
 Let the vertices P1 and P2 swap their place.
 
None transform (self, cvb.Matrix2D matrix)
 Transform this Area2D using a matrix. More...
 
None transform_affine (self, cvb.AffineMatrix2D affine_matrix)
 Transform this Area2D using an affine matrix. More...
 

Properties

 area = property
 float: Size (in pixels) of the area of interest. More...
 
 bounding_rectangle = property
 cvb.Rect: Gets the bounding box of this area.
 
 coordinate_system = property
 int: Indicates the coordinate system, in which this object is being measured (when used as an area of interest).
 
 p0 = property
 cvb.Point2D: Get or set P0 of the area (top left corner).
 
 p1 = property
 cvb.Point2D: Get or set P1 of the area (lower left corner).
 
 p2 = property
 cvb.Point2D: Get or set P2 of the area (top right corner).
 
 p3 = property
 cvb.Point2D: Gets the calculated P3 of the area (lower right corner).
 
 size = property
 cvb.Size2D: Size (width and height) of the area of interest.
 

Detailed Description

Structure that represents an area of interest in the image.

The pixels of this type are always specified in image coordinates.

Supports the same arguments as cvb.Area2D.create.

Parameters

*args : Any Parameters like cvb.Area2D.create.

**kwargs : Any Parameters like cvb.Area2D.create.

Member Function Documentation

◆ create() [1/4]

cvb.Area2D create ( )

Default constructor for an empty area.

Returns

cvb.Area2D The area.

◆ create() [2/4]

cvb.Area2D create ( cvb.Point2D  p0,
cvb.Point2D  p1,
cvb.Point2D  p2 
)

Constructor for an area from points.

Parameters

p0 : cvb.Point2D P0 (top left corner of the area

p1 : cvb.Point2D P1(top right corner of the area)

p2 : cvb.Point2D P2 (bottom left corner of the area)

Returns

cvb.Area2D The area.

◆ create() [3/4]

cvb.Area2D create ( cvb.Rect  rect,
Optional[cvb.AffineMatrix2D affine_matrix 
)

Creates an area from the given rectangle using a transformation.

Parameters

rect : cvb.Rect Rectangle to convert to image coordinates via the matrix.

affine_matrix : Optional[cvb.AffineMatrix2D] Affine matrix to transform pixel coordinates to image.

Returns

cvb.Area2D The area.

◆ create() [4/4]

cvb.Area2D create ( float  radius)

Constructor for Area2D from a radius.

Parameters

radius : float Radius to construct the area with.

Returns

cvb.Area2D The area.

◆ transform()

None transform (   self,
cvb.Matrix2D  matrix 
)

Transform this Area2D using a matrix.

Parameters

matrix : cvb.Matrix2D Matrix to transform this area with.

◆ transform_affine()

None transform_affine (   self,
cvb.AffineMatrix2D  affine_matrix 
)

Transform this Area2D using an affine matrix.

Parameters

affine_matrix : cvb.AffineMatrix2D Affine matrix to transform this area with.

Property Documentation

◆ area

area = property
static

float: Size (in pixels) of the area of interest.

As the area is a parallelogram the area (in pixels) is not simply width * height.