peak::common::PixelFormatInfo Class Reference

Provides information and utility functions for pixel formats. More...

#include <peak_common/types/peak_common_pixel_format.hpp>

Public Member Functions
	PixelFormatInfo (peak::common::PixelFormat pixelFormat)
	Constructs a PixelFormatInfo object for the specified pixel format.
	PixelFormatInfo (const std::string &name)
	Constructs a PixelFormatInfo object from the name of a pixel format.
template<typename T = size_t>
PEAK_COMMON_NO_DISCARD T	GetMinimumValuePerChannel () const
	Returns the minimum possible value per channel for the pixel format.
template<typename T = size_t>
PEAK_COMMON_NO_DISCARD T	GetMaximumValuePerChannel () const
	Returns the maximum possible value per channel for the pixel format.
PEAK_COMMON_NO_DISCARD size_t	GetStorageBitsPerPixel () const
	Returns the total number of bits used per pixel for storage.
PEAK_COMMON_NO_DISCARD size_t	GetStorageBitsPerChannel () const
	Returns the number of bits used per channel for storage.
PEAK_COMMON_NO_DISCARD std::string	GetName () const
	Returns the human-readable name of the pixel format.
PEAK_COMMON_NO_DISCARD std::vector< Channel >	GetChannels () const
	Returns the list of channels in the pixel format.
PEAK_COMMON_NO_DISCARD size_t	GetAllocatedBitsPerPixel () const
	Returns the number of allocated bits per pixel.
PEAK_COMMON_NO_DISCARD bool	HasIntensityChannel () const
	Checks whether the pixel format includes an intensity channel.
PEAK_COMMON_NO_DISCARD size_t	GetChannelIndex (Channel channel) const
	Returns the index of a specific channel within the pixel format.
PEAK_COMMON_NO_DISCARD size_t	GetNumberOfChannels () const
	Returns the total number of channels in the pixel format.
PEAK_COMMON_NO_DISCARD bool	IsSingleChannel () const
	Checks whether the pixel format contains only a single channel.
PEAK_COMMON_NO_DISCARD bool	HasChannel (Channel channel) const
	Checks whether a specific channel is present in the pixel format.
PEAK_COMMON_NO_DISCARD peak::common::PixelFormat	GetPixelFormat () const
	Returns the underlying pixel format enumeration value.
PEAK_COMMON_NO_DISCARD size_t	GetSizeInBytes (const Size &size) const
	Calculates the memory size in bytes for a given image size.
PEAK_COMMON_NO_DISCARD bool	IsPacked () const
	Returns whether the pixel format is packed.
PEAK_COMMON_NO_DISCARD bool	IsInterleaved () const
	Indicates whether the pixel format is interleaved.
PEAK_COMMON_NO_DISCARD bool	IsFloat () const
	Returns whether the pixel format uses floating points.
PEAK_COMMON_NO_DISCARD PixelFormat	GetUnpackedPixelFormat () const
	Returns the unpacked pixel format for a packed pixel format.
template<typename T>
T	GetMinimumValuePerChannel () const
template<typename T>
T	GetMaximumValuePerChannel () const
template<>
size_t	GetMinimumValuePerChannel () const
template<>
float	GetMinimumValuePerChannel () const
template<>
size_t	GetMaximumValuePerChannel () const
template<>
float	GetMaximumValuePerChannel () const

Detailed Description

Provides information and utility functions for pixel formats.

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

Since

ids_peak_common 1.0

Constructor & Destructor Documentation

PixelFormatInfo() [1/2]

peak::common::PixelFormatInfo::PixelFormatInfo ( peak::common::PixelFormat pixelFormat )

inlineexplicit

Constructs a PixelFormatInfo object for the specified pixel format.

Parameters

pixelFormat

The pixel format to describe.

Since

ids_peak_common 1.0

PixelFormatInfo() [2/2]

peak::common::PixelFormatInfo::PixelFormatInfo ( const std::string & name )

inlineexplicit

Constructs a PixelFormatInfo object from the name of a pixel format.

Parameters

name	The name of the pixel format.

Since

ids_peak_common 1.0

Member Function Documentation

GetAllocatedBitsPerPixel()

size_t peak::common::PixelFormatInfo::GetAllocatedBitsPerPixel ( ) const

inline

Returns the number of allocated bits per pixel.

Returns

Number of allocated bits per pixel.

Since

ids_peak_common 1.0

GetChannelIndex()

size_t peak::common::PixelFormatInfo::GetChannelIndex ( Channel channel ) const

inline

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

Parameters

channel

The channel to locate.

Returns

The zero-based index of the channel.

Since

ids_peak_common 1.0

GetChannels()

std::vector< Channel > peak::common::PixelFormatInfo::GetChannels ( ) const

inline

Returns the list of channels in the pixel format.

Returns

A vector containing the channels present in the pixel format.

Since

ids_peak_common 1.0

GetMaximumValuePerChannel() [1/4]

template<typename T>

T peak::common::PixelFormatInfo::GetMaximumValuePerChannel

(

)

const

GetMaximumValuePerChannel() [2/4]

template<>

size_t peak::common::PixelFormatInfo::GetMaximumValuePerChannel ( ) const

inline

GetMaximumValuePerChannel() [3/4]

template<>

float peak::common::PixelFormatInfo::GetMaximumValuePerChannel ( ) const

inline

GetMaximumValuePerChannel() [4/4]

template<typename T = size_t>

PEAK_COMMON_NO_DISCARD T peak::common::PixelFormatInfo::GetMaximumValuePerChannel

(

)

const

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

Template Parameters

T	The value type (default is size_t).

Returns

The maximum value per channel.

Since

ids_peak_common 1.0

GetMinimumValuePerChannel() [1/4]

template<typename T>

T peak::common::PixelFormatInfo::GetMinimumValuePerChannel

(

)

const

GetMinimumValuePerChannel() [2/4]

template<>

size_t peak::common::PixelFormatInfo::GetMinimumValuePerChannel ( ) const

inline

GetMinimumValuePerChannel() [3/4]

template<>

float peak::common::PixelFormatInfo::GetMinimumValuePerChannel ( ) const

inline

GetMinimumValuePerChannel() [4/4]

template<typename T = size_t>

PEAK_COMMON_NO_DISCARD T peak::common::PixelFormatInfo::GetMinimumValuePerChannel

(

)

const

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

Template Parameters

T	The value type (default is size_t).

Returns

The minimum value per channel.

Since

ids_peak_common 1.0

GetName()

std::string peak::common::PixelFormatInfo::GetName ( ) const

inline

Returns the human-readable name of the pixel format.

Returns

Name of the pixel format.

Since

ids_peak_common 1.0

GetNumberOfChannels()

size_t peak::common::PixelFormatInfo::GetNumberOfChannels ( ) const

inline

Returns the total number of channels in the pixel format.

Returns

Number of channels.

Since

ids_peak_common 1.0

GetPixelFormat()

peak::common::PixelFormat peak::common::PixelFormatInfo::GetPixelFormat ( ) const

inline

Returns the underlying pixel format enumeration value.

Returns

The pixel format.

Since

ids_peak_common 1.0

GetSizeInBytes()

size_t peak::common::PixelFormatInfo::GetSizeInBytes ( const Size & size ) const

inline

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

Parameters

size	The size of the image.

Returns

The total memory size in bytes.

Since

ids_peak_common 1.0

GetStorageBitsPerChannel()

size_t peak::common::PixelFormatInfo::GetStorageBitsPerChannel ( ) const

inline

Returns the number of bits used per channel for storage.

Returns

Bits per channel used for storage.

Since

ids_peak_common 1.0

GetStorageBitsPerPixel()

size_t peak::common::PixelFormatInfo::GetStorageBitsPerPixel ( ) const

inline

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

Returns

Bits per pixel used for storage.

Since

ids_peak_common 1.0

GetUnpackedPixelFormat()

PixelFormat peak::common::PixelFormatInfo::GetUnpackedPixelFormat ( ) const

inline

Returns the unpacked pixel format for a packed pixel format.

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

Returns

An unpacked pixel format

Since

ids_peak_common 1.1

HasChannel()

bool peak::common::PixelFormatInfo::HasChannel ( Channel channel ) const

inline

Checks whether a specific channel is present in the pixel format.

Parameters

channel

The channel to check for.

Returns

True if the channel exists in the pixel format, false otherwise.

Since

ids_peak_common 1.0

HasIntensityChannel()

bool peak::common::PixelFormatInfo::HasIntensityChannel ( ) const

inline

Checks whether the pixel format includes an intensity channel.

Returns

True if an intensity channel is present, false otherwise.

Since

ids_peak_common 1.0

IsFloat()

bool peak::common::PixelFormatInfo::IsFloat ( ) const

inline

Returns whether the pixel format uses floating points.

Returns

Bool whether format uses floating points

Since

ids_peak_common 1.1

IsInterleaved()

bool peak::common::PixelFormatInfo::IsInterleaved ( ) const

inline

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 | ...

Since

ids_peak_common 1.2

IsPacked()

bool peak::common::PixelFormatInfo::IsPacked ( ) const

inline

Returns whether the pixel format is packed.

Returns

Bool whether format is packed

Since

ids_peak_common 1.1

IsSingleChannel()

bool peak::common::PixelFormatInfo::IsSingleChannel ( ) const

inline

Checks whether the pixel format contains only a single channel.

Returns

True if the pixel format is single-channel, false otherwise.

Since

ids_peak_common 1.0

---

The documentation for this class was generated from the following files:

• peak_common/types/peak_common_pixel_format.hpp
• peak_common/types/detail/peak_common_pixel_format.ipp
• peak_common/types/detail/peak_common_pixel_format_info.ipp