public class TimeSeriesFunction extends AbstractFunction
A Function based on interpolation of a TimeSeries.
A TimeSeriesFunction can be used to apply the results of a simulation as input to other simulations.
TODO: unit tests TODO: this could be made more efficient for n-D series by wrapping them in 1D, so interpolation is only done as neededDIMENSION_PROPERTY
Constructor and Description |
---|
TimeSeriesFunction(TimeSeries series,
int dimension) |
Modifier and Type | Method and Description |
---|---|
int |
getSeriesDimension() |
TimeSeries |
getTimeSeries() |
static TimeSeries1D |
makeSeries(Function function,
float start,
float increment,
float end,
Units units) |
float |
map(float[] from) |
void |
setSeriesDimension(int dim) |
void |
setTimeSeries(TimeSeries series) |
clone, getCode, getDimension, getName, multiMap, setCode, setName
public TimeSeriesFunction(TimeSeries series, int dimension)
series
- TimeSeries from which to obtain Function of timedimension
- Dimension of series on which to base Function outputpublic TimeSeries getTimeSeries()
public void setTimeSeries(TimeSeries series)
series
- TimeSeries from which to obtain Function of timepublic int getSeriesDimension()
public void setSeriesDimension(int dim)
dim
- Dimension of series on which to base Function outputpublic float map(float[] from)
map
in interface Function
map
in class AbstractFunction
from
- Must have same length as getDimension()AbstractFunction.map(float[])
public static TimeSeries1D makeSeries(Function function, float start, float increment, float end, Units units)
function
- A 1-dimensional Functionstart
- Start timeincrement
- Time stepend
- End timeunits
- Units of Function output