peak::pipeline Namespace Reference

Namespaces
namespace	detail
namespace	features
namespace	modules
	Interface definitions and implementations for individual module types used within a pipeline.

Data Structures
class	ColorCorrectionMatrix
	Color correction matrix. More...
class	DefaultPipeline
	Image processing pipeline for sequential transformation of raw image frames. More...
class	IPipeline
	Interface defining the structure and behavior of a processing pipeline. More...
class	PipelineBase
	Base class for implementing a custom pipeline. More...

Enumerations
enum class	BinningMode {   Average = 0 ,   Sum = 1 }
	Mode parameter for the binning algorithm. More...
enum class	ChromaticAdaptionAlgorithm {   Legacy = PEAK_ICV_CHROMATIC_ADAPTION_ALGORITHM_LEGACY ,   Bradford = PEAK_ICV_CHROMATIC_ADAPTION_ALGORITHM_BRADFORD }
	Algorithm used for chromatic adaption. More...
enum class	ColorSpace {   SRGB_D50 = PEAK_ICV_COLOR_SPACE_SRGB_D50 ,   SRGB_D65 = PEAK_ICV_COLOR_SPACE_SRGB_D65 ,   CIE_RGB_E = PEAK_ICV_COLOR_SPACE_CIE_RGB_E ,   ECI_RGB_D50 = PEAK_ICV_COLOR_SPACE_ECI_RGB_D50 ,   Adobe_RGB_D65 = PEAK_ICV_COLOR_SPACE_ADOBE_RGB_D65 }
	Color spaces supported by the chromatic adaptation feature. More...
enum class	DebayerChannelLayout {   RGB = 0 ,   BGR ,   RGBA ,   BGRA }
	Specifies the channel layout used by the debayer module in image processing pipelines. More...
enum class	ProcessingPolicy {   Fast ,   Balanced ,   Enhanced }
	Specifies the processing policy. More...
enum class	Rotation {   None = 0 ,   Degree90Counterclockwise = 90 ,   Degree180 = 180 ,   Degree90Clockwise = 270 }
	Angle parameter for the rotation algorithm. More...

Functions
std::string	ToString (BinningMode mode)
	Converts a BinningMode enum value to its string representation.
std::ostream &	operator<< (std::ostream &os, BinningMode mode)
	Stream output operator for BinningMode enum.
std::string	ToString (ChromaticAdaptionAlgorithm algorithm)
	Converts an ChromaticAdaptionAlgorithm enum value to its string representation.
std::ostream &	operator<< (std::ostream &os, ChromaticAdaptionAlgorithm algorithm)
std::string	ToString (const ColorCorrectionMatrix &matrix)
	Converts a ColorCorrectionMatrix to its string representation.
std::string	ToString (ColorSpace colorSpace)
	Converts a ColorSpace enum value to its string representation.
std::ostream &	operator<< (std::ostream &os, ColorSpace colorSpace)
std::string	ToString (DebayerChannelLayout layout)
	Converts a DebayerChannelLayout enum value to its string representation.
std::ostream &	operator<< (std::ostream &os, DebayerChannelLayout layout)
	Stream output operator for DebayerChannelLayout enum.
std::string	ToString (ProcessingPolicy policy)
	Converts a ProcessingPolicy enum value to its string representation.
std::ostream &	operator<< (std::ostream &os, ProcessingPolicy policy)
	Stream output operator for ProcessingPolicy enum.
std::string	ToString (Rotation rotation)
	Converts a Rotation enum value to its string representation.
std::ostream &	operator<< (std::ostream &os, Rotation rotation)
	Stream output operator for Rotation enum.

Detailed Description

Interfaces and implementations for defining and controlling data processing pipelines.

This namespace contains the core interfaces, types, and their implementations for creating and managing pipelines that process input data through a sequence of configurable modules to produce output. It provides foundational building blocks for pipeline configuration, execution, and lifecycle management.

All pipeline-related implementations and interface definitions reside in this namespace.

Since

ids_peak_common 1.0

Function Documentation

operator<<() [1/6]

std::ostream & operator<< ( std::ostream & os, BinningMode mode )

inline

Stream output operator for BinningMode enum.

Parameters

os	The output stream.
mode	The binning mode value to output.

Returns

Reference to the output stream.

Since

ids_peak_icv 1.0

operator<<() [2/6]

std::ostream & operator<< ( std::ostream & os, ChromaticAdaptionAlgorithm algorithm )

inline

operator<<() [3/6]

std::ostream & operator<< ( std::ostream & os, ColorSpace colorSpace )

inline

operator<<() [4/6]

std::ostream & operator<< ( std::ostream & os, DebayerChannelLayout layout )

inline

Stream output operator for DebayerChannelLayout enum.

Parameters

os	The output stream.
layout	The debayer channel layout value to output.

Returns

Reference to the output stream.

Since

ids_peak_icv 1.0

operator<<() [5/6]

std::ostream & operator<< ( std::ostream & os, ProcessingPolicy policy )

inline

Stream output operator for ProcessingPolicy enum.

Parameters

os	The output stream.
policy	The processing policy value to output.

Returns

Reference to the output stream.

Since

ids_peak_icv 1.0

operator<<() [6/6]

std::ostream & operator<< ( std::ostream & os, Rotation rotation )

inline

Stream output operator for Rotation enum.

Parameters

os	The output stream.
rotation	The rotation value to output.

Returns

Reference to the output stream.

Since

ids_peak_icv 1.0

ToString() [1/7]

std::string ToString ( BinningMode mode )

inline

Converts a BinningMode enum value to its string representation.

Parameters

mode	The binning mode value to convert.

Returns

A string representation of the binning mode value.

Exceptions

NotSupportedException

If the mode value is unknown.

Since

ids_peak_icv 1.0

ToString() [2/7]

std::string ToString ( ChromaticAdaptionAlgorithm algorithm )

inline

Converts an ChromaticAdaptionAlgorithm enum value to its string representation.

ToString() [3/7]

std::string ToString ( ColorSpace colorSpace )

inline

Converts a ColorSpace enum value to its string representation.

ToString() [4/7]

std::string ToString ( const ColorCorrectionMatrix & matrix )

inline

Converts a ColorCorrectionMatrix to its string representation.

Parameters

matrix

The color correction matrix to convert.

Returns

A string representation of the matrix.

Since

ids_peak_icv 1.0

ToString() [5/7]

std::string ToString ( DebayerChannelLayout layout )

inline

Converts a DebayerChannelLayout enum value to its string representation.

Parameters

layout

The debayer channel layout value to convert.

Returns

A string representation of the channel layout value.

Exceptions

NotSupportedException

If the layout value is unknown.

Since

ids_peak_icv 1.0

ToString() [6/7]

std::string ToString ( ProcessingPolicy policy )

inline

Converts a ProcessingPolicy enum value to its string representation.

Parameters

policy

The processing policy value to convert.

Returns

A string representation of the processing policy value.

Exceptions

NotSupportedException

If the policy value is unknown.

Since

ids_peak_icv 1.0

ToString() [7/7]

std::string ToString ( Rotation rotation )

inline

Converts a Rotation enum value to its string representation.

Parameters

rotation

The rotation value to convert.

Returns

A string representation of the rotation value.

Exceptions

NotSupportedException

If the rotation value is unknown.

Since

ids_peak_icv 1.0