sequences

Features and tools for resolving sequences of images.

Classes

Sequence

Resolves a feature as a sequence.

Functions

Sequential

Converts a feature to be resolved as a sequence.

Module classes

Sequence

class deeptrack.sequences.Sequence(feature: deeptrack.features.Feature, sequence_length: int = 1, **kwargs)

Resolves a feature as a sequence.

The input feature is resolved sequence_length times, with the kwarg arguments sequene_length and sequence_step passed to all properties of the feature set.

Parameters
  • feature (Feature) – The feature to resolve as a sequence.

  • sequence_length (int) – The number of times to resolve the feature.

feature

The feature to resolve as a sequence.

Type

Feature

get(input_list, sequence_length=None, **kwargs)

Method for altering an image Abstract method that define how the feature transforms the input. The current value of all properties will be passed as keyword arguments.

Parameters
  • image (Image or List[Image]) – The Image or list of images to transform

  • **kwargs – The current value of all properties in properties as well as any global arguments.

Returns

The transformed image or list of images

Return type

Image or List[Image]

update(**kwargs)

Updates the state of all properties.

Parameters

**kwargs – Arguments that will be passed to the Property method update().

Returns

Return type

self

Module functions

Sequential

deeptrack.sequences.Sequential(feature: deeptrack.features.Feature, **kwargs)

Converts a feature to be resolved as a sequence.

Should be called on individual features, not combinations of features. All keyword arguments will be trated as sequential properties and will be passed to the parent feature.

If a property from the keyword argument already exists on the feature, the existing property will be used to initilize the passed property (that is, it will be used for the first timestep).

Parameters
  • feature (Feature) – Feature to make sequential.

  • kwargs – Keyword arguments to pass on as sequential properties of feature.