Simd Library Documentation.

Home | Release Notes | Download | Documentation | Issues | GitHub
Options Struct Reference

Options used by Simd::Motion::Detector. More...

#include <SimdMotion.hpp>

Public Member Functions

 Options ()
 

Data Fields

int CalibrationScaleLevelMax
 Maximum downscale of the input (pyramid levels). Default 3 means up to 8 times. Applied on calibration (first NextFrame or input size change).
 
int DifferenceGrayFeatureWeight
 Weight of the gray feature in difference estimation. Default 18. 0 disables the gray feature.
 
int DifferenceDxFeatureWeight
 Weight of the X-gradient feature in difference estimation. Default 18. 0 disables it (shooting-star example).
 
int DifferenceDyFeatureWeight
 Weight of the Y-gradient feature in difference estimation. Default 18. 0 disables it (shooting-star example).
 
bool DifferencePropagateForward
 Boost difference by taking the max with the reduced previous pyramid level. Default true.
 
bool DifferenceRoiMaskEnable
 Restrict difference by the ROI mask. Default true.
 
double BackgroundGrowTime
 Duration (seconds) of fast background grow after init. Default 1 second.
 
double BackgroundStatUpdateTime
 Interval (seconds) of background statistics updates in normal mode. Default 0.04. Shooting-star example uses 0.2.
 
double BackgroundUpdateTime
 Interval (seconds) between background range adjustments in normal mode. Default 1 second.
 
int BackgroundSabotageCountMax
 Consecutive sabotage frames allowed before background reinitialization. Default 3.
 
double SegmentationCreateThreshold
 Threshold in [0, 1] to seed a motion region. Default 0.5.
 
double SegmentationExpandCoefficient
 Expansion of a motion region relative to the create threshold, in [0, 1]. Default 0.75.
 
double StabilityRegionAreaMax
 Maximum fraction of the frame that may be in motion; above this Detector emits SabotageOn. Range [0, 1]. Default 0.5.
 
int TrackingTrajectoryMax
 Maximum length of Object::trajectory. Default 1024.
 
double TrackingRemoveTime
 Seconds without an update after which an object is removed (ObjectOut if it was classified). Default 1 second.
 
double TrackingAdditionalLinking
 Extra border (fraction of region size) when linking a region to a track. Default 0. Shooting-star example uses 5.
 
int TrackingAveragingHalfRange
 Half-window (in trajectory points) used to smooth Object::rect and Object::trajectory. Default 12.
 
double ClassificationShiftMin
 Minimum displacement (in screen diagonals) to classify a track as a moving object. Default 0.075. Shooting-star example uses 0.01.
 
double ClassificationTimeMin
 Minimum lifetime (seconds) to classify a track as a moving object. Default 1 second. Shooting-star example uses 0.01.
 
int DebugDrawLevel
 Pyramid level of the debug inset. Default 1. Used with DebugDrawBottomRight when output is Bgr24.
 
int DebugDrawBottomRight
 Debug inset in the bottom-right corner: 0 empty; 1 difference; 2 gray; 3 dx; 4 dy. Default 0. Requires Bgr24 output.
 
bool DebugAnnotateModel
 Draw ROI polygon and minimum object size on Bgr24 output. Default false.
 
bool DebugAnnotateMovingRegions
 Draw raw motion regions on Bgr24 output. Default false.
 
bool DebugAnnotateTrackingObjects
 Draw all tracks (including not yet classified) on Bgr24 output. Default false.
 

Detailed Description

Options used by Simd::Motion::Detector.

Typical usage constructs Options (defaults), changes a few fields and calls Detector::SetOptions before NextFrame. The shooting-star example sets TrackingAdditionalLinking = 5, ClassificationShiftMin = 0.01, ClassificationTimeMin = 0.01, DifferenceDxFeatureWeight = 0, DifferenceDyFeatureWeight = 0 and BackgroundStatUpdateTime = 0.2.

Weight 0 disables the corresponding difference feature. Debug* fields apply only when NextFrame is given a Bgr24 output Frame of the same size as input.

Constructor & Destructor Documentation

◆ Options()

Options ( )

Default constructor of Options.

Fills every field with the defaults listed above. Typical usage changes a few fields and calls Detector::SetOptions.