KPF

Algorithm Implementations

detected_object_set_input_kpf

class detected_object_set_input_kpf : public kwiver::vital::algo::detected_object_set_input

Public Functions

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

Parameters:

config – The config block to check configuration of.

Returns:

true if the configuration check passed and false if it didn’t.

virtual bool read_set(kwiver::vital::detected_object_set_sptr &set, std::string &image_name)

Read next detected object set

This method reads the next set of detected objects from the file. False is returned when the end of file is reached.

Parameters:
  • set[out] Pointer to the new set of detections. Set may be empty if there are no detections on an image.

  • image_name[out] Name of the image that goes with the detections. This string may be empty depending on the source format.

Returns:

true if detections are returned, false if end of file.

class priv

detected_object_set_output_kpf

class detected_object_set_output_kpf : public kwiver::vital::algo::detected_object_set_output

Public Functions

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

Parameters:

config – The config block to check configuration of.

Returns:

true if the configuration check passed and false if it didn’t.

virtual void write_set(const kwiver::vital::detected_object_set_sptr set, std::string const &image_name)

Write detected object set.

This method writes the specified detected object set and image name to the currently open file.

Parameters:
  • set – Detected object set

  • image_path – File path to image associated with the detections.

class priv