getsampleusingtime

Subset of timeseries data

Syntax

tsout = getsampleusingtime(tsin,timeval)

tsout = getsampleusingtime(tsin,timeval,'AllowDuplicateTimes',true)

tsout = getsampleusingtime(tsin,starttime,endtime)

Description

tsout = getsampleusingtime(tsin,timeval) returns a timeseries object that contains the single data sample of an input timeseries corresponding to the time timeval.

tsout = getsampleusingtime(tsin,timeval,'AllowDuplicateTimes',true) includes multiple data samples with the same time value specified in timeval.

example

tsout = getsampleusingtime(tsin,starttime,endtime) includes samples of tsin between the times starttime and endtime.

Examples

collapse all

Extract Subset of `timeseries`

Open Live Script

Create a timeseries object and extract the data samples corresponding to the 2nd through 4th time values.

tsin = timeseries((1:5)',1:5);
tsout = getsampleusingtime(tsin,2,4);
tsout.Data

Input Arguments

collapse all

`tsin` — Input `timeseries`
scalar

Input timeseries, specified as a scalar.

`timeval` — Sample time
scalar | vector

Sample time, specified as a numeric scalar, date character vector, or datenum scalar. Valid date character vectors can have the following forms:

Format	Example
`dd-mmm-yyyy HH:MM:SS`	`01-Mar-2000 15:45:17`
`dd-mmm-yyyy`	`01-Mar-2000`
`mm/dd/yy`	`03/01/00`
`mm/dd`	`03/01`
`HH:MM:SS`	`15:45:17`
`HH:MM:SS PM`	`3:45:17 PM`
`HH:MM`	`15:45`
`HH:MM PM`	`3:45 PM`
`mmm.dd,yyyy HH:MM:SS`	`Mar.01,2000 15:45:17`
`mmm.dd,yyyy`	`Mar.01,2000`
`mm/dd/yyyy`	`03/01/2000`

`starttime` — Start time
scalar | vector

Start time, specified as a numeric scalar, date character vector, or datenum scalar.

`endtime` — End time
scalar | vector

End time, specified as a numeric scalar, date character vector, or datenum scalar.

Tips

If the time vector in tsin is not relative to a calendar date, then starttime and endtime must be numeric.
If the time vector in tsin is relative to a calendar date, then starttime and endtime values must be date character vectors or datenum values.

getsampleusingtime

Syntax

Description