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

The class Image provides the ability of image transformation. This class belongs to the additional classes. More...

#include <bgapi2_genicam.hpp>

Inheritance diagram for BGAPI2::Image:
BGAPI2::INode

Public Member Functions

bo_uint GetWidth ()
 This function delivers the width of the image in pixel. More...
 
bo_uint GetHeight ()
 This function delivers the height of the image in pixel. More...
 
String GetPixelformat ()
 This function delivers the pixel format of the Image object. More...
 
void * GetBuffer ()
 This function delivers a pointer to the memory of the Image object. More...
 
bo_uint64 GetTransformBufferLength (String sPixelFormat)
 This function delivers the destination buffer size after the transformation. More...
 
void GetHistogram (bo_tHistRecords tHistogram, bo_uint offsetx, bo_uint offsety, bo_uint width, bo_uint height)
 This function delivers a histogram of a specified region of the Image object. More...
 
void GetHistogram (bo_tHistRecords tHistogram)
 This function delivers a histogram of the complete Image object. More...
 
void Release ()
 This function frees all used resoures.
 
void Init (bo_uint width, bo_uint height, String sPixelFormat, void *pBuffer, bo_uint64 uBufferSize)
 This function reinitialise an Image object. 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...
 

Friends

class ImageProcessor
 
class Polarizer
 

Detailed Description

The class Image provides the ability of image transformation. This class belongs to the additional classes.

Definition at line 3260 of file bgapi2_genicam.hpp.

Member Function Documentation

◆ GetBuffer()

BGAPI2::Image::GetBuffer ( )

This function delivers a pointer to the memory of the Image object.

Returns
void* The pointer to the memory of Image object.

◆ GetHeight()

BGAPI2::Image::GetHeight ( )

This function delivers the height of the image in pixel.

Returns
bo_uint The height of the image in pixel.

◆ GetHistogram() [1/2]

BGAPI2::Image::GetHistogram ( bo_tHistRecords  tHistogram,
bo_uint  offsetx,
bo_uint  offsety,
bo_uint  width,
bo_uint  height 
)

This function delivers a histogram of a specified region of the Image object.

Parameters
tHistogramA structure which includes the histogram data.
offsetxThe left coordinate of the ROI.
offsetyThe top coordinate of the ROI.
widthThe width of the ROI.
heightThe height of the ROI.
Exceptions
Exceptions::ErrorExceptionFunction returns with error.

◆ GetHistogram() [2/2]

BGAPI2::Image::GetHistogram ( bo_tHistRecords  tHistogram)

This function delivers a histogram of the complete Image object.

Parameters
tHistogramA structure which includes the histogram data.
Exceptions
Exceptions::ErrorExceptionFunction returns with error.

◆ GetPixelformat()

BGAPI2::Image::GetPixelformat ( )

This function delivers the pixel format of the Image object.

Returns
String The pixelformat of the Image object.

◆ GetTransformBufferLength()

BGAPI2::Image::GetTransformBufferLength ( String  sPixelFormat)

This function delivers the destination buffer size after the transformation.

Parameters
sPixelFormatThe pixel format for the transformation.
Returns
bo_uint64 The destination buffer size after the transformation.
Exceptions
Exceptions::ErrorExceptionFunction returned with error.

◆ GetWidth()

BGAPI2::Image::GetWidth ( )

This function delivers the width of the image in pixel.

Returns
bo_uint The width of the image in pixel.

◆ Init()

BGAPI2::Image::Init ( bo_uint  width,
bo_uint  height,
String  sPixelFormat,
void *  pBuffer,
bo_uint64  uBufferSize 
)

This function reinitialise an Image object.

Parameters
widthThe width of the Image object in pixel.
heightThe height of the Image object in pixel.
sPixelFormatThe pixelformat of the Image object.
pBufferThe user defined image buffer.
uBufferSizeThe size of the user defined image buffer bytes.
Exceptions
Exceptions::ErrorExceptionFunction returns with error.

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