MATLAB Function Reference

max (timeseries) - Maximum value of timeseries data

Syntax

ts_max = max(ts)
ts_max = max(ts,'PropertyName1',PropertyValue1,...)

Description

ts_max = max(ts) returns the maximum value in the time-series data. When ts.Data is a vector, ts_max is the maximum value of ts.Data values. When ts.Data is a matrix, ts_max is a row vector containing the maximum value of each column of ts.Data (when IsTimeFirst is true and the first dimension of ts is aligned with time). For the N-dimensional ts.Data array, max always operates along the first nonsingleton dimension of ts.Data.

ts_max = max(ts,'PropertyName1',PropertyValue1,...) specifies the following optional input arguments:

• 'MissingData' property has two possible values, 'remove' (default) or 'interpolate', indicating how to treat missing data during the calculation.

• 'Quality' values are specified by a vector of integers, indicating which quality codes represent missing samples (for vector data) or missing observations (for data arrays with two or more dimensions).

• 'Weighting' property has two possible values, 'none' (default) or 'time'.
  When you specify 'time', larger time values correspond to larger weights.

Examples

The following example illustrates how to find the maximum values in multivariate time-series data.

1. Load a 24-by-3 data array.

   load count.dat
   

2. Create a timeseries object with 24 time values.

   count_ts = timeseries(count,[1:24],'Name','CountPerSecond')
   

3. Find the maximum in each data column for this timeseries object.

   max(count_ts)
   
   ans =
   
      114   145   257
   

The maximum is found independently for each data column in the timeseries object.

See Also

iqr (timeseries), min (timeseries), median (timeseries), mean (timeseries), std (timeseries), timeseries, var (timeseries)

max

MaximizeCommandWindow