MLBackgroundTasks Overview

Introduction

The MLBackgroundTasks library offers asynchronous background tasks to ML modules. A BackgroundTask is executed using the BackgroundTasksManager and runs in another thread.

Important core classes are:

• BackgroundTask - The base class of all tasks
• BackgroundTaskManager - The manager singleton that manages queing and running of tasks
• BackgroundTaskMessage - The base class for all messages that are passed between tasks/taskmanager
• BackgroundTaskHandle - A handle to a BackgroundTasks that avoid direct access to the task
• TypedBackgroundTaskHandle - A handle to a specific BackgroundTasks that allows calling methods on its thread from the GUI thread.

Convenience classes for ML modules are:

• BackgroundTaskBaseModule - Base class for a module with a single background task running at a time.
• ModuleBackgroundTask - Base class for a task that accesses ML images from a Module.
• AsyncProcessAllPagesBaseModule - Base class for running an asynchronous ProcessAllPagesHandler.

For detailed examples, have a look at the MeVisLab/Standard/Sources/Examples/ML/MLBackgroundTasksExamples. This includes:

• AsyncProcessAllPagesExample - An example on how to run a ProcessAllPages handler from a background task.
• AsyncTypedProcessAllPagesExample - An example on how to run a typed ProcessAllPages handler from a background task.
• AsynTileProcessingExample - An example on how to process an input image tile-by-tile.
• AdvancedBackgroundTaskExample - An example that shows most features of the BackgroundTask.