PixelFormatInfo Class Reference

#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>
T	GetMinimumValuePerChannel () const
	Returns the minimum possible value per channel for the pixel format.
template<typename T = size_t>
T	GetMaximumValuePerChannel () const
	Returns the maximum possible value per channel for the pixel format.
size_t	GetStorageBitsPerPixel () const
	Returns the total number of bits used per pixel for storage.
size_t	GetStorageBitsPerChannel () const
	Returns the number of bits used per channel for storage.
std::string	GetName () const
	Returns the human-readable name of the pixel format.
std::vector< Channel >	GetChannels () const
	Returns the list of channels in the pixel format.
size_t	GetAllocatedBitsPerPixel () const
	Returns the number of allocated bits per pixel.
bool	HasIntensityChannel () const
	Checks whether the pixel format includes an intensity channel.
size_t	GetChannelIndex (Channel channel) const
	Returns the index of a specific channel within the pixel format.
size_t	GetNumberOfChannels () const
	Returns the total number of channels in the pixel format.
bool	IsSingleChannel () const
	Checks whether the pixel format contains only a single channel.
bool	HasChannel (Channel channel) const
	Checks whether a specific channel is present in the pixel format.
peak::common::PixelFormat	GetPixelFormat () const
	Returns the underlying pixel format enumeration value.
size_t	GetSizeInBytes (const Size &size) const
	Calculates the memory size in bytes for a given image size.
template<>
float	GetMaximumValuePerChannel () const
	Returns the maximum representable value per channel for floating-point pixel formats.
template<>
size_t	GetMaximumValuePerChannel () const
	Returns the maximum representable value per channel for integer pixel formats.
template<>
float	GetMinimumValuePerChannel () const
	Returns the minimum representable value per channel for floating-point pixel formats.
template<>
size_t	GetMinimumValuePerChannel () const
	Returns the minimum representable value per channel for integer pixel formats.

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

Definition at line 140 of file peak_common_pixel_format.hpp.

Constructor & Destructor Documentation

PixelFormatInfo() [1/2]

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

Definition at line 1616 of file peak_common_pixel_format.hpp.

PixelFormatInfo() [2/2]

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

Definition at line 1620 of file peak_common_pixel_format.hpp.

Member Function Documentation

GetAllocatedBitsPerPixel()

size_t GetAllocatedBitsPerPixel ( ) const

inline

Returns the number of allocated bits per pixel.

Returns

Number of allocated bits per pixel.

Since

ids_peak_common 1.0

Definition at line 2566 of file peak_common_pixel_format.hpp.

GetChannelIndex()

size_t 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

Definition at line 2700 of file peak_common_pixel_format.hpp.

GetChannels()

std::vector< Channel > 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

Definition at line 2437 of file peak_common_pixel_format.hpp.

GetMaximumValuePerChannel() [1/3]

template<typename T = size_t>

T 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

GetMaximumValuePerChannel() [2/3]

template<>

float GetMaximumValuePerChannel ( ) const

inline

Returns the maximum representable value per channel for floating-point pixel formats.

This specialization of GetMaximumValuePerChannel for float retrieves the predefined maximum value per channel for supported 32-bit floating-point pixel formats.

Returns

The maximum channel value as a float.

Exceptions

InvalidParameterException

if the current pixel format is not a 32-bit float type. In such cases, use size_t as the template argument instead.

Since

ids_peak_common 1.0

Definition at line 1706 of file peak_common_pixel_format.hpp.

GetMaximumValuePerChannel() [3/3]

template<>

size_t GetMaximumValuePerChannel ( ) const

inline

Returns the maximum representable value per channel for integer pixel formats.

This specialization of GetMaximumValuePerChannel for size_t retrieves the predefined maximum value per channel for supported integer-based pixel formats.

Returns

The maximum channel value as a size_t.

Exceptions

InvalidParameterException

if the current pixel format is not an integer type.

Since

ids_peak_common 1.0

Definition at line 1733 of file peak_common_pixel_format.hpp.

GetMinimumValuePerChannel() [1/3]

template<typename T = size_t>

T 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

GetMinimumValuePerChannel() [2/3]

template<>

float GetMinimumValuePerChannel ( ) const

inline

Returns the minimum representable value per channel for floating-point pixel formats.

This specialization of GetMinimumValuePerChannel for float retrieves the predefined minimum value per channel for supported 32-bit floating-point pixel formats.

Returns

The minimum channel value as a float.

Exceptions

InvalidParameterException

if the current pixel format is not a 32-bit float type. In such cases, use size_t as the template argument instead.

Since

ids_peak_common 1.0

Definition at line 1885 of file peak_common_pixel_format.hpp.

GetMinimumValuePerChannel() [3/3]

template<>

size_t GetMinimumValuePerChannel ( ) const

inline

Returns the minimum representable value per channel for integer pixel formats.

This specialization of GetMinimumValuePerChannel for size_t retrieves the predefined minimum value per channel for supported integer-based pixel formats.

Returns

The minimum channel value as a size_t.

Exceptions

InvalidParameterException

if the current pixel format is not an integer type.

Since

ids_peak_common 1.0

Definition at line 1912 of file peak_common_pixel_format.hpp.

GetName()

std::string GetName ( ) const

inline

Returns the human-readable name of the pixel format.

Returns

Name of the pixel format.

Since

ids_peak_common 1.0

Definition at line 2308 of file peak_common_pixel_format.hpp.

GetNumberOfChannels()

size_t GetNumberOfChannels ( ) const

inline

Returns the total number of channels in the pixel format.

Returns

Number of channels.

Since

ids_peak_common 1.0

Definition at line 2712 of file peak_common_pixel_format.hpp.

GetPixelFormat()

peak::common::PixelFormat GetPixelFormat ( ) const

inline

Returns the underlying pixel format enumeration value.

Returns

The pixel format.

Since

ids_peak_common 1.0

Definition at line 2728 of file peak_common_pixel_format.hpp.

GetSizeInBytes()

size_t 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

Definition at line 2733 of file peak_common_pixel_format.hpp.

GetStorageBitsPerChannel()

size_t 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

Definition at line 2179 of file peak_common_pixel_format.hpp.

GetStorageBitsPerPixel()

size_t 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

Definition at line 2050 of file peak_common_pixel_format.hpp.

HasChannel()

bool 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

Definition at line 2722 of file peak_common_pixel_format.hpp.

HasIntensityChannel()

bool 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

Definition at line 2695 of file peak_common_pixel_format.hpp.

IsSingleChannel()

bool 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

Definition at line 2717 of file peak_common_pixel_format.hpp.