Skip to content

← markers package

SelectMarkerSpans

Select, or discard, segments of data relative to event markers.

You can either specify a single marker or set of markers around which time segments will be extracted (marker-locked mode), or you can specify pairs of markers that define the start and end of each segment (marker-spanned mode). Multiple markers can be specified for either mode, allowing you to select (or discard) segments from different types of markers in a single pass. For example, you could use this node to drop all segments in the data that represent a break in the session (i.e., 'break_start' and 'break_end' markers), or to extract all segments that correspond to a particular block of a task (i.e., 'block1_start' and 'block1_end'). This node is for continuous "offline" data only (not streaming data and not already segmented data). Version 0.9.1

Ports/Properties

data

Data to process.

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

operation

Operation to perform on the selected segments. Keep retains the selected segments and drops all other data, while discard drops the segments and keeps the rest.

  • verbose name: Operation
  • default value: keep
  • port type: EnumPort
  • value type: str (can be None)

mode

Type of interval. Intervals can be relative to reference events of a certain type (marker-locked), or in time window spanned by two subsequent events of certain types A and B, optionally with ignored events in between (marker-spanned).

  • verbose name: Mode
  • default value: marker-locked
  • port type: EnumPort
  • value type: str (can be None)

anchor_markers

Marker/event type relative to which spans shall be generated. Applies to marker-locked and marker-spanned mode. If mode is marker-spanned, this is the first marker in a pair of successive markers (referred to as A in other places of the node documentation), while the second marker is given by the second anchor marker. If multiple are given, each marker generates a separate span, and in marker-spanned mode, there must be the same count of anchor_markers_B entries.

  • verbose name: Anchor Marker(S)
  • default value: ['myeventA']
  • port type: ListPort
  • value type: list (can be None)

anchor_marker_B

Second anchor marker (B) if span mode is marker-spanned. This marker indicates the end of a spanned range. If spans relative to multiple pairs of marker types shall be generated, this must have the same number of entries as anchor_markers.

  • verbose name: Second Anchor Marker(S) (Spanned Mode)
  • default value: ['myeventB']
  • port type: ListPort
  • value type: list (can be None)

time_limits

A list of two numbers representing lower and upper time bounds, in seconds. In marker-locked mode these times are relative to each specified marker (i.e., if the time bounds are [-1,1] a 2 second segment will be selected (to be dropped or retained, depending on the operation), for each marker starting 1 second before and ending 1 second after the marker. In marker-spanned mode, for every matching pair of markers specified in anchor_markers (A) and anchor_marker_B (B), the segment will begin x seconds relative to A (where x is the lower time bound) and end y seconds relative to B (where y is the upper time bound).

  • verbose name: Time Limits
  • default value: [0, 1]
  • port type: ListPort
  • value type: list (can be None)

intermittent_markers

If in spanned mode, this determines how to handle intermittent markers that occur between successive markers A and B by default. If set to allow, any marker type may occur between marker A and the next marker B, and a spanned range will still be generated. If set to forbid, no other marker may occur in between, or else the spanned range will not be selected. Exceptions to this can be listed in the next parameter.

  • verbose name: Handling Of Intermittent Markers (Spanned Mode)
  • default value: allow
  • port type: EnumPort
  • value type: str (can be None)

except_markers

List of markers types for which to make an exception from the default chosen in intermittent markers. For instance, if the default is allow, then the marker types in this list will be forbidden, and if the default is forbid, then the marker types in this list will be allowed.

  • verbose name: Exceptions To Intermittent Markers (Spanned Mode)
  • default value: []
  • port type: ListPort
  • value type: list (can be None)

min_length

Minimum segment length, in seconds. Ranges shorter than this will be dropped (mostly relevant for marker-spanned mode).

  • verbose name: Min Range Length
  • default value: 0
  • port type: FloatPort
  • value type: float (can be None)

max_length

Maximum segment length, in seconds. Ranges longer than this will be dropped (mostly relevant for marker-spanned mode).

  • verbose name: Max Range Length
  • default value: 10000
  • port type: FloatPort
  • value type: float (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)