xcp_d.interfaces.workbench.ChangeXfmType
- class xcp_d.interfaces.workbench.ChangeXfmType(from_file=None, resource_monitor=None, **inputs)[source]
Change transform type.
- Mandatory Inputs:
in_transform (a pathlike object or string representing an existing file) – Maps to a command-line argument:
%s(position: 0).- Optional Inputs:
args (a string) – Additional parameters to the command. Maps to a command-line argument:
%s.environ (a dictionary with keys which are a bytes or None or a value of class ‘str’ and with values which are a bytes or None or a value of class ‘str’) – Environment variables. (Nipype default value:
{})
- Outputs:
out_transform (a pathlike object or string representing an existing file)
- __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_runShould the interface be always run even if the inputs were not changed? Only applies to interfaces being run within a workflow context.
can_resumeDefines if the interface can reuse partial results after interruption.
resource_monitorversioninterfaces should implement a version property