Gentec-EO BEAMAGE SERIES User manual

121-105627

Beamage SDK User Manual Revision 1 2
WARRANTY
First Year Warranty
The Gentec-EO Beamage series beam profilers carry a one-year warranty (from date of shipment) against
material and/or workmanship defects, when used under normal operating conditions. The warranty does
not cover damages related to battery leakage or any other misuse.
Any attempt by unauthorized personnel to alter or repair the product will void the warranty.
The manufacturer is not liable for consequential damages of any kind.
Contacting Gentec Electro-Optics Inc.
In case of malfunction, contact your local Gentec-EO distributor or nearest Gentec-EO Inc. office to obtain
a return authorization number. The material should be returned to:
Gentec Electro-Optics, Inc.
445, St-Jean-Baptiste, Suite 160
Québec, QC
Canada, G2E 5N7
Tel: [phone]
Fax: [phone]
E-mail: [email protected]om
Website: gentec-eo.com
CLAIMS
To obtain warranty service, contact your nearest Gentec-EO agent or send the product, with a description
of the problem, and prepaid transportation and insurance, to the nearest Gentec-EO agent. Gentec-EO Inc.
assumes no risk for damage during transit. Gentec-EO Inc. will, at its discretion, repair or replace the
defective product free of charge or refund your purchase price. However, if Gentec-EO Inc. determines that
the failure is caused by misuse, alterations, accident, or improper conditions of operation or handling, the
product shall therefore not be covered by the warranty.

Beamage SDK User Manual Revision 1 3
TABLE OF CONTENTS
1. GENTEC-EO’S BEAMAGE SDK..........................................................................................................................5
1.1. WHAT IS THE BEAMAGE SDK ? .............................................................................................................................5
1.2. THE .NET COMPATIBLE PIPELINE FOR BEAMAGE CAMERAS..........................................................................................7
1.3. GETTING STARTED WITH THE BEAMAGE SDK............................................................................................................7
1.4. WHAT YOUR VISUAL STUDIO SOLUTION NEEDS .........................................................................................................8
1.5. UNDERSTANDING THE CODE..................................................................................................................................8
1.6. BEAMAGE SDK CLASS DIAGRAM .........................................................................................................................10
2. GET STARTED EXAMPLE................................................................................................................................ 11
2.1. FIRST EXAMPLE:C# EXAMPLE WITH VIEWER ...........................................................................................................11
2.1.1. GENERAL INFORMATION.....................................................................................................................................11
2.1.2. GRAB IMAGES ..................................................................................................................................................12
2.1.3. MATHEMATICAL OPERATIONS ON THE IMAGE BUFFER...............................................................................................13
2.1.4. EVENTS...........................................................................................................................................................14
2.2. SECOND EXAMPLE:C++ CONSOLE APPLICATION .....................................................................................................14
3. BEAMAGE API .............................................................................................................................................. 15
3.1. BCAM ............................................................................................................................................................15
Class declaration..................................................................................................................................................15
Properties.............................................................................................................................................................15
Events ..................................................................................................................................................................15
Functions..............................................................................................................................................................16
3.2. BCAMIMG.......................................................................................................................................................16
Class declaration..................................................................................................................................................16
Properties.............................................................................................................................................................16
Events ..................................................................................................................................................................17
Functions..............................................................................................................................................................17
3.3. BCAMPROPERTIES ............................................................................................................................................18
Class declaration..................................................................................................................................................18
Properties.............................................................................................................................................................18
Events ..................................................................................................................................................................18
Functions..............................................................................................................................................................18
3.4. BERRORSMANAGER..........................................................................................................................................18
Class declaration..................................................................................................................................................18
Properties.............................................................................................................................................................18
Events ..................................................................................................................................................................18
3.5. BSDK.............................................................................................................................................................19
Class declaration..................................................................................................................................................19
Properties.............................................................................................................................................................19
Events ..................................................................................................................................................................19
Functions..............................................................................................................................................................19
3.6. FUTURE CLASSES AND FUNCTIONS ........................................................................................................................20

Beamage SDK User Manual Revision 1 4
TABLE OF FIGURES
FIGURE 1–CONCEPTUAL EXAMPLE OF BEAMAGE SDK INTEGRATION ON AN ASSEMBLY LINE...............................5
FIGURE 2–ANEW WAY TO USE GENTEC-EO’SBEAMAGE CAMERA:THE BEAMAGE SDK.....................................6
FIGURE 3-FUNCTIONAL SCHEMATIC OF THE.NET COMPATIBLE PIPELINE FOR BEAMAGE CAMERAS......................7
FIGURE 4-BEAMAGESDK.DLL HAS BEEN ADDED AS A REFERENCE TO THE CURRENT VISUAL STUDIO PROJECT....8
FIGURE 5-BEAMAGE.IMG NEEDS TO BE ADDED AS AN EXISTING ITEM AND SET TO CONTENT FOR BUILD ACTION .8
FIGURE 6-BEAMAGE SDK CLASS DIAGRAM...................................................................................................10
FIGURE 7-BEAMAGE SDK SIMPLE VIEWER USER INTERFACE WHEN A BEAMAGE-4M IS CONNECTED.................11
FIGURE 8-BEAMAGE SDK SIMPLE VIEWER USER INTERFACE WHEN A BEAMAGE-3.0 IS CONNECTED.................12
FIGURE 9-BEAMAGE IMAGE ..........................................................................................................................17
FIGURE 10 -FALSE RAINBOW COLORS SCALE..................................................................................................17

Beamage SDK User Manual Revision 1 5
1. Gentec-EO’s Beamage SDK
1.1. What is the Beamage SDK ?
Gentec-EO’s Beamage SDK has been designed to help clients develop their own software user interface,
make their own image analysis, and integrate the Beamage camera to their system without necessarily
using Gentec-EO’s PC-Beamage software.
Figure 1 –Conceptual example of Beamage SDK integration on an assembly line
Gentec-EO’s Beamage SDK is a dll (Dynamic Link Library) that communicates with the camera drivers. It
provides our customers with specific software functions to control the Beamage camera and retrieve images
from it, in order to build custom Windows applications.
This dll is written in C# and is compatible with all .NET languages: C++, C#, Visual Basic, F#, etc.
Customers can build custom software or Windows applications to meet many specific needs: image
analysis, hardware integration, quality control, assembly line safety, laboratory maintenance, etc.
Below is a simple schematic that illustrates the difference between 2 ways of managing the Beamage
camera: the Beamage SDK and Gentec-EO’s PC-Beamage software.
Energy
Diameter
Shape

Beamage SDK User Manual Revision 1 6
Figure 2 –A new way to use Gentec-EO’s Beamage camera: the Beamage SDK
Beamage
camera
Camera drivers
PC-Beamage
software
PC-Beamage
user interface
Gentec-EO's
Beamage SDK
Microsoft .NET
compatible
software
- Integration
- Custom user
interface

Beamage SDK User Manual Revision 1 7
1.2. The .NET compatible pipeline for Beamage cameras
Gentec-EO’s Beamage SDK offers basic functions and no calculation on diameter for now. If you would like
your custom Windows application to include the powerful advanced functions available in Gentec-EO’s
PC-Beamage software, the .NET compatible pipeline will be of great use to you.
Instead of communicating directly with the camera, the .NET compatible pipeline option enables
communication with the PC-Beamage software via a RAM pipeline. Your custom Windows software
application can be made to control the Beamage camera and obtain almost any measurement through the
PC-Beamage software.
Below is a simple schematic that illustrates how the .Net compatible pipeline works.
For more information on the .NET compatible pipeline and how to use it, please refer to the PC-Beamage
user manual.
Figure 3 - Functional schematic of the.NET compatible pipeline for Beamage cameras
1.3. Getting started with the Beamage SDK
Gentec-EO offers different ways to get you up to speed using the Beamage SDK. Before using the
Beamage SDK,be sure that you are able to properly use the Beamage camera and its drivers with the PC-
Beamage software. The latest available version of PC-Beamage, the drivers and the User Manual can be
Beamage camera
Camera drivers
PC-Beamage
software
PC-Beamage user
interface
RAM Pipeline
Microsoft .NET
compatible
software
Custom user
interface software
and integration
Labview software

Beamage SDK User Manual Revision 1 8
downloaded from the Resource Center on the following web page: https://gentec-eo.com/products/beam-
diagnostics/Beamage-3.0.
This document contains API documentation and code samples that will help you understand how to use
each function included in the Beamage SDK (BSDK).
Gentec-EO also provides a Beamage SDK Samples solution for Visual Studio. This example shows how
to create a Beamage camera object, connect to it, grab images, and how to use many other of the Beamage
SDK functions. The present document includes a

Beamage SDK User Manual Revision 1 9
Get started example section that helps guide you through the Beamage SDK Samples.
1.4. What your Visual Studio solution needs
To create your first software application with Beamage SDK, launch Visual Studio and create a new project.
Then, download the Gentec-EO Beamage SDK.zip from our Download Center to your computer and extract
all files. Find the BeamageSDK.dll file and add it as a reference to your Visual Studio project.
Figure 4 - BeamageSDK.dll has been added as a reference to the current Visual Studio project
Then, add the Beamage camera firmware image file (Beamage.img) to your project as Existing Item and
set the Build Action properties to Content.
Figure 5 - Beamage.img needs to be added as an Existing Item and set to Content for Build Action
That’s it! Everything is now in place to start coding and communicating with the Beamage camera.
1.5. Understanding the code
Nothing is better than code samples to understand how to use the Beamage SDK. Here, we can see a
simple class that instantiates the BSDK class and makes a connection with the first Beamage camera
that the drivers will find on the computer: Code Sample
using BeamageApi;// import reference from namespace BeamageApi
namespace Beamage_SDK_Example
{
public class BeamageSdkExample
{
BSDK bsdk; // Beamage SDK object
public BeamageSdkExample()
{
bsdk = new BSDK(); // Create Beamage SDK
bsdk.AutoConnect(); // This method will connect the first camera found by the drivers
// Resize the picture box if we have a Beamage-4M sensor
if(bsdk.camera.camProperties.Is4mSensor())
{
Size size = new Size(512, 512);

Beamage SDK User Manual Revision 1 10
pictureBox1.Size = size;
labelBeamage.Text = "Beamage-4M";
}
else
{
Size size = new Size(512, 272);
pictureBox1.Size = size;
labelBeamage.Text = "Beamage-3.0";
}
}
}
}
That’s it! Once the BSDK object is created, all other functions in the Beamage SDK will be available.
For more code samples and to see how to use all functions, please refer to the