xcp_d.interfaces.restingstate.SurfaceReHo
- class xcp_d.interfaces.restingstate.SurfaceReHo(from_file=None, resource_monitor=None, **inputs)[source]
Calculate regional homogeneity (ReHo) on a surface file.
Examples
>>> from tempfile import TemporaryDirectory >>> tmpdir = TemporaryDirectory() >>> os.chdir(tmpdir.name) .. doctest:: >>> surfacereho_wf = SurfaceReHo() >>> surfacereho_wf.inputs.surf_bold = 'rhhemi.func.gii' >>> surfacereho_wf.inputs.surf_hemi = 'R' >>> surfacereho_wf.run() .. testcleanup:: >>> tmpdir.cleanup()
- Mandatory Inputs:
surf_bold (a pathlike object or string representing an existing file) – Left or right hemisphere gii .
surf_hemi (a string) – L or R .
- Outputs:
surf_gii (a pathlike object or string representing an existing file) – lh hemisphere reho.
- __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.
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