DataVision.BeeYard.Sdk.HalconXL-24.05-Progress 12.11.0

C# Halcon SDK for BeeYard

Documentation

See https://docs.beeyard.ai/docs/beeyard-sdks/csharp/halcon-sdk/.

Installation

The C# Halcon SDK comes in various flavors. It's published for both the XL and non-XL versions of Halcon and the two latest versions of the Progress editions of Halcon.

To for example install Halcon 23.11 Progress XL version, execute:

dotnet add package DataVision.BeeYard.Sdk.HalconXL-23.11-Progress

Usage

Converters

The SDK contains converters for reading and writing various Halcon objects from/to bytes and from/to stream by temporarily writing the object to disk. There are converters for working with HImage, HRegion, HXLDCont, and HDict.

HRegionConverter:

using var region = new HRegion();
region.GenRectangle1(2.5, 1, 20, 10);

// to and from stream
using var stream = HRegionConverter.ToStream(region);
using var region2 = HRegionConverter.FromStream(stream);

// to and from bytes
var bytes = HRegionConverter.ToBytes(region);
using var region3 = HRegionConverter.FromBytes(bytes);

HiveClient Extensions

The SDK also contains extensions to the HiveClient that come from the C# SDK to BeeYard. It's for example possible to add/read HImage as an image to/from a cell in BeeYard.

using var image = new HImage("autobahn");
var format = new HImageFormat("png fastest");
var imageName = "autobahn.png"

// Add HImage
using var addResponse = await hiveClient.AddHImageAsync(cellId, imageName, image, format);
addResponse.EnsureSuccessStatusCode();

// Read HImage
using var readResponse = await hiveClient.ReadFileAsync(cellId, imageName);
readResponse.EnsureSuccessStatusCode();
using var image2 = await readResponse.ReadHImageAsync();