SetDocTimestampFrequency

Returns the frequency (in Hertz) used in the specified file to store the timestamps.

Syntax

SetDocTimestampFrequency(doc, freq)

Parameters

Parameter

Type

Description

doc

document reference

Reference to the document.

freq

number

Timestamp frequency in Hz.

Note

Internally, the timestamps are stored as 64-bit integers representing the number of time ticks from the start of the experiment. The time tick is equal to 1./Timestamp_Frequency.

Return

None.

Examples

Python

import nex
doc = nex.NewDocument(20000)
nex.SetDocTimestampFrequency(doc, 33000.33)

NexScript

doc = GetActiveDocument()
SetDocTimestampFrequency(doc, 33000.33)