HALCON

https://www.mvtec.com/doc/halcon/2505/en/
Admin
HALCON is a comprehensive machine vision software platform providing image processing, pattern...
Tokens:3,473,507
Snippets:29,219
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### get_camera_setup_param

Source: https://www.mvtec.com/doc/halcon/2505/en/toc_calibration_multiview.html

Gets generic camera setup model parameters.

```APIDOC
## get_camera_setup_param

### Description
Get generic camera setup model parameters.

### Method
APIDOC

### Endpoint
get_camera_setup_param

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

--------------------------------

### Set Icon for Region Output (C Example)

Source: https://www.mvtec.com/doc/halcon/2505/en/set_icon.html

This C example demonstrates how to draw a region and an icon, set the icon for display, and then display the region with the specified icon. It requires prior setup of a WindowHandle and icon region.

```c
/* draw a region and an icon */
T_draw_region(&Region,WindowHandle);
T_draw_region(&Icon,WindowHandle);
set_icon(Icon);
create_tuple_s(&icon,"icon");
T_set_shape(WindowHandle,icon);
destroy_tuple(icon);
T_disp_region(Region,WindowHandle);

```

--------------------------------

### Get Camera Setup Parameters

Source: https://www.mvtec.com/doc/halcon/2505/en/get_camera_setup_param.html

Retrieves generic or camera-specific parameters from a camera setup model.

```APIDOC
## get_camera_setup_param

### Description
Inspects diverse generic parameters of the camera setup model `CameraSetupModelID`.

### Parameters
*   **CameraSetupModelID** (input) - `hv_cameras_setup_model_id`
    The ID of the camera setup model.
*   **CameraIdx** (input) - `hv_camera_idx`
    The index of the camera to query. Set to 'general' for general parameters.
*   **GenParamName** (input) - `hv_gen_param_name`
    The name of the general parameter to query.
*   **GenParamValue** (output) - `hv_gen_param_value`
    The value of the queried general parameter.

### General Parameters (when CameraIdx = 'general')
*   **'num_cameras'**: Number of cameras described in the model.
*   **'camera_calib_error'**: The root mean square error (RMSE) of the back projection of the camera system optimization.
*   **'reference_camera'**: The index of the camera defined as the reference camera.
*   **'coord_transf_pose'**: The pose in which the coordinate system of the setup has been moved.

### Camera-Specific Parameters (when CameraIdx is a valid camera index)
*   **'type'**: Camera type.
*   **'params'**: A tuple with internal camera parameters.
*   **'params_deviations'**: A tuple representing the standard deviations of the internal camera parameters.
*   **'params_covariances'**: A tuple representing the covariance matrix of the internal camera parameters.
*   **'pose'**: Camera pose relative to the setup's coordinate system.

### Example
```halcon
get_camera_setup_param(CameraSetupModelID, 'general', 'num_cameras', NumCameras)
get_camera_setup_param(CameraSetupModelID, 0, 'pose', CameraPose)
```
```

--------------------------------

### Get Icon for Region Output (C)

Source: https://www.mvtec.com/doc/halcon/2505/en/get_icon.html

Draws a region and an icon, sets the icon, and then retrieves it again. This example demonstrates the typical workflow of setting and getting an icon for a region.

```c
/* draw a region and an icon.  */
/* set it and get it again.    */
T_draw_region(&Region,WindowHandle);
T_draw_region(&Icon,WindowHandle);
set_icon(Icon);
create_tuple_s(&icon,"icon");
T_set_shape(WindowHandle,icon);
destroy_tuple(icon);
T_disp_region(Region,WindowHandle);
get_icon(&OldIcon);
T_disp_region(OldIcon,WindowHandle);

```

--------------------------------

### create_camera_setup_model

Source: https://www.mvtec.com/doc/halcon/2505/en/create_camera_setup_model.html

Creates a new camera setup model and returns a handle to it. The number of cameras in the setup is specified during creation and cannot be changed later.

```APIDOC
## create_camera_setup_model

### Description
Creates a new camera setup model and returns a handle to it in _`CameraSetupModelID`_. The camera setup comprises a fixed number of cameras, which is specified by _`NumCameras`_ and cannot be changed once the model was created.

### Signature
`create_camera_setup_model(NumCameras)`

### Parameters
#### Input Control Parameters
* **`NumCameras`** (integer) - Number of cameras in the setup. Default: 2. Restriction: `NumCameras >= 1`.

#### Output Control Parameters
* **`CameraSetupModelID`** (camera_setup_model) - Handle to the camera setup model.

### Example
```halcon
* Create a camera setup model with 2 cameras
create_camera_setup_model (2, CameraSetupModelID)
```
```

--------------------------------

### GetCameraSetupParam

Source: https://www.mvtec.com/doc/halcon/2505/en/HOperatorSet.html

Gets generic camera setup model parameters.

```APIDOC
## GetCameraSetupParam

### Description
Gets generic camera setup model parameters.

### Method
(Not specified in source)

### Endpoint
(Not specified in source)

### Parameters
(Not specified in source)

### Request Example
(Not specified in source)

### Response
(Not specified in source)
```

--------------------------------

### Update Kalman Filter Example (C)

Source: https://www.mvtec.com/doc/halcon/2505/en/update_kalman.html

This C example illustrates the input and output values for the update_kalman function, mirroring the HDevelop example for system parameter updates.

```C
/* The following values are describing the system                      */
/*                                                                     */
/*DimensionIn   = [3,1,0]                                              */
/*ModelIn       = [1.0,1.0,0.5,0.0,1.0,1.0,0.0,0.0,1.0,1.0,0.0,0.0,    */
/*                      54.3,37.9,48.0,37.9,34.3,42.5,48.0,42.5,43.7]  */
/*MeasurementIn = [1,2]                                                */
/*                                                                     */
/*An example of the Updatefile:                                        */
/*                                                                     */
/*n=3 m=1 p=0                                                          */
/*A+C-Q-G-u-L-R-                                                       */
/*transitions at time t=15:                                            */
/*2 1 1                                                                */
/*0 2 2                                                                */
/*0 0 2                                                                */
/*                                                                     */
/*the results of update_kalman:                                        */
/*                                                                     */
/*DimensionOut   = [3,1,0]                                             */
/*ModelOut       = [2.0,1.0,1.0,0.0,2.0,2.0,0.0,0.0,2.0,1.0,0.0,0.0,   */
/*                       54.3,37.9,48.0,37.9,34.3,42.5,48.0,42.5,43.7] */
/*MeasurementOut = [1.2]                                               */


```

--------------------------------

### SerializeCameraSetupModel

Source: https://www.mvtec.com/doc/halcon/2505/en/HOperatorSet.html

Serializes a camera setup model.

```APIDOC
## SerializeCameraSetupModel

### Description
Serializes a camera setup model.

### Method
Not specified (likely a function call in an SDK)

### Endpoint
Not applicable

### Parameters
Not specified

### Request Example
Not specified

### Response
Not specified
```

--------------------------------

### Switch

Source: https://www.mvtec.com/doc/halcon/2505/en/HOperatorSet.html

Starts a multiway branch block.

```APIDOC
## Switch

### Description
Starts a multiway branch block.

### Method
Not specified (likely a function call in an SDK)

### Endpoint
Not applicable

### Parameters
None specified

### Request Example
None specified

### Response
None specified
```

--------------------------------

### Open I/O Device and Channel in HDevelop

Source: https://www.mvtec.com/doc/halcon/2505/en/open_io_device.html

This example demonstrates how to query available I/O interfaces and devices, open an I/O device, query its channels, open a specific channel, and read data from it. Ensure the correct I/O interface name is selected.

```HDevelop
* Select a suitable i/o device interface of name IOInterfaceName
query_io_interface (IOInterfaceName, 'io_device_names', DeviceNames)
open_io_device (IOInterfaceName, DeviceNames[0], [], [], IODeviceHandle)
query_io_device (IODeviceHandle, [], 'io_channel_names.digital_input',
                 ChannelInputNames)
open_io_channel (IODeviceHandle, ChannelInputNames[0], [], [], 
                 IOChannelHandle)
read_io_channel (IOChannelHandle, Value, Status)

```

--------------------------------

### WriteCameraSetupModel

Source: https://www.mvtec.com/doc/halcon/2505/en/HOperatorSet.html

Stores a camera setup model into a file.

```APIDOC
## WriteCameraSetupModel

### Description
Store a camera setup model into a file.

### Method
(Not specified in source)

### Endpoint
(Not specified in source)

### Parameters
(Not specified in source)

### Request Example
(Not specified in source)

### Response
(Not specified in source)
```

--------------------------------

### Querying IO Interface and Devices

Source: https://www.mvtec.com/doc/halcon/2505/en/query_io_interface.html

This example demonstrates how to query available I/O interfaces, list device names associated with an interface, open an I/O device, query channel names, open an I/O channel, and read data from a channel.

```APIDOC
## query_io_interface

### Description
Queries the available I/O interfaces and their properties.

### Method
`query_io_interface(IOInterfaceName, Query, Result)

### Parameters
#### Input Parameters
* **IOInterfaceName** (string) - The name of the I/O interface to query.
* **Query** (string) - The type of information to query. For example, 'io_device_names'.

#### Output Parameters
* **Result** (various) - The result of the query. For example, a tuple of device names.

### Example
```hdevelop
* Select a suitable i/o device interface of name IOInterfaceName
query_io_interface (IOInterfaceName, 'io_device_names', DeviceNames)
open_io_device (IOInterfaceName, DeviceNames[0], [], [], IODeviceHandle)
query_io_device (IODeviceHandle, [], 'io_channel_names.digital_input', ChannelInputNames)
open_io_channel (IODeviceHandle, ChannelInputNames[0], [], [], IOChannelHandle)
read_io_channel (IOChannelHandle, Value, Status)
```

## Result
If the parameters are valid, the operator `query_io_interface` returns the value `2` (`H_MSG_TRUE`). If necessary, an exception is raised. In this case, extended error information may be set and can be queried with the operator `get_extended_error_info`.
```

--------------------------------

### ReadCameraSetupModel

Source: https://www.mvtec.com/doc/halcon/2505/en/HOperatorSet.html

Restores a camera setup model from a file.

```APIDOC
## ReadCameraSetupModel

### Description
Restores a camera setup model from a file.

### Method
(Not specified, assumed to be a function call)

### Endpoint
(Not applicable for SDK methods)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not applicable for SDK methods)

### Response
(Response details not specified in the source)
```

--------------------------------

### GetComprise

Source: https://www.mvtec.com/doc/halcon/2505/en/HOperatorSet.html

Gets the output treatment of an image matrix.

```APIDOC
## GetComprise

### Description
Gets the output treatment of an image matrix.

### Method
(Not specified in source)

### Endpoint
(Not specified in source)

### Parameters
(Not specified in source)

### Request Example
(Not specified in source)

### Response
(Not specified in source)
```

--------------------------------

### GetChapterInfo

Source: https://www.mvtec.com/doc/halcon/2505/en/HOperatorSet.html

Gets information concerning the chapters on operators.

```APIDOC
## GetChapterInfo

### Description
Gets information concerning the chapters on operators.

### Method
(Not specified in source)

### Endpoint
(Not specified in source)

### Parameters
(Not specified in source)

### Request Example
(Not specified in source)

### Response
(Not specified in source)
```

--------------------------------

### Create Structured Light Model (.NET)

Source: https://www.mvtec.com/doc/halcon/2505/en/create_structured_light_model.html

This .NET example shows the instantiation of a structured light model object. The constructor takes the model type as a string.

```.NET
public HStructuredLightModel(string _modelType_)
```

--------------------------------

### Get Generic Camera Setup Parameters

Source: https://www.mvtec.com/doc/halcon/2505/en/get_camera_setup_param.html

This function retrieves the values of generic parameters from a camera setup model. You can query parameters such as calibration error, pose, number of cameras, and more.

```APIDOC
## get_camera_setup_param

### Description
Retrieves the values of generic parameters from a camera setup model.

### Parameters
#### Input
* **`camera_setup_model_id`** (HCameraSetupModel) - Handle to the camera setup model.
* **`camera_idx`** (integer / string) - Index of the camera in the setup. Default: 0. Suggested values: 0, 1, 2, 'general'.
* **`gen_param_name`** (string) - Names of the generic parameters to be queried. Possible values: 'camera_calib_error', 'coord_transf_pose', 'num_cameras', 'params', 'params_covariances', 'params_deviations', 'pose', 'reference_camera', 'type'.

#### Output
* **`gen_param_value`** (real / integer / string) - Values of the generic parameters to be queried.
```

--------------------------------

### While

Source: https://www.mvtec.com/doc/halcon/2505/en/HOperatorSet.html

Starts a loop block that is executed as long as the condition is true.

```APIDOC
## While

### Description
Starts a loop block that is executed as long as the condition is true.

### Method
(Not specified in source)

### Endpoint
(Not specified in source)

### Parameters
(Not specified in source)

### Request Example
(Not specified in source)

### Response
(Not specified in source)
```

--------------------------------

### Get Window Extents in HDevelop

Source: https://www.mvtec.com/doc/halcon/2505/en/get_window_extents.html

Retrieves the current window extents. This example repeatedly gets the mouse button state and window extents, writing the row and column to a file until the mouse button is released.

```HDevelop
open_window(100,100,200,200,'root','visible','',WindowHandle)
fwrite_string(FileHandle, 'Move the window with the mouse!')
fnew_line(FileHandle)
repeat
get_mbutton(WindowHandle,_,_,Button)
get_window_extents(WindowHandle,Row,Column,Width,Height)
fwrite_string(FileHandle, ['(',Row,',',Column,')'])
fnew_line(FileHandle)
until(Button == 4)

```

--------------------------------

### Region Growing Example in C

Source: https://www.mvtec.com/doc/halcon/2505/en/regiongrowing.html

Shows how to use the region growing algorithm in C. This example reads an image, applies a mean filter, and then segments regions.

```C
read_image(&Image,"fabrik");
mean_image(Image,&Mean,RasterHeight,RasterWidth);
regiongrowing(Mean,&Result,RasterHeight,RasterWidth,6,100);
```

--------------------------------

### SetCameraSetupParam

Source: https://www.mvtec.com/doc/halcon/2505/en/HOperatorSet.html

Sets generic camera setup model parameters. This method allows for the configuration of various parameters related to camera setup models.

```APIDOC
## SetCameraSetupParam

### Description
Set generic camera setup model parameters.

### Method
Not specified (assumed to be a function call in an SDK)

### Endpoint
Not applicable (SDK method)

### Parameters
Not specified in the source text.

### Request Example
Not specified in the source text.

### Response
Not specified in the source text.
```

--------------------------------

### Kalman Filter Initialization and Usage (C)

Source: https://www.mvtec.com/doc/halcon/2505/en/filter_kalman.html

Provides a C language example demonstrating the typical procedure for initializing Kalman filter variables, generating measurements, performing the first Kalman filtering, and using the estimated value. It also illustrates the process for subsequent filtering steps with new measurements.

```C
/* Typical procedure: */
/* 1. To initialize the variables
      which describe the model, e.g., with */

read_kalman("kalman.init",Dim,Mod,Meas,Pred);

/* Generation of the first measurements (typically of the
   first image of an image series) with an appropriate
   problem-specific routine (there is a fictitious routine
   extract_features in this example):  */

extract_features(Image1,Meas,&Meas1);

/* first Kalman-Filtering: */

filter_kalman(Dim,Mod,Meas1,Pred,&Pred1,&Est1);

/* To use the estimate value (if need be the prediction too) */
/* with a problem-specific routine (here use_est): */

use_est(Est1);

/* To get the next measurements (e.g., from the next image): */

extract_next_features(Image2,Meas1,&Meas2);

/* if need be Update of the  model parameter (a constant model) */
/* second Kalman-Filtering: */

filter_kalman(Dim,Mod,Meas2,Pred1,&Pred2,&Est2);
use_est(Est2);
extract_next_features(Image3,Meas2,&Meas3);

/* etc. */

```

--------------------------------

### Get Rectangle Pose Example

Source: https://www.mvtec.com/doc/halcon/2505/en/get_rectangle_pose.html

This example demonstrates finding rectangles in an image and then calculating their 3D poses using the get_rectangle_pose operator. It includes image preprocessing steps like thresholding and edge detection.

```HDevelop
* Process an image with several rectangles of the same size appearing
* as light objects.
RectWidth := 0.04
RectHeight := 0.025
gen_cam_par_area_scan_division (0.014, 830, 4.58e-006, 4.65e-006, \ 
                                509, 488, 800, 800, CameraParam)
read_image (Image, 'barcode/ean13/tea_box_01')
* Find light objects in the image.
mean_image (Image, ImageMean, 201, 201)
dyn_threshold (Image, ImageMean, Region, 5, 'light')
* Fill gaps in the objects.
fill_up (Region, RegionFillUp)
* Extract rectangular contours.
connection (RegionFillUp, ConnectedRegions)
select_shape (ConnectedRegions, SelectedRegions, ['area','rectangularity'], \ 
              'and', [50000,0.9], [640000,1])
boundary (SelectedRegions, RegionBorder, 'inner')
dilation_circle (RegionBorder, RegionDilation, 3.5)
* NOTE: for a real application, this step might require some additional
*       pre- or postprocessing.
reduce_domain (Image, RegionDilation, ImageReduced)
edges_sub_pix (ImageReduced, Edges, 'canny', 1, 20, 40)
* Get the pose of all contours found.
get_rectangle_pose (Edges, CameraParam, RectWidth, RectHeight, 'huber', 2, \ 
                    Poses, CovPose, Error)
NumPoses := |Poses|/7
for I := 0 to NumPoses-1 by 1
  Pose := Poses[I*7:I*7+6]
  * Use the Pose here.
  * ...
endfor

```

--------------------------------

### Dump Window to PostScript File (C)

Source: https://www.mvtec.com/doc/halcon/2505/en/dump_window.html

This C example shows how to display an image and regions in a window and then dump the window's content to a PostScript file. Ensure the window handle and desired format are correctly specified.

```C
/* PostScript - Dump of Image and Regions */
disp_image(Image,WindowHandle);
set_colored(WindowHandle,12);
disp_region(Regions,WindowHandle);
dump_window(WindowHandle,"postscript","halcon_dump");

```

--------------------------------

### Apply Guided Filter in HDevelop

Source: https://www.mvtec.com/doc/halcon/2505/en/guided_filter.html

This example demonstrates how to apply the guided filter for edge-preserving smoothing and a rolling filter effect. Ensure the 'Image' is read before applying the filter. The 'ImageGuide' is used as a guidance image for the rolling filter.

```HDevelop
read_image (Image, 'mreut')
* Edge-preserving smoothing
guided_filter (Image, Image, ImageGuided, 5, 20)
* Rolling filter (5 iterations)
gen_image_proto (Image, ImageGuide, 0)
for I := 1 to 5 by 1
  guided_filter (Image, ImageGuide, ImageGuide, 5, 20)
endfor

```

--------------------------------

### ParJoin

Source: https://www.mvtec.com/doc/halcon/2505/en/HOperatorSet.html

Wait for subthreads that were started with the par_start qualifier.

```APIDOC
## ParJoin

### Description
Wait for subthreads that were started with the par_start qualifier.

### Method
Not specified

### Endpoint
Not specified

### Parameters
Not specified

### Request Example
Not specified

### Response
Not specified
```

--------------------------------

### Get Window Extents in C

Source: https://www.mvtec.com/doc/halcon/2505/en/get_window_extents.html

Retrieves the current window extents. This example repeatedly gets the mouse button state and window extents, writing the row and column to a string buffer and then to a file until the mouse button is released.

```C
open_window(100,100,200,200,"root","visible","",&WindowHandle);
fwrite_string(FileHandle,"Move the window with the mouse!");
fnew_line(FileHandle);
create_tuple(&String,1);
do
{
  get_mbutton(WindowHandle,NULL,NULL,&Button);
  get_window_extents(WindowHandle,&Row,&Column,&Width,&Height);
  sprintf(buf,"Row %d Col %d ",Row,Column); 
  set_s(String,buf,0);
  T_fwrite_string(FileHandle, String);
  fnew_line(FileHandle);
}
while(Button < 4);

```

--------------------------------

### HDevelop Example for Structured Light Pattern Decoding

Source: https://www.mvtec.com/doc/halcon/2505/en/decode_structured_light_pattern.html

This HDevelop example demonstrates the complete workflow for structured light pattern analysis, from model creation and parameter setting to pattern generation, decoding, and result retrieval. Ensure the structured light model and camera images are properly initialized before execution.

```HDevelop
* Create the model
create_structured_light_model ('deflectometry', StructuredLightModel)
* Set the size of the monitor
set_structured_light_model_param (StructuredLightModel, \
                                  'pattern_width', 1600)
set_structured_light_model_param (StructuredLightModel, \
                                  'pattern_height', 1200)
* Set the smallest width of the stripes in the pattern
set_structured_light_model_param (StructuredLightModel, \
                                  'min_stripe_width', 8)
* Generate the patterns to project
gen_structured_light_pattern (PatternImages, StructuredLightModel)
* Set the expected black/white contrast in the region of interest
set_structured_light_model_param (StructuredLightModel, \
                                  'min_gray_difference', 70)
* Decode the camera images
decode_structured_light_pattern (CameraImages, StructuredLightModel)
* Get the computed correspondences and defects
get_structured_light_object (CorrespondenceImages, StructuredLightModel, \
                             'correspondence_image')
set_structured_light_model_param (StructuredLightModel, 'derivative_sigma', \
                                  Sigma)
get_structured_light_object (DefectImage, StructuredLightModel, \
                             'defect_image')

```

--------------------------------

### Example: Create, Add, Get, and Remove Texture Inspection Model Images

Source: https://www.mvtec.com/doc/halcon/2505/en/remove_texture_inspection_model_image.html

This HDevelop example demonstrates the complete workflow of creating a texture inspection model, adding training images, retrieving them, and then removing specific images.

```HDevelop
* Create texture inspection model
create_texture_inspection_model ('basic', TextureInspectionModel)
* Read and add training images
read_image (TrainImage, 'carpet/carpet_01')
add_texture_inspection_model_image (TrainImage, TextureInspectionModel, \
                                    Indices)
* Get added training images
get_texture_inspection_model_image (TrainImageOut, TextureInspectionModel)
* Remove training images
remove_texture_inspection_model_image (TextureInspectionModel, Indices, \
                                       RemainingIndices)
```

--------------------------------

### Create and Configure Camera Setup Model

Source: https://www.mvtec.com/doc/halcon/2505/en/create_camera_setup_model.html

Initializes a camera setup model for three cameras, defines their intrinsic parameters, and sets their extrinsic poses relative to the origin. It also sets the object pose to define the coordinate system origin.

```HDevelop
* Create camera setup of three cameras.
create_camera_setup_model (3, CameraSetupModelID)
gen_cam_par_area_scan_division (0.006, 0, 8.3e-6, 8.3e-6,
              512, 384, 1024, 768, StartCamPar)
* Camera 0 is located in the origin.
set_camera_setup_cam_param (CameraSetupModelID, 0, [], StartCamPar,
                            [0, 0, 0, 0, 0, 0, 0])

* Camera 1 is shifted 0.07 m in positive x-direction relative to
* camera 0.
set_camera_setup_cam_param (CameraSetupModelID, 1, [], StartCamPar,
                            [0.07, 0, 0, 0, 0, 0, 0])

* Camera 2 is shifted 0.1 m in negative y-direction relative to
* camera 0.
set_camera_setup_cam_param (CameraSetupModelID, 2, [], StartCamPar,
                            [0.0, -0.1, 0, 0, 0, 0, 0])

* There is an object, which is 0.5 away from the origin in
* z-direction, and is facing the origin.
ObjectPose := [0, 0, 0.5, 180, 0, 0, 0]
* Place the setup's origin in the object.
set_camera_setup_param (CameraSetupModelID, 'general', 'coord_transf_pose',
                        ObjectPose)

* Now the camera poses are given relative to the object.
get_camera_setup_param (CameraSetupModelID, 0, 'pose', CamPose0)
* CamPose0 is equivalent to [0.0, 0.0, 0.5, 180.0, 0.0, 0.0, 0]

get_camera_setup_param (CameraSetupModelID, 1, 'pose', CamPose1)
* CamPose1 is equivalent to [0.07, 0.0, 0.5, 180.0, 0.0, 0.0, 0]

get_camera_setup_param (CameraSetupModelID, 2, 'pose', CamPose2)
* CamPose2 is equivalent to [0.0, 0.1, 0.5, 180.0, 0.0, 0.0, 0]

```

--------------------------------

### get_chapter_info

Source: https://www.mvtec.com/doc/halcon/2505/en/index_by_name.html

Get information concerning the chapters on operators.

```APIDOC
## get_chapter_info

### Description
Get information concerning the chapters on operators.

### Method
APIDOC

### Endpoint
get_chapter_info

### Parameters
None specified in source.
```

--------------------------------

### get_paint

Source: https://www.mvtec.com/doc/halcon/2505/en/index_by_name.html

Get the current display mode for gray values.

```APIDOC
## get_paint

### Description
Get the current display mode for gray values.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
APIDOC

### Request Example
APIDOC

### Response
APIDOC
```

--------------------------------

### Draw Point Mod (HDevelop)

Source: https://www.mvtec.com/doc/halcon/2505/en/draw_point_mod.html

This HDevelop example demonstrates how to use draw_point_mod to get interactive point coordinates and then draw a cross at that location.

```HDevelop
draw_point_mod (WindowHandle, 100, 100, Row,Column)
gen_cross_contour_xld (Cross, Row, Column, 6, 0)
```

--------------------------------

### Initialize and Run Background Estimation

Source: https://www.mvtec.com/doc/halcon/2505/en/get_bg_esti_params.html

This snippet demonstrates the initialization of a background estimation dataset using `create_bg_esti` and subsequent background estimation using `run_bg_esti` with sample images. It also shows how to retrieve and set parameters using `get_bg_esti_params` and `set_bg_esti_params`.

```HDevelop
* Read image for initialization:
read_image(InitImage,'xing/init')
* Initialize BgEsti dataset with
* fixed gains and threshold adaption:
create_bg_esti(InitImage,0.7,0.7,'fixed',0.002,0.02, \
               'on',7.0,10,3.25,15.0,BgEstiHandle)
* Read the next image in sequence:
read_image(Image0,'xing/xing000')
* Estimate the background:
run_bg_esti(Image0,ForegroundRegion1,BgEstiHandle)
* Display the foreground region:
dev_display (ForegroundRegion1)
* Read the next image in sequence:
read_image(Image1,'xing/xing001')
* Estimate the background:
run_bg_esti(Image1,ForegroundRegion2,BgEstiHandle)
* Display the foreground region:
dev_display (ForegroundRegion2)
* etc.
* Change only the gain parameter in dataset:
get_bg_esti_params(BgEstiHandle, Syspar1, Syspar2, \
                   GainMode, Gain1, Gain2, AdaptMode,
                   MinDiff, StatNum, ConfidenceC, TimeC)
set_bg_esti_params(BgEstiHandle, Syspar1, Syspar2, \
                   GainMode, 0.004, 0.08, AdaptMode,
                   MinDiff, StatNum, ConfidenceC, TimeC)
* Read the next image in sequence:
read_image(Image3,'xing/xing003')
* Estimate the background:
run_bg_esti(Image3,ForegroundRegion3,BgEstiHandle)
* Display the foreground region:
dev_display(ForegroundRegion3)
* etc

```

--------------------------------

### Create and Configure Structured Light Model, then Generate Patterns

Source: https://www.mvtec.com/doc/halcon/2505/en/gen_structured_light_pattern.html

This HDevelop example demonstrates the complete workflow for generating structured light patterns. It involves creating a model, setting its parameters like monitor resolution and minimum stripe width, and then generating the patterns using `gen_structured_light_pattern`. Ensure `create_structured_light_model` and `set_structured_light_model_param` are called prior to this.

```HDevelop
* Create the model
create_structured_light_model ('deflectometry', StructuredLightModel)
* Set the size of the monitor
set_structured_light_model_param (StructuredLightModel, \
                                  'pattern_width', 1600)
set_structured_light_model_param (StructuredLightModel, \
                                  'pattern_height', 1200)
* Set the smallest width of the stripes in the pattern
set_structured_light_model_param (StructuredLightModel, \
                                  'min_stripe_width', 8)
* Generate the patterns to project
gen_structured_light_pattern (PatternImages, StructuredLightModel)
* Decode the camera images
decode_structured_light_pattern (CameraImages, StructuredLightModel)

```

--------------------------------

### Create and Train a DL Model, then Get Layer Weights

Source: https://www.mvtec.com/doc/halcon/2505/en/get_dl_model_layer_weights.html

This example demonstrates the complete workflow: creating a simple deep learning model, training it, and then retrieving specific layer weights using get_dl_model_layer_weights. It also shows how to get gradients and activations for comparison.

```HDevelop
set_system ('seed_rand', 42)
* Create a small model network.
create_dl_layer_input ('input', [InputImageSize[0],InputImageSize[1],1], [],
                       [], DLGraphNodeInput)
create_dl_layer_convolution (DLGraphNodeInput, 'conv', 3, 1, 1, 2, 1, 'none',
                             'none', [], [], DLGraphNodeConvolution)
create_dl_layer_activation (DLGraphNodeConvolution, 'relu', 'relu', [], [],
                            DLGraphNodeActivation)
create_dl_layer_dense (DLGraphNodeActivation, 'dense', 3, [], [],
                       DLGraphNodeDense)
create_dl_layer_softmax (DLGraphNodeDense, 'softmax', [], [],
                          DLGraphNodeSoftMax)
create_dl_model (DLGraphNodeSoftMax, DLModelHandle)
*
set_dl_model_param (DLModelHandle, 'type', 'classification')
set_dl_model_param (DLModelHandle, 'batch_size', 1)
set_dl_model_param (DLModelHandle, 'runtime', 'gpu')
set_dl_model_param (DLModelHandle, 'runtime_init', 'immediately')
*
* Train for 5 iterations.
for TrainIterations := 1 to NumTrainIterations by 1
    train_dl_model_batch (DLModelHandle, DLSample, DLTrainResult)
endfor
*
* Get the gradients, weights, and activations.
get_dl_model_layer_gradients (GradientsSoftmax, DLModelHandle, 'softmax')
get_dl_model_layer_gradients (GradientsDense, DLModelHandle, 'dense')
get_dl_model_layer_gradients (GradientsConv, DLModelHandle, 'conv')
*
get_dl_model_layer_weights (WeightsDense, DLModelHandle, 'dense',
                      'weights_gradient')
get_dl_model_layer_weights (WeightsConv, DLModelHandle, 'conv',
                      'weights_gradient')
*
get_dl_model_layer_activations (ActivationsDense,  DLModelHandle, 'dense')
get_dl_model_layer_activations (ActivationsConv,  DLModelHandle, 'conv')
```

--------------------------------

### Get Error Text in C

Source: https://www.mvtec.com/doc/halcon/2505/en/get_error_text.html

Retrieves the error message for a HALCON error code in C. This example demonstrates how to disable automatic error reporting with set_check, call an operator that might fail, and then use get_error_text to get a custom error message if an error occurred.

```C
Herror   err;
char       message[MAX_STRING];

set_check("~give_error");
err = send_region(region,socket);
set_check("give_error");
if (err != H_MSG_TRUE) {
get_error_text((Hlong)err,message);
  fprintf(stderr,"my error message: %s\n",message);
  exit(1);
}

```

--------------------------------

### Region Growing Example in C++

Source: https://www.mvtec.com/doc/halcon/2505/en/regiongrowing.html

Illustrates the region growing algorithm using the C++ HALCON interface. This example includes image reading, mean filtering, region growing, and displaying the results.

```C++
#include "HIOStream.h"
#if !defined(USE_IOSTREAM_H)
using namespace std;
#endif
#include "HalconCpp.h"
using namespace Halcon;

int main (int argc, char *argv[])
{
  if (argc != 2)
  {
    cout << "Usage : " << argv[0] << " <name of the image>" << endl;
    return (-1);
  }

  HImage   image (argv[1]),
           mean;
  HWindow  win;

  mean = image.MeanImage (5, 5);

  HRegionArray reg = mean.Regiongrowing (5, 5, 6, 100);

  reg.Display (win);
  win.Click ();

  return (0);
}
```

--------------------------------

### Start Asynchronous Grab in HDevelop

Source: https://www.mvtec.com/doc/halcon/2505/en/grab_image_start.html

This HDevelop example demonstrates how to open an image acquisition device, start an asynchronous grab, and enter a loop to continuously acquire images. Ensure 'AcqName' is replaced with your actual acquisition interface name. The MaxDelay parameter is obsolete for grab_image_start.

```HDevelop
open_framegrabber('AcqName', 1, 1, 0, 0, 0, 0, 'default', -1, 'default', \
                  -1.0, 'default', 'default', 'default', -1, -1, AcqHandle)
grab_image_start(AcqHandle, -1)
while (true)
    grab_image_async(Image, AcqHandle, -1.0)
    * Next: Do something with the grabbed image.
endwhile
close_framegrabber(AcqHandle)

```

--------------------------------

### Open Text Window Example

Source: https://www.mvtec.com/doc/halcon/2505/en/open_textwindow.html

Demonstrates opening two text windows with different parameters and then using one to display image information interactively. The first window is a root window, and the second is a child window. It includes reading an image, displaying it in a separate graphics window, and continuously reading mouse position and gray values, writing them to the second text window until the mouse button is released.

```HDevelop
open_textwindow(0,0,900,600,1,'black','slate blue','root','visible',
              '',WindowHandle1)
open_textwindow(10,10,300,580,3,'red','blue',WindowHandle1,'visible',
              '',WindowHandle2)
open_window(10,320,570,580,WindowHandle1,'visible','',WindowHandle)
set_color(WindowHandle,'red')
read_image(Image,'monkey')
disp_image(Image,WindowHandle)
Button := 0
repeat
  try
      get_mposition(WindowHandle,Row,Column,Button)
      get_grayval(Image,Row,Column,Gray)
      write_string(WindowHandle2,['  Position (',Row,',',Column,')  '])
      write_string(WindowHandle2,['Gray value (',Gray,')  '])
      new_line(WindowHandle2)
  catch (Exception)
  endtry
until(Button == 4)
close_window(WindowHandle1)

```

--------------------------------

### Get 2D Data Code Objects (HDevelop)

Source: https://www.mvtec.com/doc/halcon/2505/en/get_data_code_2d_objects.html

This example demonstrates retrieving iconic objects for undecoded 2D data code candidates. It shows how to get the contour, foreground module regions, and background module regions for each undecoded symbol. Ensure `find_data_code_2d` has been called prior to using this.

```HDevelop
* Example demonstrating how to access the iconic objects of the data code
* search.

* Create a model for reading Data matrix ECC 200 codes
create_data_code_2d_model ('Data Matrix ECC 200', [], [], DataCodeHandle)
set_data_code_2d_param (DataCodeHandle, 'default_parameters',
                        'maximum_recognition')
set_data_code_2d_param (DataCodeHandle, 'persistence', 1)
* Read an image
read_image (Image, 'datacode/ecc200/ecc200_disturbed_012')
* Read the symbol in the image
find_data_code_2d (Image, SymbolXLDs, DataCodeHandle, [], [],
                   ResultHandles, DecodedDataStrings)

* Get the handles of all candidates that were detected as a symbol but
* could not be read
get_data_code_2d_results (DataCodeHandle, 'all_undecoded', 'handle',
                          HandlesUndecoded)

* For every undecoded symbol, get the contour and the classified
* module regions
for I := 0 to |HandlesUndecoded| - 1 by 1
  * Display image.
  dev_display (Image)
  dev_set_draw ('margin')
  * Get the contour of the symbol.
  dev_set_color ('blue')
  get_data_code_2d_objects (SymbolXLD, DataCodeHandle,
                            HandlesUndecoded[I], 'candidate_xld')
  dev_display (SymbolXLD)
  * Get the module regions of the foreground modules
  dev_set_color ('green')
  get_data_code_2d_objects (ModuleFG, DataCodeHandle,
                            HandlesUndecoded[I], 'module_1_rois')
  dev_display (ModuleFG)
  * Get the module regions of the background modules
  dev_set_color ('red')
  get_data_code_2d_objects (ModuleBG, DataCodeHandle,
                            HandlesUndecoded[I], 'module_0_rois')
  dev_display (ModuleBG)
  * Stop for inspecting the image.
  stop ()
endfor

* Clear the model
clear_data_code_2d_model (DataCodeHandle)

```

--------------------------------

### C Example: RGB to HSV and back

Source: https://www.mvtec.com/doc/halcon/2505/en/trans_to_rgb.html

This C snippet demonstrates converting an image from RGB to HSV using trans_from_rgb and then back to RGB using trans_to_rgb. It reads an image, decomposes it into channels, performs the transformations, and displays the result.

```C
/* Transformation from rgb to hsv and conversely */
read_image(Image, "patras");
disp_color(Image,WindowHandle);
decompose3(Image,&Rimage,&Gimage,&Bimage);
trans_from_rgb(Rimage,Gimage,Bimage,&Image1,&Image2,&Image3,"hsv");
trans_to_rgb(Image1,Image2,Image3,&ImageRed,&ImageGreen,&ImageBlue,"hsv");
compose3(ImageRed,ImageGreen,ImageBlue,&Multichannel);
disp_color(Multichannel,WindowHandle);

```

--------------------------------

### Generate Ellipse Contour (HDevelop)

Source: https://www.mvtec.com/doc/halcon/2505/en/gen_ellipse_contour_xld.html

Generates an XLD contour for an ellipse. This example shows how to use the function with specific parameters and includes a transformation for calculating the start angle.

```HDevelop
draw_ellipse(WindowHandle,Row,Column,Phi,Radius1,Radius2)
gen_ellipse_contour_xld(Ellipse,Row,Column,Phi,Radius1,Radius2,0,6.28319, \
                        'positive',1.5)
length_xld(Ellipse,Length)
* Transform StartPhi so that the start point of the ellipse actually
* intersects the line through origin at the angle StartPhi measured from
* the positive main axis
affine_trans_point_2d ([1.0,0.0,0.0,0.0,1.0*Radius2/Radius1,0.0], \
                       sin(StartPhi), cos(StartPhi), Qx, Qy)
StartPhiEllipse := atan2(Qx,Qy)
```

--------------------------------

### Initialize and Estimate Background Image

Source: https://www.mvtec.com/doc/halcon/2505/en/give_bg_esti.html

This HDevelop example demonstrates the complete workflow: initializing a background estimation dataset, running the estimation with a new image, and then retrieving the estimated background image.

```HDevelop
read_image(InitImage,'xing/init')
create_bg_esti(InitImage,0.7,0.7,'fixed',0.002,0.02, \
               'on',7.0,10,3.25,15.0,BgEstiHandle)
read_image(Image0,'xing/xing000')
run_bg_esti(Image0,ForegroundRegion1,BgEstiHandle)
give_bg_esti(BgImage,BgEstiHandle)
dev_display(BgImage)
```

--------------------------------

### create_camera_setup_model

Source: https://www.mvtec.com/doc/halcon/2505/en/toc_calibration_multiview.html

Creates a model for a setup of calibrated cameras.

```APIDOC
## create_camera_setup_model

### Description
Create a model for a setup of calibrated cameras.

### Method
APIDOC

### Endpoint
create_camera_setup_model

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

--------------------------------

### Get Message Parameters in HDevelop

Source: https://www.mvtec.com/doc/halcon/2505/en/get_message_param.html

This example demonstrates how to retrieve message parameters using get_message_param. It first fetches all available message keys and then retrieves the data type for those keys.

```HDevelop
get_message_param (Message, 'message_keys', [], AllKeys)
get_message_param (Message, 'key_data_type', AllKeys, KeysType)
```

--------------------------------

### Get Current Font in C

Source: https://www.mvtec.com/doc/halcon/2505/en/get_font.html

Retrieves the current font from the specified window handle in C. This example demonstrates setting and then retrieving the font, along with writing text to the window.

```C
T_get_font(WindowHandle,&CurrentFont);
T_set_font(WindowHandle,MyFont);
sprintf(buf,"The name of my Font is: %s ",get_s(Myfont,0));
create_tuple_s(&String,buf);
T_write_string(WindowHandle,String);
T_new_line(WindowHandle);
T_set_font(WindowHandle,CurrentFont);
```

--------------------------------

### Kalman Filter Initialization and Usage (HDevelop)

Source: https://www.mvtec.com/doc/halcon/2505/en/filter_kalman.html

Demonstrates the typical procedure for initializing Kalman filter variables, generating measurements, performing the first Kalman filtering, and using the estimated value. This example also shows the process for subsequent filtering steps with new measurements.

```HDevelop
* Typical procedure:
* To initialize the variables, which describe the model, e.g., with
read_kalman('kalman.init',Dim,Mod,Meas,Pred)

* Generation of the first measurements (typical of the first image of an
* image series) with an appropriate problem-specific procedure (there is a
* fictitious procedure extract_features in example):
* extract_features(Image1,Meas,Meas1)

* first Kalman-Filtering:
filter_kalman(Dim,Mod,Meas1,Pred,Pred1,Est1)

* To use the estimate value (if need be the prediction too)
* with a problem-specific procedure (here use_est):
* use_est(Est1)

* To get the next measurements (e.g., from the next image):
* extract_next_features(Image2,Meas1,Meas2)

* if need be Update of the model parameter (a constant model)
* second Kalman-Filtering:
filter_kalman(Dim,Mod,Meas2,Pred1,Pred2,Est2)
* use_est(Est2)
* extract_next_features(Image3,Meas2,Meas3)
* etc.

```

--------------------------------

### GetSpy

Source: https://www.mvtec.com/doc/halcon/2505/en/HOperatorSet.html

Gets the current configuration of the debugging tool. Useful for inspecting and debugging system behavior.

```APIDOC
## GetSpy

### Description
Current configuration of the debugging-tool.

### Method
(Not specified in source, assuming a generic method call)

### Endpoint
(Not applicable for SDK methods)

### Parameters
(Parameters not specified in source)

### Request Example
(Not applicable for SDK methods)

### Response
(Response details not specified in source)
```

--------------------------------

### Get Active Window Handle in HDevelop

Source: https://www.mvtec.com/doc/halcon/2505/en/dev_get_window.html

This HDevelop example demonstrates how to open two windows, get the handle of the currently active window, set a different window as active, display an image and region, and then restore the original active window. Use this when you need to programmatically switch between and manage multiple graphics windows.

```HDevelop
read_image (Image,'mreut')
threshold (Image, Region, 100, 200)
dev_open_window (1, 1, 200, 200, 'black', WindowID1)
dev_open_window (1, 220, 200, 200, 'black', WindowID2)
dev_get_window (CurrentWindowID)
dev_set_window (WindowID1)
dev_set_color ('blue')
dev_display (Image)
dev_display (Region)
dev_set_window(CurrentWindowID)
```

--------------------------------

### Query and Set Colors in C

Source: https://www.mvtec.com/doc/halcon/2505/en/query_colored.html

This C code example shows how to query the possible number of colors using T_query_colored and then set a specific color for display using T_set_colored. Ensure the WindowHandle is valid before calling display functions.

```C
Htuple Colors;
regiongrowing(Image,&Seg,5,5,6,100);
T_query_colored(&Colors);
create_tuple_i(&color,get_i(Colors,1));
T_set_colored(WindowHandle,color);
destroy_tuple(color);
T_disp_region(Seg,WindowHandle);

```

--------------------------------

### Fit Line to Contour using Regression (HDevelop)

Source: https://www.mvtec.com/doc/halcon/2505/en/fit_line_contour_xld.html

Fits a line to XLD contours using the 'regression' algorithm. This example demonstrates the typical setup for contour processing and line fitting.

```HDevelop
read_image (Image, 'mreut')
edges_sub_pix (Image, Edges, 'lanser2', 0.5, 20, 40)
gen_polygons_xld (Edges, Polygons, 'ramer', 2)
split_contours_xld (Polygons, Contours, 'polygon', 1, 5)
fit_line_contour_xld (Contours, 'regression', -1, 0, 5, 2, RowBegin, \
                      ColBegin, RowEnd, ColEnd, Nr, Nc, Dist)
```
Tokens:
Raw