Skip to content

← neural package

PhaseAmplitudeCoupling

Calculates the degree of dependence of the amplitude signal on the phase of the phase signal.

For example, high-frequency or spiking rate activity can be entrained to the trough of a low frequency (e.g., alpha) oscillation. The phases stream and the amplitudes stream must have identical instance and time axes. If they share at least some common items in the space axis, then PAC will be calculated within-channel only for channels that are shared between both inputs. 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

phases_stream_name

Name of the stream that provides the phases.

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

amplitudes_stream_name

Name of the stream that provides the (non-zero) amplitudes.

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

pac_metric

Type of metric to use to calculate phase amplitue coupling value. MI is the Modulation Index, MVL is the Mean Vector Length, and HR is the Height Ratio.

  • verbose name: Metric
  • default value: MI
  • port type: EnumPort
  • value type: str (can be None)

n_bins

Number of bins to divide phases (-pi to +pi).

  • verbose name: N Bins
  • default value: 10
  • port type: IntPort
  • value type: int (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)