Skip to content

← markers package

CalculateMarkerTimeDifference

Calculate difference between all markers and provided timestamps.

timestamps packet can be the output of ExtractMarkerTimestamps node (deprecated). Time difference will be stored as a new field/column in the instance axis data. Version 0.3.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

timestamps

Packet containing timestamps, usually from the output of ExtractMarkerTimestamps. If not provided then timestamps will be drawn from the data packet target_event.

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

look_for

Direction to search for timestamp relative to each marker. Using 'next' will find reaction time from marker to timestamp.

  • verbose name: Look For
  • default value: next
  • port type: EnumPort
  • value type: str (can be None)

target_event

Only calculate time differences to this or these events. Pass as string or list of strings. If not provided then all events are considered potential targets.

  • verbose name: Target Event
  • default value: None
  • port type: DataPort
  • value type: object (can be None)
  • data direction: INOUT

target_field

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

source_event

Only find time differences from this event in the data packet. If not provided them timestamps will be calculated from all events.

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

source_field

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

new_field_name

Name of field/column added to data instance table.

  • verbose name: New Field Name
  • default value: ReactionTime
  • port type: StringPort
  • value type: str (can be None)

transform

Time differences, or reaction times, are typically skewed and may have outliers. Transforming reaction time can help mitigate these problems, which is helpful before doing statistical analyses. https://opensiuc.lib.siu.edu/cgi/viewcontent.cgi?referer=&httpsredir=1&article=1077&context=tpr

  • verbose name: Transform
  • default value: none
  • port type: EnumPort
  • value type: str (can be None)

grouping_fields

When the timestamps input is not provided, thus both the source and target are taken from the same instance table, you can further constrain the search so target and source events will only be matched if they have equal values in all indicated grouping fields. Typical values for this parameter are one or more fields that key a unique trial id.

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

time_bounds_criteria

Optional list of [minimum, maximum] (absolute value seconds) allowed between the source and target time difference in order to be logged as valid. For example, in the case of response (reaction) times from stimulus, if a trial had a missing response (e.g. no target response marker found) this node will by default calculate the time difference from stimulus to the next trial's response marker and therefore log a reaction time that is not valid for the current trial. Setting this time bound criteria can ignore these cases and not mis-identify invalid reaction times. Example: [0, 2.5] only allows valid time differences >0 and <2.5 seconds (non-inclusive) to be logged.

  • verbose name: Time Bounds Criteria
  • default value: []
  • port type: ListPort
  • value type: list (can be None)

add_to_existing

Add time differences to the existing field (defined in new_field_name) if it already exists in the data. (That allows this node to be run multiple times over the same data.)

  • verbose name: Add To Existing
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

pattern_syntax

Optionally the syntax to use for the input marker patterns. If set to none, the input strings are not used as patterns but used to match a specific marker string verbatim. If set to wildcards, then the special character * can be used to match any number of characters (or none), while the character ? can be used to match any single character.

  • verbose name: Pattern Syntax
  • default value: none
  • port type: EnumPort
  • value type: str (can be None)

absolute_time

Always record time differences in absolute values.

  • verbose name: Absolute Time
  • 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)