Special Pipeline Types

Collaboration diagram for Special Pipeline Types:

Data Structures
class	ColorCorrectionMatrix
	Color correction matrix. More...

Enumerations
enum class	DebayerConversionPolicy {   Bypass ,   BayerOnly ,   BayerAndMono }
	Defines the conditions under which the Debayer module performs color conversion. More...
enum class	BinningMode {   Average = 0 ,   Sum = 1 }
	Mode parameter for the binning algorithm. More...
enum class	DebayerChannelLayout {   RGB = 0 ,   BGR ,   RGBA ,   BGRA }
	Specifies the desired channel layout of the output image. 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...

Detailed Description

Supporting data structures, enumerations, and type definitions for pipeline configuration.

This group contains the specialized types used throughout the pipeline system for configuration, control, and data representation. These types provide type-safe interfaces for pipeline parameters and ensure consistent behavior across the system.

Enumeration Type Documentation

BinningMode

enum class BinningMode

strong

Mode parameter for the binning algorithm.

The enum holding the possible modes.

Since

ids_peak_icv 1.0

Enumerator
Average	The averaged pixel values of neighboring rows and/or columns are computed during binning.
Sum	The pixel values of neighboring rows and/or columns are summed during binning.

Definition at line 30 of file peak_icv_binning_mode.hpp.

DebayerChannelLayout

enum class DebayerChannelLayout

strong

Specifies the desired channel layout of the output image.

Since

ids_peak_icv 1.0

Enumerator
RGB	Red-Green-Blue format with 3 channels.
BGR	Blue-Green-Red format with 3 channels.
RGBA	Red-Green-Blue-Alpha format with 4 channels.
BGRA	Blue-Green-Red-Alpha format with 4 channels.

Definition at line 29 of file peak_icv_debayer_channel_layout.hpp.

DebayerConversionPolicy

enum class DebayerConversionPolicy

strong

Defines the conditions under which the Debayer module performs color conversion.

Since

ids_peak_icv 1.0

Enumerator
Bypass	Do not convert images.
BayerOnly	Convert only Bayer-pattern images.
BayerAndMono	Convert both Bayer-pattern and monochrome images.

Definition at line 36 of file peak_icv_debayer_module.hpp.

ProcessingPolicy

enum class ProcessingPolicy

strong

Specifies the processing policy.

Defines how the image processing pipeline handles the bit depth conversions during processing, balancing performance and image quality.

Warning

Changing the processing policy during active processing may cause inconsistent results. Set the policy before starting image processing operations.

See also

DefaultPipeline::SetProcessingPolicy(), DefaultPipeline::GetProcessingPolicy()

Since

ids_peak_icv 1.0

Enumerator
Fast	Prefer speed. Reduces the bit depth of the input image at the earliest suitable stage if the target bit depth is lower. Prioritizes performance over image quality.
Balanced	Balance speed and quality. Retains the original bit depth throughout processing until the final pixel format conversion. Provides a trade-off between performance and quality.
Enhanced	Prefer quality. Increases the bit depth of the input image for all processing steps, if the target bit depth is higher. Prioritizes improved image quality over performance.

Definition at line 37 of file peak_icv_processing_policy.hpp.

Rotation

enum class Rotation

strong

Angle parameter for the rotation algorithm.

Since

ids_peak_icv 1.0

Enumerator
None	No rotation applied to the image. Since ids_peak_icv 1.0
Degree90Counterclockwise	Rotate the image 90 degrees counterclockwise. Since ids_peak_icv 1.0
Degree180	Rotate the image 180 degrees (upside down). Since ids_peak_icv 1.0
Degree90Clockwise	Rotate the image 90 degrees clockwise. Since ids_peak_icv 1.0

Definition at line 30 of file peak_icv_rotation.hpp.