xcp_d.interfaces.nilearn.BinaryMath
- class xcp_d.interfaces.nilearn.BinaryMath(check_import=True, *args, **kwargs)[source]
Do math on an image.
- Mandatory Inputs:
expression (a string) – A mathematical expression to apply to the image. Must have ‘img’ in it.
in_file (a pathlike object or string representing an existing file) – An image to do math on.
- Optional Inputs:
out_file (a pathlike object or string representing a file) – The name of the mathified file to write out. out_img.nii.gz by default. (Nipype default value:
out_img.nii.gz
)- Outputs:
out_file (a pathlike object or string representing an existing file) – Mathified output file.
Methods
__init__
([check_import])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.
imports
resource_monitor
version
interfaces should implement a version property