Plane Class Reference

Plane container. More...

Inherits object.

Public Member Functions
cvb.Plane	from_image_plane (cvb.ImagePlane image_plane, int role=cvb.PlaneRole.Undefined)
	Creates a plane from an image plane. More...
int	increment (self, int dimension)
	Gets the increment to the next element in the given dimension. More...
int	length (self, int dimension)
	Gets the number of elements in the given dimension. More...

Properties
	base_ptr = property
	int: Gets the pointer to the first element of this plane.
	data_type = property
	cvb.DataType: Get the data type of this plane.
	rank = property
	int: Get the rank of this plane.
	role = property
	int: Get the meaning of this plane (see cvb.PlaneRole).

Detailed Description

Plane container.

Member Function Documentation

from_image_plane()

cvb.Plane from_image_plane	(	cvb.ImagePlane	image_plane,
		int	role = cvb.PlaneRole.Undefined
	)

Creates a plane from an image plane.

Parameters

image_plane : cvb.ImagePlane The image plane.

role : int The role of this plane.

Returns

cvb.Plane The new plane.

increment()

int increment	(		self,
		int	dimension
	)

Gets the increment to the next element in the given dimension.

Parameters

dimension : int Zero based dimension to access.

Returns

int Variable to receive the offset to the next element in the given dimension in bytes.

length()

int length	(		self,
		int	dimension
	)

Gets the number of elements in the given dimension.

Parameters

dimension : int Dimension to access the length for.

Returns

int Number of elements.