Burnout¶
Burnout Track Descriptors Algorithm¶
-
class
burnout_track_descriptors
: public kwiver::vital::algorithm_impl<burnout_track_descriptors, vital::algo::compute_track_descriptors>¶ -
Public Functions
-
vital::config_block_sptr
get_configuration
() const¶ Get this algorithm’s configuration block .
Get this alg’s configuration block .
This method returns the required configuration for the algorithm. The implementation of this method should be light-weight and only create and fill in the config block.
This base virtual function implementation returns an empty configuration.
- Return
config_block
containing the configuration for this algorithm and any nested components.
-
void
set_configuration
(vital::config_block_sptr config)¶ Set this algorithm’s properties via a config block.
This method is called to pass a configuration to the algorithm. The implementation of this method should be light-weight and only save the necessary config values. Defer any substantial processing in another method.
- Exceptions
no_such_configuration_value_exception
: Thrown if an expected configuration value is not present.algorithm_configuration_exception
: Thrown when the algorithm is given an invalidconfig_block
or is otherwise unable to configure itself.
- Parameters
config
: Theconfig_block
instance containing the configuration parameters for this algorithm
-
bool
check_configuration
(vital::config_block_sptr config) const¶ Check that the algorithm’s configuration config_block is valid.
This checks solely within the provided
config_block
and not against the current state of the instance. This isn’t static for inheritance reasons.- Return
- true if the configuration check passed and false if it didn’t.
- Parameters
config
: The config block to check configuration of.
-
vital::track_descriptor_set_sptr
compute
(kwiver::vital::timestamp ts, kwiver::vital::image_container_sptr image_data, kwiver::vital::object_track_set_sptr tracks)¶ Compute track descriptors given an image and tracks.
- Return
- a set of track descriptors
- Parameters
ts
: timestamp for the current frameimage_data
: contains the image data to processtracks
: the tracks to extract descriptors around
-
vital::track_descriptor_set_sptr
flush
()¶ Flush any remaining in-progress descriptors.
This is typically called at the end of a video, in case any temporal descriptors and currently in progress and still need to be output.
- Return
- a set of track descriptors
-
vital::config_block_sptr