Operator Reference

close_bg_estiT_close_bg_estiCloseBgEstiCloseBgEsticlose_bg_esti (Operator)

close_bg_estiT_close_bg_estiCloseBgEstiCloseBgEsticlose_bg_esti — Delete the background estimation data set.

Signature

close_bg_esti( : : BgEstiHandle : )

Herror T_close_bg_esti(const Htuple BgEstiHandle)

void CloseBgEsti(const HTuple& BgEstiHandle)

void HBgEsti::CloseBgEsti() const

static void HOperatorSet.CloseBgEsti(HTuple bgEstiHandle)

void HBgEsti.CloseBgEsti()

def close_bg_esti(bg_esti_handle: HHandle) -> None

Description

close_bg_esticlose_bg_estiCloseBgEstiCloseBgEsticlose_bg_esti deletes the background estimation data set and releases all used memory.

Execution Information

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

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

BgEstiHandleBgEstiHandleBgEstiHandlebgEstiHandlebg_esti_handle (input_control, state is modified)  bg_estimation HBgEsti, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

ID of the BgEsti data set.

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/xing001')
* 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/xing002')
* Estimate the background:
run_bg_esti(Image1,ForegroundRegion2,BgEstiHandle)
* Display the foreground region:
dev_display (ForegroundRegion2)
* etc.
* - End of background estimation -
* Close the dataset:
close_bg_esti(BgEstiHandle)

Result

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

Possible Predecessors

run_bg_estirun_bg_estiRunBgEstiRunBgEstirun_bg_esti

See also

create_bg_esticreate_bg_estiCreateBgEstiCreateBgEsticreate_bg_esti

Module

Foundation