Signal (FPScript)
Composes a signal, signal series or a space curve from individual components.
Syntax
Signal(YComponent, [ XComponent ] [ , ZComponent ])
The syntax of the Signal function consists of the following parts:
Part |
Description |
|---|---|
YComponent |
The Y component of the data structure to be generated. If you specify a signal, a signal series or a space curve, only the Y component of this data structure will be used. All data structures are allowed, except scalar value. Not supported data types arestring. |
XComponent |
The X component of the data structure to be generated. If you specify a signal, a signal series or a space curve, only the Y component of this data structure will be used. If you specify a scalar value, then this is interpreted as the increment for a data series beginning with zero. If you omit the argument, an X component starting with zero with an increment of one is added, unless YComponent already contains an X component. All data structures are allowed. All real data types are permitted. |
ZComponent |
The Z component of the data structure to be generated. If a signal is specified, its Y component is used. If you specify a scalar value, then this is interpreted as the increment for a data series beginning with zero. Permitted data structures are scalar value, data series, signal und list. All real data types are permitted. |
Remarks
The units of the individual components are included in the result. An exact description of the data structures that you can build with this function is located under Data Structures.
The numbers of values of the passed components automatically are lined up with each other, and thus surplus values are ignored.
The function can also process lists. To do this, at least the Y component must be passed as a list. The lists are processed on a per-element basis and the result is once again a list with aggregated elements. The element names are copied from the list with the Y components.
Available in
FlexPro View, Basic, Professional, Developer Suite
Examples
Signal({1, 3, 5, 7}, {0, 1, 2, 3}) |
Results in a signal with four points. |
Signal({1, 3, 5, 7}) |
Results in a signal with four points. Adds the X component {0, 1, 2, 3}. |
Signal({1, 3, 5, 7}, {0, 1, 2, 3, 4}) |
Also results in a signal with four points. The fifth X value is cut off because only four Y values are present. |
Signal(DataSeries, 0.1 s) |
Transforms a data series into a signal with a sampling rate of 10 Hz. |