tsdata.event

Create tsdata.event object

Description

A tsdata.event object contains event information for a timeseries object within its properties. To add events in a tsdata.event to a timeseries, you can use the addevent function.

Creation

To create a tsdata.event object, use the tsdata.event function.

Syntax

tse = tsdata.event(eventname,eventtime)

tse = tsdata.event(eventname,eventtime,'Datenum')

Description

tse = tsdata.event(eventname,eventtime) creates a tsdata.event object named eventname occurring at the time eventtime.

tse = tsdata.event(eventname,eventtime,'Datenum') indicates that the eventtime value is a serial date number generated by the datenum function. eventtime is converted to a date character vector after the event is created.

Input Arguments

eventname — Event name

character vector

Event name, specified as a character vector.

eventtime — Event time

scalar

Event time, specified as a numeric scalar.

Properties

EventData — Event data

array

Event data, represented as an array containing user-defined information about the event.

Name — Event name

character vector

Event name, represented as a character vector.

Time — Event time

vector

Time values, represented as a numeric scalar.

Units — Time units

'weeks' | 'days' | 'hours' | 'minutes' | 'seconds' | 'milliseconds' | 'microseconds' | 'nanoseconds'

Time units, specified as 'weeks', 'days', 'hours', 'minutes', 'seconds', 'milliseconds', 'microseconds', or 'nanoseconds'.

StartDate — Start date

character vector

Start date, specified as a valid datestr character vector.

Object Functions

findEvent	Query tsdata.event by name
getTimeStr	Query tsdata.event times

Examples

Create Event

Create a tsdata.event object.

tse = tsdata.event('MyEvent',6)

    EventData: []
         Name: 'MyEvent'
         Time: 6
        Units: 'seconds'
    StartDate: ''

Create a timeseries object and add the event to the timeseries.

ts = timeseries((1:5)',1:5);
ts = addevent(ts,tse);
ts.Events

    EventData: []
         Name: 'MyEvent'
         Time: 6
        Units: 'seconds'
    StartDate: ''

Version History

Introduced before R2006a