Class Analysis

This class is used to instance an analysis

It's can run locally or on TagoIO.

Hierarchy

TagoIOModule<AnalysisConstructorParams>
- Analysis

Index

Constructors

Properties

Methods

Constructors

constructor

new Analysis(
analysis: analysisFunction,
params?: AnalysisConstructorParams,
): Analysis
Parameters
- analysis: analysisFunction
- params: AnalysisConstructorParams = ...
Returns Analysis
Overrides TagoIOModule<AnalysisConstructorParams>.constructor
- Defined in modules/Analysis/Analysis.ts:17

Properties

started

started: boolean = false

Methods

start

start(): void
Returns void
- Defined in modules/Analysis/Analysis.ts:26

`Static`use

use(analysis: analysisFunction, params?: AnalysisConstructorParams): Analysis
Parameters
- analysis: analysisFunction
- Optionalparams: AnalysisConstructorParams
Returns Analysis
- Defined in modules/Analysis/Analysis.ts:161