CVBpy 14.0
ImagePlane Class Reference

Plane of an image with a specific index. More...

Inherits object.

Public Member Functions

float get_pixel (self, cvb.Point2D position)
 Gets the pixel value at the given position (as float). More...
 
cvb.Image map (self)
 Create a map from a single image plane, that shares its memory with the original plane. More...
 

Properties

 data_type = property
 cvb.DataType: Data type descriptor for this plane.
 
 plane = property
 int: Plane index in the image, to which this plane refers to.
 
 rank = property
 int: The number of dimensions of this plane.
 

Detailed Description

Plane of an image with a specific index.

Implicitly convert a plane to an image plane.

Parameters

plane : cvb.Plane Plane to convert to image plane. Plane must be 2D.

Member Function Documentation

◆ get_pixel()

float get_pixel (   self,
cvb.Point2D  position 
)

Gets the pixel value at the given position (as float).

Parameters

position : cvb.Point2D Pixel position.

Returns

float The pixel value.

◆ map()

cvb.Image map (   self)

Create a map from a single image plane, that shares its memory with the original plane.

Returns

cvb.Image The mapped image.