Logo
Programmer's Guide Baumer GAPI SDK Reference v2.10.0
Public Member Functions | List of all members
BGAPI2::ImageProcessor Class Reference

The task of the class ImageProcessor are the creation of image objects and the transformation of pixel formats. More...

#include <bgapi2_genicam.hpp>

Inheritance diagram for BGAPI2::ImageProcessor:
BGAPI2::INode

Public Member Functions

 ImageProcessor ()
 Parameterless constructor for creating of an ImageProcessor-Object.
 
 ~ImageProcessor ()
 destructor to destroy an ImageProcessor object.
 
String GetVersion ()
 Get the version number of the ImageProcessor library. The delivered string is composed of these several tags: Major.Minor.LastChanged.RevId. More...
 
ImageCreateImage ()
 This function creates an empty Image object. More...
 
ImageCreateImage (bo_uint width, bo_uint height, String pixelformat, void *pBuffer, bo_uint64 uBufferSize)
 
ImageCreateTransformedImage (Image *pInputImage, const char *szDestinationPixelformat)
 This function transforms the pixelformat of the passed Image object into a new created Image object. More...
 
void TransformImageToBuffer (Image *pInputImage, const char *szDestinationPixelformat, void *pBuffer, bo_uint64 uBufferSize)
 This function transformes the pixel format of the Image object and writes the data into the passed destination buffer. More...
 
- Public Member Functions inherited from BGAPI2::INode
NodeGetNode (String name)
 This function delivers a certain object of the Node list and provides the access to a node objcet without the detour across a NodeMap object. This function is functional identical to NodeMap::GetNode. More...
 
NodeMapGetNodeTree ()
 This function provides the features of a object derived from INode interface as tree structure in form of a NodeMap pointer. For a detailed description of the tree structure representation refer to the class description of NodeMap. More...
 
NodeMapGetNodeList ()
 This function provides the features of a object derived from INode interface as unstructured list in form of a NodeMap pointer. For a detailed description of the unstructured list representation refer to the class description of NodeMap. More...
 

Detailed Description

The task of the class ImageProcessor are the creation of image objects and the transformation of pixel formats.

This class belongs to the additional classes. A transformation can be the demosaicing of raw sensor pixel arrangements in a common displayable pixelformat, e.g. RAWBAYER to RGB8 or RGB to YUV. This class is based on DLL "bgapi2_img.dll".

Definition at line 3352 of file bgapi2_genicam.hpp.

Member Function Documentation

◆ CreateImage()

BGAPI2::ImageProcessor::CreateImage ( )

This function creates an empty Image object.

This function creates an Image object according the parameters width, height and pixelformat. The Image object uses a user defines buffer.

Returns
Image* The pointer to a new created Image object.
Parameters
widthThe width of the Image object in pixel.
heightThe height of the Image object in pixel.
pixelformatThe pixelformat of the Image object.
pBufferThe user defined image buffer.
uBufferSizeThe size of the user defined image buffer bytes.
Returns
Image* The pointer to a new created Image object.
See also
Image::GetTransformBufferLength

◆ CreateTransformedImage()

BGAPI2::ImageProcessor::CreateTransformedImage ( Image pInputImage,
const char *  szDestinationPixelformat 
)

This function transforms the pixelformat of the passed Image object into a new created Image object.

Parameters
pInputImageA pointer to a Image object whose image data is to be transformed.
szDestinationPixelformatThe desired destination pixel format of the delivered Image object.
Returns
Image* A pointer to a new created Image object which includes the transformed image data.

◆ GetVersion()

BGAPI2::ImageProcessor::GetVersion ( )

Get the version number of the ImageProcessor library. The delivered string is composed of these several tags: Major.Minor.LastChanged.RevId.

Returns
String The version number of the ImageProcessor library.

◆ TransformImageToBuffer()

BGAPI2::ImageProcessor::TransformImageToBuffer ( Image pInputImage,
const char *  szDestinationPixelformat,
void *  pBuffer,
bo_uint64  uBufferSize 
)

This function transformes the pixel format of the Image object and writes the data into the passed destination buffer.

Parameters
pInputImageA pointer to an Image object whose image data is to be transformed.
szDestinationPixelformatThe destination pixel format.
pBufferThe destination buffer.
uBufferSizeThe destination buffer size.
Exceptions
Exceptions::ErrorExceptionError while transform the image.

The documentation for this class was generated from the following file:
bgapi: BGAPI::Camera Class Reference

Jan, 14 2020
Baumer Optronic GmbH, Badstrasse 30, 01454 D-Radeberg, Tel:+49-3528-4386-0, Fax:+49-3528-4386-86, Email:support.cameras@baumer.com