gettsatevent

New timeseries object with samples occurring at event

Syntax

ts1 = gettsatevent(ts,event)
ts1 = gettsatevent(ts,event,n)

Description

ts1 = gettsatevent(ts,event) returns a new timeseries object ts1 with samples occurring at an event in ts, where event can be either a tsdata.event object or a string. When event is a tsdata.event object, the time defined by event is used. When event is a string, the first tsdata.event object in the Events property of ts that matches the event name specifies the time.

ts1 = gettsatevent(ts,event,n) returns a new time series ts1 with samples occurring at an event in time series ts, where n is the number of the event occurrence with a matching event name.

More About

expand all

Tips

When the timeseries object ts contains date strings and event uses numeric time, the time selected by the event is treated as a date that is calculated relative to the StartDate property in the ts.TimeInfo.

When ts uses numeric time and event uses calendar dates, the time selected by the event is treated as a numeric value that is not associated with a calendar date.

Was this topic helpful?