Operator Reference

HALCON Operator Reference / Tools / Background Estimator

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

get_bg_esti_paramsT_get_bg_esti_paramsGetBgEstiParamsGetBgEstiParamsget_bg_esti_params (Operator)

get_bg_esti_paramsT_get_bg_esti_paramsGetBgEstiParamsGetBgEstiParamsget_bg_esti_params — Return the parameters of the data set.

Signature

get_bg_esti_params( : : BgEstiHandle : Syspar1, Syspar2, GainMode, Gain1, Gain2, AdaptMode, MinDiff, StatNum, ConfidenceC, TimeC)

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

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

double HBgEsti::GetBgEstiParams(double* Syspar2, HString* GainMode, double* Gain1, double* Gain2, HString* AdaptMode, double* MinDiff, Hlong* StatNum, double* ConfidenceC, double* TimeC) const

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

double HBgEsti.GetBgEstiParams(out double syspar2, out string gainMode, out double gain1, out double gain2, out string adaptMode, out double minDiff, out int statNum, out double confidenceC, out double timeC)

def get_bg_esti_params(bg_esti_handle: HHandle) -> Tuple[float, float, str, float, float, str, float, int, float, float]

Description

get_bg_esti_paramsget_bg_esti_paramsGetBgEstiParamsGetBgEstiParamsget_bg_esti_params returns the parameters of the data set. The returned parameters are the same as in create_bg_esticreate_bg_estiCreateBgEstiCreateBgEsticreate_bg_esti and set_bg_esti_paramsset_bg_esti_paramsSetBgEstiParamsSetBgEstiParamsset_bg_esti_params (see these for an explanation).

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 (output_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

1. system matrix parameter.

Syspar2Syspar2Syspar2syspar2syspar_2 (output_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

2. system matrix parameter.

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

Gain type.

Gain1Gain1Gain1gain1gain_1 (output_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Kalman gain / foreground adaptation time.

Gain2Gain2Gain2gain2gain_2 (output_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Kalman gain / background adaptation time.

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

Threshold adaptation.

MinDiffMinDiffMinDiffminDiffmin_diff (output_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Foreground / background threshold.

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

Number of statistic data sets.

ConfidenceCConfidenceCConfidenceCconfidenceCconfidence_c (output_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Confidence constant.

TimeCTimeCTimeCtimeCtime_c (output_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Constant for decay time.

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 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

Result

get_bg_esti_paramsget_bg_esti_paramsGetBgEstiParamsGetBgEstiParamsget_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

set_bg_esti_paramsset_bg_esti_paramsSetBgEstiParamsSetBgEstiParamsset_bg_esti_params

Module

Foundation

---

ClassesClasses | | Operators