China Daheng Group, Inc.

Beijing Image Vision Technology Branch

DotNET SDK
Programmer's Guide

Version：V1.2.2
Date：2020-10-12
 Notice

All rights reserved. No parts of this manual may be used or reproduced, in any forms or by any means,
without prior written permission of China Daheng Group, Inc. Beijing Image Vision Technology Branch.

The right is also reserved to modify or change any parts of this manual in the future without prior notification.

All other trademarks are the properties of their respective owners.

© 2020 China Daheng Group, Inc. Beijing Image Vision Technology Branch
Web: http://www.daheng-imaging.com
Sales Email: [email protected]
Sales Tel: +86 10 8282 8878
Support Email: [email protected]
 Contents
1. Introduction ..................................................................................................................... 1
2. Programming Guide ....................................................................................................... 2
2.1. Build Programming Environment ..............................................................................2
2.1.1. Using the Wizard to Create a Console Application ............................................................. 2
2.1.2. Add the GxIAPINET.dll to the Project Manually .................................................................. 2
2.1.3. How to Call the GxIAPINET Library .................................................................................... 3
2.2. Precautions for Debugging the GigE Vision Cameras ..............................................4
2.3. Initialization and Uninitialization ................................................................................5
2.4. Error Handling ..........................................................................................................5
2.5. Enumerating Devices ...............................................................................................5
2.6. Configure Camera IP Address ..................................................................................6
2.7. Open and Close Devices ..........................................................................................7
2.8. Features Control .......................................................................................................8
2.8.1. Controller Type .................................................................................................................... 8
2.8.2. Data Type............................................................................................................................. 9
2.8.3. Access Type ......................................................................................................................... 9
2.8.4. How to Get the Camera's Parameters ................................................................................ 9
2.8.5. How to Get the Sample Code for Feature Read & Write .................................................. 10
2.8.6. Different Types of Feature Sample Code .......................................................................... 10
2.8.7. Precautions ........................................................................................................................ 12
2.9. Acquisition Control and Image Processing .............................................................12
2.9.1. Get a Single Image ............................................................................................................ 12
2.9.2. Acquisition with Callback Functions .................................................................................. 13
2.9.3. Set the Number of Acquisition Buffer ................................................................................ 15
2.9.4. Image Processing .............................................................................................................. 16
2.9.5. Stream Object Features Control........................................................................................ 21
2.9.6. Precautions ........................................................................................................................ 22
2.10. Get Devices Events ..............................................................................................23
2.10.1. Selection Events .............................................................................................................. 23
2.10.2. Enabled Events................................................................................................................ 23
2.10.3. Registered Events Message Callback Function ............................................................. 23
2.10.4. Get Events Data Information ........................................................................................... 23
2.10.5. Sample Code ................................................................................................................... 24
2.11. Get Offline Event ..................................................................................................25
2.12. Import and Export Cameras' Configuration Parameters .......................................26
3. Data Type Definition ..................................................................................................... 27
3.1. GX_STATUS_LIST .................................................................................................27
3.2. GX_DEVICE_CLASS_LIST ....................................................................................27
3.3. GX_ACCESS_STATUS ..........................................................................................27
3.4. GX_ACCESS_MODE .............................................................................................28

© China Daheng Group, Inc. Beijing Image Vision Technology Branch I

 3.5. GX_PIXEL_FORMAT_ENTRY ...............................................................................28
3.6. GX_FRAME_STATUS_LIST...................................................................................29
3.7. GX_FEATURE_TYPE ............................................................................................29
3.8. GX_BAYER_CONVERT_TYPE_LIST ....................................................................29
3.9. GX_VALLID_BIT_LIST ...........................................................................................29
3.10. GX_IP_CONFIGURE_MODE_LIST .....................................................................29
3.11. GX_RESET_DEVICE_MODE...............................................................................30
3.12. COLOR_TRANSFORM_FACTOR ........................................................................30
4. Handle Type Definition ................................................................................................. 31
5. Delegate Function Type Definition .............................................................................. 32
6. Module Interface Definition .......................................................................................... 33
6.1. IGXFactory .............................................................................................................33
6.1.1. GetInstance ....................................................................................................................... 33
6.1.2. Init ...................................................................................................................................... 33
6.1.3. Uninit .................................................................................................................................. 33
6.1.4. UpdateDeviceList............................................................................................................... 34
6.1.5. UpdateAllDeviceList .......................................................................................................... 34
6.1.6. OpenDeviceByIP/MAC/SN/UserID .................................................................................... 34
6.1.7. GigEIPConfiguration .......................................................................................................... 34
6.1.8. GigEForceIP ...................................................................................................................... 35
6.1.9. GigEResetDevice .............................................................................................................. 35
6.2. IGXDeviceInfo ........................................................................................................36
6.2.1. GetVendorName ................................................................................................................ 37
6.2.2. GetModelName.................................................................................................................. 37
6.2.3. GetSN ................................................................................................................................ 37
6.2.4. GetDisplayName................................................................................................................ 37
6.2.5. GetDeviceID ...................................................................................................................... 37
6.2.6. GetUserID .......................................................................................................................... 37
6.2.7. GetAccessStatus ............................................................................................................... 38
6.2.8. GetDeviceClass ................................................................................................................. 38
6.2.9. GetMAC ............................................................................................................................. 38
6.2.10. GetIP ................................................................................................................................ 38
6.2.11. GetSubnetMask ............................................................................................................... 38
6.2.12. GetGateway ..................................................................................................................... 38
6.2.13. GetNICMAC ..................................................................................................................... 39
6.2.14. GetNICIP ......................................................................................................................... 39
6.2.15. GetNICSubnetMask......................................................................................................... 39
6.2.16. GetNICGateway............................................................................................................... 39
6.2.17. GetNICDescription ........................................................................................................... 39
6.3. IGXDevice ..............................................................................................................39
6.3.1. GetDeviceInfo .................................................................................................................... 40
6.3.2. GetStreamCount ................................................................................................................ 40

© China Daheng Group, Inc. Beijing Image Vision Technology Branch II

 6.3.3. OpenStream ...................................................................................................................... 40
6.3.4. GetFeatureControl ............................................................................................................. 40
6.3.5. GetRemoteFeatureControl ................................................................................................ 41
6.3.6. GetEventNumInQueue ...................................................................................................... 41
6.3.7. FlushEvent ......................................................................................................................... 41
6.3.8. RegisterDeviceOfflineCallback .......................................................................................... 41
6.3.9. UnregisterDeviceOfflineCallback ....................................................................................... 41
6.3.10. CreateImageProcessConfig ............................................................................................ 42
6.3.11. ExportConfigFile .............................................................................................................. 42
6.3.12. ImportConfigFile .............................................................................................................. 42
6.3.13. Close ................................................................................................................................ 42
6.4. IGXFeatureControl .................................................................................................42
6.4.1. GetFeatureNameList ......................................................................................................... 43
6.4.2. GetFeatureType ................................................................................................................. 43
6.4.3. IsImplemented ................................................................................................................... 43
6.4.4. IsReadable......................................................................................................................... 43
6.4.5. IsWritable ........................................................................................................................... 44
6.4.6. GetIntFeature..................................................................................................................... 44
6.4.7. GetFloatFeature................................................................................................................. 44
6.4.8. GetEnumFeature ............................................................................................................... 44
6.4.9. GetBoolFeature ................................................................................................................. 44
6.4.10. GetStringFeature ............................................................................................................. 44
6.4.11. GetCommandFeature ...................................................................................................... 45
6.4.12. GetRegisterFeature ......................................................................................................... 45
6.4.13. RegisterFeatureCallback ................................................................................................. 45
6.4.14. UnregisterFeatureCallback .............................................................................................. 45
6.5. IIntFeature ..............................................................................................................45
6.5.1. GetMin ............................................................................................................................... 45
6.5.2. GetMax .............................................................................................................................. 46
6.5.3. GetInc ................................................................................................................................ 46
6.5.4. GetValue ............................................................................................................................ 46
6.5.5. SetValue............................................................................................................................. 46
6.6. IFloatFeature ..........................................................................................................46
6.6.1. GetMin ............................................................................................................................... 47
6.6.2. GetMax .............................................................................................................................. 47
6.6.3. HasInc ................................................................................................................................ 47
6.6.4. GetInc ................................................................................................................................ 47
6.6.5. GetUnit ............................................................................................................................... 47
6.6.6. GetValue ............................................................................................................................ 47
6.6.7. SetValue............................................................................................................................. 48
6.7. IEnumFeature .........................................................................................................48
6.7.1. GetEnumEntryList.............................................................................................................. 48
6.7.2. GetValue ............................................................................................................................ 48
6.7.3. SetValue............................................................................................................................. 48

© China Daheng Group, Inc. Beijing Image Vision Technology Branch III
6.8. IBoolFeatur .............................................................................................................49
6.8.1. GetValue ............................................................................................................................ 49
6.8.2. SetValue............................................................................................................................. 49
6.9. IStringFeature .........................................................................................................49
6.9.1. GetValue ............................................................................................................................ 49
6.9.2. SetValue............................................................................................................................. 49
6.9.3. GetStringMaxLength .......................................................................................................... 50
6.10. ICommandFeature................................................................................................50
6.10.1. Execute ............................................................................................................................ 50
6.11. IRegisterFeature ...................................................................................................50
6.11.1. GetLength ........................................................................................................................ 50
6.11.2. GetBuffer .......................................................................................................................... 50
6.11.3. SetBuffer .......................................................................................................................... 51
6.12. IGXStream ............................................................................................................51
6.12.1. StartGrab ......................................................................................................................... 51
6.12.2. StopGrab ......................................................................................................................... 52
6.12.3. RegisterCaptureCallback................................................................................................. 52
6.12.4. UnregisterCaptureCallback ............................................................................................. 52
6.12.5. GetImage ......................................................................................................................... 52
6.12.6. GetImageNoThrow .......................................................................................................... 52
6.12.7. GetFeatureControl ........................................................................................................... 53
6.12.8. FlushQueue ..................................................................................................................... 53
6.12.9. SetAcquisitionBufferNumber ........................................................................................... 53
6.12.10. Close .............................................................................................................................. 53
6.12.11. GetOptimalPacketSize ................................................................................................... 54
6.13. IFrameData ..........................................................................................................54
6.13.1. GetStatus ......................................................................................................................... 54
6.13.2. GetPayloadSize ............................................................................................................... 55
6.13.3. GetWidth .......................................................................................................................... 55
6.13.4. GetHeight......................................................................................................................... 55
6.13.5. GetPixelFormat ................................................................................................................ 55
6.13.6. GetFrameID ..................................................................................................................... 55
6.13.7. GetTimeStamp ................................................................................................................. 55
6.13.8. GetBuffer.......................................................................................................................... 56
6.13.9. ConvertToRaw8 ............................................................................................................... 56
6.13.10. ConvertToRGB24 .......................................................................................................... 56
6.13.11. ImageProcess ................................................................................................................ 56
6.14. IImageData ...........................................................................................................56
6.15. IImagProcessConfig .............................................................................................57
6.15.1. SetValidBit........................................................................................................................ 58
6.15.2. GetValidBit ....................................................................................................................... 58
6.15.3. EnableDefectivePixelCorrect ........................................................................................... 58
6.15.4. IsDefectivePixelCorrect ................................................................................................... 58
6.15.5. EnableSharpen ................................................................................................................ 58

© China Daheng Group, Inc. Beijing Image Vision Technology Branch IV

 6.15.6. IsSharpen ........................................................................................................................ 59
6.15.7. EnableAccelerate ............................................................................................................ 59
6.15.8. IsAccelerate ..................................................................................................................... 59
6.15.9. SetSharpenParam ........................................................................................................... 59
6.15.10. GetSharpenParam ......................................................................................................... 59
6.15.11. SetContrastParam ......................................................................................................... 60
6.15.12. GetContrastParam ......................................................................................................... 60
6.15.13. SetGammaParam .......................................................................................................... 60
6.15.14. GetGammaParam ......................................................................................................... 60
6.15.15. SetLightnessParam ....................................................................................................... 60
6.15.16. GetLightnessParam ....................................................................................................... 60
6.15.17. EnableDenoise .............................................................................................................. 61
6.15.18. IsDenoise ....................................................................................................................... 61
6.15.19. SetSaturationParam ...................................................................................................... 61
6.15.20. GetSaturationParam ...................................................................................................... 61
6.15.21. SetConvertType ............................................................................................................. 61
6.15.22. GetConvertType ............................................................................................................ 61
6.15.23. EnableConvertFlip ......................................................................................................... 62
6.15.24. IsConvertFlip.................................................................................................................. 62
6.15.25. EnableColorCorrection .................................................................................................. 62
6.15.26. IsColorCorrection ........................................................................................................... 62
6.15.27. Reset.............................................................................................................................. 62
6.15.28. Destroy .......................................................................................................................... 62
6.15.29. IsUserSetCCParam ....................................................................................................... 63
6.15.30. EnableUserSetCCParam............................................................................................... 63
6.15.31. SetUserCCParam .......................................................................................................... 63
6.15.32. GetUserCCParam ......................................................................................................... 63

7. Revision History ........................................................................................................... 64

© China Daheng Group, Inc. Beijing Image Vision Technology Branch V

 1.Introduction

1. Introduction

The GxIAPINET.dll library is an encapsulated general and unified application programming interface which
based on the object-oriented method; it is suit for MERCURY, MARS series of DAHENG IMAGING camera.

The main modules and functions as follow:

Main modules Functions
IGXFactory Initialize the interface library, enumerate devices, open devices.
Device objects, via this object as an entrance to control the objects features, image
IGXDevice
acquisition, get the cameras' events.
IGXStream Stream object, get from IGXDevice, responsible for image acquisition and etc.
Features control object, you can get the feature control objects from IGXDevice
IGXFeatureControl
and IGXStream, and to handle various features control.
The callback acquisition method returns image structure, including the image
IFrameData acquisition/output results: Image buffer and image information, and comes with
image format conversion/image effect enhance function.
Get a single image method returns the image structure, the function is the same
IImageData
as IFrameData.
This object exists in the form of source code in the Sample program, responsible
GXBitmap
for the image display and storage functions, as shown in the Sample program.
Table 1-1 Main modules and functions

 Supported programming environment

Microsoft Visual Studio 2005

Microsoft Visual Studio 2008

Microsoft Visual Studio 2010

Microsoft Visual Studio 2012

Microsoft Visual Studio 2013

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 1

 2.Programming Guide

2. Programming Guide
2.1. Build Programming Environment
2.1.1. Using the Wizard to Create a Console Application

Figure 2-1

2.1.2. Add the GxIAPINET.dll to the Project Manually

Right click the References in the solution explorer, select AddReference, as shown in the following figure:

Figure 2-2

In the pop-up Add Reference dialog box, select Browse tab and select the GxIAPINET.dll file, then click
OK, see the following figure:

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 2

 2.Programming Guide

Figure 2-3

Click OK and we can see the library which we have selected in the Reference, see the following figure:

Figure 2-4

2.1.3. How to Call the GxIAPINET Library

Before calling the library, you should add a using namespace GXIAPINET in the Code Editor area, see the
following figure:

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 3

 2.Programming Guide

Figure 2-5

2.2. Precautions for Debugging the GigE Vision Cameras

When the Windows users use Visual Studio development platform debugging the GigE Vision cameras,
they may encounter device offline, which is caused by the heartbeat timeout. The application must send
heartbeat packet to the camera in defined intervals. If the camera doesn't receive this heartbeat, it will
consider the current connection as broken and won't accept any commands from the application.

When the user running the application, it will send heartbeat packet normally and keep connect with the
camera, but in debug mode, when the application runs to the breakpoint, the debugger will suspend all the
thread, including the sending heartbeat packet thread, so in debug mode, the application will not send
heartbeat packet to the camera.

Users can add heartbeat timeout to resolve it.

Users can change the heartbeat timeout by two ways:

The first one is: open the device in the program and add the following code:

Only in debugging mode can use this code snippet, don't use it in the release program.
//Open device, here, open the device through Serial Number (SN), the SN will
//be subject to the actual device. Users can also open the device by other ways.
#ifDEBUG

IGXDevice objIGXDevice = objIGXFactory.OpenDeviceBySN("RN0001007012",

GX_ACCESS_EXCLUSIVE);

//Get remote device feature controller.

IGXFeatureControl objFeatureControl = objIGXDevice.GetRemoteFeatureControl();

//Set heratbeat timeout for 5 minutes.

objFeatureControl.GetIntFeature("GevHeartbeatTimeout").SetValue(300000);

#endif

The other way is: add environment variable 'MER_HEARTBEAT_TIMEOUT' in the system, and assign a
value greater than zero, then open the device with application program, the device's heartbeat timeout will
automatically become the environment variable's value. Only to add the environment variable in the
development system and they will work in the application no matter in debug mode or release mode.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 4

 2.Programming Guide

Note: If the user set the heartbeat timeout very long, when close the program it will not call the close device
method to close the device, this will lead to the device cannot to be reset in the heartbeat time, thus when
the user try again to open the device, it will fail. This problem can be solved by resetting or reconnecting
the device.

There are two methods to reset or reconnect the device:

1) select “Reset Device” or “Reconnect Device” button directly in the IP Configurator.
2) reset or reconnect the device by the interface 'GXGigEResetDevice'.

Reset device: It is equivalent to powering off and powering up the device, and the programs in the camera
are completely reloaded.

Reconnect device: It is equivalent to the software interface close the device. After doing this, the user can
reopen the device.

2.3. Initialization and Uninitialization

The GxIAPINET library must be initialized before use. Before using any other methods, the
IGXFactory.GetInstance ().Init () must be called first.
//Call this function to initialize before using any other methods.
IGXFactory.GetInstance().Init();

The IGXFactory.GetInstance().Uninit() must be called to release all the resources of the GxIAPINET
application before the process exits.
//After closing the device, can't call any other interface library.
IGXFactory.GetInstance().Uninit();

2.4. Error Handling

All the GxIAPINET API functions throw exceptions when errors are detected. The exception type is
CGalaxyException, which inherited from the Exception. Users can call the function
CGalaxyException::GetErrorCode () to get the error codes, and the error code type can be referred to
GX_STATUS_LIST. Users can also access the exception class properties by
CGalaxyException.Message to get detailed error description information string.

A typical error handling code might look like:

try
{
IGXFactory.GetInstance().Init();
}
catch (CGalaxyExceptionex)
{
stringstrErrorInfo = "error code:" + ex.GetErrorCode().ToString() +
"error message:" + ex.Message;
Console.WriteLine(strErrorInfo);
}

2.5. Enumerating Devices

Users can call function IGXFactory.GetInstance().UpdateAllDeviceList to enumerate all the current
available devices, and get a device information list, the list type is List<IGXDeviceInfo>, enumeration
device code snippet as follows:
List<IGXDeviceInfo> listGXDeviceInfo = new List<IGXDeviceInfo>();

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 5

 2.Programming Guide

//Enumeration timeout assumptions for 200ms.

IGXFactory.GetInstance().UpdateAllDeviceList(200, listGXDeviceInfo);
foreach (IGXDeviceInfoobjDeviceInfoinlistGXDeviceInfo)
{
Console.WriteLine(objDeviceInfo.GetModelName());
Console.WriteLine(objDeviceInfo.GetVendorName());
//More devices information can refer IGXDeviceInfo method.
}

Note: Except the enumerated methods above, GxIAPINET also provides another enumerated method
IGXFactory.GetInstance().UpdateDeviceList. For non-GigE Vision cameras, they are the same in the
function, but for GigE Vision cameras, they are different in the internal enumeration mechanism.

UpdateAllDeviceList: Enumerate in all subnet.

UpdateDeviceList: Enumerate in the same subnet.

2.6. Configure Camera IP Address

Users can call the following two different modes to set the IP address of Camera.

IGXFactory::GetInstance().GigEIpConfiguration

IGXFactory::GetInstance().GigEForceIp

Use the function GigEIpConfiguration can set the camera static (permanent) IP address, and provide
four setting modes: direct write static IP address, use DHCP server to assign IP addresses, use LLA (Link-
Local Address) to configure camera IP and use default mode to set IP. When you choose the default mode,
the internal camera will enable the other three configure modes, but the static IP as a preferred way to
configure camera IP address.

Use the function GigEForceIp can perform ForceIP operations on the camera. ForceIP means that setting
the IP address is valid only for this use. When the camera power off and power on will restore the original
IP address.

Two ways to configure the IP address of the camera sample code is as follows.
//Sample MAC address, actual camera MAC address can be obtained by enumeration.
String strMAC = "00-21-49-00-00-00";
String strIPAddress= "192.168.10.10";
String strSubnetMask= "255.255.255.0";
String strDefaultGateway= "192.168.10.2";
String strUserID= "DAHENG Imaging";
GX_IP_CONFIGURE_MODE emIpConfigureMode = IP_CONFIGURE_STATIC_IP;

IGXFactory.GetInstance().GigEIpConfiguration(strMAC, emIpConfigureMode,
strIpAddress, strSubnetMask,
strDefaultGateway, strUserID);

//Sample MAC address, actual camera MAC address can be obtained by enumeration.
String strMAC = "00-21-49-00-00-00";
String strIPAddress= "192.168.10.10";
String strSubnetMask= "255.255.255.0";
String strDefaultGateway= "192.168.10.2";

//ForceIp
IGXFactory.GetInstance().GigEForceIp (strMAC, strIpAddress, strSubnetMask,
strDefaultGateway);

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 6

 2.Programming Guide

Note:
1) Before calling these two interfaces, you must first enumeration, and when you do this, the camera can't
be opened.
2) The maximum length of the user-defined name (UserID) allowed is 16 characters.

2.7. Open and Close Devices

Users can call the following four different modes to open the device:

IGXFactory.GetInstance().OpenDeviceBySN

IGXFactory.GetInstance().OpenDeviceByUserID

IGXFactory.GetInstance().OpenDeviceByMAC

IGXFactory.GetInstance().OpenDeviceByIP

SN: device serial number.

UserID: user defined name (if the device does not support UserID, assign this item as a null string).

MAC: the MAC address of the device (for non-GigE Vision cameras, assign this item as a null string).

IP: the device's IP address (for non-GigE Vision cameras, assign this item as a null string).

It is strongly recommended the user to call the enumeration device method and update the GxIAPINET
library internal device list before open the device, otherwise may open the device failure. The sample code
snippet as follows:
List<IGXDeviceInfo> listGXDeviceInfo = new List<IGXDeviceInfo>();
IGXFactory.GetInstance().UpdateAllDeviceList(200, listGXDeviceInfo);

if (listGXDeviceInfo.Count> 0)
{
//Open the first device in the list.
IGXDevice objDevice = null;
String strSN = listGXDeviceInfo[0].GetSN();
String strUserID = listGXDeviceInfo[0].GetUserID();
String strMAC = listGXDeviceInfo[0].GetMAC();
String strIP = listGXDeviceInfo[0].GetIP();
//Users can also assign the device information of the opened device
//directly. The information shown in the following code is indicative only,
//the actual information may differ.
//String strSN = "GA0140100002";
//String strUserID = "MyUserName";
//String strMAC = "A1-0B-32-7C-6F-81";
//String strIP = "192.168.0.100";
objDevice = IGXFactory.GetInstance().OpenDeviceBySN(strSN,
GX_ACCESS_EXCLUSIVE);
//objDevice = IGXFactory.GetInstance().OpenDeviceByUserID(strUserID,
GX_ACCESS_EXCLUSIVE);
//objDevice = IGXFactory.GetInstance().OpenDeviceByMAC(strMAC,
GX_ACCESS_EXCLUSIVE);
//objDevice = IGXFactory.GetInstance().OpenDeviceByIP(strIP,
GX_ACCESS_EXCLUSIVE);
}

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 7

 2.Programming Guide

Note: For GigE Vision devices, users can open the device directly without enumeration, because the
network mechanism allows to establishment connection directly by IP address.

Users can call the IGXDevice::Close to close device, release all the device resources. Code snippet as
follows:
//After closing the device, user can not to call the function 'IDevice' and
//all the 'IFeatureControl&IStream' functions of the device.
objDevice.Close();

Note: After closing the device, all the resources about the device will be released, including the
IGXFeatureControl object and IGXStream object which get from the device object, so when the device
is closed, these objects' interface are not allowed to be called again.

2.8. Features Control

2.8.1. Controller Type
There are three feature controllers, see as follows:
1) IGXFeatureControlIGXDevice::GetRemoteFeatureControl //Including the device's main
information, such as: width, height, exposure, gain etc. General users mainly use this feature controller.
2) IGXFeatureControlIGXDevice::GetFeatureControl //Including some local features, the device
functions of different type may differ.
3) IGXFeatureControlIGXStream::GetFeatureContro l //Stream object feature controller, a feature
access controller about acquisition control and data statistics.

Running the GalaxyView demo to open the device, you can see the parameters in the right properties
controller tree, there are three parts: the upper one is the properties which return from
IGXDevice::GetRemoteFeatureControl, and the middle one is the properties which return from
IGXDevice::GetFeatureControl. The lower one is the return properties from
IGXStream::GetFeatureControl.

Figure 2-6

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 8

 2.Programming Guide

2.8.2. Data Type

There are seven data types, see as follows:
1) IIntFeatureIGXFeatureControl::GetIntFeature //integer
2) IFloatFeatureIGXFeatureControl::GetFloatFeature //float
3) IBoolFeatureIGXFeatureControl::GetBoolFeature //Boolean
4) IEnumFeatureIGXFeatureControl::GetEnumFeature //enumerated
5) IStringFeatureIGXFeatureControl::GetStringFeature //string
6) ICommandFeatureIGXFeatureControl::GetCommandFeature //command
7) IRegisterFeatureIGXFeatureControl::GetRegisterFeature //register

2.8.3. Access Type

There are three access types, see as follows:
1) System::BooleanIGXFeatureControl.IsImplemented //Is the feature implemented?
2) System::BooleanIGXFeatureControl. IsReadable //Is the feature readable?
3) System::BooleanIGXFeatureControl. IsWritable //Is the feature writable?

2.8.4. How to Get the Camera's Parameters

Get from the function: IGXFeatureControl.GetFeatureNameList, returns the function name string which the
current features control supported.

Get from the GalaxyView demo: open the device by GalaxyView demo, look over the right side—
properties list, the English name of every control node, as shown in the following figure:

Figure 2-7

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 9

 2.Programming Guide

As shown above, when the mouse pitch on image width, the function name, maximum, minimum, step
etc. will be shown in the Function Properties Description Area.

Note: The function name string is case sensitive.

2.8.5. How to Get the Sample Code for Feature Read & Write
The GalaxyView.exe provides sample codes for feature read & write. In the demo program menu bar: View
-> Feature Document, you can open the window, as shown in the following:

Figure 2-8

In the view of feature document, three development languages are available. Switch to C# Tab to get the
code for reading and writing user-specified feature in C# language. The code can be directly copied to the
user's development project.

2.8.6. Different Types of Feature Sample Code

2.8.6.1. Read & Write Access Control

All functions are controlled by function string. Check to see if the feature is currently available, and then to
read or write.
IGXFeature Control objIGXFeatureControl =
objIGXDevice.GetRemoteFeatureControl();
//Get width node.
Boolean bIsImplemented = objIGXFeatureControl.IsImplemented("Width");

if (bIsImplemented)
{
//Is readable?
Boolean bIsReadable = objIGXFeatureControl.IsReadable("Width");
//Is writable?
Boolean bIsWritable = objIGXFeatureControl.IsWritable("Width");
}

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 10

 2.Programming Guide

2.8.6.2. Integer Control

According to the data type, the camera's function is divided into seven categories, integer is one of them,
including width, height and other integer control parameters, users can use the integer controller
IntFeature to read the current value, inquire the maximum, minimum and step.
IGXFeatureControl objIGXFeatureControl =
objIGXDevice.GetRemoteFeatureControl();
IIntFeatureobjInt = objIGXFeatureControl.GetIntFeature("Width");
Int64 nMax = objInt.GetMax(); //Get the maximum value.
Int64 nMin = objInt.GetMin(); //Get the minimum value.
Int64 nInc = objInt.GetInc(); //Get the increment value.
Int64 nValue = objInt.GetValue(); //Get the current value.
objInt.SetValue(nValue); //Set the current value.

2.8.6.3. Float Control

To access the float data by FloatFeature, you can read and write the current value, check the Maximum,
Minimum, whether to support increment, increment value and unit.
IGXFeatureControl objIGXFeatureControl =
objIGXDevice.GetRemoteFeatureControl();
IFloatFeature objFloat = objIGXFeatureControl.GetFloatFeature("Gain");
Double dMax = objFloat.GetMax(); //Get the maximum value.
Double dMin = objFloat.GetMin(); //Get the minimum value.
Boolean bHasInc = objFloat.HasInc();
if (bHasInc)
{
Double dInc = objFloat.GetInc(); //Get the increment value.
}
String strUnit = objFloat.GetUnit(); //Get the unit.
Double dValue = objFloat.GetValue();//Get the current value.
objFloat.SetValue(dValue); //Set the current value.

2.8.6.4. Boolean Control

Boolean is relatively simple, only True and False.

IGXFeatureControl objIGXFeatureControl = objIGXDevice.GetRemoteFeatureControl();
IBoolFeature objBool = objIGXFeatureControl.GetBoolFeature("ChunkModeActive");
Boolean bValue = objBool.GetValue();//Get the current value.
objBool.SetValue(bValue); //Set the current value.

2.8.6.5. Enumeration Control

Enumerated can check the options, and read/write interfaces which the enumerated function supported.
IGXFeatureControl objIGXFeatureControl = objIGXDevice.GetRemoteFeatureControl();
IEnumFeature objEnum = objIGXFeatureControl.GetEnumFeature("AcquisitionMode");
List<String> listEnumEntry = newList<String>();
listEnumEntry = objEnum.GetEnumEntryList();//Get the enum items list.
foreach (String str in listEnumEntry)
{
Console.WriteLine(str); //Print all the enum items.
}
String strValue = objEnum.GetValue(); //Get the current item.
objEnum.SetValue(strValue); //Set the current item.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 11

 2.Programming Guide

2.8.6.6. String Control

String provides the function to read/write the current value, check the maximum string length supported
before write.
IGXFeatureControl objIGXFeatureControl = objIGXDevice.GetRemoteFeatureControl();
IStringFeature objString = objIGXFeatureControl.GetStringFeature("DeviceUserID");
//Get the current value.
String strValue = objString.GetValue();
//Get the maximum length can be written to.
Int64 nMaxLength = objString.GetStringMaxLength();
//Write the current value.
objString.SetValue(strValue);

2.8.6.7. Command Control

The command type is simplest, only one executes method.

IGXFeatureControl objIGXFeatureControl = objIGXDevice.GetRemoteFeatureControl();
ICommandFeature objCommand = objIGXFeatureControl.GetCommandFeature(
"AcquisitionStart");
objCommand.Execute(); //Execute the command.

2.8.7. Precautions
After getting from the device object, the features controller IGXFeatureControl is valid until the device
closed. Once the device is closed, the features controller is invalid; you cannot call any features of the
features controller.

2.9. Acquisition Control and Image Processing

All the methods and control related to Acquisition are in the IGXStream object. How to get and open the
stream object please see the following code:
UInt32 nStreamNum = objIGXDevice.GetStreamCount();
if (nStreamNum > 0)
{
IGXStream objIGXStream = objIGXDevice.OpenStream(0);

//Stream object control or acquisition.

//Closing it when no longer to use the stream object.

objIGXStream.Close();
}

There two acquisition ways: callback acquisition and get a single image.

2.9.1. Get a Single Image

After opening the stream object acquisition and sending start acquisition command to the device, you can
call the GetImage to get a single image, please see the following code:
IGXStream objIGXStream = objIGXDevice.OpenStream(0);

//Improve the acquisition performance of the network camera, the setting

//method refers to the following code (currently only the Gigabit network
//camera supports the optimal packet length).
GX_DEVICE_CLASS_LIST objDeviceClass =
m_objIGXDevice.GetDeviceInfo().GetDeviceClass();
if (GX_DEVICE_CLASS_LIST.GX_DEVICE_CLASS_GEV == objDeviceClass)

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 12

 2.Programming Guide

{
//Determine whether the device supports the stream channel packet function.
if (true == m_objIGXFeatureControl.IsImplemented("GevSCPSPacketSize"))
{
//Get the optimal packet length value of the current network environment.
uint nPacketSize = m_objIGXStream.GetOptimalPacketSize();

//Set the optimal packet length value to the stream channel packet
//length of the current device.
m_objIGXFeatureControl.GetIntFeature("GevSCPSPacketSize").SetValue(
nPacketSize);
}
}

//Open stream channel acquisition.

objIGXStream.StartGrab();

//Send start acquisition command to the device.

IGXFeatureControl objIGXFeatureControl = objIGXDevice.GetRemoteFeatureControl();
objIGXFeatureControl.GetCommandFeature("AcquisitionStart").Execute();

//Get a single image.

IImageData objImageData = null;

//Set 'timeout'=500ms, users can set the value by themselves.

objImageData = objIGXStream.GetImage(500);
if (objImageData.GetStatus() == GX_FRAME_STATUS_SUCCESS)
{
//If the acquisition is success and the image is a full frame, then the
//user can process the image.
}

//Destroy the 'objImageData' object.

objImageData.Destroy();

//Stop acquisition.
objIGXFeatureControl.GetCommandFeature("AcquisitionStop").Execute();
objIGXStream.StopGrab();

//Close stream channel.

objIGXStream.Close();

Note: Users must call the StartGrab to start the stream channel acquisition first, and then send start
acquisition command to the device, otherwise the start acquisition command will invalid. Users use the
function GetImage to get the IImageData object, if you do not use this function anymore, please destroy
it by calling the Destroy method. When using a high-resolution camera for high-speed data
acquisition, recommend you to use callback acquisition mode, because the buffer copy inside the
GetImage will affect the transmission performance.

2.9.2. Acquisition with Callback Functions

Users can register callback function to grab images, see the following code:
IGXStream objIGXStream = objIGXDevice.OpenStream(0);

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 13

 2.Programming Guide

//Improve the acquisition performance of the network camera, the setting

//method refers to the following code (currently only the Gigabit network
//camera supports the optimal packet length).
GX_DEVICE_CLASS_LIST objDeviceClass =
m_objIGXDevice.GetDeviceInfo().GetDeviceClass();
if (GX_DEVICE_CLASS_LIST.GX_DEVICE_CLASS_GEV == objDeviceClass)
{
//Determine whether the device supports the stream channel packet function.
if (true == m_objIGXFeatureControl.IsImplemented("GevSCPSPacketSize"))
{
//Get the optimal packet length value of the current network environment.
uint nPacketSize = m_objIGXStream.GetOptimalPacketSize();

//Set the optimal packet length value to the stream channel packet
//length of the current device.
m_objIGXFeatureControl.GetIntFeature("GevSCPSPacketSize").SetValue(
nPacketSize);
}
}

//Register the acquisition callback function. Note: the first parameter is a user's
//private parameter, user can set any type of object, and also can set it null.
//The user's private parameter used within the callback function for restore,
//if not use the private parameter, you can set it null.
objIGXStream.RegisterCaptureCallback(objIGXDevice, OnFrameCallbackFun);

//Start stream channel acquisition.

objIGXStream.StartGrab();

//Send start acquisition command to the device.

IGXFeatureControl objIGXFeatureControl = objIGXDevice.GetRemoteFeatureControl();
objIGXFeatureControl.GetCommandFeature("AcquisitionStart").Execute();

//Callback acquisition process, please refer the callback function.

//Stop acquisition, unregister acquisition callback function.
objIGXFeatureControl.GetCommandFeature("AcquisitionStop").Execute();
objIGXStream.StopGrab();
objIGXStream.UnregisterCaptureCallback();

//Close stream channel.

objIGXStream.Close();

User's callback function, see the following code:

PublicvoidOnFrameCallbackFun(object obj, IFrameData objIFrameData)
{
//User's private parameter obj, the device object was set when the user
//register the callback function, you can restore the parameter as a user
//private parameter within the callback function.
IGXDeviceobjIGXDevice = objasIGXDevice;
if (objIFrameData.GetStatus() == GX_FRAME_STATUS_SUCCESS)
{
//If the image acquisition is a full frame, then you can read the image
//width, height,data format and etc.
UInt64 nWidth = objIFrameData.GetWidth();
UInt64 nHeight = objIFrameData.GetHeight();
GX_PIXEL_FORMAT_ENTRY emPixelFormat = objIFrameData.GetPixelFormat();

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 14

 2.Programming Guide

//More images information please refer the IFrameData interfacedefine.

}
}

Note: Users must call the function StartGrab to start stream channel acquisition, and then send start
acquisition command to the device; otherwise the start acquisition command will invalid.

2.9.3. Set the Number of Acquisition Buffer

After opening the stream, users can call SetAcqusitionBufferNumber to set the number of acquisition buffer,
see the following code:
IGXStream objStream= objDevice.OpenStream(0);

//Improve the acquisition performance of the network camera, the setting

//method refers to the following code (currently only the Gigabit network
//camera supports the optimal packet length).
GX_DEVICE_CLASS_LIST objDeviceClass =
m_objIGXDevice.GetDeviceInfo().GetDeviceClass();
if (GX_DEVICE_CLASS_LIST.GX_DEVICE_CLASS_GEV == objDeviceClass)
{
//Determine whether the device supports the stream channel packet function.
if (true == m_objIGXFeatureControl.IsImplemented("GevSCPSPacketSize"))
{
//Get the optimal packet length value of the current network environment.
uint nPacketSize = m_objIGXStream.GetOptimalPacketSize();

//Set the optimal packet length value to the stream channel packet
//length of the current device.
m_objIGXFeatureControl.GetIntFeature("GevSCPSPacketSize").SetValue(
nPacketSize);
}
}

//Set the number of acquisition buffer.

objStream.SetAcqusitionBufferNumber(10);

//Start stream channel acquisition.

objStream.StartGrab();

//start acquisition command to the device.

IGXFeatureControl objIGXFeatureControl = objIGXDevice.GetRemoteFeatureControl();
objIGXFeatureControl.GetCommandFeature("AcquisitionStart").Execute();

// ………

//Stop acquisition.
objIGXFeatureControl.GetCommandFeature("AcquisitionStop").Execute();
objStream.StopGrab();

//Close stream channel.

objStream.Close();

Note:
1) This interface is an optional interface. When multiple cameras are acquisiting at the same time, if the
frame rate of individual cameras is 0, you can call this interface to adjust the number of acquisition
buffers of all cameras to ensure that all cameras have buffers for acquisition.
2) The buffer number must be set before calling StartGrab to start the stream channel acquisition,
otherwise the setting is invalid.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 15

 2.Programming Guide

2.9.4. Image Processing

2.9.4.1. Image Format Conversion

Function description: Specified for an 8 bit valid data. Assume that the original data is non 8-bit, no matter
mono or color, you can call the function CovertToRaw8 to specify for an 8-bit data, and the return value
type is IntPtr. The specified memory size is Width * Height.

Sample Code:
IntPtr pRaw8Buffer = IntPtr.Zero;
//Assume the original data is mono8 image.
pRaw8Buffer = objIBaseData.ConvertToRaw8(GX_BIT_0_7);
//Assume the original data is Mono12 image.
pRaw8Buffer = objIBaseData.ConvertToRaw8(GX_BIT_4_11);
//Assume the original data is BayerRG8 image.
pRaw8Buffer = objIBaseData.ConvertToRaw8(GX_BIT_0_7);
//Assume the original data is BayerRG12 image.
pRaw8Buffer = objIBaseData.ConvertToRaw8(GX_BIT_4_11);

Function description: Bayer format convert to RGB24 format, no matter the current image output is mono
or color, 8-bit or non 8-bit, you can call the function ConvertToRGB24 to complete data interpolation
processing, and the return IntPtr is RGB24 format. The memory size is Width*Height*3.

Sample Code:
//The parameter 'objIBseData' can be the 'IFrameData' which set by the
//acquisition callback function, and also can be the 'IImageData' which the
//function 'GetImage' acquired.
IntPtr pRGB24Buffer = IntPtr.Zero;
//Assume the original data is mono8 image.
pRGB24Buffer = objIBaseData.ConvertToRGB24(GX_BIT_0_7, GX_RAW2RGB_NEIGHBOUR,
true);
//Assume the original data is Mono12 image.
pRGB24Buffer = objIBaseData.ConvertToRGB24(GX_BIT_4_11, GX_RAW2RGB_NEIGHBOUR,
true);
//Assume the original data is BayerRG8 image.
pRGB24Buffer = objIBaseData.ConvertToRGB24(GX_BIT_0_7, GX_RAW2RGB_NEIGHBOUR,
true);
//Assume the original data is BayerRG12 image.
pRGB24Buffer = objIBaseData.ConvertToRGB24(GX_BIT_4_11,GX_RAW2RGB_NEIGHBOUR,
true);

2.9.4.2. Image Effect Enhanced

The interface library also provides the image effect enhanced in software side, users can do some image
effect enhanced operate selectively, such as: defective-pixel correction, sharpening, contrast, brightness
and etc. The image effect enhanced involves the functions IImageProcessConfig, IFrameData and
IImageData.

Sample Code:
//Use the device object to construct image processing configuration object.
IImageProcessConfig objcfg = objIGXDevice.CreateImageProcessConfig();

//The parameter 'objIBseData' can be the 'IFrameData' which introduced by the

//acquisition callback function, and also can be the 'IImageData' which the
//function 'GetImage' acquired.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 16

 2.Programming Guide

IntPtrpRGB24Processed = IntPtr.Zero;

//The return result is RGB24 format data which is handled by image effect enhanced.
pRGB24Processed = objIBaseData.ImageProcess(objcfg);

//Release it when no longer use the 'objcfg'.

objcfg.Destroy();

For different data type cameras, the support of effect enhanced from interface library is also different.
Details as follows:
RawData
function Corresponding interface Mono Bayer
Mono8 Bayer8
non8 non8
Set valid bit SetValidBit Yes Yes Yes Yes
Defective Pixel correction
EnableDefectivePixelCorrect Yes Yes Yes Yes
switch
Sharpen switch EnableSharpen Yes Yes Yes Yes
Sharpen factor SetSharpenParam Yes Yes Yes Yes
Contrast SetContrastParam Yes Yes Yes Yes
Gamma SetGammaParam Yes Yes Yes Yes
Brightness SetLightnessParam Yes Yes Yes Yes
Noise reduction switch EnableDenoise No No Yes Yes
Saturation SetSaturationParam No No Yes Yes
RGB24 interpolation type SetConvertType No No Yes Yes
RGB24 interpolation flip
EnableConvertFlip No No Yes Yes
switch
Color correction switch EnableColorCorrection No No Yes Yes

Table 2-1 Image effect enhanced comparison table

The parameter range of Image effect enhance and the detail explanation as follows:
Functions Default value Range Remarks
 For 8bit data , only one to select : GX_BIT_0_7
 For 10bit data, you can select GX_BIT_0_7,
Refer GX_BIT_1_8, GX_BIT_2_9, recommend
Set valid bit GX_BIT_0_7 GX_VALID_B GX_BIT_2_9
IT_LIST  For 12bit data, you can select GX_BIT_0_7,
GX_BIT_1_8, GX_BIT_2_9, GX_BIT_3_10,
GX_BIT_4_11, recommend GX_BIT_4_11
Defective Pixel true: switch on defective Pixel correction
false true, false
correction switch false: switch off defective Pixel correction
true: switch on sharpen
Sharpen switch false true, false
false: switch off sharpen
Sharpen factor 0.1 [0.1, 5] Increase sharpening effect gradually

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 17

 2.Programming Guide

0: the contrast ratio does not change

Contrast 0 [-50, 100] > 0: increasing contrast ratio
<0: decrease contrast ratio
Gamma 0 [0.1, 10] -
0 : the brightness does not change
Brightness 0 [-150, 150] > 0: increasing brightness
< 0: decrease brightness
Noise reduction true: switch on noise reduction
false true, false
switch false: switch off noise reduction
64: saturation does not change
>64: increasing saturation
Saturation 64 [0, 128] < 64: decrease saturation
128: double the current saturation
0: mono image
Refer
RGB24 GX_RAW2R
GX_BAYER_
interpolation GB_NEIGHB -
CONVERT_T
type OUR
YPE_LIST
RGB24
true: flip
interpolation flip false true, false
false: non-flip
switch
Table 2-2 Image effect enhanced parameters range and description

The advanced user can fine-tune the parameter after getting IImageProcessConfig object, see as follows:
//Through the device object to construct image processing configuration object.
IImageProcessConfigobjcfg = objIGXDevice.CreateImageProcessConfig();

//Initialization the default configuration parameter when constructing the

//'objcfg' object, the user can choose to fine-tune the configuration parameter.

//Select significance bit 0-7.

objcfg.SetValidBit(GX_BIT_0_7);
//Enable defective Pixel correction.
objcfg.EnableDefectivePixelCorrect(true);
//Enable sharpen.
objcfg.EnableSharpen(true);
//Set sharpen factor is 1.
objcfg.SetSharpenParam(1);
//Set contrast control parameter.
objcfg.SetContrastParam(0);
//Set Gamma factor.
objcfg.SetGammaParam(1);
//Set brightness control parameter.
objcfg.SetLightnessParam(0);
//Enable noise reduction switch, not support mono camera.
objcfg.EnableDenoise(true);
//Set saturation control factor, not support mono camera.
objcfg.SetSaturationParam(0);
//Set interpolation algorithm, not support mono camera.
objcfg.SetConvertType(GX_RAW2RGB_NEIGHBOUR);

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 18

 2.Programming Guide

//Enable interpolation flip, not support mono camera.

objcfg.EnableConvertFlip(true);

//User can also choose to restore the optimum default parameter configuration.
objcfg.Reset();

//The parameter 'objIBseData' can be the 'IFrameData' which set the acquisition
//callback function, and also can be the 'IImageData' which the function 'GetImage'
//acquired.
IntPtrpRGB24Processed = IntPtr.Zero;

//The return result is RGB24 format data which is handled by image effect enhanced.
pRGB24Processed = objIBaseData.ImageProcess(objcfg);

//Release it when no longer use the 'objcfg'.

objcfg.Destroy();

2.9.4.3. The Result of Image Effect Enhanced

According on the cameras' type and usage scenario, the image effect enhanced configuration parameters
are also different, but there are still a few recommend functions can meet the needs of most users. Take
MER-200-20GC GigE Vision camera for example, the image which the camera output after image format
conversion to RGB24 bit, the result as follows without any effect enhance processing:

Figure 2-9 Neighborhood interpolation RGB image (color correction: off; saturation: 64; Gamma: 1; contrast: 0)

On the basis of Figure 2-9, switch on the color correction function, see the result as follows:

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 19

 2.Programming Guide

Figure 2-10 Switch on color correction based on figure2-10 (color correction: on; saturation: 64; Gamma: 1; Contrast: 0)

On the basis of Figure 2-10, increase the saturation to 80, see the result as follows:

Figure 2-11 Set saturation to 80(color correction: on; saturation: 80; Gamma: 1; Contrast: 0)

On the basis of Figure 2-11, adjust the Gamma to 1.98, make the image more close to what the users see
in the actual scene, the value 1.98 is just for an example, for different cameras the Gamma value will differ.
For the USB2.0 and USB3.0 cameras, users can read the gamma by the read/write interface. But for the
GigE Vision camera, the user should adjust the gamma by himself, there is not an interface to be called
directly.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 20

 2.Programming Guide

Figure 2-12 Set the Gamma is 1.98(color correction: on; saturation: 80; Gamma: 1.98; Contrast: 0)

On the basis of Figure 2-12, set the contrast to 40, see the result as follows:

Figure 2-13 Set the contrast is 40(color correction: on; saturation: 80; Gamma: 1.98; Contrast: 40)

2.9.5. Stream Object Features Control

We have mentioned that the stream layer has its own features control in the chapter FeaturesControl,
users can get it by calling the interface IGXStream::GetFeatureControl. The control features of the
stream layer include the acquisition control and statistical information. Take the Gigabit Ethernet stream
layer statistical for example, such as to check the current acquisition and statistical information in the
process of acquisition.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 21

 2.Programming Guide

//'objGXStream' is an 'IGXStream' object which get from the interface

//'IGXDevice::OpenStream'.
IGXFeatureControl objStreamFeatureControl = objGXStream.GetFeatureControl();

//Check the acquisition and statistical information.

//The lost frame count which caused by the buffer lack.
objStreamFeatureControl.GetIntFeature("StreamLostFrameCount").GetValue();

//The count of incomplete frame.

objStreamFeatureControl.GetIntFeature("StreamIncompleteFrameCount").GetValue();

//The delivered packet count.

objStreamFeatureControl.GetIntFeature("StreamDeliveredPacketCount").GetValue();

//The resend packet count.

objStreamFeatureControl.GetIntFeature("StreamResendPacketCount").GetValue();

//Set acquisition configuration parameter.

//Set the block timeout is 200ms.
objStreamFeatureControl.GetIntFeature("BlockTimeout").SetValue(200);

The "StreamBufferHandlingMode" in the stream object features can set the processing mode of the Buffer.
Three Buffer processing modes are available:

1) OldestFirst: The default value. The image buffer follows the first-in-first-out principle. After all the
buffers are filled, the new image data will be discarded until the user completes the processing of the
buffer that has filled the image data. The typical application is to receive each frame of images
acquired by the camera without losing frames. In order to achieve no frame loss, the speed of image
data transmission and processing need to be as fast as possible (at least less than the frame period).

2) OldestFirstOverwrite: Follow the first-in-first-out principle. The difference from the OldestFirst mode is
that when all the buffers are filled, the SDK will automatically discard one frame of image buffer with
the oldest timestamp to receive new image data. The typical application is that it does not require
receiving each frame of images acquired by the camera, and the image data transmission and
processing speed is slow.

3) NewestOnly: In this mode, the user always receives the latest image received by the SDK. Each time
the SDK receives a new frame of image data, it will automatically discard the image with the old
timestamp. Therefore, when the user's image processing is not timely or the speed is slow, frame loss
will occur. In the main applications, the real-time requirements of image acquisition and display are
high, and it is not required to receive each frame of images acquired by the camera. However,
depending on the camera's frame rate, memory cache, transmission speed, and user applications,
there may be a delay between the latest image received by the SDK and the latest image exposed by
the camera.

Note: The above code snippet just shown the stream layer control function of the GigE Vision cameras,
for the other cameras, please use the GalaxyView demo to open the device, or call the function
IGXFeatureControl.GetFeatureNameList to get the function list.

2.9.6. Precautions
After getting from the device object, the features controller IGXStream is valid, until the device is closed.
Once the device is closed, the stream object will invalid, you cannot call any interface of the stream object.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 22

 2.Programming Guide

2.10. Get Devices Events

DAHENG IMAGING GigE Vision cameras can send event messages. For example: when a sensor
exposure has finished, the camera can send an end-of-exposure event to the PC. The event can be
received by the PC before the image data for the finished exposure has been completely transferred. In
this section will illustrate how to obtain events and event data.

2.10.1. Selection Events

Feature name string Function type Description Options (subject to the current device)
Maybe include the following options:
ExposureEnd [Exposure end.]
Event BlockDiscard [Block discard.]
EventSelector enumeration source EventOverrun [Event queue overflow.]
select FrameStartOvertrigger [Trigger signal overflow.]
BlockNotEmpty [Image buffer is not empty.]
InternalError [Internal error]

2.10.2. Enabled Events

Feature name string Function type Description Options (subject to the current device)
Event include the following options:
EventNotification enumeration
enable Off [off] On [on]

2.10.3. Registered Events Message Callback Function

The function which the register event used is IGXFeatureControl.RegisterFeatureCallback, the first
parameter is the function code of the event which to be registered, the event function code to be selected
is as follows:
Feature name string Function type Description

EventExposureEnd integer ID exposure end event ID

EventBlockDiscard integer data block discard event ID

EventOverrun integer event queue overflow ID

EventFrameStartOvertrigger integer trigger signal is shield event ID

EventBlockNotEmpty integer the frame buffer is not empty event ID

EventInternalError Integer internal error event ID

2.10.4. Get Events Data Information

User can call the function CGXFeatureControlPointer to read/write the current channel event information
within the event callback function, the section 2.9.3 declared 5 event types, the event information of the 5
types of events can be getting by the following control codes:
string for Register event related event data string Function type Description in Chinese
EventExposureEndTime exposure end event
integer
stamp timestamp
EventExposureEnd
EventExposureEndFra
integer exposure end event ID
meID

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 23

 2.Programming Guide

EventBlockDiscardTime data block discard

EventBlockDiscard integer
stamp event timestamp
EventOverrunTimestam event queue overflow
EventOverrun integer
p timestamp
EventFrameStartOvertri trigger signal is shield
EventFrameStartOvertrigger integer
ggerTimestamp event timestamp
EventBlockNotEmptyTi the frame buffer is not
EventBlockNotEmpty integer
mestamp empty event timestamp
EventInternalErrorTimes internal error event time
EventInternalError integer
tamp stamp

2.10.5. Sample Code

Take the getting exposure end event for example, the code snippet as follows:
//The 'objIGXDevice' is the 'IGXDevice' device object, the device is open.
//If the device event's features is on the far-end device feature controller,
//get the far-end device feature controller first.
IGXFeatureControl objRemoteFeatureControl = objIGXDevice.GetRemoteFeatureControl();

//Select the event source.

objRemoteFeatureControl.GetEnumFeature("EventSelector").SetValue("ExposureEnd");

//Enable the event.

objRemoteFeatureControl.GetEnumFeature("EventNotification").SetValue("On");

//Register event callback function, note that the second parameter is a user
//private parameter, the user can set any 'object' type object.
//The private parameter can be restored for the user's use within the callback
//function, if the user does not use the private parameter, the parameter can
//be set to null.
//Here we set the 'objRemoteFeatureControl' object.
GX_FEATURE_CALLBACK_HANDLE objEventHandle = null;
objEventHandle = objRemoteFeatureControl.RegisterFeatureCallback(
"EventExposureEnd",
objRemoteFeatureControl,
OnFeatureCallback);

//Start stream channel acquisition.

objIGXStream.StartGrab();

//Send start acquisition command to the device.

IGXFeatureControl objIGXFeatureControl = objIGXDevice.GetRemoteFeatureControl();
objIGXFeatureControl.GetCommandFeature("AcquisitionStart").Execute();

//Send start acquisition command and the camera start exposuring and
//outputting images, when the exposure is end, an exposure end event will
//generate, then will activate the callback 'OnFeatureCallback' interface.
//Receive the exposure end event, please refer to the
//'OnFeatureCallback'function.
//Send stop acquisition command to the device.
objIGXFeatureControl.GetCommandFeature("AcquisitionStop").Execute();
objIGXStream.StopGrab();

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 24

 2.Programming Guide

//Unregister event.
objRemoteFeatureControl.UnregisterFeatureCallback(objEventHandle);

Event delegate function as follows:

voidOnFeatureCallback(object objUserParam, string strFeatureName)
{
//Use 'IGXFeatureControl' object as a user private parameter when registering
//the events.
//Resotre it within the delegate callback function, to get the data of
//exposure end event.
IGXFeatureControl objFeatureControl = objUserParam as IGXFeatureControl;

//Get exposure end event timestamp.

objFeatureControl.GetIntFeature("EventExposureEndTimestamp").GetValue();

//Get exposure end event ID.

objFeatureControl.GetIntFeature("EventExposureEndFrameID").GetValue();
}

Note: Users must send the start acquisition command first, then the camera can output exposure end
event and send start acquisition command. So the user must call the IGXStream::StartGrab first, and
then get the AcquisitionStart command node by the features controller and to execute the command
Execute.

2.11. Get Offline Event

DAHENG IMAGING GigE Vision camera provides device offline event mechanism; users can get the
device offline event by callback function, and register the event after open the device.

Steps of get the offline events:

1) Register the offline events.

2) Motivate the callback function after the device offline.

3) Unregister the offline events.

Register offline events code snippet as follows:

GX_DEVICE_OFFLINE_CALLBACK_HANDLE hDeviceOffline = null;
//ObjIGXDevice is the IGXDevice device object, the device is open.
//The user can set a string to the first parameter, such as device name, the
//parameter is user private, user can restore and print it within the callback function.
//If not use it, set it null.
hDeviceOffline = objIGXDevice.RegisterDeviceOfflineCallback(null,
OnDeviceOfflineEvent);

Unregister events before close the device:

objIGXDevice.UnregisterDeviceOfflineCallback(hDeviceOffline);

The callback function as follows:

public void OnDeviceOfflineEvent(object obj)
{
//Obj is a user private parameter, users can set it when registering the
//callback function and restore it here.
//Users are not allowed to execute close device inner the offline callback

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 25

 2.Programming Guide

//function, otherwise an illegal call exception will throw out.

}

Note: Not allowed to execute close the device operation within the offline callback function.

2.12. Import and Export Cameras' Configuration Parameters

Open device by running the GalaxyView Demo, expanding the menu File, you can see the menu import
device configuration and export device configuration, see as follows:

Figure 2-14

Select Export Device Configuration menu, a new text file will create in the local disk to save the current
parameter of the device.

Select Import Device Configuration menu, select the local file and import it.

There is also having corresponding user interface to be called in C# interface library.

Import/export configuration files, sample code as follows:

//Open device, here we open the device by the serial number, the serial number
//is subject to the actual device.Users can open the device by other ways.
IGXDevice objIGXDevice = objIGXFactory.OpenDeviceBySN("RN0001007012",
GX_ACCESS_EXCLUSIVE);

//Open the first stream object of the device.

IGXStream objIGXStream = objIGXDevice.OpenStream(0);

//Export configuration files, users can free to take the file name, but the
//export catalog must be existed first.
objIGXDevice.ExportConfigFile("D:\\Config.txt");

//Import configuration files.

objIGXDevice.ImportConfigFile("D:\\Config.txt");

Note: Before executing the import/export configuration file, you should open the device first, and open the
first stream object of the device.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 26

 3.Data Type Definition

3. Data Type Definition

3.1. GX_STATUS_LIST
Definition Value Explanation
GX_STATUS_SUCCESS 0 Success.
GX_STATUS_ERROR -1 Error unexpected.
GX_STATUS_NOT_FOUND_TL -2 Cannot find TL library.
GX_STATUS_NOT_FOUND_DEVICE -3 Cannot find devices.
GX_STATUS_OFFLINE -4 Current device status is offline.
GX_STATUS_INVALID_PARAMETER -5 Invalid parameter.
GX_STATUS_INVALID_HANDLE -6 Invalid handle.
GX_STATUS_INVALID_CALL -7 Invalid interface calling.
Current function cannot be accessed or the
GX_STATUS_INVALID_ACCESS -8
device access mode is incorrect.
GX_STATUS_NEED_MORE_BUFFER -9 User's buffer is not enough.
Feature type error, such as use IntFeature to
GX_STATUS_ERROR_TYPE -10
handle float function.
GX_STATUS_OUT_OF_RANGE -11 Input value is out of the range.
GX_STATUS_NOT_IMPLEMENTED -12 Unsupported function.
GX_STATUS_NOT_INIT_API -13 Not call initialize interface.
GX_STATUS_TIMEOUT -14 Timeout error.

3.2. GX_DEVICE_CLASS_LIST
Definition Value Explanation
GX_DEVICE_CLASS_UNKNOWN 0 The class of the Device is unknown.
GX_DEVICE_CLASS_USB2 1 USB2.0 device.
GX_DEVICE_CLASS_GEV 2 GigE device.
GX_DEVICE_CLASS_U3V 3 USB3.0 device.

3.3. GX_ACCESS_STATUS
Definition Value Explanation
GX_ACCESS_STATUS_UNKNOWN 0 The status of the current device is unknown.
The status of the current device is
GX_ACCESS_STATUS_READWRITE 1
readable/writable.
GX_ACCESS_STATUS_READONLY 2 The status of the current device is read-only.
The status of the current device is not readable /
GX_ACCESS_STATUS_NOACCESS 3
writable.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 27

 3.Data Type Definition

3.4. GX_ACCESS_MODE
Definition Value Explanation
GX_ACCESS_READONLY 2 The access mode is read-only mode.
GX_ACCESS_CONTROL 3 The access mode is control mode.
GX_ACCESS_EXCLUSIVE 4 The access mode is exclusive mode.

3.5. GX_PIXEL_FORMAT_ENTRY
Definition Value Explanation
GX_PIXEL_FORMAT_UNDEFINED 0x00000000 -
GX_PIXEL_FORMAT_MONO8 0x01080001 Monochrome 8-bit.
GX_PIXEL_FORMAT_MONO8_SIGNED 0x01080002 Monochrome 8-bit signed.
GX_PIXEL_FORMAT_MONO10 0x01100003 Monochrome 10-bit unpacked.
GX_PIXEL_FORMAT_MONO12 0x01100005 Monochrome 12-bit unpacked.
GX_PIXEL_FORMAT_MONO14 0x01100025 Monochrome 14-bit unpacked.
GX_PIXEL_FORMAT_MONO16 0x01100007 Monochrome 16-bit.
GX_PIXEL_FORMAT_BAYER_GR8 0x01080008 Bayer Green-Red 8-bit.
GX_PIXEL_FORMAT_BAYER_RG8 0x01080009 Bayer Red-Green 8-bit.
GX_PIXEL_FORMAT_BAYER_GB8 0x0108000A Bayer Green-Blue 8-bit.
GX_PIXEL_FORMAT_BAYER_BG8 0x0108000B Bayer Blue-Green 8-bit.
GX_PIXEL_FORMAT_BAYER_GR10 0x0110000C Bayer Green-Red 10-bit.
GX_PIXEL_FORMAT_BAYER_RG10 0x0110000D Bayer Red-Green 10-bit.
GX_PIXEL_FORMAT_BAYER_GB10 0x0110000E Bayer Green-Blue 10-bit.
GX_PIXEL_FORMAT_BAYER_BG10 0x0110000F Bayer Blue-Green 10-bit.
GX_PIXEL_FORMAT_BAYER_GR12 0x01100010 Bayer Green-Red 12-bit.
GX_PIXEL_FORMAT_BAYER_RG12 0x01100011 Bayer Red-Green 12-bit.
GX_PIXEL_FORMAT_BAYER_GB12 0x01100012 Bayer Green-Blue 12-bit.
GX_PIXEL_FORMAT_BAYER_BG12 0x01100013 Bayer Blue-Green 12-bit.
GX_PIXEL_FORMAT_BAYER_GR16 0x0110002E Bayer Green-Red 16-bit.
GX_PIXEL_FORMAT_BAYER_RG16 0x0110002F Bayer Red-Green 16-bit.
GX_PIXEL_FORMAT_BAYER_GB16 0x01100030 Bayer Green-Blue 16-bit.
GX_PIXEL_FORMAT_BAYER_BG16 0x01100031 Bayer Blue-Green 16-bit.
GX_PIXEL_FORMAT_RGB8_PLANAR 0x02180021 Red-Green-Blue 8-bit planar.
GX_PIXEL_FORMAT_RGB10_PLANAR 0x02300022 Red-Green-Blue 10-bit unpacked.
GX_PIXEL_FORMAT_RGB12_PLANAR 0x02300023 Red-Green-Blue 12-bit unpacked.
GX_PIXEL_FORMAT_RGB16_PLANAR 0x02300024 Red-Green-Blue 16-bit planar.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 28

 3.Data Type Definition

3.6. GX_FRAME_STATUS_LIST
Definition Value Explanation
GX_FRAME_STATUS_SUCCESS 0 The frame status is successful.
GX_FRAME_STATUS_INCOMPLETE -1 The frame status is incomplete.

3.7. GX_FEATURE_TYPE
Definition Value Explanation
GX_FEATURE_INT 0x10000000 Integer function.
GX_FEATURE_FLOAT 0x20000000 Float function.
GX_FEATURE_ENUM 0x30000000 Enumerated function.
GX_FEATURE_BOOL 0x40000000 Boolean function.
GX_FEATURE_STRING 0x50000000 String function.
GX_FEATURE_BUFFER 0x60000000 Register function.
GX_FEATURE_COMMAND 0x70000000 Command function.

3.8. GX_BAYER_CONVERT_TYPE_LIST
Definition Value Explanation
GX_RAW2RGB_NEIGHBOUR 0 Neighborhood average interpolation algorithm.
GX_RAW2RGB_ADAPTIVE 1 Edge adaptive interpolation algorithm.
GX_RAW2RGB_NEIGHBOUR3 2 Larger neighborhood average algorithm.

3.9. GX_VALLID_BIT_LIST
Definition Value Explanation
GX_BIT_0_7 0 bit 0~7
GX_BIT_1_8 1 bit 1~8
GX_BIT_2_9 2 bit 2~9
GX_BIT_3_10 3 bit 3~10
GX_BIT_4_11 4 bit 4~11

3.10. GX_IP_CONFIGURE_MODE_LIST
Definition Value Explanation
GX_IP_CONFIGURE_LLA 4 Start LLA mode to configure IP address.
GX_IP_CONFIGURE_STATIC_IP 5 Use static IP mode to configure IP address.
Use DHCP mode, use DHCP server to configure
GX_IP_CONFIGURE_DHCP 6
IP address.
GX_IP_CONFIGURE_DEFAULT 7 Use default mode to configure IP address.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 29

 3.Data Type Definition

3.11. GX_RESET_DEVICE_MODE
Definition Value Explanation
GX_MANUFACTURER_SPECIFIC_REC Device reconnection. It is equivalent to the
1
ONNECT software interface close the device.
GX_MANUFACTURER_SPECIFIC_RES Device reset. It is equivalent to powering off and
2
ET powering up the device.

3.12. COLOR_TRANSFORM_FACTOR
Definition Default value Value range Explanation
float
1.0 -4.0 ~ 4.0 Red Channel Gain contribution to the red pixel.
fGain00
float
0.0 -4.0 ~ 4.0 Green Channel Gain contribution to the red pixel.
fGain01
float
0.0 -4.0 ~ 4.0 Blue Channel Gain contribution to the red pixel.
fGain02
float
0.0 -4.0 ~ 4.0 Red Channel Gain contribution to the green pixel.
fGain10
float
1.0 -4.0 ~ 4.0 Green Channel Gain contribution to the green pixel.
fGain11
float
0.0 -4.0 ~ 4.0 Blue Channel Gain contribution to the green pixel.
fGain12
float
0.0 -4.0 ~ 4.0 Red Channel Gain contribution to the blue pixel.
fGain20
float
0.0 -4.0 ~ 4.0 Green Channel Gain contribution to the blue pixel.
fGain21

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 30

 4.Handle Type Definition

4. Handle Type Definition

Definition Explanation
GX_DEVICE_OFFLINE_CALLBA The handle of Offline event, which can be get by calling the
CK_HANDLE interface 'IGXDevice::RegisterDeviceOfflineCallback'.
GX_FEATURE_CALLBACK_HAN The handle of feature update event, which can be get by calling
DLE the interface: 'IGXFeatureControl::RegisterFeatureCallback'.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 31

 5.Delegate Function Type Definition

5. Delegate Function Type Definition

Type Denifition
public delegate void CaptureDelegate(System::Object
Acquisition callback delegate function
obj,GxIAPINET::IFrameData objIFrameData)
public delegate void DeviceOfflineDelegate(System::Object
Device offline event delegate function
obj)
public delegate void FeatureDelegate(System::Object
Feature update event delegate function
objUserParam,String strFeatureName)

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 32

 6.Module Interface Definition

6. Module Interface Definition

6.1. IGXFactory
The 'IGXFactory' is responsible for initializing global resources, enumerating devices, and opening devices.

Interface List:

GetInstance Static function, and can be called globally. Return to the IGXFactory object

instance.

Init Initialize the library resources.

Uninit Release library resources.

UpdateDeviceList Enumerate the device (subnet enumeration for GigE Vision device).

UpdateAllDeviceList Enumerate the device (all subnet enumeration for GigE Vision device).

OpenDeviceByIP Open the device by IP address.

OpenDeviceByMAC Open the device by MAC address.

OpenDeviceBySN Open the device by SN.

OpenDeviceByUserID Open the device by user ID.

GigEIPConfiguration Configure the camera static state (perpetual) IP address.

GigEForceIP Execute Force IP operation.

GigEResetDevice Execute device reconnection or device reset operation.

6.1.1. GetInstance
Interface definition:

static IGXFactory GetInstance ()

Function description:

Static function, and can be called globally. Return to the IGXFactory object instance.

6.1.2. Init
Interface definition:

void Init(void)

Function description:

Initialize library resources.

6.1.3. Uninit
Interface definition:

void Uninit(void)

Function description:

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 33

 6.Module Interface Definition

Release library resources.

6.1.4. UpdateDeviceList
Interface definition:

void UpdateDeviceList(UInt32 nTimeout,

System::Collections::Generic::List<IGXDeviceInfo> listDeviceInfo)

Function description:

Enumerate devices (subnet enumerate for GigE Vision device).

Parameter1: timeout time, unit: ms.

Parameter2: returned device information list.

6.1.5. UpdateAllDeviceList
Interface definition:

void UpdateAllDeviceList(UInt32 nTimeout,

System::Collections::Generic::List<IGXDeviceInfo> listDeviceInfo)

Function description:

Enumerate devices (all subnet enumerate GigE Vision device).

Parameter1: timeout time, unit: ms.

Parameter2: returned device information list.

6.1.6. OpenDeviceByIP/MAC/SN/UserID
Interface definition:

IGXDevice OpenDeviceByIP(String strIP, GX_ACCESS_MODE emAccessMode)

Function description:

Open devices by IP address.

Parameter1: the device's IP address.

Parameter2: the mode of open device.

Return value: IGXDevice object instance.

6.1.7. GigEIPConfiguration
Interface definition:

void GigEIpConfiguration(String^ strDeviceMacAddress,

GX_IP_CONFIGURE_MODE emIpConfigMode,

const GxIAPICPP::gxstring^ strIpAddress,

const GxIAPICPP::gxstring^ strSubnetMask,

const GxIAPICPP::gxstring^ strDefaultGateway,

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 34

 6.Module Interface Definition

const GxIAPICPP::gxstring^ strUserID)

Function description:

Configure the camera static state (perpetual) IP address.

Parameter1: The MAC address of the device.

Parameter2: The IP configuration mode.

Parameter3: The IP address to be configured.

Parameter4: The subnet mask to be configured.

Parameter5: The default gateway to be configured.

Parameter6: The user-defined name to be configured.

Return value: NULL.

6.1.8. GigEForceIP
Interface definition:

void GigEForceIp(String^ strDeviceMacAddress,

String^ strIpAddress,

String^ strSubnetMask,

String^ strDefaultGateway)

Function description:

Execute Force IP operation.

Parameter1: The MAC address of the device.

Parameter2: The IP address value to be set.

Parameter3: The subnet mask to be set.

Parameter4: The default gateway to be set.

Return value: NULL.

6.1.9. GigEResetDevice
Interface definition:

void GigEResetDevice (String^ strDeviceMacAddress, GX_RESET_DEVICE_MODE ui32FeatureInfo)

Function description:

Execute device reconnection or device reset operation. See section 2.2 for details.

Device reconnection is usually used when debugging GigE cameras. The device has been opened, the
program is abnormal, and then the device is reopened immediately, and an error is reported (because the
heartbeat time is 5 minutes, the device is still open). In this case, you can use the device reconnection
function to make the device unopened. Then open the device again and it will succeed.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 35

 6.Module Interface Definition

Device reset is usually used when the camera status is abnormal. In this case, the device reconnection
function does not work, and there is no condition to repower the device. Try to use the device reset function
to power off and power up the device. After the device is reset, you need to enumerate device and open
device again.

Note：

1) Device reset takes about 1s, so you need to ensure that the enumeration interface is called after 1s.
2) If the device is acquiring normally, you cannot use the device reset and device reconnection function,
otherwise the device will offline.

Parameter1: The MAC address of the device.

Parameter2: Reset device mode.

Return value: NULL.

6.2. IGXDeviceInfo
Device information storage unit, stores all the information of the device. You can get the information by the
enumeration interface: IGXFactory::UpdateDeviceList or IGXFactory::UpdateAllDeviceList

Interface list:

GetVendorName Get the name of the manufacturer.

GetModelName Get the name of the device model.

GetSN Get the Series Number of the device.

GetDisplayName Get the display name of the device.

GetDeviceID Get the DeviceID, and the ID can be used to identify the device uniquely.

GetUserID Get the user-defined name.

GetAccessStatus Get the current addressable status of the device.

GetDeviceClass Get the device class, such as USB2.0, USB3.0, and GigE.

GetMAC Get the MAC address of the device, set the value to NULL for non-GigE device.

GetIP Get the IP address of the device, set the value to NULL for non-GigE device.

GetSubnetMask Get the subnet mask of the device, set the value to NULL for non-GigE device.

GetGateway Get the default gateway of the device, set the value to NULL for non-GigE
device.

GetNICMAC Get the corresponding NIC MAC address of the device, set the value to NULL
for non-GigE device.

GetNICIP Get the corresponding NIC IP address of the device, set the value to NULL for
non-GigE device.

GetNICSubnetMask Get the corresponding NIC subnet mask of the device, set the value to NULL
for non-GigE device.

GetNICGateway Get the corresponding NIC default gateway of the device, set the value to NULL

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 36

 6.Module Interface Definition

for non-GigE device.

GetNICDescription Get the corresponding NIC description information of the device, set the value
to NULL for non-GigE device.

6.2.1. GetVendorName
Interface definition:

String GetVendorName()

Function description:

Get the name of the manufacturer.

6.2.2. GetModelName
Interface definition:

String GetModelName()

Function description:

Get the model name of the device.

6.2.3. GetSN
Interface definition:

String GetSN()

Function description:

Get the Series Number of the device.

6.2.4. GetDisplayName
Interface definition:

String GetDisplayName()

Function description:

Get the display name of the device.

6.2.5. GetDeviceID
Interface definition:

String GetDeviceID()

Function description:

Get the DeviceID, and the ID can be used to identify the device uniquely.

6.2.6. GetUserID
Interface definition:

String GetUserID()

Function description:

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 37

 6.Module Interface Definition

Get the user-defined name.

6.2.7. GetAccessStatus
Interface definition:

GX_ACCESS_STATUS GetAccessStatus()

Function description:

Get the current addressable status of the device.

6.2.8. GetDeviceClass
Interface definition:

GX_DEVICE_CLASS_LIST GetDeviceClass()

Function description:

Get the device class, such as USB2.0, USB3.0, and GigE.

6.2.9. GetMAC
Interface definition:

String GetMAC()

Function description:

Get the MAC address of the device, set the value to NULL for non-GigE device.

6.2.10. GetIP
Interface definition:

String GetIP()

Function description:

Get the IP address of the device, set the value to NULL for non-GigE device.

6.2.11. GetSubnetMask
Interface definition:

String GetSubnetMask()

Function description:

Get the IP address of the device, set the value to NULL for non-GigE device.

6.2.12. GetGateway
Interface definition:

String GetGateway()

Function description:

Get the default gateway of the device, set the value to NULL for non-GigE device.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 38

 6.Module Interface Definition

6.2.13. GetNICMAC
Interface definition:

String GetNICMAC()

Function description:

Get the NIC MAC address of the device, set the value to NULL for non-GigE device.

6.2.14. GetNICIP
Interface definition:

String GetNICIP()

Function description:

Get the NIC IP address of the device, set the value to NULL for non-GigE device.

6.2.15. GetNICSubnetMask
Interface definition:

String GetNICSubnetMask()

Function description:

Get the NIC subnet mask of the device, set the value to NULL for non-GigE device.

6.2.16. GetNICGateway
Interface definition:

String GetNICGateway()

Function description:

Get the NIC default gateway of the device, set the value to NULL for non-GigE device.

6.2.17. GetNICDescription
Interface definition:

String GetNICDescription()

Function description:

Get the NIC description information of the device, set the value to NULL for non-GigE device.

6.3. IGXDevice
Device object, is responsible for getting device information, feature controller (control channel), stream
object (acquisition channel), and device offline events. You can get the information by calling the interface:
IGXFactory::OpenDeviceByIP/MAC/SN/UserID.

Interface list:

GetDeviceInfo Get the information object of the device.

GetStreamCount Get the number of stream channel.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 39

 6.Module Interface Definition

OpenStream The user can open the stream by the stream channel number
which is specified, and get the stream channel object.

GetFeatureControl Get the local device layer feature controller, and control all the
functions of the local device via this controller.

GetRemoteFeatureControl Get the remote device layer feature controller, and control all the
functions of the remote device via this controller.

GetEventNumInQueue Get the event queue length of the device, represents how much
cache data is in the current event queue.

FlushEvent Flush the device event queue.

RegisterDeviceOfflineCallback Register offline callback function.

UnregisterDeviceOfflineCallback Unregister offline callback function.

CreateImageProcessConfig Creating the image processing configure parameter object.

ExportConfigFile Export the current configuration parameter to the text file.

ImportConfigFile Import the parameters in the configuration file to the camera.

Close Close the device.

6.3.1. GetDeviceInfo
Interface definition:

IGXDeviceInfo GetDeviceInfo()

Function description:

Get the information object of the device.

6.3.2. GetStreamCount
Interface definition:

UInt32 GetStreamCount()

Function description:

Get the number of stream channel.

6.3.3. OpenStream
Interface definition:

IGXStream OpenStream(UInt32 nStreamID)

Function description:

Parameter1: 'nStreamID' stream channel number, starts from 0. The user can open the stream by the
stream channel number which is specified, and get the stream channel object.

6.3.4. GetFeatureControl
Interface definition:

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 40

 6.Module Interface Definition

IGXFeatureControl GetFeatureControl()

Function description:

Get the local device layer feature controller, and control all the functions of the local device via this
controller.

6.3.5. GetRemoteFeatureControl
Interface definition:

IGXFeatureControl GetRemoteFeatureControl()

Function description:

Get the remote device layer feature controller, and control all the functions of the remote device via
this controller.

6.3.6. GetEventNumInQueue
Interface definition:

UInt32 GetEventNumInQueue()

Function description:

Get the event queue length of the device, represents how much cache data is in the current event
queue.

6.3.7. FlushEvent
Interface definition:

void FlushEvent()

Function description:

Flush the device event queue.

6.3.8. RegisterDeviceOfflineCallback
Interface definition:

GX_DEVICE_OFFLINE_CALLBACK_HANDLE RegisterDeviceOfflineCallback(

Object objUserParam,DeviceOfflineHandler delDeviceNotify)

Function description:

Register offline callback function.

6.3.9. UnregisterDeviceOfflineCallback
Interface definition:

void UnregisterDeviceOfflineCallback(GX_DEVICE_OFFLINE_CALLBACK_HANDLE hCallBack)

Function description:

Unregister offline callback function.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 41

 6.Module Interface Definition

6.3.10. CreateImageProcessConfig
Interface definition:

IImageProcessConfig CreateImageProcessConfig()

Function description:

Creating the image processing configuration parameter object.

6.3.11. ExportConfigFile
Interface definition:

void ExportConfigFile(String^ strFilePath)

Function description:

Export the current configuration parameter of the camera to text file.

6.3.12. ImportConfigFile
Interface definition:

void ImportConfigFile(String^ strFilePath)

Function description:

Import the parameter which is in the configuration file to the camera.

6.3.13. Close
Interface definition:

void Close()

Function description:

Close the device.

6.4. IGXFeatureControl
Feature controller, the device object IGXDevice and stream object IGXStream have their own feature
controllers. Users can control all the function features of the camera via the feature controller, such as
getting an integer function controller and then controlling read-write function via the integer controller. You
can also register a feature update callback function for the feature. Users can get three different types of
feature controllers by these three ways: IGXDevice::GetFeatureControl,
IGXDevice::GetRemoteFeatureControl and IGXStream::GetFeatureControl.

Interface list:

GetFeatureNameList Get all the function name string list which the current controller supports.

GetFeatureType Get the data type of the current string feature: integer, float, enumerated
etc., for more details please see the function definition:
GX_FEATURE_TYPE.

IsImplemented Check to see if the current feature control is available.

IsReadable Check to see if the current feature is readable.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 42

 6.Module Interface Definition

IsWritable Check to see if the current feature is writable.

GetIntFeature Get an integer controller.

GetFloatFeature Get a float controller.

GetEnumFeature Get an enumerated controller.

GetBoolFeature Get a Boolean controller.

GetStringFeature Get a string controller.

GetCommandFeature Get a command controller.

GetRegisterFeature Get a register controller.

RegisterFeatureCallback Register the function feature update callback function.

UnregisterFeatureCallback Unregister the function feature update callback function.

6.4.1. GetFeatureNameList
Interface definition:

void GetFeatureNameList(System::Collections::Generic::List<String> listFeatureNameList)

Function description:

Get all the function name string list which the current controller supports.

6.4.2. GetFeatureType
Interface definition:

GX_FEATURE_TYPE GetFeatureType(String strFeatureName)

Function description:

Get the data type of the current string feature: integer, float, enumerated etc. For more details please
see the function definition: GX_FEATURE_TYPE.

6.4.3. IsImplemented
Interface definition:

System::Boolean IsImplemented(String strFeatureName)

Function description:

Check to see if the current feature control is supported.

6.4.4. IsReadable
Interface definition:

System::Boolean IsReadable(String strFeatureName)

Function description:

Check to see if the current feature is readable.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 43

 6.Module Interface Definition

6.4.5. IsWritable
Interface definition:

System::Boolean IsWritable(String strFeatureName)

Function description:

Check to see if the current feature is writable.

6.4.6. GetIntFeature
Interface definition:

IIntFeature GetIntFeature(String strFeatureName)

Function description:

Get an integer feature controller.

6.4.7. GetFloatFeature
Interface definition:

IFloatFeature GetFloatFeature(String strFeatureName)

Function description:

Get a float feature controller.

6.4.8. GetEnumFeature
Interface definition:

IEnumFeature GetEnumFeature(String strFeatureName)

Function description:

Get an enumerated controller.

6.4.9. GetBoolFeature
Interface definition:

IBoolFeature GetBoolFeature(String strFeatureName)

Function description:

Get a Boolean controller.

6.4.10. GetStringFeature
Interface definition:

IStringFeature GetStringFeature(String strFeatureName)

Function description:

Get a string controller.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 44

 6.Module Interface Definition

6.4.11. GetCommandFeature
Interface definition:

ICommandFeature GetCommandFeature(String strFeatureName)

Function description:

Get a command controller.

6.4.12. GetRegisterFeature
Interface definition:

IRegisterFeature GetRegisterFeature(String strFeatureName)

Function description:

Get a register controller.

6.4.13. RegisterFeatureCallback
Interface definition:

GX_FEATURE_CALLBACK_HANDLE RegisterFeatureCallback(String strFeatureName, Object objUserParam,

FeatureDelegate delFeatureNotify)

Function description:

Register the function feature update callback function.

6.4.14. UnregisterFeatureCallback
Interface definition:

void UnregisterFeatureCallback(GX_FEATURE_CALLBACK_HANDLE hCallback)

Function description:

Unregister the function feature update callback function.

6.5. IIntFeature
Integer function node controller, corresponds to one integer node and can be get from
IGXFeatureControl::GetIntFeature.

Interface list:

GetMin Get the minimum value of integer function.

GetMax Get the maximum value of integer function.

GetInc Get the step length of integer function.

GetValue Get the current value of integer function.

SetValue Set the current value of integer function.

6.5.1. GetMin
Interface definition:

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 45

 6.Module Interface Definition

int64GetMin()

Function description:

Get the minimum value of integer function.

6.5.2. GetMax
Interface definition:

int64 GetMax()

Function description:

Get the maximum value of integer function.

6.5.3. GetInc
Interface definition:

int64GetInc()

Function description:

Get the step length of integer function.

6.5.4. GetValue
Interface definition:

int64 GetValue()

Function description:

Get the current value of integer function.

6.5.5. SetValue
Interface definition:

void SetValue(Int64 nValue)

Function description:

Set the current value of integer function.

6.6. IFloatFeature
Float function node controller, corresponds one float function node and can be get from
IGXFeatureControl::GetFloatFeature.

Interface list:

GetMin Get the minimum value of float type.

GetMax Get the maximum value of float.

HasInc Check to see if the float type value has step length.

GetInc Get the step length of float type value. If HasInc interface returns 'false', then it
will return 0 when calling this interface.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 46

 6.Module Interface Definition

GetUnit Get the unit of the float value.

GetValue Get the current value of float type value.

SetValue Set the current value of float type value.

6.6.1. GetMin
Interface definition:

Double GetMin()

Function description:

Get the minimum value of float type.

6.6.2. GetMax
Interface definition:

Double GetMax()

Function description:

Get the maximum value of float type.

6.6.3. HasInc
Interface definition:

System::Boolean HasInc()

Function description:

Check to see if the float type value has step length.

6.6.4. GetInc
Interface definition:

Double GetInc()

Function description:

Get the step length of float type value. If HasInc interface returns 'false', then it will return 0 when
calling this interface.

6.6.5. GetUnit
Interface definition:

String GetUnit()

Function description:

Get the unit of the float value.

6.6.6. GetValue
Interface definition:

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 47

 6.Module Interface Definition

Double GetValue()

Function description:

Get the current value of the float type value.

6.6.7. SetValue
Interface definition:

void SetValue(Double dValue)

Function description:

Set the current value of the float type value.

6.7. IEnumFeature
The enumeration function node controller is corresponding to one enumeration function node and can be
get by the function: IGXFeatureControl::GetEnumFeature.

Interface list:

GetEnumEntryList Get the enumeration item list which enumeration function supports.

GetValue Get the current enumeration item value of enumeration function.

SetValue Set the current enumeration item value of enumeration function.

6.7.1. GetEnumEntryList
Interface definition:

System::Collections::Generic::List<String> GetEnumEntryList()

Function description:

Get the enumeration item list which enumeration function supports.

6.7.2. GetValue
Interface definition:

String GetValue()

Function description:

Get the current enumeration item value of enumeration function.

6.7.3. SetValue
Interface definition:

void SetValue(String strValue)

Function description:

Set the current enumeration item value of enumeration function.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 48

 6.Module Interface Definition

6.8. IBoolFeatur
The boolean function node controller is corresponding to one Boolean function node and can be get by
the function:: IGXFeatureControl::GetBoolFeature.

Interface list:

GetValue Get the current value of Boolean function.

SetValue Set the current value of Boolean function.

6.8.1. GetValue
Interface definition:

System::Boolean GetValue()

Function description:

Get the current value of Boolean function.

6.8.2. SetValue
Interface definition:

void SetValue(System::Boolean bValue)

Function description:

Set the current value of Boolean function.

6.9. IStringFeature
The string function node controller is corresponding to one string function node and can be get by the
function: IGXFeatureControl::GetStringFeature.

Interface list:

GetValue Get the current value of the string.

SetValue Set the current value of the string.

GetStringMaxLength Get the maximum length of the string that can be set, not including the
terminator.

6.9.1. GetValue
Interface definition:

String GetValue()

Function description:

Get the current value of the string.

6.9.2. SetValue
Interface definition:

void SetValue(String strValue)

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 49

 6.Module Interface Definition

Function description:

Set the current value of the string.

6.9.3. GetStringMaxLength
Interface definition:

Int64 GetStringMaxLength()

Function description:

Get the maximum length of the string that can be set, not including the terminator.

6.10. ICommandFeature
The command function node controller is corresponding to one command function node and can be get
by the function: IGXFeatureControl::GetCommandFeature.

Interface list:

Execute Execute command.

6.10.1. Execute
Interface definition:

void Execute()

Function description:

Execute command.

6.11. IRegisterFeature
The register function node controller is corresponding to one command function node and can be get by
the function: IGXFeatureControl::GetCommandFeature.

Interface list:

GetLength Get the length of the register buffer. The user reads this length to read-write buffer.

Get the value of the current register buffer. The length of input parameter 'ptrBuffer'
GetBuffer
must equal to the length that the interface 'GetLength' gets.

Set the value of the current register buffer. The length of input parameter 'ptrBuffer'
SetBuffer
must equal to the length that the interface 'GetLength' gets.

6.11.1. GetLength
Interface definition:

Int64 GetLength()

Function description:

Get the length of the register buffer. The user reads this length to read-write buffer.

6.11.2. GetBuffer
Interface definition:

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 50

 6.Module Interface Definition

void GetBuffer(array<Byte> ptrBuffer)

Function description:

Get the value of the current register buffer. The length of input parameter 'ptrBuffer' must equal to the
length that the interface 'GetLength' gets.

6.11.3. SetBuffer
Interface definition:

void SetBuffer(array<Byte> ptrBuffer)

Function description:

Set the value of the current register buffer. The length of input parameter 'ptrBuffer' must equal to the
length that the interface 'GetLength' gets.

6.12. IGXStream
Representing the stream object, and it is responsible for the related operation of grabbing images, such
as unregistering callback function and getting a single image. It can be get by the interface function:
IGXDevice::OpenStream interface.

Interface list:

StartGrab Start stream layer acquisition, whether using callback acquisition or a

single image acquisition, the user must call the interface function
StartGrab first.

StopGrab Stop stream layer acquisition.

RegisterCaptureCallback Register the delegation acquisition callback function.

UnregisterCaptureCallback Unregister the acquisition callback function.

GetImage Get a single image.

GetFeatureControl Get the stream layer feature controller to control the function feature of
the stream layer.

FlushQueue Flush the cache images in the acquisition queue.

SetAcqusitionBufferNumber Set the count of acquisition buffer.

Close Close the stream object.

GetOptimalPacketSize Get the optimal packet length of the device.

6.12.1. StartGrab
Interface definition:

void StartGrab()

Interface description:

Start stream layer acquisition, whether using callback acquisition or a single image acquisition, the
user must call the interface function StartGrab first and start stream layer acquisition, including start
acquisition thread and resource application operation of TLClass layer.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 51

 6.Module Interface Definition

6.12.2. StopGrab
Interface definition:

void StopGrab()

Interface description:

Stop stream layer acquisition, including stop acquisition thread of TLClass layer and release resources
operation etc.

6.12.3. RegisterCaptureCallback
Interface definition:

void RegisterCaptureCallback(Object objUserParam,GxIAPINET::CaptureDelegate delCaptureFun)

Interface description:

Register the user delegate acquisition callback function. Parameter 1 is the user private parameter, it
is returned to the user by delegation, and parameter 2 is the user delegate callback function object.

Function requirements:
1) After starting acquisition, that is after calling the interface function StartGrab, you do not allowed
to call the register interface function.
2) The user can register the acquisition callback function repeatedly, and using the overwrite
mechanism.

6.12.4. UnregisterCaptureCallback
Interface definition:

void UnregisterCaptureCallback()

Interface description:

Unregister acquisition callback function.

6.12.5. GetImage
Interface definition:

IImageData GetImage(UInt32 nTimeout)

Interface description:

Get a single image. Parameter 1 is timeout time, unit is ms. If the image is not captured within the
time, the timeout error will returned.

Function requirements:

If the user registers the acquisition delegate function, then it is not allowed to call GetImage interface.
If call this interface forcibly, it will return illegal call exception error.

6.12.6. GetImageNoThrow
Interface definition:

IImageData GetImageNoThrow(UInt32 nTimeout)

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 52

 6.Module Interface Definition

Interface description:

Get a single image. Parameter 1 is timeout time, unit is ms. If the image is not captured within the
time, NULL will be returned.

Function requirements:

If the user registers the acquisition delegate function, then it is not allowed to call GetImage interface.
If call this interface forcibly, it will return illegal call exception error.

6.12.7. GetFeatureControl
Interface definition:

IGXFeatureControl GetFeatureControl()

Interface description:

Get stream layer feature controller, to control the stream layer function feature.

6.12.8. FlushQueue
Interface definition:

void FlushQueue()

Interface description:

Flush the cache images in the acquisition queue.

6.12.9. SetAcquisitionBufferNumber
Interface definition:

void SetAcqusitionBufferNumber(uint64_t nBufferNum)

Interface description:

The user set the count of acquisition buffer.

Function requirements:
1) This interface is optional and is not necessary in the start acquisition process.
2) The setting value must be greater than 0, if the setting value is too large and exceed the system
capacity, it will not to start acquisition successfully.
3) If need to call this interface, it must be called before start acquisition and it is not allowed to call
this interface during the acquisition process.
4) Once the user has set up the buffer number and has been successfully captured, the buffer
number will remain valid until the stream object is closed.

6.12.10. Close
Interface definition:

void Close()

Interface description:

Close the stream object.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 53

 6.Module Interface Definition

6.12.11. GetOptimalPacketSize
Interface definition:

uint32_t GetOptimalPacketSize(void)

Interface description:

Get the optimal packet length of the device.

Function requirements:
1) This interface only supports Gigabit network cameras to obtain optimal packet length.
2) If need to call this interface, it must be called before starting acquisition and it is not allowed to
call this interface during the acquisition process.

6.13. IFrameData
Image object, including image databuffer and image information. After the user registering acquisition
callback function, when the images come, the image object will return to the user via entrance parameter
of the acquisition callback function.

Interface list:

GetStatus Get the status of the current frame and see if the frame is complete.

GetPayloadSize Get the current frame load and the image size.

GetWidth Get the width of the current frame.

GetHeight Get the height of the current frame.

GetPixelFormat Get the pixel format of the current frame.

GetFrameID Get the current frame ID.

GetTimeStamp Get the timestamp of the current frame.

GetBuffer Get the image data buffer, return the IntPtr type pointer and point to the
unmanaged memory directly.

ConvertToRaw8 The interface is used for non 8-bit. The user can get the specified 8
valid bit in non 8-bit data.

ConvertToRGB24 Convert the raw data to the RGB24 bit data that is interpolated.

ImageProcess To enhance the current image, and return the image after enhancing
effect.

6.13.1. GetStatus
Interface definition:

GX_FRAME_STATUS_LIST GetStatus()

Function description:

Get the status of the current frame and see if the frame is complete.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 54

 6.Module Interface Definition

6.13.2. GetPayloadSize
Interface definition:

UInt64 GetPayloadSize()

Function description:

Get the current frame load, and the image size. If the frame information is accessible, this value is the
sum of image data size and frame information size; if the frame information is not accessible, this
value is the image data size.

6.13.3. GetWidth
Interface definition:

UInt64 GetWidth()

Function description:

Get the width of the current frame.

6.13.4. GetHeight
Interface definition:

UInt64 GetHeight()

Function description:

Get the height of the current frame.

6.13.5. GetPixelFormat
Interface definition:

GX_PIXEL_FORMAT_ENTRYGetPixelFormat()

Function description:

Get the pixelformat of the current frame.

6.13.6. GetFrameID
Interface definition:

UInt64 GetFrameID()

Function description:

Get the current frame ID.

6.13.7. GetTimeStamp
Interface definition:

UInt64 GetTimeStamp()

Function description:

Get the timestamp of the current frame.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 55

 6.Module Interface Definition

6.13.8. GetBuffer
Interface definition:

IntPtr GetBuffer()

Function description:

Get the image data buffer, return the IntPtr type pointer and point to the unmanaged memory directly.

6.13.9. ConvertToRaw8
Interface definition:

IntPtr ConvertToRaw8 (GX_VALID_BIT_LIST emValidBits)

Function description:

The interface is used for non 8-bit data. The user can get specified 8 valid bit in non 8-bit data.

6.13.10. ConvertToRGB24
Interface definition:

IntPtr ConvertToRGB24 (GX_VALID_BIT_LIST emValidBits,

GX_BAYER_CONVERT_TYPE_LIST emConvertType, System::Boolean bFlip)

Function description:

Convert the raw data to the RGB24 bit data by interpolation algorithm.

6.13.11. ImageProcess
Interface definition:

IntPtrImageProcess(IImageProcessConfig^ objCfg)

Function description:

To enhance the current image, and returns the enhanced image data.

Note:
1) If the 'IImageProcessConfig::IsAccelerate' returns 'true', then it will process the images by
accelerating mode. At this time the image height must be an integer multiple of four, otherwise an
error will occur in the interface.
2) The mono camera void* returns 8bit image data, the image size is image width * image height.
3) The color camera void* returns RGB image data, image size is image width * image height * 3.

6.14. IImageData
IImageData is an image data obtained from the IGXStream::GetImage interface. The interface of this object
is basically consistent with the 'IFrameData' object. Compared with the interface IFrameData, the interface
IImageData has one interface "void IImageData::Destroy()", which is used for destroying itself and
releasing resources.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 56

 6.Module Interface Definition

6.15. IImagProcessConfig
The configurable parameter object of Image enhancement, which has a set of configuration parameter
inside, and can be get by the interface: IGXDevice::CreateImageProcessConfig.

Interface List:

SetValidBit Select the specified 8 bit valid data that to be get, and the interface is
used to specify which 8bit is selected.

GetValidBit Get the 8 valid bits which are currently specified.

EnableDefectivePixelCorrect Enable defective-pixel correction.

IsDefectivePixelCorrect Check whether the defective-pixel correction is enabled currently.

EnableSharpen Enable sharpness function.

IsSharpen Check whether the sharpness function is enabled.

EnableAccelerate Enable accelerating image processing.

IsAccelerate Check whether it works in the accelerating enable status currently.

SetSharpenParam Set the sharpness intensity factor.

GetSharpenParam Get the sharpness intensity factor currently used.

SetContrastParam Set contrast adjustment parameter.

GetContrastParam Get the contrast adjustment parameter currently used.

SetGammaParam Set Gamma coefficient.

GetGammaParam Get Gamma coefficient.

SetLightnessParam Set brightness adjustment parameter.

GetLightnessParam Get brightness adjustment parameter.

EnableDenoise Enable denoise function.

IsDenoise Check whether the denoise function is enabled currently.

SetSaturationParam Set saturation coefficient.

GetSaturationParam Get saturation coefficient.

SetConvertType Set image format conversion algorithm.

GetConvertType Get image format conversion algorithm.

EnableConvertFlip Enable image format conversion flip.

IsConvertFlip Check whether the image format conversion flip function is enabled
currently.

EnableColorCorrection Enable color correction.

IsColorCorrection Check whether the color correction function is enabled.

Reset Restore the default adjustment parameter.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 57

 6.Module Interface Definition

Destroy Destroy itself and release resources.

IsUserSetCCParam Check whether the color correction function is user-set mode.

EnableUserSetCCParam Enable user-set mode for color correction function.

SetUserCCParam Set color transform factor by user.

GetUserCCParam Get color transform factor which set by user.

6.15.1. SetValidBit
Interface definition:

void SetValidBit(GX_VALID_BIT_LISTemValidBits)

Function description:

Select the specified 8 bit valid data that to be get, and the interface is used for non-8bit raw data.

6.15.2. GetValidBit
Interface definition:

GX_VALID_BIT_LIST GetValidBit()

Function description:

Get specified 8 bit valid data, and the interface is used for non-8bit raw data.

6.15.3. EnableDefectivePixelCorrect
Interface definition:

voidEnableDefectivePixelCorrect(System::Boolean bEnable)

Function description:

Enable defective-pixel correction function. The defective pixel correction is enabled when the
'bEnable' is 'ture', and the defective pixel correction is disable when the 'bEnable' is 'false'.

6.15.4. IsDefectivePixelCorrect
Interface definition:

System::Boolean IsDefectivePixelCorrect()

Function description:

Get the status of defective pixel correction.

6.15.5. EnableSharpen
Interface definition:

voidEnableSharpen(System::Boolean bEnable)

Function description:

Enable sharpen function. When the 'bEnable' is 'ture', the sharpness function is enabled; when the
'bEnable' is 'false' the sharpness function is disabled.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 58

 6.Module Interface Definition

6.15.6. IsSharpen
Interface definition:

System::Boolean IsSharpen()

Function description:

Get the status of sharpness.

6.15.7. EnableAccelerate
Interface definition:

void EnableAccelerate(System::Boolean bEnable)

Function description:

Image processing accelerating enable. If it is set 'true', the accelerating function is enabled and if it is
set 'false', the accelerating function is disabled. If the CPU of the current PC is not allowed to
accelerate because of itself limitation, an error will occurs when the user sets 'true'.

Note:

When the acceleration function is enabled, the current image height must be an integer multiple of
four, otherwise an error will occurs in the IFrameData::ImageProces interface or
IImageData::ImageProcess interface.

6.15.8. IsAccelerate
Interface definition:

System::Boolean IsAccelerate()

Function description:

Check whether the device works in the accelerating enable status currently. 'true' means accelerating
and 'false' means not accelerating.

6.15.9. SetSharpenParam
Interface definition:

void SetSharpenParam(System::Double dParam)

Function description:

Set the sharpness intensity factor.

6.15.10. GetSharpenParam
Interface definition:

System::Double GetSharpenParam()

Function description:

Get the sharpness intensity factor currently used.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 59

 6.Module Interface Definition

6.15.11. SetContrastParam
Interface definition:

void SetContrastParam(Int32 nParam)

Function description:

Set the contrast adjustment parameter.

6.15.12. GetContrastParam
Interface definition:

Int32 GetContrastParam()

Function description:

Get the contrast adjustment parameter currently used.

6.15.13. SetGammaParam
Interface definition:

void SetGammaParam(System::Double dParam)

Function description:

Set Gama coefficient.

6.15.14. GetGammaParam
Interface definition:

System::Double GetGammaParam()

Function description:

Get Gamma coefficient.

6.15.15. SetLightnessParam
Interface definition:

void SetLightnessParam(Int32 nParam)

Function description:

Set brightness adjustment parameter.

6.15.16. GetLightnessParam
Interface definition:

Int32 GetLightnessParam()

Function description:

Get brightness adjustment parameter.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 60

 6.Module Interface Definition

6.15.17. EnableDenoise
Interface definition:

void EnableDenoise(System::Boolean bEnable)

Function description:

Enable denoise switch (not support for monochrome cameras), when the 'bEnable' is 'true', the
denoise function is enabled; when the 'bEnable' is 'false', the denoise function is disabled.

6.15.18. IsDenoise
Interface definition:

System::Boolean IsDenoise()

Function description:

Get denoise switch (not support for monochrome cameras).

6.15.19. SetSaturationParam
Interface definition:

void SetSaturationParam(Int32 nParam)

Function description:

Set saturation coefficient (not support for monochrome cameras).

6.15.20. GetSaturationParam
Interface definition:

Int32 GetSaturationParam()

Function description:

Get saturation coefficient (not support for monochrome cameras).

6.15.21. SetConvertType
Interface definition:

void SetConvertType(GX_BAYER_CONVERT_TYPE_LIST emConvertType)

Function description:

Set image format conversion algorithm (not support for monochrome cameras).

6.15.22. GetConvertType
Interface definition:

GX_BAYER_CONVERT_TYPE_LIST GetConvertType()

Function description:

Get interpolation algorithm (not support for monochrome cameras).

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 61

 6.Module Interface Definition

6.15.23. EnableConvertFlip
Interface definition:

void EnableConvertFlip(System::Boolean bFlip)

Function description:

Enable interpolation flip (not support for monochrome cameras).

6.15.24. IsConvertFlip
Interface definition:

System::Boolean IsConvertFlip()

Function description:

Get interpolation flit identification (not support for monochrome cameras), 'true' means flipping and
'false' means not flipping.

6.15.25. EnableColorCorrection
Interface definition:

void EnableColorCorrection(System::Boolean bEnable)

Function description:

Enable color correction (not support for monochrome cameras), 'true' means enable color correction
and 'false' means disabling color correction.

6.15.26. IsColorCorrection
Interface definition:

System::Boolean IsColorCorrection()

Function description:

Check whether the color correction is enabled (not support for monochrome cameras).

6.15.27. Reset
Interface definition:

void Reset()

Function description:

The user can select to restore the optimal default parameter configuration.

6.15.28. Destroy
Interface definition:

void Destroy()

Function description:

Destroy itself and release resources.

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 62

 6.Module Interface Definition

6.15.29. IsUserSetCCParam
Interface definition:

System::Boolean IsUserSetCCParam()

Function description:

Check whether the color correction function is user-set mode (not support for monochrome cameras).
Returns true if it is user-set mode, otherwise returns false.

6.15.30. EnableUserSetCCParam
Interface definition:

void EnableUserSetCCParam(System::Boolean bIsUserMode)

Function description:

Enable user-set mode for color correction function (not support for monochrome cameras). If
bIsUserMode is true the user-set mode is enabled; otherwise it is disabled.

6.15.31. SetUserCCParam
Interface definition:

void SetUserCCParam(COLOR_TRANSFORM_FACTOR stColorTransformFactor)

Function description:

Set stColorTransformFactor to color correction function (only supported for user-set mode) (The
recommended range of color correction structure parameters is -4 ~ 4. If the parameter setting is less
than -4, the correction effect is consistent with -4. If the parameter setting is greater than 4, the
correction effect is consistent with 4.).

6.15.32. GetUserCCParam
Interface definition:

COLOR_TRANSFORM_FACTOR GetUserCCParam()

Function description:

Get current stColorTransformFactor which used to color correction function (only supported for user-
set mode).

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 63

 7.Revision History

7. Revision History
No. Version Changes Date

1 V1.0.4 Initial release 2015-09

2 V1.0.6 Modify description of device event acquisition 2016-01-05

1. Add some informations of GetImage

2. Added description that remote device are only
3 V1.0.8 2016-02-01
supported by gigabit networks
3. Modify the sample image

4 V1.0.10 Modifiy the description of GetImage 2016-02-04

1. Modify he precautions for debugging the gigabit

network camera
5 V1.0.11 2016-03-22
2. Added the description of modifying the device
heartbeat timeout by adding environment variables

Add the interface description of GigEIPConfiguration and

6 V1.0.13 2016-07-20
GigEForceIp

7 V1.0.15 Add the interface description of the acquisition buffer 2016-10-24

Added description of camera internal error event: internal

8 V1.0.16 2016-12-14
error event ID and time stamp

Modify section 2.10.4 Gamma default value to 1.0, contrast

9 V1.0.20 2019-07-01
default value to 0, saturation default value to 64

1. Add new device reset and reconnect port

10 V1.0.21 2. Add some description information to the ImageProcess 2019-07-16
interface

1. Added an interface for obtaining the optimal packet

length of the device
11 V1.0.22 2019-08-15
2. Add the code for setting the optimal packet length of
the device

1. Add a data type: COLOR_TRANSFORM_FACTOR

12 V1.0.23 2. Add 4 user-set color correction factor interfaces in 2019-09-29
IImageProcessConfig

13 V1.2.0 Add related parameters of StreamBufferHandlingMode 2019-12-25

Add the description of how to get the sample code for

14 V1.2.1 2020-08-28
feature read & write in section 2.9.5

Add the description about set the number of acquisition

15 V1.2.2 2020-10-12
buffer

© China Daheng Group, Inc. Beijing Image Vision Technology Branch 64