Documentation
The API section contains the generated documentation of individual structures and functions from source code docstrings.
- Analysis module
AnalysisAxesCurveDrawableLabelMeasureMissingResultsExceptionMultidimensionalPlotPointResultSeparableAnalysisSequenceAggregatorSequenceSeparableAnalysisSortingTrackerSeparableAnalysisis_special()AnalysisErrorAnalysisFutureAnalysisJoinTaskAnalysisPartTaskAnalysisProcessorAnalysisTaskDebugExecutorExecutorWrapperFuturesAggregatorhashkey()process_stack_analyses()unwrap()- Accuracy analysis
- Failure analysis
- Long-term measures
- Multi-start measures
- Supervision analysis
- Dataset module
BasedSequenceChannelDatasetDatasetExceptionFrameFrameListInMemoryChannelInMemorySequencePatternFileListChannelSequenceSequenceDataSequenceIteratordownload_bundle()download_dataset()load_dataset()load_sequence()read_legacy_sequence()convert_int()download_dataset_meta()index_sequences()read_sequence()read_sequence_legacy()write_sequence()- Extended dataset support
- Report module
DefaultStyleLegendLinePlotObjectVideoPlotPlotStyleReportReportConfigurationScatterPlotSeparableReportStyleManagerTableTrackerSorterVideoconfigure_axes()configure_figure()generate_document()generate_serialized()SequenceOverlapPlotsStackAnalysesPlotsStackAnalysesTableextract_measures_table()extract_plots()format_value()merge_repeats()per_tracker()read_resource()- HTML report generation
- LaTeX report generation
- Experiment module
- Region module
- Stack module
- Tracker module
- Utilities module
ColoredFormatterProgressRegistryThreadPoolExecutorTimeralias()arg_hash()class_fullname()class_string()extract_files()file_hash()flatten()flip()format_size()import_class()localize_path()normalize_path()read_properties()singleton()to_logical()to_number()to_string()which()write_properties()- CLI
- Data
- Drawing
- Input/Output
- Network
- Notebook
Configuration
Some basic functions and classes used by the toolkit.
- class vot.GlobalConfiguration
Global configuration object for the toolkit. It is used to store global configuration options. It can be initialized from environment variables. The following options are supported:
VOT_DEBUG_MODE: Enables debug mode for the toolkit.VOT_SEQUENCE_CACHE_SIZE: Maximum number of sequences to keep in cache.VOT_RESULTS_BINARY: Enables binary results format.VOT_MASK_OPTIMIZE_READ: Enables mask optimization when reading masks.VOT_WORKER_POOL_SIZE: Number of workers to use for parallel processing.VOT_PERSISTENT_CACHE: Enables persistent cache for analysis results in workspace.
- exception vot.ToolkitException
Base class for all toolkit related exceptions
- vot.check_debug() bool
Checks if debug is enabled for the toolkit via an environment variable.
- Returns
True if debug is enabled, False otherwise
- Return type
bool
- vot.check_updates() bool
Checks for toolkit updates on Github, requires internet access, fails silently on errors.
- Returns
True if an update is available, False otherwise.
- Return type
bool
- vot.print_config()
Prints the global configuration object to the logger.
- vot.toolkit_version() str
Returns toolkit version as a string
- Returns
Version of the toolkit
- Return type
str