Header menu logo bristlecone

Masking Module

Masks to only return the requested values, for example when comparing with observational data.

Functions and values

Function or value Description

makeMaskOutput stepType dateMode startDate dataTimeToIndexTime

Full Usage: makeMaskOutput stepType dateMode startDate dataTimeToIndexTime

Parameters:
Returns: RunnerOutput<MeasureOne> -> CodedMap<TypedTensor<Vector, MeasureProduct<state, MeasureOne>>>

Apply masking/normalisation to runner output, producing aligned vectors.

stepType : StepType<'date>
dateMode : DateMode<'date, 'yearType, 'timespan>
startDate : 'date
dataTimeToIndexTime : ResolutionToModelUnits<'date, 'timespan, MeasureProduct<time index, MeasureOne>>
Returns: RunnerOutput<MeasureOne> -> CodedMap<TypedTensor<Vector, MeasureProduct<state, MeasureOne>>>

Type something to start searching.