rebase
(Series)
Rebase times series data to specified period
Syntax
[outputSeries, priorValue, reciprocal] = rebase(inputSeries, basePeriod, baseValue, ___)
Input arguments
inputSeries
[ Series ]
Input time series that will be rebased.
basePeriod
[ Dater | "allStart"
| "allEnd"
] -
Date relative to which the input data will be rebased;
'allStart'
means the first date for which all time series columns have a NaN observation;'allEnd'
means the last such date. ThebasePeriod
may be a vector of dates, in which case the mean or geometric mean of the corresponding values will be calculated.
baseValue
[ numeric ]
The new value that the
outputSeries
will see in thebasePeriod
.
Options
Mode="auto"
[ "auto"
| "additive"
| "multiplicative"
]
Rebasing mode; if
Mode="auto"
, the rebasing mode will be based on thebaseValue
:"additive"
forbaseValue=0
,"multiplicative"
otherwise;
Reciprocal=[]
[ empty | Series ]
A reciprocal series that will be rebased so that the sum or the product (depending on the
Mode=
) of theinputSeries
and theReciprocal
is preserved. TheReciprocal=
series must be the same size as theinputSeries
.
Output arguments
outputSeries
[ Series ]
Rebased output time series.
priorValue
[ numeric ]
The value of the
inputSeries
inbasePeriod
before rebasing.
reciprocal
[ empty | Series ]
Rebased reciprocal series.