Skip to content

Basler_ImageFormatConverterParams::CImageFormatConverterParams_Params#

A parameter class containing all parameters as members that are available for Image Format Converter. More…

#include <pylon/_ImageFormatConverterParams.h>

Inherits from Basler_ImageFormatConverterParams::CImageFormatConverterParams_Params_v7_1_0

Inherited by Pylon::CImageFormatConverter

Public Attributes#

Name
Pylon::IIntegerEx & AdditionalLeftShift
Additional shifting value used for converting monochrome images - Applies to: ImageFormatConverter.
Pylon::IFloatEx & Gamma
Gamma value for converting monochrome images - Applies to: ImageFormatConverter.
Pylon::IEnumParameterT< MonoConversionMethodEnums > & MonoConversionMethod
Sets the conversion method for monochrome images - Applies to: ImageFormatConverter.
Pylon::IEnumParameterT< InconvertibleEdgeHandlingEnums > & InconvertibleEdgeHandling
Sets how to handle rows and columns that can't be converted - Applies to: ImageFormatConverter.
Pylon::IIntegerEx & MaxNumThreads
The maximum number of threads that are used for the format conversion - Applies to: ImageFormatConverter.
Pylon::IEnumParameterT< OutputBitAlignmentEnums > & OutputBitAlignment
Sets the alignment of the bits in the target pixel type - Applies to: ImageFormatConverter.
Pylon::IEnumParameterT< OutputOrientationEnums > & OutputOrientation
Sets the vertical orientation of the output image in the buffer - Applies to: ImageFormatConverter.
Pylon::IIntegerEx & OutputPaddingX
Number of additional data bytes at the end of each line - Applies to: ImageFormatConverter.

Detailed Description#

class Basler_ImageFormatConverterParams::CImageFormatConverterParams_Params;

A parameter class containing all parameters as members that are available for Image Format Converter.

The parameter class is used by the [Pylon::CImageFormatConverter](class_pylon_1_1_c_image_format_converter.md) class. The [Pylon::CImageFormatConverter](class_pylon_1_1_c_image_format_converter.md) creates new images by converting a source image to a different format. Once the format converter is configured it can convert almost all image formats supported by Basler camera devices. The [Utility_ImageFormatConverter] code sample shows the use of the Image Format Converter class.

Public Attributes Documentation#

AdditionalLeftShift#

Pylon::IIntegerEx & AdditionalLeftShift;

Additional shifting value used for converting monochrome images - Applies to: ImageFormatConverter.

Additional shifting value used for converting monochrome images. Only effective if the Mono Conversion Method parameter is set to Truncate. If the parameter value isn't zero, the image data is converted using a lookup table. Shifted values exceeding the maximum output value boundary are set to the maximum allowed value. Negative values are treated as right-shifted values.

Visibility: Beginner

Gamma#

Pylon::IFloatEx & Gamma;

Gamma value for converting monochrome images - Applies to: ImageFormatConverter.

Gamma value for converting monochrome images. The image data is converted using a lookup table.

Visibility: Beginner

MonoConversionMethod#

Pylon::IEnumParameterT< MonoConversionMethodEnums > & MonoConversionMethod;

Sets the conversion method for monochrome images - Applies to: ImageFormatConverter.

Visibility: Beginner

InconvertibleEdgeHandling#

Pylon::IEnumParameterT< InconvertibleEdgeHandlingEnums > & InconvertibleEdgeHandling;

Sets how to handle rows and columns that can't be converted - Applies to: ImageFormatConverter.

Visibility: Beginner

MaxNumThreads#

Pylon::IIntegerEx & MaxNumThreads;

The maximum number of threads that are used for the format conversion - Applies to: ImageFormatConverter.

Visibility: Beginner

OutputBitAlignment#

Pylon::IEnumParameterT< OutputBitAlignmentEnums > & OutputBitAlignment;

Sets the alignment of the bits in the target pixel type - Applies to: ImageFormatConverter.

Sets the alignment of the bits in the target pixel type if the target bit depth is greater than the source bit depth, e.g., if you are converting from a 10-bit to a 16-bit format.

Visibility: Beginner

OutputOrientation#

Pylon::IEnumParameterT< OutputOrientationEnums > & OutputOrientation;

Sets the vertical orientation of the output image in the buffer - Applies to: ImageFormatConverter.

Visibility: Beginner

OutputPaddingX#

Pylon::IIntegerEx & OutputPaddingX;

Number of additional data bytes at the end of each line - Applies to: ImageFormatConverter.

Number of additional data bytes at the end of each line. These bytes are set to zero during the conversion.

Visibility: Beginner


Updated on 27 July 2022 at 19:03:45