Inheritance diagram for PixelFormat:

Public Member Functions
str	__str__ (self)
	Return a human-readable string of the PixelFormat object.

str	__repr__ (self)
	Return an unambiguous string of the PixelFormat object.

Union[int, float]	minimum_value_per_channel (self)
	Returns the minimum possible value per channel for the pixel format.

Union[int, float]	maximum_value_per_channel (self)
	Returns the maximum possible value per channel for the pixel format.

int	storage_bits_per_channel (self)
	Returns the number of bits used per channel for storage.

int	storage_bits_per_pixel (self)
	Returns the total number of bits used per pixel for storage.

str	string_value (self)
	Returns the human-readable name of the pixel format.

Tuple[Channel,...]	channels (self)
	Returns the list of channels in the pixel format.

int	allocated_bits_per_pixel (self)
	Returns the number of allocated bits per pixel.

str	numpy_dtype (self)
	Returns the numpy dtype string for this pixel format.

bool	has_intensity_channel (self)
	Returns True if the pixel format has an intensity channel.

int	number_of_channels (self)
	Returns the total number of channels in the pixel format.

bool	is_single_channel (self)
	Returns True if the pixel format has only a single channel.

bool	is_packed (self)
	Returns True if the pixel format is packed.

bool	is_interleaved (self)
	Indicates whether the pixel format is interleaved.

PixelFormat	unpacked_format (self)
	Returns the unpacked pixel format for a packed pixel format.

int	get_channel_index (self, Channel channel)
	Returns the index of a specific channel within the pixel format.

bool	has_channel (self, Channel channel)
	Returns True if the pixel format has a specific channel.

int	get_size_in_bytes (self, Size size)
	Calculates the memory size in bytes for a given image size.

bool	is_float (self)

Static Public Member Functions
PixelFormat	create_from_string_value (str string_value)

Data Fields
	is_float

	channels

Static Public Attributes
int	BAYER_GR_8 = 0x01080008

int	BAYER_GR_10 = 0x0110000C

int	BAYER_GR_12 = 0x01100010

int	BAYER_RG_8 = 0x01080009

int	BAYER_RG_10 = 0x0110000D

int	BAYER_RG_12 = 0x01100011

int	BAYER_GB_8 = 0x0108000A

int	BAYER_GB_10 = 0x0110000E

int	BAYER_GB_12 = 0x01100012

int	BAYER_BG_8 = 0x0108000B

int	BAYER_BG_10 = 0x0110000F

int	BAYER_BG_12 = 0x01100013

int	MONO_8 = 0x01080001

int	MONO_10 = 0x01100003

int	MONO_12 = 0x01100005

int	MONO_16 = 0x01100007

int	CONFIDENCE_8 = 0x010800C6

int	CONFIDENCE_16 = 0x011000C7

int	COORD3D_C8 = 0x010800B1

int	COORD3D_C16 = 0x011000B8

int	COORD3D_C32F = 0x012000BF

int	COORD3D_ABC32F = 0x026000C0

int	YUV420_8_YY_UV_SEMIPLANAR_IDS = 0x420C0001

int	YUV420_8_YY_VU_SEMIPLANAR_IDS = 0x420C0002

int	YUV422_8_UYVY = 0x0210001F

int	RGB_8 = 0x02180014

int	RGB_10 = 0x02300018

int	RGB_12 = 0x0230001A

int	BGR_8 = 0x02180015

int	BGR_10 = 0x02300019

int	BGR_12 = 0x0230001B

int	RGBA_8 = 0x02200016

int	RGBA_10 = 0x0240005F

int	RGBA_12 = 0x02400061

int	BGRA_8 = 0x02200017

int	BGRA_10 = 0x0240004C

int	BGRA_12 = 0x0240004E

int	BAYER_BG_10_PACKED = 0x010A0052

int	BAYER_BG_12_PACKED = 0x010C0053

int	BAYER_GB_10_PACKED = 0x010A0054

int	BAYER_GB_12_PACKED = 0x010C0055

int	BAYER_GR_10_PACKED = 0x010A0056

int	BAYER_GR_12_PACKED = 0x010C0057

int	BAYER_RG_10_PACKED = 0x010A0058

int	BAYER_RG_12_PACKED = 0x010C0059

int	MONO_10_PACKED = 0x010A0046

int	MONO_12_PACKED = 0x010C0047

int	RGB_10_PACKED_32 = 0x0220001D

int	BGR_10_PACKED_32 = 0x0220001E

int	BAYER_RG_10_GROUPED_40_IDS = 0x40000001

int	BAYER_GB_10_GROUPED_40_IDS = 0x40000002

int	BAYER_GR_10_GROUPED_40_IDS = 0x40000003

int	BAYER_BG_10_GROUPED_40_IDS = 0x40000004

int	BAYER_RG_12_GROUPED_24_IDS = 0x40000011

int	BAYER_GB_12_GROUPED_24_IDS = 0x40000012

int	BAYER_GR_12_GROUPED_24_IDS = 0x40000013

int	BAYER_BG_12_GROUPED_24_IDS = 0x40000014

int	MONO_10_GROUPED_40_IDS = 0x4000000f

int	MONO_12_GROUPED_24_IDS = 0x4000001f

int	MONO_32F_IDS = 0x81200020

int	RGB_32F_IDS = 0x82600021

int	MONO_10_GROUPED_40_IDS_INTERLEAVED_A_B = 0x9200000F

int	BAYER_RG_10_GROUPED_40_IDS_INTERLEAVED_A_B = 0x92000001

int	BAYER_BG_10_GROUPED_40_IDS_INTERLEAVED_A_B = 0x92000004

int	BAYER_GR_10_GROUPED_40_IDS_INTERLEAVED_A_B = 0x92000003

int	BAYER_GB_10_GROUPED_40_IDS_INTERLEAVED_A_B = 0x92000002

int	MONO_12_GROUPED_24_IDS_INTERLEAVED_A_B = 0x9200001F

int	BAYER_RG_12_GROUPED_24_IDS_INTERLEAVED_A_B = 0x92000011

int	BAYER_BG_12_GROUPED_24_IDS_INTERLEAVED_A_B = 0x92000014

int	BAYER_GR_12_GROUPED_24_IDS_INTERLEAVED_A_B = 0x92000013

int	BAYER_GB_12_GROUPED_24_IDS_INTERLEAVED_A_B = 0x92000012

int	MONO_8_INTERLEAVED_A_B = 0x92080001

int	BAYER_RG_8_INTERLEAVED_A_B = 0x92080009

int	BAYER_BG_8_INTERLEAVED_A_B = 0x9208000B

int	BAYER_GR_8_INTERLEAVED_A_B = 0x92080008

int	BAYER_GB_8_INTERLEAVED_A_B = 0x9208000A

int	MONO_10_INTERLEAVED_A_B = 0x92100003

int	BAYER_RG_10_INTERLEAVED_A_B = 0x9210000D

int	BAYER_BG_10_INTERLEAVED_A_B = 0x9210000F

int	BAYER_GR_10_INTERLEAVED_A_B = 0x9210000C

int	BAYER_GB_10_INTERLEAVED_A_B = 0x9210000E

int	MONO_12_INTERLEAVED_A_B = 0x92100005

int	BAYER_RG_12_INTERLEAVED_A_B = 0x92100011

int	BAYER_BG_12_INTERLEAVED_A_B = 0x92100013

int	BAYER_GR_12_INTERLEAVED_A_B = 0x92100010

int	BAYER_GB_12_INTERLEAVED_A_B = 0x92100012

int	MONO_10_PACKED_INTERLEAVED_A_B = 0x920A0046

int	BAYER_RG_10_PACKED_INTERLEAVED_A_B = 0x920A0058

int	BAYER_BG_10_PACKED_INTERLEAVED_A_B = 0x920A0052

int	BAYER_GR_10_PACKED_INTERLEAVED_A_B = 0x920A0056

int	BAYER_GB_10_PACKED_INTERLEAVED_A_B = 0x920A0054

int	MONO_12_PACKED_INTERLEAVED_A_B = 0x920C0047

int	BAYER_RG_12_PACKED_INTERLEAVED_A_B = 0x920C0059

int	BAYER_BG_12_PACKED_INTERLEAVED_A_B = 0x920C0053

int	BAYER_GR_12_PACKED_INTERLEAVED_A_B = 0x920C0057

int	BAYER_GB_12_PACKED_INTERLEAVED_A_B = 0x920C0055

int	MONO_8_INTERLEAVED_AB_CD = 0xB2080001

int	MONO_10_INTERLEAVED_AB_CD = 0xB2100003

int	MONO_12_INTERLEAVED_AB_CD = 0xB2100005

int	MONO_10_PACKED_INTERLEAVED_AB_CD = 0xB20A0046

int	MONO_12_PACKED_INTERLEAVED_AB_CD = 0xB20C0047

int	MONO_10_GROUPED_40_IDS_INTERLEAVED_AB_CD = 0xB200000F

int	MONO_12_GROUPED_24_IDS_INTERLEAVED_AB_CD = 0xB200001F

int	MONO_10_AB = 0x81200022

int	BAYER_RG_10_AB = 0x81100003

int	BAYER_BG_10_AB = 0x81100004

int	BAYER_GR_10_AB = 0x81100005

int	BAYER_GB_10_AB = 0x81100006

int	MONO_12_AB = 0x81100007

int	BAYER_RG_12_AB = 0x81100008

int	BAYER_BG_12_AB = 0x81100009

int	BAYER_GR_12_AB = 0x8110000a

int	BAYER_GB_12_AB = 0x8110000b

int	MONO_8_AB = 0x8110000c

int	BAYER_RG_8_AB = 0x8110000d

int	BAYER_BG_8_AB = 0x8110000e

int	BAYER_GR_8_AB = 0x8110000f

int	BAYER_GB_8_AB = 0x81100010

int	MONO_8_ABCD = 0x81200011

int	MONO_10_ABCD = 0x81400012

int	MONO_12_ABCD = 0x81400013

Protected Member Functions
_PixelFormatMetadata	_metadata (self)

Detailed Description

Enum listing all supported pixel formats and their internal IDs.

Each enumerator represents a specific pixel layout and bit depth, used for interpreting raw image data correctly.

This class also offers methods to query characteristics of specific pixel formats, such as value ranges, storage sizes, and channel configurations.

Definition at line 97 of file pixelformat.py.

Member Function Documentation

◆ repr()

str __repr__ ( self )

Return an unambiguous string of the PixelFormat object.

Definition at line 273 of file pixelformat.py.

◆ str()

str __str__ ( self )

Return a human-readable string of the PixelFormat object.

Definition at line 266 of file pixelformat.py.

◆ _metadata()

_PixelFormatMetadata _metadata ( self )

protected

Definition at line 461 of file pixelformat.py.

◆ allocated_bits_per_pixel()

int allocated_bits_per_pixel ( self )

Returns the number of allocated bits per pixel.

Definition at line 335 of file pixelformat.py.

◆ channels()

Tuple[Channel, ...] channels ( self )

Returns the list of channels in the pixel format.

Definition at line 327 of file pixelformat.py.

◆ create_from_string_value()

PixelFormat create_from_string_value ( str string_value )

static

Definition at line 259 of file pixelformat.py.

◆ get_channel_index()

int get_channel_index	(		self,
		Channel	channel )

Returns the index of a specific channel within the pixel format.

Definition at line 438 of file pixelformat.py.

◆ get_size_in_bytes()

int get_size_in_bytes	(		self,
		Size	size )

Calculates the memory size in bytes for a given image size.

Definition at line 452 of file pixelformat.py.

◆ has_channel()

bool has_channel	(		self,
		Channel	channel )

Returns True if the pixel format has a specific channel.

Definition at line 445 of file pixelformat.py.

◆ has_intensity_channel()

bool has_intensity_channel ( self )

Returns True if the pixel format has an intensity channel.

Definition at line 351 of file pixelformat.py.

◆ is_float()

bool is_float ( self )

Definition at line 465 of file pixelformat.py.

◆ is_interleaved()

bool is_interleaved ( self )

Indicates whether the pixel format is interleaved.

Interleaved pixel formats arrange multiple image streams in memory using different patterns. The exact interleaving strategy depends on the pixel format family:

Mono*_A_B Images A and B alternate by row:

Memory row 1: Image A (row 1) Memory row 2: Image B (row 1) Memory row 3: Image A (row 2) Memory row 4: Image B (row 2) ...

Bayer*_A_B Images A and B are grouped in pairs of rows:

Memory row 1: Image A (row 1) Memory row 2: Image A (row 2) Memory row 3: Image B (row 1) Memory row 4: Image B (row 2) Memory row 5: Image A (row 3) Memory row 6: Image A (row 4) Memory row 7: Image B (row 3) Memory row 8: Image B (row 4) ...

Mono*_AB_CD Four image streams (A, B, C, D) are interleaved within each row:

Memory row 1: | A | B | A | B | A | B | Memory row 2: | C | D | C | D | C | D | Memory row 3: | A | B | A | B | A | B | Memory row 4: | C | D | C | D | C | D | ...

Returns: bool: True if the pixel format is interleaved, otherwise False.

Definition at line 383 of file pixelformat.py.

◆ is_packed()

bool is_packed ( self )

Returns True if the pixel format is packed.

Definition at line 375 of file pixelformat.py.

◆ is_single_channel()

bool is_single_channel ( self )

Returns True if the pixel format has only a single channel.

Definition at line 367 of file pixelformat.py.

◆ maximum_value_per_channel()

Union[int, float] maximum_value_per_channel ( self )

Returns the maximum possible value per channel for the pixel format.

Definition at line 292 of file pixelformat.py.

◆ minimum_value_per_channel()

Union[int, float] minimum_value_per_channel ( self )

Returns the minimum possible value per channel for the pixel format.

Definition at line 281 of file pixelformat.py.

◆ number_of_channels()

int number_of_channels ( self )

Returns the total number of channels in the pixel format.

Definition at line 359 of file pixelformat.py.

◆ numpy_dtype()

str numpy_dtype ( self )

Returns the numpy dtype string for this pixel format.

Definition at line 343 of file pixelformat.py.

◆ storage_bits_per_channel()

int storage_bits_per_channel ( self )

Returns the number of bits used per channel for storage.

Definition at line 303 of file pixelformat.py.

◆ storage_bits_per_pixel()

int storage_bits_per_pixel ( self )

Returns the total number of bits used per pixel for storage.

Definition at line 311 of file pixelformat.py.

◆ string_value()

str string_value ( self )

Returns the human-readable name of the pixel format.

Definition at line 319 of file pixelformat.py.

◆ unpacked_format()

PixelFormat unpacked_format ( self )

Returns the unpacked pixel format for a packed pixel format.

If the pixel format is already unpacked, the same format is returned.

Definition at line 429 of file pixelformat.py.

Field Documentation

◆ BAYER_BG_10

int BAYER_BG_10 = 0x0110000F

static

Definition at line 124 of file pixelformat.py.

◆ BAYER_BG_10_AB

int BAYER_BG_10_AB = 0x81100004

static

Definition at line 241 of file pixelformat.py.

◆ BAYER_BG_10_GROUPED_40_IDS

int BAYER_BG_10_GROUPED_40_IDS = 0x40000004

static

Definition at line 183 of file pixelformat.py.

◆ BAYER_BG_10_GROUPED_40_IDS_INTERLEAVED_A_B

int BAYER_BG_10_GROUPED_40_IDS_INTERLEAVED_A_B = 0x92000004

static

Definition at line 198 of file pixelformat.py.

◆ BAYER_BG_10_INTERLEAVED_A_B

int BAYER_BG_10_INTERLEAVED_A_B = 0x9210000F

static

Definition at line 213 of file pixelformat.py.

◆ BAYER_BG_10_PACKED

int BAYER_BG_10_PACKED = 0x010A0052

static

Definition at line 162 of file pixelformat.py.

◆ BAYER_BG_10_PACKED_INTERLEAVED_A_B

int BAYER_BG_10_PACKED_INTERLEAVED_A_B = 0x920A0052

static

Definition at line 223 of file pixelformat.py.

◆ BAYER_BG_12

int BAYER_BG_12 = 0x01100013

static

Definition at line 125 of file pixelformat.py.

◆ BAYER_BG_12_AB

int BAYER_BG_12_AB = 0x81100009

static

Definition at line 246 of file pixelformat.py.

◆ BAYER_BG_12_GROUPED_24_IDS

int BAYER_BG_12_GROUPED_24_IDS = 0x40000014

static

Definition at line 188 of file pixelformat.py.

◆ BAYER_BG_12_GROUPED_24_IDS_INTERLEAVED_A_B

int BAYER_BG_12_GROUPED_24_IDS_INTERLEAVED_A_B = 0x92000014

static

Definition at line 203 of file pixelformat.py.

◆ BAYER_BG_12_INTERLEAVED_A_B

int BAYER_BG_12_INTERLEAVED_A_B = 0x92100013

static

Definition at line 218 of file pixelformat.py.

◆ BAYER_BG_12_PACKED

int BAYER_BG_12_PACKED = 0x010C0053

static

Definition at line 163 of file pixelformat.py.

◆ BAYER_BG_12_PACKED_INTERLEAVED_A_B

int BAYER_BG_12_PACKED_INTERLEAVED_A_B = 0x920C0053

static

Definition at line 228 of file pixelformat.py.

◆ BAYER_BG_8

int BAYER_BG_8 = 0x0108000B

static

Definition at line 123 of file pixelformat.py.

◆ BAYER_BG_8_AB

int BAYER_BG_8_AB = 0x8110000e

static

Definition at line 251 of file pixelformat.py.

◆ BAYER_BG_8_INTERLEAVED_A_B

int BAYER_BG_8_INTERLEAVED_A_B = 0x9208000B

static

Definition at line 208 of file pixelformat.py.

◆ BAYER_GB_10

int BAYER_GB_10 = 0x0110000E

static

Definition at line 120 of file pixelformat.py.

◆ BAYER_GB_10_AB

int BAYER_GB_10_AB = 0x81100006

static

Definition at line 243 of file pixelformat.py.

◆ BAYER_GB_10_GROUPED_40_IDS

int BAYER_GB_10_GROUPED_40_IDS = 0x40000002

static

Definition at line 181 of file pixelformat.py.

◆ BAYER_GB_10_GROUPED_40_IDS_INTERLEAVED_A_B

int BAYER_GB_10_GROUPED_40_IDS_INTERLEAVED_A_B = 0x92000002

static

Definition at line 200 of file pixelformat.py.

◆ BAYER_GB_10_INTERLEAVED_A_B

int BAYER_GB_10_INTERLEAVED_A_B = 0x9210000E

static

Definition at line 215 of file pixelformat.py.

◆ BAYER_GB_10_PACKED

int BAYER_GB_10_PACKED = 0x010A0054

static

Definition at line 165 of file pixelformat.py.

◆ BAYER_GB_10_PACKED_INTERLEAVED_A_B

int BAYER_GB_10_PACKED_INTERLEAVED_A_B = 0x920A0054

static

Definition at line 225 of file pixelformat.py.

◆ BAYER_GB_12

int BAYER_GB_12 = 0x01100012

static

Definition at line 121 of file pixelformat.py.

◆ BAYER_GB_12_AB

int BAYER_GB_12_AB = 0x8110000b

static

Definition at line 248 of file pixelformat.py.

◆ BAYER_GB_12_GROUPED_24_IDS

int BAYER_GB_12_GROUPED_24_IDS = 0x40000012

static

Definition at line 186 of file pixelformat.py.

◆ BAYER_GB_12_GROUPED_24_IDS_INTERLEAVED_A_B

int BAYER_GB_12_GROUPED_24_IDS_INTERLEAVED_A_B = 0x92000012

static

Definition at line 205 of file pixelformat.py.

◆ BAYER_GB_12_INTERLEAVED_A_B

int BAYER_GB_12_INTERLEAVED_A_B = 0x92100012

static

Definition at line 220 of file pixelformat.py.

◆ BAYER_GB_12_PACKED

int BAYER_GB_12_PACKED = 0x010C0055

static

Definition at line 166 of file pixelformat.py.

◆ BAYER_GB_12_PACKED_INTERLEAVED_A_B

int BAYER_GB_12_PACKED_INTERLEAVED_A_B = 0x920C0055

static

Definition at line 230 of file pixelformat.py.

◆ BAYER_GB_8

int BAYER_GB_8 = 0x0108000A

static

Definition at line 119 of file pixelformat.py.

◆ BAYER_GB_8_AB

int BAYER_GB_8_AB = 0x81100010

static

Definition at line 253 of file pixelformat.py.

◆ BAYER_GB_8_INTERLEAVED_A_B

int BAYER_GB_8_INTERLEAVED_A_B = 0x9208000A

static

Definition at line 210 of file pixelformat.py.

◆ BAYER_GR_10

int BAYER_GR_10 = 0x0110000C

static

Definition at line 112 of file pixelformat.py.

◆ BAYER_GR_10_AB

int BAYER_GR_10_AB = 0x81100005

static

Definition at line 242 of file pixelformat.py.

◆ BAYER_GR_10_GROUPED_40_IDS

int BAYER_GR_10_GROUPED_40_IDS = 0x40000003

static

Definition at line 182 of file pixelformat.py.

◆ BAYER_GR_10_GROUPED_40_IDS_INTERLEAVED_A_B

int BAYER_GR_10_GROUPED_40_IDS_INTERLEAVED_A_B = 0x92000003

static

Definition at line 199 of file pixelformat.py.

◆ BAYER_GR_10_INTERLEAVED_A_B

int BAYER_GR_10_INTERLEAVED_A_B = 0x9210000C

static

Definition at line 214 of file pixelformat.py.

◆ BAYER_GR_10_PACKED

int BAYER_GR_10_PACKED = 0x010A0056

static

Definition at line 168 of file pixelformat.py.

◆ BAYER_GR_10_PACKED_INTERLEAVED_A_B

int BAYER_GR_10_PACKED_INTERLEAVED_A_B = 0x920A0056

static

Definition at line 224 of file pixelformat.py.

◆ BAYER_GR_12

int BAYER_GR_12 = 0x01100010

static

Definition at line 113 of file pixelformat.py.

◆ BAYER_GR_12_AB

int BAYER_GR_12_AB = 0x8110000a

static

Definition at line 247 of file pixelformat.py.

◆ BAYER_GR_12_GROUPED_24_IDS

int BAYER_GR_12_GROUPED_24_IDS = 0x40000013

static

Definition at line 187 of file pixelformat.py.

◆ BAYER_GR_12_GROUPED_24_IDS_INTERLEAVED_A_B

int BAYER_GR_12_GROUPED_24_IDS_INTERLEAVED_A_B = 0x92000013

static

Definition at line 204 of file pixelformat.py.

◆ BAYER_GR_12_INTERLEAVED_A_B

int BAYER_GR_12_INTERLEAVED_A_B = 0x92100010

static

Definition at line 219 of file pixelformat.py.

◆ BAYER_GR_12_PACKED

int BAYER_GR_12_PACKED = 0x010C0057

static

Definition at line 169 of file pixelformat.py.

◆ BAYER_GR_12_PACKED_INTERLEAVED_A_B

int BAYER_GR_12_PACKED_INTERLEAVED_A_B = 0x920C0057

static

Definition at line 229 of file pixelformat.py.

◆ BAYER_GR_8

int BAYER_GR_8 = 0x01080008

static

Definition at line 111 of file pixelformat.py.

◆ BAYER_GR_8_AB

int BAYER_GR_8_AB = 0x8110000f

static

Definition at line 252 of file pixelformat.py.

◆ BAYER_GR_8_INTERLEAVED_A_B

int BAYER_GR_8_INTERLEAVED_A_B = 0x92080008

static

Definition at line 209 of file pixelformat.py.

◆ BAYER_RG_10

int BAYER_RG_10 = 0x0110000D

static

Definition at line 116 of file pixelformat.py.

◆ BAYER_RG_10_AB

int BAYER_RG_10_AB = 0x81100003

static

Definition at line 240 of file pixelformat.py.

◆ BAYER_RG_10_GROUPED_40_IDS

int BAYER_RG_10_GROUPED_40_IDS = 0x40000001

static

Definition at line 180 of file pixelformat.py.

◆ BAYER_RG_10_GROUPED_40_IDS_INTERLEAVED_A_B

int BAYER_RG_10_GROUPED_40_IDS_INTERLEAVED_A_B = 0x92000001

static

Definition at line 197 of file pixelformat.py.

◆ BAYER_RG_10_INTERLEAVED_A_B

int BAYER_RG_10_INTERLEAVED_A_B = 0x9210000D

static

Definition at line 212 of file pixelformat.py.

◆ BAYER_RG_10_PACKED

int BAYER_RG_10_PACKED = 0x010A0058

static

Definition at line 171 of file pixelformat.py.

◆ BAYER_RG_10_PACKED_INTERLEAVED_A_B

int BAYER_RG_10_PACKED_INTERLEAVED_A_B = 0x920A0058

static

Definition at line 222 of file pixelformat.py.

◆ BAYER_RG_12

int BAYER_RG_12 = 0x01100011

static

Definition at line 117 of file pixelformat.py.

◆ BAYER_RG_12_AB

int BAYER_RG_12_AB = 0x81100008

static

Definition at line 245 of file pixelformat.py.

◆ BAYER_RG_12_GROUPED_24_IDS

int BAYER_RG_12_GROUPED_24_IDS = 0x40000011

static

Definition at line 185 of file pixelformat.py.

◆ BAYER_RG_12_GROUPED_24_IDS_INTERLEAVED_A_B

int BAYER_RG_12_GROUPED_24_IDS_INTERLEAVED_A_B = 0x92000011

static

Definition at line 202 of file pixelformat.py.

◆ BAYER_RG_12_INTERLEAVED_A_B

int BAYER_RG_12_INTERLEAVED_A_B = 0x92100011

static

Definition at line 217 of file pixelformat.py.

◆ BAYER_RG_12_PACKED

int BAYER_RG_12_PACKED = 0x010C0059

static

Definition at line 172 of file pixelformat.py.

◆ BAYER_RG_12_PACKED_INTERLEAVED_A_B

int BAYER_RG_12_PACKED_INTERLEAVED_A_B = 0x920C0059

static

Definition at line 227 of file pixelformat.py.

◆ BAYER_RG_8

int BAYER_RG_8 = 0x01080009

static

Definition at line 115 of file pixelformat.py.

◆ BAYER_RG_8_AB

int BAYER_RG_8_AB = 0x8110000d

static

Definition at line 250 of file pixelformat.py.

◆ BAYER_RG_8_INTERLEAVED_A_B

int BAYER_RG_8_INTERLEAVED_A_B = 0x92080009

static

Definition at line 207 of file pixelformat.py.

◆ BGR_10

int BGR_10 = 0x02300019

static

Definition at line 151 of file pixelformat.py.

◆ BGR_10_PACKED_32

int BGR_10_PACKED_32 = 0x0220001E

static

Definition at line 178 of file pixelformat.py.

◆ BGR_12

int BGR_12 = 0x0230001B

static

Definition at line 152 of file pixelformat.py.

◆ BGR_8

int BGR_8 = 0x02180015

static

Definition at line 150 of file pixelformat.py.

◆ BGRA_10

int BGRA_10 = 0x0240004C

static

Definition at line 159 of file pixelformat.py.

◆ BGRA_12

int BGRA_12 = 0x0240004E

static

Definition at line 160 of file pixelformat.py.

◆ BGRA_8

int BGRA_8 = 0x02200017

static

Definition at line 158 of file pixelformat.py.

◆ channels

channels

Definition at line 364 of file pixelformat.py.

◆ CONFIDENCE_16

int CONFIDENCE_16 = 0x011000C7

static

Definition at line 133 of file pixelformat.py.

◆ CONFIDENCE_8

int CONFIDENCE_8 = 0x010800C6

static

Definition at line 132 of file pixelformat.py.

◆ COORD3D_ABC32F

int COORD3D_ABC32F = 0x026000C0

static

Definition at line 139 of file pixelformat.py.

◆ COORD3D_C16

int COORD3D_C16 = 0x011000B8

static

Definition at line 136 of file pixelformat.py.

◆ COORD3D_C32F

int COORD3D_C32F = 0x012000BF

static

Definition at line 137 of file pixelformat.py.

◆ COORD3D_C8

int COORD3D_C8 = 0x010800B1

static

Definition at line 135 of file pixelformat.py.

◆ is_float

is_float

Definition at line 286 of file pixelformat.py.

◆ MONO_10

int MONO_10 = 0x01100003

static

Definition at line 128 of file pixelformat.py.

◆ MONO_10_AB

int MONO_10_AB = 0x81200022

static

Definition at line 239 of file pixelformat.py.

◆ MONO_10_ABCD

int MONO_10_ABCD = 0x81400012

static

Definition at line 255 of file pixelformat.py.

◆ MONO_10_GROUPED_40_IDS

int MONO_10_GROUPED_40_IDS = 0x4000000f

static

Definition at line 190 of file pixelformat.py.

◆ MONO_10_GROUPED_40_IDS_INTERLEAVED_A_B

int MONO_10_GROUPED_40_IDS_INTERLEAVED_A_B = 0x9200000F

static

Definition at line 196 of file pixelformat.py.

◆ MONO_10_GROUPED_40_IDS_INTERLEAVED_AB_CD

int MONO_10_GROUPED_40_IDS_INTERLEAVED_AB_CD = 0xB200000F

static

Definition at line 236 of file pixelformat.py.

◆ MONO_10_INTERLEAVED_A_B

int MONO_10_INTERLEAVED_A_B = 0x92100003

static

Definition at line 211 of file pixelformat.py.

◆ MONO_10_INTERLEAVED_AB_CD

int MONO_10_INTERLEAVED_AB_CD = 0xB2100003

static

Definition at line 232 of file pixelformat.py.

◆ MONO_10_PACKED

int MONO_10_PACKED = 0x010A0046

static

Definition at line 174 of file pixelformat.py.

◆ MONO_10_PACKED_INTERLEAVED_A_B

int MONO_10_PACKED_INTERLEAVED_A_B = 0x920A0046

static

Definition at line 221 of file pixelformat.py.

◆ MONO_10_PACKED_INTERLEAVED_AB_CD

int MONO_10_PACKED_INTERLEAVED_AB_CD = 0xB20A0046

static

Definition at line 234 of file pixelformat.py.

◆ MONO_12

int MONO_12 = 0x01100005

static

Definition at line 129 of file pixelformat.py.

◆ MONO_12_AB

int MONO_12_AB = 0x81100007

static

Definition at line 244 of file pixelformat.py.

◆ MONO_12_ABCD

int MONO_12_ABCD = 0x81400013

static

Definition at line 256 of file pixelformat.py.

◆ MONO_12_GROUPED_24_IDS

int MONO_12_GROUPED_24_IDS = 0x4000001f

static

Definition at line 191 of file pixelformat.py.

◆ MONO_12_GROUPED_24_IDS_INTERLEAVED_A_B

int MONO_12_GROUPED_24_IDS_INTERLEAVED_A_B = 0x9200001F

static

Definition at line 201 of file pixelformat.py.

◆ MONO_12_GROUPED_24_IDS_INTERLEAVED_AB_CD

int MONO_12_GROUPED_24_IDS_INTERLEAVED_AB_CD = 0xB200001F

static

Definition at line 237 of file pixelformat.py.

◆ MONO_12_INTERLEAVED_A_B

int MONO_12_INTERLEAVED_A_B = 0x92100005

static

Definition at line 216 of file pixelformat.py.

◆ MONO_12_INTERLEAVED_AB_CD

int MONO_12_INTERLEAVED_AB_CD = 0xB2100005

static

Definition at line 233 of file pixelformat.py.

◆ MONO_12_PACKED

int MONO_12_PACKED = 0x010C0047

static

Definition at line 175 of file pixelformat.py.

◆ MONO_12_PACKED_INTERLEAVED_A_B

int MONO_12_PACKED_INTERLEAVED_A_B = 0x920C0047

static

Definition at line 226 of file pixelformat.py.

◆ MONO_12_PACKED_INTERLEAVED_AB_CD

int MONO_12_PACKED_INTERLEAVED_AB_CD = 0xB20C0047

static

Definition at line 235 of file pixelformat.py.

◆ MONO_16

int MONO_16 = 0x01100007

static

Definition at line 130 of file pixelformat.py.

◆ MONO_32F_IDS

int MONO_32F_IDS = 0x81200020

static

Definition at line 193 of file pixelformat.py.

◆ MONO_8

int MONO_8 = 0x01080001

static

Definition at line 127 of file pixelformat.py.

◆ MONO_8_AB

int MONO_8_AB = 0x8110000c

static

Definition at line 249 of file pixelformat.py.

◆ MONO_8_ABCD

int MONO_8_ABCD = 0x81200011

static

Definition at line 254 of file pixelformat.py.

◆ MONO_8_INTERLEAVED_A_B

int MONO_8_INTERLEAVED_A_B = 0x92080001

static

Definition at line 206 of file pixelformat.py.

◆ MONO_8_INTERLEAVED_AB_CD

int MONO_8_INTERLEAVED_AB_CD = 0xB2080001

static

Definition at line 231 of file pixelformat.py.

◆ RGB_10

int RGB_10 = 0x02300018

static

Definition at line 147 of file pixelformat.py.

◆ RGB_10_PACKED_32

int RGB_10_PACKED_32 = 0x0220001D

static

Definition at line 177 of file pixelformat.py.

◆ RGB_12

int RGB_12 = 0x0230001A

static

Definition at line 148 of file pixelformat.py.

◆ RGB_32F_IDS

int RGB_32F_IDS = 0x82600021

static

Definition at line 194 of file pixelformat.py.

◆ RGB_8

int RGB_8 = 0x02180014

static

Definition at line 146 of file pixelformat.py.

◆ RGBA_10

int RGBA_10 = 0x0240005F

static

Definition at line 155 of file pixelformat.py.

◆ RGBA_12

int RGBA_12 = 0x02400061

static

Definition at line 156 of file pixelformat.py.

◆ RGBA_8

int RGBA_8 = 0x02200016

static

Definition at line 154 of file pixelformat.py.

◆ YUV420_8_YY_UV_SEMIPLANAR_IDS

int YUV420_8_YY_UV_SEMIPLANAR_IDS = 0x420C0001

static

Definition at line 141 of file pixelformat.py.

◆ YUV420_8_YY_VU_SEMIPLANAR_IDS

int YUV420_8_YY_VU_SEMIPLANAR_IDS = 0x420C0002

static

Definition at line 142 of file pixelformat.py.

◆ YUV422_8_UYVY

int YUV422_8_UYVY = 0x0210001F

static

Definition at line 144 of file pixelformat.py.

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ __repr__()

◆ __str__()

◆ _metadata()

◆ allocated_bits_per_pixel()

◆ channels()

◆ create_from_string_value()

◆ get_channel_index()

◆ get_size_in_bytes()

◆ has_channel()

◆ has_intensity_channel()

◆ is_float()

◆ is_interleaved()

◆ is_packed()

◆ is_single_channel()

◆ maximum_value_per_channel()

◆ minimum_value_per_channel()

◆ number_of_channels()

◆ numpy_dtype()

◆ storage_bits_per_channel()

◆ storage_bits_per_pixel()

◆ string_value()

◆ unpacked_format()

Field Documentation

◆ BAYER_BG_10

◆ BAYER_BG_10_AB

◆ BAYER_BG_10_GROUPED_40_IDS

◆ BAYER_BG_10_GROUPED_40_IDS_INTERLEAVED_A_B

◆ BAYER_BG_10_INTERLEAVED_A_B

◆ BAYER_BG_10_PACKED

◆ BAYER_BG_10_PACKED_INTERLEAVED_A_B

◆ BAYER_BG_12

◆ BAYER_BG_12_AB

◆ BAYER_BG_12_GROUPED_24_IDS

◆ BAYER_BG_12_GROUPED_24_IDS_INTERLEAVED_A_B

◆ BAYER_BG_12_INTERLEAVED_A_B

◆ BAYER_BG_12_PACKED

◆ BAYER_BG_12_PACKED_INTERLEAVED_A_B

◆ BAYER_BG_8

◆ BAYER_BG_8_AB

◆ BAYER_BG_8_INTERLEAVED_A_B

◆ BAYER_GB_10

◆ BAYER_GB_10_AB

◆ BAYER_GB_10_GROUPED_40_IDS

◆ BAYER_GB_10_GROUPED_40_IDS_INTERLEAVED_A_B

◆ BAYER_GB_10_INTERLEAVED_A_B

◆ BAYER_GB_10_PACKED

◆ BAYER_GB_10_PACKED_INTERLEAVED_A_B

◆ BAYER_GB_12

◆ BAYER_GB_12_AB

◆ BAYER_GB_12_GROUPED_24_IDS

◆ BAYER_GB_12_GROUPED_24_IDS_INTERLEAVED_A_B

◆ BAYER_GB_12_INTERLEAVED_A_B

◆ BAYER_GB_12_PACKED

◆ BAYER_GB_12_PACKED_INTERLEAVED_A_B

◆ BAYER_GB_8

◆ BAYER_GB_8_AB

◆ BAYER_GB_8_INTERLEAVED_A_B

◆ BAYER_GR_10

◆ BAYER_GR_10_AB

◆ BAYER_GR_10_GROUPED_40_IDS

◆ BAYER_GR_10_GROUPED_40_IDS_INTERLEAVED_A_B

◆ BAYER_GR_10_INTERLEAVED_A_B

◆ BAYER_GR_10_PACKED

◆ BAYER_GR_10_PACKED_INTERLEAVED_A_B

◆ BAYER_GR_12

◆ BAYER_GR_12_AB

◆ BAYER_GR_12_GROUPED_24_IDS

◆ BAYER_GR_12_GROUPED_24_IDS_INTERLEAVED_A_B

◆ BAYER_GR_12_INTERLEAVED_A_B

◆ BAYER_GR_12_PACKED

◆ BAYER_GR_12_PACKED_INTERLEAVED_A_B

◆ BAYER_GR_8

◆ BAYER_GR_8_AB

◆ repr()

◆ str()