trackermanaged Lua Interface¶
get¶
Get a pointer to the TrackerManaged object
- Arguments:
- any ptr Pointer to Module object
- Returns:
- trackermanaged ptr Pointer to casted TrackerManaged object
Example
ptr = trackermanaged:.get(ptr)
getConfig¶
Get the configuration object for the plugin
Arguments:
- Returns:
- table obj Map with configurations
Example
obj = trackermanaged:.getConfig()
saveConfig¶
Save the configuration object for the plugin
- Arguments:
- any ptr Pointer to TrackerManaged object
- table new_config Map with configurations
Example
trackermanaged:.saveConfig(ptr,new_config)
getName¶
Get the plugin name
Arguments:
- Returns:
- string name Plugin Name
Example
name = trackermanaged:.getName()
getTrackIds¶
Get the ids present on the current track list
Arguments:
- Returns:
- table ids Vector
with Tracker list ids
Example
ids = trackermanaged:.getTrackIds()
getTrackIds¶
Get the ids present on the current track list
Arguments:
- Returns:
- table ids Vector
with Tracker list ids
Example
ids = trackermanaged:.getTrackIds()
hasTrack¶
Returns if a specific track ID exists
Arguments:
- Returns:
- boolean True or false depending on the track existence
Example
True = trackermanaged:.hasTrack()
getTrackCount¶
Get the tracker list size
Arguments:
- Returns:
- number size Tracks list size
Example
size = trackermanaged:.getTrackCount()
getNewTrackIds¶
Get newly created tracks
Arguments:
- Returns:
- table ids Vector
with new tracker ids
Example
ids = trackermanaged:.getNewTrackIds()
getUnmatchedTracks¶
Get tracks that were not matched with a bbox
Arguments:
- Returns:
- table ids Vector
with the unmatched tracks
Example
ids = trackermanaged:.getUnmatchedTracks()
getMatchedTracks¶
Get tracks that were matched against the bboxes
Arguments:
- Returns:
- table ids map
Example
ids = trackermanaged:.getMatchedTracks()
getTrackById¶
Get the track object with at a specific id
- Arguments:
- any ptr Pointer to TrackerManaged object
- number id Target track ID
- Returns:
- table track Track object
Example
track = trackermanaged:.getTrackById(ptr,id)
getTrackValue¶
Get a value inside a track with at a specific id
- Arguments:
- any ptr Pointer to TrackerManaged object
- number id Target track ID
- string name Track key to get
- Returns:
- any value Track value
Example
value = trackermanaged:.getTrackValue(ptr,id,name)
getTracks¶
Return all tracks
- Arguments:
- any ptr Pointer to TrackerManaged object
- Returns:
- table track Track objects
Example
track = trackermanaged:.getTracks(ptr)
deleteTracks¶
Deletes all tracks
Arguments:
Example
trackermanaged:.deleteTracks()
saveTrack¶
Save a track object with at a specific id
- Arguments:
- any ptr Pointer to TrackerManaged object
- number id Target track ID
- table track Track object
- Returns:
- boolean ok Track saved
Example
ok = trackermanaged:.saveTrack(ptr,id,track)
saveTrackValue¶
Save a value inside a track with at a specific id
- Arguments:
- any ptr Pointer to TrackerManaged object
- number id Target track ID
- string name Track key to set
- any val Track value
- Returns:
- boolean ok Track saved
Example
ok = trackermanaged:.saveTrackValue(ptr,id,name,val)
trackObjects¶
Run the tracker on the regions provided by the getSourceBoxes function
Arguments:
Example
trackermanaged:.trackObjects()
trackAndUpdateObjects¶
Run the tracker on the regions provided by the getSourceBoxes function and update matched/unmatched tracks
- Arguments:
- trackermanaged ptr Pointer to trackermanaged object
- Rect[] objs List of detections
- number timestep Time step
Example
trackermanaged:.trackAndUpdateObjects(ptr,objs,timestep)
deleteTrackById¶
Delete a track with a specific ID
- Arguments:
- any ptr Pointer to TrackerManaged object
- number id Target track ID
Example
trackermanaged:.deleteTrackById(ptr,id)
updateTrackAverageEntry¶
Update a custom entry on a tracker with an average value
- Arguments:
- any ptr Pointer to TrackerManaged object
- number id Target track ID
- string entry Track internal dictionary entry to store value
- number val New value to add to average buffer
- number max_buffer_size Maximum buffer size to calc average
- Returns:
- number Current average
Example
Current = trackermanaged:.updateTrackAverageEntry(ptr,id,entry,val,max_buffer_size)
updateTracks¶
Update tracks with timestep
Arguments:
Example
trackermanaged:.updateTracks()
get¶
Get a pointer to the TrackerManaged object
- Arguments:
- any ptr Pointer to Module object
- Returns:
- trackermanaged ptr Pointer to casted TrackerManaged object
Example
ptr = trackermanaged:.get(ptr)
getConfig¶
Get the configuration object for the plugin
Arguments:
- Returns:
- table obj Map with configurations
Example
obj = trackermanaged:.getConfig()
saveConfig¶
Save the configuration object for the plugin
- Arguments:
- any ptr Pointer to TrackerManaged object
- table new_config Map with configurations
Example
trackermanaged:.saveConfig(ptr,new_config)
getName¶
Get the plugin name
Arguments:
- Returns:
- string name Plugin Name
Example
name = trackermanaged:.getName()
reset¶
Reset the plugin
Arguments:
- Returns:
- boolean ok Reset success
Example
ok = trackermanaged:.reset()
clearDeadTracks¶
Remove all tracks that are marked as dead
Arguments:
- Returns:
- string name Plugin Name
Example
name = trackermanaged:.clearDeadTracks()
markTrackAsDead¶
Mark a track as dead
Arguments:
- Returns:
- string name Plugin Name
Example
name = trackermanaged:.markTrackAsDead()
getTrackIds¶
Get the ids present on the current track list
Arguments:
- Returns:
- table ids Vector
with Tracker list ids
Example
ids = trackermanaged:.getTrackIds()
getTrackIds¶
Get the ids present on the current track list
Arguments:
- Returns:
- table ids Vector
with Tracker list ids
Example
ids = trackermanaged:.getTrackIds()
hasTrack¶
Returns if a specific track ID exists
Arguments:
- Returns:
- boolean True or false depending on the track existence
Example
True = trackermanaged:.hasTrack()
getTrackCount¶
Get the tracker list size
Arguments:
- Returns:
- number size Tracks list size
Example
size = trackermanaged:.getTrackCount()
getNewTrackIds¶
Get newly created tracks
Arguments:
- Returns:
- table ids Vector
with new tracker ids
Example
ids = trackermanaged:.getNewTrackIds()
getUnmatchedTracks¶
Get tracks that were not matched with a bbox
Arguments:
- Returns:
- table ids Vector
with the unmatched tracks
Example
ids = trackermanaged:.getUnmatchedTracks()
getMatchedTracks¶
Get tracks that were matched against the bboxes
Arguments:
- Returns:
- table ids map
Example
ids = trackermanaged:.getMatchedTracks()
getTrackById¶
Get the track object with at a specific id
- Arguments:
- any ptr Pointer to TrackerManaged object
- number id Target track ID
- Returns:
- table track Track object
Example
track = trackermanaged:.getTrackById(ptr,id)
getTrackValue¶
Get a value inside a track with at a specific id
- Arguments:
- any ptr Pointer to TrackerManaged object
- number id Target track ID
- string name Track key to get
- Returns:
- any value Track value
Example
value = trackermanaged:.getTrackValue(ptr,id,name)
getTracks¶
Return all tracks
- Arguments:
- any ptr Pointer to TrackerManaged object
- Returns:
- table track Track objects
Example
track = trackermanaged:.getTracks(ptr)
deleteTracks¶
Deletes all tracks
Arguments:
Example
trackermanaged:.deleteTracks()
saveTrack¶
Save a track object with at a specific id
- Arguments:
- any ptr Pointer to TrackerManaged object
- number id Target track ID
- table track Track object
- Returns:
- boolean ok Track saved
Example
ok = trackermanaged:.saveTrack(ptr,id,track)
saveTrackValue¶
Save a value inside a track with at a specific id
- Arguments:
- any ptr Pointer to TrackerManaged object
- number id Target track ID
- string name Track key to set
- any val Track value
- Returns:
- boolean ok Track saved
Example
ok = trackermanaged:.saveTrackValue(ptr,id,name,val)
trackObjects¶
Run the tracker on the regions provided by the getSourceBoxes function
Arguments:
Example
trackermanaged:.trackObjects()
trackAndUpdateObjects¶
Run the tracker on the regions provided by the getSourceBoxes function and update matched/unmatched tracks
- Arguments:
- trackermanaged ptr Pointer to trackermanaged object
- Rect[] objs List of detections
- number timestep Time step
Example
trackermanaged:.trackAndUpdateObjects(ptr,objs,timestep)
deleteTrackById¶
Delete a track with a specific ID
- Arguments:
- any ptr Pointer to TrackerManaged object
- number id Target track ID
Example
trackermanaged:.deleteTrackById(ptr,id)
updateTrackAverageEntry¶
Update a custom entry on a tracker with an average value
- Arguments:
- any ptr Pointer to TrackerManaged object
- number id Target track ID
- string entry Track internal dictionary entry to store value
- number val New value to add to average buffer
- number max_buffer_size Maximum buffer size to calc average
- Returns:
- number Current average
Example
Current = trackermanaged:.updateTrackAverageEntry(ptr,id,entry,val,max_buffer_size)
updateTracks¶
Update tracks with timestep
Arguments:
Example
trackermanaged:.updateTracks()