Skip to content

← markers package

AddEventMarker

Find trials matching a particular set of event markers, and add a new marker with a time stamp that matches one of those events.

Such new markers can then be used for purposes such as segmentation to events where the surrounding trial satisfies certain desired conditions etc. The node uses regular expressions, a very powerful language for string matching to identify which markers comprise a trial of interest. See the below link for more details. To add markers matching different criteria (e.g., 'left', and 'right'), use multiple copies of this node in succession. More Info... Version 1.2.3

Ports/Properties

data

Data to process.

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

stream

Name of stream containing markers to use for trial selection. Wildcards are supported, i.e. mystream* will select the first stream whose name starts with mystream. If unspecified, the first stream will be used.

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

trial_criteria

List of marker patterns that constitute a matching trial. When a trial is found, the event markers in the trial will be matched against this list in order. If all conditions are true, a new event marker will be added to the trial. These conditions are assumed to be regular expressions.

  • verbose name: Required Trial Markers
  • default value: []
  • port type: ListPort
  • value type: list (can be None)

trial_start

The event marker that indicates the start of a trial. Can be a regular expression.

  • verbose name: Trial Start
  • default value:
  • port type: StringPort
  • value type: str (can be None)

trial_end

The event marker that indicates the end of a trial, used to move to the next trial. Can be a regular expression.

  • verbose name: Trial End
  • default value:
  • port type: StringPort
  • value type: str (can be None)

event_to_match

The event within a matching trial that the new event marker should be time-locked to. This should be one of the items in the 'Trial Criteria' parameter. When a matching trial is found a new event marker will be written with the same time stamp as this event marker.

  • verbose name: Event To Match
  • default value:
  • port type: StringPort
  • value type: str (can be None)

match_first_event_only

If there are multiple event markers matching the event_to_match parameter, a new event marker will only be created for the first one.

  • verbose name: Match First Event Only
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

new_event_marker

The name of the new event marker to be added to matching trials.

  • verbose name: New Event Marker
  • default value:
  • port type: StringPort
  • value type: str (can be None)

full_criteria

A dictionary containing a set of criteria for adding markers, where the keys are the names of properties of this node (i.e ., trial_criteria, trial_start, etc.) and the values are the values for those properties (the same values you would pass if you were setting those properties directly. This provides a convenient way to programmatically pass in a collection of settings at once, to this single property, rather than having to set each property. If set, this will take precedence over all the other properties.

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

verbose

Verbose debugging output.

  • verbose name: Verbose
  • default value: False
  • port type: BoolPort
  • value type: bool (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)