aslprep.interfaces.plotting module

Plotting interfaces.

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

Bases: SimpleInterface

Copy the x-form matrices from hdr_file to out_file.

Clearly that’s wrong.

Mandatory Inputs:

in_func (a pathlike object or string representing an existing file) – Input ASL time-series (4D file).

Optional Inputs:

  • confounds_file (a pathlike object or string representing an existing file) – BIDS’ _confounds.tsv file.

  • confounds_list (a list of at least 1 items which are a string or a tuple of the form: (a string, a string or None) or a tuple of the form: (a string, a string or None, a string or None)) – List of headers to extract from the confounds_file.

  • in_mask (a pathlike object or string representing an existing file) – 3D brain mask.

  • in_segm (a pathlike object or string representing an existing file) – Resampled segmentation.

  • str_or_tuple (a string or a tuple of the form: (a string, a string or None) or a tuple of the form: (a string, a string or None, a string or None))

  • tr (a float or None) – The repetition time. (Nipype default value: None)

Outputs:

out_file (a pathlike object or string representing an existing file) – Written file path.

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

Bases: SimpleInterface

Prepare an CBF summary plot for the report.

Mandatory Inputs:

  • cbf (a pathlike object or string representing an existing file)

  • label (a string) – Label.

  • ref_vol (a pathlike object or string representing an existing file)

  • vmax (an integer) – Max value of asl.

Outputs:

out_file (a pathlike object or string representing an existing file) – Written file path.

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

Bases: SimpleInterface

Prepare an CBF summary plot for the report.

Mandatory Inputs:

  • cbf_ts (a pathlike object or string representing an existing file) – cbf time series.

  • seg_file (a pathlike object or string representing an existing file) – Seg_file.

  • tr (a float) – TR.

Optional Inputs:

  • conf_file (a pathlike object or string representing an existing file) – Confound file .

  • score_file (a pathlike object or string representing an existing file) – Scorexindex file .

Outputs:

out_file (a pathlike object or string representing an existing file) – Written file path.