Module DynAIkonTrap.filtering.filtering

A simple interface to the frame animal filtering pipeline is provided by this module. It encapsulates both motion- and image-based filtering as well as any smoothing of this in time. Viewed from the outside the Filter reads from a Camera's output and in turn outputs only frames containing animals.

Internally frames are first analysed by the MotionFilter and then, if sufficient motion is detected, placed on the MotionQueue. Within the queue the AnimalFilter stage is applied with only the animal frames being returned as the output of this pipeline.

The output is accessible via a queue, which mitigates problems due to the burstiness of this stage's output and also allows the pipeline to be run in a separate process.

Classes

class Filter (read_from: Camera, settings: FilterSettings)

Wrapper for the complete image filtering pipeline

Args

read_from : Camera

Read frames from this camera

settings : FilterSettings

Settings for the filter pipeline

Methods

def close(self)

def get(self) ‑> Frame

Retrieve the next animal Frame from the filter pipeline's output

Returns

Frame

An animal frame