Class SpeedMatrixContainer

Constructors

constructor

new SpeedMatrixContainer(json): SpeedMatrixContainer
Parameters
- json: {
  matrices: SpeedMatrix[];
  }
  - matrices: SpeedMatrix[]
Returns SpeedMatrixContainer
- Defined in quality/SpeedMatrixContainer.ts:35

Methods

`Static` CreateFromJson

CreateFromJson(json): SpeedMatrixContainer
Parameters
- json: any
Returns SpeedMatrixContainer
- Defined in quality/SpeedMatrixContainer.ts:44

`Static` BuildCompares

BuildCompares(qualities, removeDuplicates?): ICompares
Parameters
- qualities: RainComputationQuality[]
- removeDuplicates: boolean = true
Returns ICompares
- Defined in quality/SpeedMatrixContainer.ts:61

`Static` BuildCompareTimeline

BuildCompareTimeline(currentQuality, dateMin, dateMax): ICompare[]
Parameters
- currentQuality: RainComputationQuality
- dateMin: Date
- dateMax: Date
Returns ICompare[]
- Defined in quality/SpeedMatrixContainer.ts:143

getMatrix

getMatrix(index?): SpeedMatrix
Parameters
- index: number = 0
Returns SpeedMatrix
- Defined in quality/SpeedMatrixContainer.ts:294

getMatrixByName

getMatrixByName(name): SpeedMatrix
Parameters
- name: string
Returns SpeedMatrix
- Defined in quality/SpeedMatrixContainer.ts:301

getMatrices

getMatrices(): SpeedMatrix[]
Returns SpeedMatrix[]
- Defined in quality/SpeedMatrixContainer.ts:309

getQualityPoints

getQualityPoints(matrixName?): QualityPoint[]
Parameters
- Optional matrixName: string
Returns QualityPoint[]
- Defined in quality/SpeedMatrixContainer.ts:313

getQualityPointsByHistoricalPosition

getQualityPointsByHistoricalPosition(position?): QualityPoint[]
Parameters
- position: number = 0
Returns QualityPoint[]
- Defined in quality/SpeedMatrixContainer.ts:345

getMaxGauge

getMaxGauge(matrixName?): number
Parameters
- Optional matrixName: string
Returns number
- Defined in quality/SpeedMatrixContainer.ts:362

getMaxRain

getMaxRain(matrixName?): number
Parameters
- Optional matrixName: string
Returns number
- Defined in quality/SpeedMatrixContainer.ts:371

getQuality

getQuality(matrixName?): number
Get summed quality indicator (0 ideally)
Parameters
- Optional matrixName: string
Returns number
Link
SpeedMatrix.ComputeQualityIndicator
- Defined in quality/SpeedMatrixContainer.ts:384

getTrustedIndicators

getTrustedIndicators(): number[]
Returns number[]
- Defined in quality/SpeedMatrixContainer.ts:389

getSpeed

getSpeed(): {
angleInDegrees: number;
pixelsPerPeriod: number;
}
Returns {
angleInDegrees: number;
pixelsPerPeriod: number;
}
- angleInDegrees: number
- pixelsPerPeriod: number
- Defined in quality/SpeedMatrixContainer.ts:402

isConsistent

isConsistent(): boolean
Returns boolean
- Defined in quality/SpeedMatrixContainer.ts:423

getFlattenMatrixCount

getFlattenMatrixCount(): number
Returns number
- Defined in quality/SpeedMatrixContainer.ts:433

renderFlattenMatrix

renderFlattenMatrix(index?, options?): PositionValue[]
Parameters
- index: number = 0
- options: {
  normalize?: boolean;
  } = ...
  - Optional normalize?: boolean
Returns PositionValue[]
- Defined in quality/SpeedMatrixContainer.ts:437

renderMergedMatrix

renderMergedMatrix(options?): PositionValue[]
Parameters
- options: {
  normalize?: boolean;
  } = ...
  - Optional normalize?: boolean
Returns PositionValue[]
- Defined in quality/SpeedMatrixContainer.ts:455

toJSON

toJSON(options?): {
    qualityPoints: QualityPoint[];
    trustedIndicators: number[];
    flattenMatrices: PositionValue[][];
    speed: {
        angleInDegrees: number;
        pixelsPerPeriod: number;
    };
    matrices: {
        name: string;
        remarks: string;
        flattenPositionHistory: number[][];
        flattenPositionRange: {
            xMin: number;
            xMax: number;
            yMin: number;
            yMax: number;
        };
        speed: {
            angleInDegrees: number;
            pixelsPerPeriod: number;
        };
        qualityPoints: QualityPoint[];
        trustedTechnicalIndicator: number;
        roundScale: Position;
    }[];
}
Parameters
- Optional options: {
      removeFlatten?: boolean;
      removeMatrices?: boolean;
      removeIndicators?: boolean;
  }
  - Optional removeFlatten?: boolean
  - Optional removeMatrices?: boolean
  - Optional removeIndicators?: boolean
Returns {
    qualityPoints: QualityPoint[];
    trustedIndicators: number[];
    flattenMatrices: PositionValue[][];
    speed: {
        angleInDegrees: number;
        pixelsPerPeriod: number;
    };
    matrices: {
        name: string;
        remarks: string;
        flattenPositionHistory: number[][];
        flattenPositionRange: {
            xMin: number;
            xMax: number;
            yMin: number;
            yMax: number;
        };
        speed: {
            angleInDegrees: number;
            pixelsPerPeriod: number;
        };
        qualityPoints: QualityPoint[];
        trustedTechnicalIndicator: number;
        roundScale: Position;
    }[];
}
- qualityPoints: QualityPoint[]
- trustedIndicators: number[]
- flattenMatrices: PositionValue[][]
- speed: {
  angleInDegrees: number;
  pixelsPerPeriod: number;
  }
  - angleInDegrees: number
  - pixelsPerPeriod: number
- matrices: {
      name: string;
      remarks: string;
      flattenPositionHistory: number[][];
      flattenPositionRange: {
          xMin: number;
          xMax: number;
          yMin: number;
          yMax: number;
      };
      speed: {
          angleInDegrees: number;
          pixelsPerPeriod: number;
      };
      qualityPoints: QualityPoint[];
      trustedTechnicalIndicator: number;
      roundScale: Position;
  }[]
- Defined in quality/SpeedMatrixContainer.ts:481

merge

merge(speedMatrixContainerToMergeIn): SpeedMatrixContainer
Parameters
- speedMatrixContainerToMergeIn: SpeedMatrixContainer
Returns SpeedMatrixContainer
- Defined in quality/SpeedMatrixContainer.ts:511

logMergedMatrix

logMergedMatrix(options?): void
Parameters
- options: {
  normalize: boolean;
  logger: any;
  } = ...
  - normalize: boolean
  - logger: any
Returns void
- Defined in quality/SpeedMatrixContainer.ts:523

Class SpeedMatrixContainer

Index

Constructors

Methods

Constructors

constructor

Parameters

matrices: SpeedMatrix[]

Returns SpeedMatrixContainer

Methods

Static CreateFromJson

Parameters

Returns SpeedMatrixContainer

Static BuildCompares

Parameters

Returns ICompares

Static BuildCompareTimeline

Parameters

Returns ICompare[]

getMatrix

Parameters

Returns SpeedMatrix

getMatrixByName

Parameters

Returns SpeedMatrix

getMatrices

Returns SpeedMatrix[]

getQualityPoints

Parameters

Returns QualityPoint[]

getQualityPointsByHistoricalPosition

Parameters

Returns QualityPoint[]

getMaxGauge

Parameters

Returns number

getMaxRain

Parameters

Returns number

getQuality

Parameters

Returns number

Link

getTrustedIndicators

Returns number[]

getSpeed

Returns { angleInDegrees: number; pixelsPerPeriod: number; }

angleInDegrees: number

pixelsPerPeriod: number

isConsistent

Returns boolean

getFlattenMatrixCount

Returns number

renderFlattenMatrix

Parameters

Optional normalize?: boolean

Returns PositionValue[]

renderMergedMatrix

Parameters

Optional normalize?: boolean

Returns PositionValue[]

toJSON

Parameters

Optional removeFlatten?: boolean

Optional removeMatrices?: boolean

Optional removeIndicators?: boolean

qualityPoints: QualityPoint[]

trustedIndicators: number[]

flattenMatrices: PositionValue[][]

speed: { angleInDegrees: number; pixelsPerPeriod: number; }

angleInDegrees: number

pixelsPerPeriod: number

merge

Parameters

Returns SpeedMatrixContainer

logMergedMatrix

Parameters

normalize: boolean

logger: any

Returns void

`Static` CreateFromJson

`Static` BuildCompares

`Static` BuildCompareTimeline

Returns {
angleInDegrees: number;
pixelsPerPeriod: number;
}

`Optional` normalize?: boolean

`Optional` normalize?: boolean

`Optional` removeFlatten?: boolean

`Optional` removeMatrices?: boolean

`Optional` removeIndicators?: boolean

speed: {
angleInDegrees: number;
pixelsPerPeriod: number;
}