IDS peak ICV v1.4.0
Loading...
Searching...
No Matches
Special Pipeline Types

Data Structures

class  ColorCorrectionMatrix
 Color correction matrix. 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...
 

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.

◆ ChromaticAdaptionAlgorithm

enum class ChromaticAdaptionAlgorithm
strong

Algorithm used for chromatic adaption.

Since
ids_peak_icv 1.3
Enumerator
Legacy 

Legacy adaption algorithm.

Bradford 

Bradford adaption algorithm (Default).

◆ ColorSpace

enum class ColorSpace
strong

Color spaces supported by the chromatic adaptation feature.

Since
ids_peak_icv 1.3
Enumerator
SRGB_D50 
SRGB_D65 
CIE_RGB_E 
ECI_RGB_D50 
Adobe_RGB_D65 

◆ DebayerChannelLayout

enum class DebayerChannelLayout
strong

Specifies the channel layout used by the debayer module in image processing pipelines.

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.

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

◆ 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