Public Member Functions | Properties | List of all members
DataType Class Reference

Data type description for an image plane. More...

Inherits object.

Public Member Functions

cvb.DataType float32_bpp ()
 Represents single precision (32-bit) floating point pixels. More...
 
cvb.DataType float64_bpp ()
 Represents double precision (64-bit) floating point pixels. More...
 
cvb.DataType int10_bpp_unsigned ()
 Represents 10-bit unsigned integer pixels. More...
 
cvb.DataType int12_bpp_unsigned ()
 Represents 12-bit unsigned integer pixels. More...
 
cvb.DataType int16_bpp_signed ()
 Represents 16-bit signed integer pixels. More...
 
cvb.DataType int16_bpp_unsigned ()
 Represents 16-bit unsigned integer pixels. More...
 
cvb.DataType int8_bpp_signed ()
 Represents 8-bit signed integer pixels. More...
 
cvb.DataType int8_bpp_unsigned ()
 Represents 8-bit unsigned integer pixels (bytes). More...
 

Properties

 bits_per_pixel = property
 int: Number of actually valid bits per pixel. More...
 
 bytes_per_pixel = property
 int: Number of bytes occupied by each pixel. More...
 
 has_overlay_bit = property
 bool: Gets whether the pixels of the plane have signed integer values. More...
 
 is_complex_packed = property
 bool: Gets whether bit 0 of the pixels of the plane are being used as an overlay indicator bit. More...
 
 is_float = property
 bool: Gets whether the pixels of the plane have floating point values. More...
 
 is_signed_integer = property
 bool: Gets whether the pixels of the plane have unsigned integer values. More...
 
 is_unsigned_integer = property
 bool: Gets whether the pixels of the plane have unsigned integer values. More...
 
 max_val = property
 float: Gets the maximum pixel value that fits this data type (as float). More...
 
 min_val = property
 float: Gets the minimum pixel value that fits this data type (as float). More...
 
 numeric_type = property
 int: Returns the basic numeric type of the pixels (see cvb.PixelDataType). More...
 
 undefined_val = property
 float: Gets the undefined value for this data type (as float). More...
 

Detailed Description

Data type description for an image plane.

Use factory methods to create a data type.

Member Function Documentation

◆ float32_bpp()

cvb.DataType float32_bpp ( )

Represents single precision (32-bit) floating point pixels.

Returns

cvb.DataType Data type descriptor object.

◆ float64_bpp()

cvb.DataType float64_bpp ( )

Represents double precision (64-bit) floating point pixels.

Returns

cvb.DataType Data type descriptor object.

◆ int10_bpp_unsigned()

cvb.DataType int10_bpp_unsigned ( )

Represents 10-bit unsigned integer pixels.

Returns

cvb.DataType Data type descriptor object.

◆ int12_bpp_unsigned()

cvb.DataType int12_bpp_unsigned ( )

Represents 12-bit unsigned integer pixels.

Returns

cvb.DataType Data type descriptor object.

◆ int16_bpp_signed()

cvb.DataType int16_bpp_signed ( )

Represents 16-bit signed integer pixels.

Returns

cvb.DataType Data type descriptor object.

◆ int16_bpp_unsigned()

cvb.DataType int16_bpp_unsigned ( )

Represents 16-bit unsigned integer pixels.

Returns

cvb.DataType Data type descriptor object.

◆ int8_bpp_signed()

cvb.DataType int8_bpp_signed ( )

Represents 8-bit signed integer pixels.

Returns

cvb.DataType Data type descriptor object.

◆ int8_bpp_unsigned()

cvb.DataType int8_bpp_unsigned ( )

Represents 8-bit unsigned integer pixels (bytes).

Returns

cvb.DataType Data type descriptor object.

Property Documentation

◆ bits_per_pixel

bits_per_pixel = property
static

int: Number of actually valid bits per pixel.

◆ bytes_per_pixel

bytes_per_pixel = property
static

int: Number of bytes occupied by each pixel.

◆ has_overlay_bit

has_overlay_bit = property
static

bool: Gets whether the pixels of the plane have signed integer values.

◆ is_complex_packed

is_complex_packed = property
static

bool: Gets whether bit 0 of the pixels of the plane are being used as an overlay indicator bit.

◆ is_float

is_float = property
static

bool: Gets whether the pixels of the plane have floating point values.

◆ is_signed_integer

is_signed_integer = property
static

bool: Gets whether the pixels of the plane have unsigned integer values.

◆ is_unsigned_integer

is_unsigned_integer = property
static

bool: Gets whether the pixels of the plane have unsigned integer values.

◆ max_val

max_val = property
static

float: Gets the maximum pixel value that fits this data type (as float).

◆ min_val

min_val = property
static

float: Gets the minimum pixel value that fits this data type (as float).

◆ numeric_type

numeric_type = property
static

int: Returns the basic numeric type of the pixels (see cvb.PixelDataType).

◆ undefined_val

undefined_val = property
static

float: Gets the undefined value for this data type (as float).

Pixel value for those pixels whose value cannot be defined correctly. For example in scanning situations, where pixels outside the image are accessed.