Skip to content

← statistics package

CorrelationCoefficient

Compute the Pearson correlation coefficient (PCC) between elements along a given axis, and average over another axis.

Optionally return p-values for each correlation. More Info... Version 1.1.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

avg_axis

Axis over which to compute correlation. After correlation, this axis will be removed from the data unless 'keep correlation axis' is checked..

verbose name
Axis Over Which The Correlation Is Computed
default value
time
port type
ComboPort
value type
str (can be None)

cov_axis

Axis containing the independent variables between which correlation will be calculated. This axis will be duplicated in the data.

verbose name
Axis With Ivs To Correlate
default value
space
port type
ComboPort
value type
str (can be None)

keep_avg_axis

Keep the axis over which correlation is computed. If enabled, the axis will be retained as a 1-element axis. This axis will be of the same type as the original axis if it was a time or frequency axis, and a generic axis otherwise.

verbose name
Keep Correlation Axis
default value
False
port type
BoolPort
value type
bool (can be None)

return_pvalues

Return p-values for the correlation coefficients. If enabled, the output will contain a new statistic axis with 2 elements, the Pearson R values and corresponding p-values.

verbose name
Return Pvalues
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)