Writers

class stonesoup.writer.base.Writer[source]

Bases: Base

Writer base class

class stonesoup.writer.base.MetricsWriter(metric_generator: MetricGenerator)[source]

Bases: Writer

Metrics Writer base class.

Writes out metrics to some form of storage for analysis.

Parameters:

metric_generator (MetricGenerator) – Source of metric to be written out

metric_generator: MetricGenerator

Source of metric to be written out

class stonesoup.writer.base.TrackWriter(tracker: Tracker)[source]

Bases: Writer

Track Writer base class.

Writes out tracks to some form of storage for analysis.

Parameters:

tracker (Tracker) – Source of tracks to be written out

tracker: Tracker

Source of tracks to be written out

YAML

class stonesoup.writer.yaml.YAMLWriter(path: Path, groundtruth_source: GroundTruthReader = None, sensor_data_source: SensorDataReader = None, detections_source: DetectionReader = None, tracks_source: Tracker = None)[source]

Bases: Writer

YAML Writer

Parameters:
path: Path

File to save data to. Str will be converted to Path

Kafka

class stonesoup.writer.kafka.KafkaWriter(kafka_config: Dict[str, str])[source]

Bases: Writer

A simple Kafka writer that writes data to a Kafka topic.

Parameters:

kafka_config (Dict[str, str]) – Configuration properties for the underlying kafka consumer. See the confluent-kafka documentation for more details.

kafka_config: Dict[str, str]

Configuration properties for the underlying kafka consumer. See the confluent-kafka documentation for more details.