Skip to content

← utilities package

AppendSyntheticChannels

Append channels defined by a time-dependent formula to a time series.

This node can be used to append certain types of artificial channels to the data, for example test data, or nuisance regressors (e.g., for subsequent use in a convolutional regression model). The node can instead also create a new stream with such channels that inherits the time axis from a source stream stream. Version 1.0.0

Ports/Properties

data

Data to process

  • verbose name: Data
  • default value: None
  • port type: DataPort
  • value type: Packet (can be None)
  • data direction: INOUT

family

function family. Constant is a simple constant value, multiplied by the given parameter, otherwise a constant 1. Linear is a linear trend that starts at the first parameter value and ends at second parameter value. If not given, it goes from -sqrt(3) to +sqrt(3) so as to have unit variance and zero mean. dct-2 (Type-II DCT) form an orthonormal basis of cosine functions up to a given limit frequency (the given parameter), or between a low and a high cutoff frequency (if two parameters given). Legendre polynomials are orthonormal polynomials up to (and including) a given degree (e.g., 3), which can model non-linear trends in the data.

  • verbose name: Family
  • default value: constant
  • port type: EnumPort
  • value type: str (can be None)

params

Parameters for the function family. If a family requires only one parameter, this is a one-element list. See family.

  • verbose name: Params
  • default value: None
  • port type: ListPort
  • value type: list (can be None)

reference_stream

Name (or name prefix) of the stream from which to take the time axis. The first matching stream that also has a time axis will be used. Note that if no new stream is created and channels are appended to this stream, then the stream also needs to have a space axis.

  • verbose name: Reference Stream
  • default value: None
  • port type: StringPort
  • value type: str (can be None)

channel_axis

Axis to use to enumerate the newly-generated channels. If not specified, this defaults to feature if the ref data has a feature axis, and otherwise space.

  • verbose name: Channel Axis
  • default value: auto
  • port type: EnumPort
  • value type: str (can be None)

new_stream

Name of the new stream to create, or empty if channels shall be appended to the reference stream. In either case, the newly generated data will be on the same compute backend as the reference stream's data.

  • verbose name: Optional New Stream
  • default value: synthetic
  • port type: StringPort
  • value type: str (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

  • verbose name: Set Breakpoint (Debug Only)
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

  • verbose name: Metadata
  • default value: {}
  • port type: DictPort
  • value type: dict (can be None)