Package: formatting

Data formatting nodes.

These nodes typically do not change the actual numeric values contained in the received data streams, but instead change the format of the data (for instance, the shape of the blocks, the properties of the chunks, possibly the number of streams in a packet). The most important use cases are to extract segments from continuous data, and to "play back" a long packet by chopping it into a series of successive streaming packets, as well as stream (chunk) manipulation of packets such as splitting, merging, renaming, and so forth. Noteworthy node classes: - nodes starting with Create are used to construct the respective NeuroPype native data structures (Axis, Block, Chunk, Packet).

Nodes in this package:

• Apply Axis Mask
  Apply an axis mask that was previously generated using Generate Axis Mask.

• Promote Axis to Stream
  Promote one or more axes in a packet to their own stream(s).

• Batch Instances
  Group and batch instances based on some some criterion along a new feature axis.

• Create Axis
  An axis indexes data along a dimension.

• Create Block
  A block is a multi-dimensional array with named/typed axes.

• Create Chunk
  A chunk is a pairing of a data block (an N-dimensional array with named/typed axes) and a dictionary of descriptive properties.

• Create Packet
  Create a packet from chunks and their desired names.

• Extract Streams
  Extract streams which match a certain criteria, either the stream name, or certain stream properties (i.e

• Fuse Streams
  Fuse all streams in streaming data into a single multi-channel stream.

• Get Axis Mask
  Identifies which slices meet criteria parameters and outputs the result as a mask packet.

• Merge Streams
  Merge the streams in the given packets into one packet that contains all streams.

• Rename Streams
  Rename streams in the given data.

• Segmentation
  Cut fixed-length segments out of a continuous time series.

• Select Instances
  Select trials (items along the "instance" axis, therefore "instances") based on metadata (i.e

• Separate Signal Streams
  Separate the signal streams from the non-signal streams.

• Separate Stream Properties
  Selectively split properties of streams off into a separate dictionary.

• Separate Streams
  Separate streams that match a criterion from other streams.

• Set Instance Details
  Set per-instance (e.g

• Split Streams
  Break up a packet into its constituent streams.

• Stream Data
  Play back a data set in real time or at a desired rate.

• Restore Axis from Stream
  Reconstitute axes that had previously been promoted to a stream; this is the reverse operation of Axis to Stream.