C#與Halcon混合編程的幾種方式

Halcon的學習過程中，關於Halcon的混合編程是無法避免的，Halcon可以和很多種語言進行混編，這里僅贅述與C#語言進行混編的一些簡單方式。

C#與Halcon進行混編的方式大體可以分為：使用Halcon導出功能、面向對象的方式、Halcon引擎。

當然，除了以上方法，還有導出庫工程這樣的方式可以選擇，這里就不再闡述。

---

 

一、Halcon導出功能

下圖為使用Halcon編寫的簡單程序

然后點擊文件-》導出，或者直接點擊如下按鈕

點擊導出之后，選擇語言為C#-Halcon/.NET，選擇好導出文件的路徑，則會得到一個和Halcon程序同名的.cs文件

 打開.cs文件，我們看到導出的代碼中有一個action的方法，這個方法是即是我們需要重點關注的部分，我們在Halcon中寫的代碼都在這個方法中有所實現。以下為action的代碼：

 private void action()
  {


    // Local iconic variables 

    HObject ho_Image, ho_Region, ho_ConnectedRegions;
    HObject ho_RegionDilation;

    // Local control variables 

    HTuple hv_Width = null, hv_Height = null;
    // Initialize local and output iconic variables 
    HOperatorSet.GenEmptyObj(out ho_Image);
    HOperatorSet.GenEmptyObj(out ho_Region);
    HOperatorSet.GenEmptyObj(out ho_ConnectedRegions);
    HOperatorSet.GenEmptyObj(out ho_RegionDilation);
    ho_Image.Dispose();
    HOperatorSet.ReadImage(out ho_Image, "printer_chip/printer_chip_01");
    HOperatorSet.GetImageSize(ho_Image, out hv_Width, out hv_Height);
    if (HDevWindowStack.IsOpen())
    {
      HOperatorSet.SetPart(HDevWindowStack.GetActive(), 0, 0, hv_Height, hv_Width);
    }
    ho_Region.Dispose();
    HOperatorSet.Threshold(ho_Image, out ho_Region, 128, 255);
    ho_ConnectedRegions.Dispose();
    HOperatorSet.Connection(ho_Region, out ho_ConnectedRegions);
    ho_RegionDilation.Dispose();
    HOperatorSet.DilationCircle(ho_ConnectedRegions, out ho_RegionDilation, 3.5);
    if (HDevWindowStack.IsOpen())
    {
      HOperatorSet.DispObj(ho_Image, HDevWindowStack.GetActive());
    }
    if (HDevWindowStack.IsOpen())
    {
      HOperatorSet.DispObj(ho_ConnectedRegions, HDevWindowStack.GetActive());
    }


    ho_Image.Dispose();
    ho_Region.Dispose();
    ho_ConnectedRegions.Dispose();
    ho_RegionDilation.Dispose();

  }

現在，需要我們對這個代碼進行簡單的更改，就可以在C#的Halcon窗體控件中將其顯示出來，首先，新建一個C#窗體程序，添加halcondotnet的引用，並且添加其命名空間，在主窗體上添加一個Halcon的窗體控件和一個Button控件，並在Button的Click事件對應的方法中添加如下代碼即可：

 代碼如下：

namespace Halconprogram
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e)
        {

            // Local iconic variables 

            HObject ho_Image, ho_Region, ho_ConnectedRegions;
            HObject ho_RegionDilation;

            // Local control variables 

            HTuple hv_Width = null, hv_Height = null;
            // Initialize local and output iconic variables 
            HOperatorSet.GenEmptyObj(out ho_Image);
            HOperatorSet.GenEmptyObj(out ho_Region);
            HOperatorSet.GenEmptyObj(out ho_ConnectedRegions);
            HOperatorSet.GenEmptyObj(out ho_RegionDilation);
            ho_Image.Dispose();
            HOperatorSet.ReadImage(out ho_Image, "printer_chip/printer_chip_01");
            HOperatorSet.GetImageSize(ho_Image, out hv_Width, out hv_Height);

            HOperatorSet.SetPart(hWindowControl1.HalconID, 0, 0, hv_Height, hv_Width);

            ho_Region.Dispose();
            HOperatorSet.Threshold(ho_Image, out ho_Region, 128, 255);
            ho_ConnectedRegions.Dispose();
            HOperatorSet.Connection(ho_Region, out ho_ConnectedRegions);
            ho_RegionDilation.Dispose();
            HOperatorSet.DilationCircle(ho_ConnectedRegions, out ho_RegionDilation, 3.5);

            HOperatorSet.DispObj(ho_Image, hWindowControl1.HalconID);


            HOperatorSet.DispObj(ho_ConnectedRegions, hWindowControl1.HalconID);


            ho_Image.Dispose();
            ho_Region.Dispose();
            ho_ConnectedRegions.Dispose();
            ho_RegionDilation.Dispose();
        }
    }
}

比較前兩段代碼可以發現，只是對Halcon中導出的.cs文件進行了簡單的窗體句柄的更改，其他地方沒有任何改變，即可實現想要的效果。

需要注意的是，如果Halcon代碼中存在外部函數的話，在導出時，除了action方法外，還需要將導出的cs文件中對應外部函數的整個方法實現也要拷貝到自己的工程中。

---

 

二、面向對象的方式

使用Halcon程序導出為C#程序之后，可以發現它的可讀性並不太好，而且更改起來不太方便，所有的對象都是HObject類型。

以下程序不使用Halcon的IDE，直接添加引用和命名空間后，在C#環境下編寫:

namespace Halconprogram
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e)
        {
            HImage img = new HImage("printer_chip/printer_chip_01");
            img.GetImageSize(out HTuple width, out HTuple height);
            hWindowControl1.HalconWindow.SetPart(0D, 0, height, width);
            HRegion region = img.Threshold(128D, 255);
            HRegion conRegion = region.Connection();
            HRegion dilationRegion = conRegion.DilationCircle(3.5);
            hWindowControl1.HalconWindow.SetColored(12);
            hWindowControl1.HalconWindow.DispObj(img);
            hWindowControl1.HalconWindow.DispObj(dilationRegion);

            img.Dispose();
            region.Dispose();
            conRegion.Dispose();
            dilationRegion.Dispose();
        }
    }
}

可以看出，使用這種方式同樣能達到相同的效果，並且對於圖像、區域、XLD都有相關的HImage、HRegion、HXLD類與其對應，看起來更加直觀。其實在使用導出功能時，調用Halcon的方法基本使用的都是HOperatorSet這個類，這個類里面包含了Halcon的幾乎所有的算子的靜態方法，那么為什么Halcon還要提供如HImage、HRegion、HXLD等許多的其他的類呢，我覺得是因為在一些情況下，使用面向對象的方式更容易進行代碼封裝，而且更容易去修改代碼。不過，存在即合理，我覺得在一些代碼量較小的Halcon算法中，使用這種方法的確挺好的，可以很好的鍛煉自己脫離Halcon的IDE去寫Halcon算法的能力，但是面對代碼量很大的Halcon算法，個人覺得這不是一個很好好的方式，寫起來會比較累，不那么容易調試，前提還是在你對這種方式足夠熟悉的基礎上。

---

 

三、Halcon引擎

在了解Halcon引擎之前，我們最好先了解HDevelop函數文件，即.hdvp后綴的Halcon文件。使用Halcon引擎在C#中進行編程的方式我覺得主要是面向三種Halcon程序：

1.不含自己創建的外部函數的Halcon程序，

這樣的程序只需要new一個HDevEngine實例，一個HDevProgram實例，以及一個HDevProgramCall實例(其實可以不用這個實例也可以，為了方便可以new一個)，在編寫時主要需要注意的是HDev文件的路徑，我這里將HDev文件放在了Debug目錄下的HDEV文件夾內。

　　　最終效果：　

　　代碼：

namespace MyProgramCall
{
    public partial class Form1 : Form
    {

        public Form1()
        {
            InitializeComponent();
        }
        HDevEngine hDevEngine = new HDevEngine();//引擎
        HDevProgram HDevProgram;//Halcon程序
        HDevProgramCall HDevProgramCall;//Halcon程序執行實例
        HWindow window;//窗體
        HDevOpMultiWindowImpl HDevOpMultiWindowImpl;//方便Halcon程序操作顯示的實例
        string exePath = "";
        private void btn_Init_Click(object sender, EventArgs e)
        {
            window = hWindowControl1.HalconWindow;
            //通過以下兩句，表示整個要執行的Halcon的HDev程序的父窗口（即顯示窗口）為當前的窗口控件，如果不添加以下兩句，則無法將Halcon程序的顯示內容顯示在窗體控件上，不過寫程序時不建議通過將Halcon程序內的內容通過這種方式顯示在控件上，可以直接拿到想要的對象然后再顯示比較好
            //HDevOpMultiWindowImpl = new HDevOpMultiWindowImpl(window);
            //hDevEngine.SetHDevOperators(HDevOpMultiWindowImpl);
            HDevProgram = new HDevProgram(exePath + "HDEV\\test.hdev");//實例化一個HDevProgram的實例
            HDevProgramCall = new HDevProgramCall(HDevProgram);//實例化一個執行Halcon程序的實例
            MessageBox.Show("初始化成功！！！");
        }

        private void Form1_Load(object sender, EventArgs e)
        {
            exePath = AppDomain.CurrentDomain.BaseDirectory;
        }

        private void btn_Execute_Click(object sender, EventArgs e)
        {
            try
            {
                HDevProgramCall.Execute();
            }
            catch (HDevEngineException Ex)
            {
                MessageBox.Show(Ex.Message, "HDevEngine Exception");
                return;
            }

            //建議不使用以上顯示的兩句，手動顯示想要顯示的部分
            HImage img =  HDevProgramCall.GetIconicVarImage("Image");
            HRegion region = HDevProgramCall.GetIconicVarRegion("RegionDilation");
            if(img.IsInitialized())
            {
                img.GetImageSize(out HTuple width, out HTuple height);
                window.SetPart(0D, 0, height, width);
                //window.SetColor("green");
                window.SetColored(12);
                window.SetDraw("fill");
                window.DispObj(img);
                window.DispObj(region);
            }
            img.Dispose();
        }
    }
}

2.一個單一的HDevlop函數文件

如果只是封裝好的一個.hdvp后綴的外部函數的文件，同樣可以利用Halcon引擎來調用。這里我封裝了一個十分簡單的加法的Halcon函數文件，在調用時，只需要傳入適當的參數，即可調用函數

 這個函數有兩個輸入的控制參數分別為num1和num2，有一個輸出的控制參數為a，在C#中建立一個如下的窗口界面：

 其中三個textbox分別代表兩個輸入和一個輸出，ADD按鈕表示執行這個函數，label2表示通過引擎調用這個函數的消耗時間

 效果如下：

 代碼：

namespace hdvpFUc
{
    public partial class Form1 : Form
    {
        
        public Form1()
        {
            InitializeComponent();
        }

        HDevEngine hDevEngine = new HDevEngine();//引擎
        HDevProcedure HDevProcedure;//Halcon函數
        Stopwatch sw = new Stopwatch();
        string exePath = "";
        public void LoadAlgorithm()
        {
            string procedurePath = exePath + "HDEV";
            hDevEngine.SetProcedurePath(procedurePath);//使用引擎配置函數的路徑，參數為這個函數的目錄
            HDevProcedure = new HDevProcedure("add_Num");//new一個Halcon外部函數的實例，參數為函數名
            HDevProcedureCall hDevProcedureCall = new HDevProcedureCall(HDevProcedure);//new一個函數執行的實例
            HTuple num1 = new HTuple(int.Parse(textBox1.Text));
            HTuple num2 = new HTuple(int.Parse(textBox2.Text));
            try
            {
                //設置函數參數，這里的參數名要和函數內的參數名一一對應
                hDevProcedureCall.SetInputCtrlParamTuple("num1", num1);
                hDevProcedureCall.SetInputCtrlParamTuple("num2", num2);
                sw.Start();
                hDevProcedureCall.Execute();//執行函數
                sw.Stop();
            }
            catch (HDevEngineException EX)
            {
                MessageBox.Show(EX.ToString());
                return;
            }
            string time = sw.ElapsedMilliseconds.ToString();
            label2.Text = time;
            HTuple a = hDevProcedureCall.GetOutputCtrlParamTuple("a");//獲得函數的輸出的控制參數”a"
            textBox3.Text = a.ToString();
        }
        private void button1_Click(object sender, EventArgs e)
        {
            LoadAlgorithm();
        }

        private void Form1_Load(object sender, EventArgs e)
        {
            exePath = AppDomain.CurrentDomain.BaseDirectory;
        }
    }
}

3.包含外部函數的Halcon程序

個人覺得這個是最常用的情況，使用Halcon引擎的情況下，在Halcon程序寫好后，我們往往會對其中的核心代碼封裝成一個外部函數文件，並設置好輸入輸出的參數。

其實就是將1、2兩步結合在一起即可，想執行整個程序就通過HDevProgramCall的實例調用其Execute方法，並通過這個實例的Getxxxxxx開頭的方法獲取想得到的控制參數或者圖標參數，如果想執行Halcon程序中的某個外部函數，那么就通過HDevProcedureCall的實例，在執行其Execute方法前通過這個實例的Setxxxxx開頭的方法傳入相關參數，然后執行即可，獲取參數的方法和前面一樣。這里只通過一個簡單的示例說明

路徑：

 .hdev文件

.hdvp文件

效果

 代碼：

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms;
using HalconDotNet;
namespace MultiDisplayEngeeni
{
    public partial class Form1 : Form
    {
        HDevEngine hDevEngine;
        HDevProgram hDevProgram;
        HDevProgramCall hDevProgramCall;
        HDevProcedure hDevProcedure;
        HDevProcedureCall hDevProcedureCall;
        String[] _fileNames;
        HImage img = new HImage();
        HXLDCont contour = new HXLDCont();
        HXLD affContour = new HXLD();
        HShapeModel HShapeModel = new HShapeModel("board.shm");
        int _Index = 0;
        ManualResetEvent ManualResetEvent = new ManualResetEvent(false);
        string exePath = "";
        public Form1()
        {
            InitializeComponent();
        }

        private void btn_Init_Click(object sender, EventArgs e)
        {
            InitHdevlop();
            Action();
            btn_Init.Enabled = false;
            btn_Start.Enabled = true;
        }

        public void InitHdevlop()
        {
            hDevEngine = new HDevEngine();
            hDevEngine.SetProcedurePath(@"./HDVP");
            hDevProgram = new HDevProgram(@"./HDEV\affine_trans_model.hdev");
            hDevProgramCall = new HDevProgramCall(hDevProgram);
            hDevProcedure = new HDevProcedure(hDevProgram, "affine_trans_find_model");
            hDevProcedureCall = new HDevProcedureCall(hDevProcedure);
        }
        
        public void Action()
        {
            Action ac = new Action(() => {
                hWindowControl1.HalconWindow.DispImage(img);
                hWindowControl1.HalconWindow.DispObj(affContour);
            });
            Task.Run(() =>
            {
                while (true)
                {
                    try
                    {
                        ManualResetEvent.WaitOne();
                        img.Dispose();
                        affContour.Dispose();
                        string imgPath = exePath + _fileNames[_Index];
                        img = new HImage(imgPath);
                        img.GetImageSize(out HTuple width, out HTuple height);
                        hWindowControl1.HalconWindow.SetPart(0D, 0, height, width);
                        hDevProcedureCall.SetInputCtrlParamTuple("ModelID", HShapeModel);
                        hDevProcedureCall.SetInputIconicParamObject("Image", img);
                        hDevProcedureCall.SetInputIconicParamObject("ModelContours", contour);
                        hDevProcedureCall.Execute();
                        affContour = hDevProcedureCall.GetOutputIconicParamXld("ContoursAffineTrans");
                        Invoke(ac);
                        _Index++;
                        if (_Index == _fileNames.Length - 1)
                        {
                            _Index = 0;
                        }
                        Thread.Sleep(10);
                    }
                    catch (Exception)
                    {
                        return;
                    }
                }
            });
        }

        private void Form1_Load(object sender, EventArgs e)
        {
            exePath = AppDomain.CurrentDomain.BaseDirectory;
            _fileNames = Directory.GetFiles("Images");
            hWindowControl1.HalconWindow.SetColor("blue");
            contour.ReadObject("contours.hobj");
            btn_Init.Enabled = true;
            btn_Start.Enabled = false;
            btn_Stop.Enabled = false;
        }

        private void btn_Start_Click(object sender, EventArgs e)
        {
            btn_Start.Enabled = false;
            btn_Stop.Enabled = true;
            ManualResetEvent.Set();
        }

        private void btn_Stop_Click(object sender, EventArgs e)
        {
            btn_Start.Enabled = true;
            btn_Stop.Enabled = false;
            ManualResetEvent.Reset();
        }
    }
}

在使用Halcon引擎時，個人覺得需要注意的是路徑的配置（最好使用相對路徑，方便程序移植），以及傳參和獲取參數時要保持和Halcon程序內部的參數名保持一致。

---

 

最后，做個小總結，關於具體使用哪種方法較好，我覺得因人而異，因為每種方法都可以實現相同的效果，並且各有優缺點

1.導出比較方便快捷，但是其不易封裝和修改，可讀性差。

2.面向對象的方式易封裝和修改，並且完全可以脫離Halcon的IDE，但是它要求比較高的熟練度，而且面對較為復雜的程序和較多的代碼量，這樣的效率比較低。

3.使用Halcon引擎在代碼修改方面十分方便，只需要在Halcon的IDE中修改好保存即可，並且也不存在可讀性差的問題，無論是較為復雜的程序還是很簡單的程序都是適用的，但是它比較依賴Halcon的軟件，在移植的時候，Halcon的程序和外部函數文件也要一同進行移植。

---

 

以上所有內容僅為個人看法，如有不當，歡迎指正！