xcp_d.interfaces.connectivity.ConnectPlot

class xcp_d.interfaces.connectivity.ConnectPlot(from_file=None, resource_monitor=None, **inputs)[source]

Extract timeseries and compute connectivity matrices.

Mandatory Inputs:
  • atlas_names (a list of items which are a string) – List of atlases. Aligned with the list of time series in time_series_tsv.

  • atlas_tsvs (a list of items which are a string) – The dseg.tsv associated with each atlas.

  • correlations_tsv (a list of items which are a pathlike object or string representing an existing file) – List of TSV file with correlation matrices. Aligned with the list of atlases in atlas_names.

Outputs:

connectplot (a pathlike object or string representing an existing file) – Path to SVG file with four correlation heat maps.

__init__(from_file=None, resource_monitor=None, **inputs)[source]

Subclasses must implement __init__

Methods

__init__([from_file, resource_monitor])

Subclasses must implement __init__

aggregate_outputs([runtime, needed_outputs])

Collate expected outputs and apply output traits validation.

help([returnhelp])

Prints class help

load_inputs_from_json(json_file[, overwrite])

A convenient way to load pre-set inputs from a JSON file.

plot_matrix(corr_mat, network_labels, ax)

Plot matrix in subplot Axes.

run([cwd, ignore_exception])

Execute this interface.

save_inputs_to_json(json_file)

A convenient way to save current inputs to a JSON file.

Attributes

always_run

Should the interface be always run even if the inputs were not changed? Only applies to interfaces being run within a workflow context.

can_resume

Defines if the interface can reuse partial results after interruption.

resource_monitor

version

interfaces should implement a version property