Operator Reference

HALCON Operator Reference / Tools / Background Estimator
ClassesClasses | | Operators

set_bg_esti_paramsT_set_bg_esti_paramsSetBgEstiParamsSetBgEstiParamsset_bg_esti_params (Operator)

set_bg_esti_paramsT_set_bg_esti_paramsSetBgEstiParamsSetBgEstiParamsset_bg_esti_params — Change the parameters of the data set.

Signature

Herror T_set_bg_esti_params(const Htuple BgEstiHandle, const Htuple Syspar1, const Htuple Syspar2, const Htuple GainMode, const Htuple Gain1, const Htuple Gain2, const Htuple AdaptMode, const Htuple MinDiff, const Htuple StatNum, const Htuple ConfidenceC, const Htuple TimeC)

void SetBgEstiParams(const HTuple& BgEstiHandle, const HTuple& Syspar1, const HTuple& Syspar2, const HTuple& GainMode, const HTuple& Gain1, const HTuple& Gain2, const HTuple& AdaptMode, const HTuple& MinDiff, const HTuple& StatNum, const HTuple& ConfidenceC, const HTuple& TimeC)

void HBgEsti::SetBgEstiParams(double Syspar1, double Syspar2, const HString& GainMode, double Gain1, double Gain2, const HString& AdaptMode, double MinDiff, Hlong StatNum, double ConfidenceC, double TimeC) const

void HBgEsti::SetBgEstiParams(double Syspar1, double Syspar2, const char* GainMode, double Gain1, double Gain2, const char* AdaptMode, double MinDiff, Hlong StatNum, double ConfidenceC, double TimeC) const

void HBgEsti::SetBgEstiParams(double Syspar1, double Syspar2, const wchar_t* GainMode, double Gain1, double Gain2, const wchar_t* AdaptMode, double MinDiff, Hlong StatNum, double ConfidenceC, double TimeC) const   ( Windows only)

static void HOperatorSet.SetBgEstiParams(HTuple bgEstiHandle, HTuple syspar1, HTuple syspar2, HTuple gainMode, HTuple gain1, HTuple gain2, HTuple adaptMode, HTuple minDiff, HTuple statNum, HTuple confidenceC, HTuple timeC)

void HBgEsti.SetBgEstiParams(double syspar1, double syspar2, string gainMode, double gain1, double gain2, string adaptMode, double minDiff, int statNum, double confidenceC, double timeC)

def set_bg_esti_params(bg_esti_handle: HHandle, syspar_1: float, syspar_2: float, gain_mode: str, gain_1: float, gain_2: float, adapt_mode: str, min_diff: float, stat_num: int, confidence_c: float, time_c: float) -> None

Description

set_bg_esti_paramsset_bg_esti_paramsSetBgEstiParamsSetBgEstiParamsset_bg_esti_params is used to change the parameters of the data set. The parameters passed by set_bg_esti_paramsset_bg_esti_paramsSetBgEstiParamsSetBgEstiParamsset_bg_esti_params are the same as in create_bg_esticreate_bg_estiCreateBgEstiCreateBgEsticreate_bg_esti (see there for an explanation).

The image format cannot be changed! To do this, a new data set with an initialization image of the appropriate format has to be created.

To exchange the background image completely, use update_bg_estiupdate_bg_estiUpdateBgEstiUpdateBgEstiupdate_bg_esti. The current image then has to be passed for both the input image and the update region.

Attention

If GainModeGainModeGainModegainModegain_mode was set to 'frame'"frame""frame""frame""frame", the run-time can be extremely long for large values of Gain1Gain1Gain1gain1gain_1 or Gain2Gain2Gain2gain2gain_2, because the values for the gains' table are determined by a simple binary search.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

BgEstiHandleBgEstiHandleBgEstiHandlebgEstiHandlebg_esti_handle (input_control)  bg_estimation → HBgEsti, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

ID of the BgEsti data set.

Syspar1Syspar1Syspar1syspar1syspar_1 (input_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

1. system matrix parameter.

Default: 0.7

Suggested values: 0.65, 0.7, 0.75

Value range: 0.05 ≤ Syspar1 Syspar1 Syspar1 syspar1 syspar_1 ≤ 1.0

Recommended increment: 0.05

Syspar2Syspar2Syspar2syspar2syspar_2 (input_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

2. system matrix parameter.

Default: 0.7

Suggested values: 0.65, 0.7, 0.75

Value range: 0.05 ≤ Syspar2 Syspar2 Syspar2 syspar2 syspar_2 ≤ 1.0

Recommended increment: 0.05

GainModeGainModeGainModegainModegain_mode (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Gain type.

Default: 'fixed' "fixed" "fixed" "fixed" "fixed"

List of values: 'fixed'"fixed""fixed""fixed""fixed", 'frame'"frame""frame""frame""frame"

Gain1Gain1Gain1gain1gain_1 (input_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Kalman gain / foreground adaptation time.

Default: 0.002

Suggested values: 10.0, 20.0, 50.0, 0.1, 0.05, 0.01, 0.005, 0.001

Restriction: 0.0 <= Gain1

Gain2Gain2Gain2gain2gain_2 (input_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Kalman gain / background adaptation time.

Default: 0.02

Suggested values: 2.0, 4.0, 8.0, 0.5, 0.1, 0.05, 0.01

Restriction: 0.0 <= Gain2

AdaptModeAdaptModeAdaptModeadaptModeadapt_mode (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Threshold adaptation.

Default: 'on' "on" "on" "on" "on"

List of values: 'off'"off""off""off""off", 'on'"on""on""on""on"

MinDiffMinDiffMinDiffminDiffmin_diff (input_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Foreground/background threshold.

Default: 7.0

Suggested values: 3.0, 5.0, 7.0, 9.0, 11.0

Recommended increment: 0.2

StatNumStatNumStatNumstatNumstat_num (input_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of statistic data sets.

Default: 10

Suggested values: 5, 10, 20, 30

Value range: 1 ≤ StatNum StatNum StatNum statNum stat_num

Recommended increment: 5

ConfidenceCConfidenceCConfidenceCconfidenceCconfidence_c (input_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Confidence constant.

Default: 3.25

Suggested values: 4.30, 3.25, 2.82, 2.62

Recommended increment: 0.01

Restriction: 0.0 < ConfidenceC

TimeCTimeCTimeCtimeCtime_c (input_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Constant for decay time.

Default: 15.0

Suggested values: 10.0, 15.0, 20.0

Recommended increment: 5.0

Restriction: 0.0 < TimeC

Example (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 parameter in dataset:
set_bg_esti_params(BgEstiHandle,0.7,0.7,'fixed', \
                    0.004,0.08,'on',9.0,10,3.25,20.0)
* Read the next image in sequence:
read_image(Image2,'xing/xing002')
* Estimate the background:
run_bg_esti(Image2,ForegroundRegion3,BgEstiHandle)
* Display the foreground region:
dev_display(ForegroundRegion3)
* etc.

Result

set_bg_esti_paramsset_bg_esti_paramsSetBgEstiParamsSetBgEstiParamsset_bg_esti_params returns 2 ( H_MSG_TRUE) if all parameters are correct.

Possible Predecessors

create_bg_esticreate_bg_estiCreateBgEstiCreateBgEsticreate_bg_esti

Possible Successors

run_bg_estirun_bg_estiRunBgEstiRunBgEstirun_bg_esti

See also

update_bg_estiupdate_bg_estiUpdateBgEstiUpdateBgEstiupdate_bg_esti

Module

Foundation

ClassesClasses | | Operators