peak::pipeline::detail Namespace Reference

Data Structures
class	ColorMatrixTransformationModule
	Color matrix transformation is an image pipeline module that applies a ColorCorrectionMatrix to an image. More...
class	DebayerModule
	Debayer is an image pipeline module that converts Bayer RAW images into standard color formats. More...
class	DownsamplingModule
	Downsampling is used to decrease the image size. More...
class	GainModule
	Image pipeline module for applying gain to the image. More...
class	HotpixelCorrectionModule
	Hotpixel correction is an image pipeline module for detecting and correcting hot pixels in camera images. More...
class	MonoConversionModule
	Mono conversion is an image pipeline module that converts images to a monochrome format. More...
class	PixelFormatConversionModule
	Pixel format conversion module that transforms images to a specified output pixel format. More...
class	SharpeningModule
	Sharpening is an image pipeline module that applies a sharpening filter to enhance image detail. More...
class	ToneCurveCorrectionModule
	Tone curve correction is an image pipeline module that applies digital black correction and inverse gamma transformation to an image. More...
class	TransformationModule
	Transformation is an image pipeline module that provides mirror and rotation functionality. More...
class	UnpackModule
	Unpack is an image pipeline module that converts packed pixel formats into corresponding unpacked Bayer or mono formats. More...

Enumerations
enum class	DebayerConversionPolicy {   Bypass ,   BayerOnly ,   BayerAndMono }
	Specifies the conditions under which the Debayer module performs color conversion. More...
enum class	DownsamplingMode {   BinningAverage = 0 ,   BinningSum = 1 ,   Decimation = 2 }
	Mode parameter for the downsampling algorithm. More...

Functions
std::string	ToString (const DebayerConversionPolicy &policy)
DebayerConversionPolicy	ToDebayerConversionPolicy (const std::string &policy)
std::string	ToString (DownsamplingMode mode)
DownsamplingMode	ToMode (const std::string &mode)
void	ValidateVersion (int64_t version, const std::string &moduleName)
BinningMode	ToBinningMode (const std::string &mode)
	Converts a string representation to a BinningMode enum value.
ChromaticAdaptionAlgorithm	ToChromaticAdaptionAlgorithm (const std::string &algorithm)
ColorSpace	ToColorSpace (const std::string &colorSpace)
DebayerChannelLayout	ToDebayerChannelLayout (const std::string &layout)
	Converts a string representation to a DebayerChannelLayout enum value.
ProcessingPolicy	ToProcessingPolicy (const std::string &policy)
	Converts a string representation to a ProcessingPolicy enum value.
Rotation	ToRotation (const std::string &rotation)
	Converts a string representation to a Rotation enum value.

Function Documentation

ToBinningMode()

BinningMode ToBinningMode ( const std::string & mode )

inline

Converts a string representation to a BinningMode enum value.

Parameters

mode	The string representation of the binning mode value.

Returns

The corresponding BinningMode enum value.

Exceptions

NotSupportedException

If the string does not match any known mode value.

Since

ids_peak_icv 1.0

ToChromaticAdaptionAlgorithm()

ChromaticAdaptionAlgorithm ToChromaticAdaptionAlgorithm ( const std::string & algorithm )

inline

ToColorSpace()

ColorSpace ToColorSpace ( const std::string & colorSpace )

inline

ToDebayerChannelLayout()

DebayerChannelLayout ToDebayerChannelLayout ( const std::string & layout )

inline

Converts a string representation to a DebayerChannelLayout enum value.

Parameters

layout

The string representation of the channel layout value.

Returns

The corresponding DebayerChannelLayout enum value.

Exceptions

NotSupportedException

If the string does not match any known layout value.

Since

ids_peak_icv 1.0

ToDebayerConversionPolicy()

DebayerConversionPolicy ToDebayerConversionPolicy ( const std::string & policy )

inline

ToMode()

DownsamplingMode ToMode ( const std::string & mode )

inline

ToProcessingPolicy()

ProcessingPolicy ToProcessingPolicy ( const std::string & policy )

inline

Converts a string representation to a ProcessingPolicy enum value.

Parameters

policy

The string representation of the processing policy value.

Returns

The corresponding ProcessingPolicy enum value.

Exceptions

NotSupportedException

If the string does not match any known policy value.

Since

ids_peak_icv 1.0

ToRotation()

Rotation ToRotation ( const std::string & rotation )

inline

Converts a string representation to a Rotation enum value.

Parameters

rotation

The string representation of the rotation value.

Returns

The corresponding Rotation enum value.

Exceptions

NotSupportedException

If the string does not match any known rotation value.

Since

ids_peak_icv 1.0

ToString() [1/2]

std::string ToString ( const DebayerConversionPolicy & policy )

inline

ToString() [2/2]

std::string ToString ( DownsamplingMode mode )

inline

ValidateVersion()

void ValidateVersion ( int64_t version, const std::string & moduleName )

inline