xcp_d.interfaces.ants.ConvertTransformFile

class xcp_d.interfaces.ants.ConvertTransformFile(command=None, terminal_output=None, write_cmdline=False, **inputs)

Wrapped executable: ConvertTransformFile.

Wrapper for the ANTS ConvertTransformFile command.

Utility to read in a transform file (presumed to be in binary format) and output it in various formats. Default output is legacy human-readable text format. Without any options, the output filename extension must be .txt or .tfm to signify a text-formatted transform file.

Mandatory Inputs:

in_transform (a string or os.PathLike object referring to an existing file) – Maps to a command-line argument: %s (position: 1).

Optional Inputs:

• args (a string) – Additional parameters to the command. Maps to a command-line argument: %s.

• dimension (3 or 2) – Maps to a command-line argument: %d (position: 0). (Nipype default value: 3)

• 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: {})

• out_transform (a string or os.PathLike object) – Maps to a command-line argument: %s (position: 2).

Outputs:

out_transform (a string or os.PathLike object referring to an existing file)

__init__(command=None, terminal_output=None, write_cmdline=False, **inputs)

Subclasses must implement __init__

Methods

__init__([command, terminal_output, ...])	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.
raise_exception(runtime)
run([cwd, ignore_exception])	Execute this interface.
save_inputs_to_json(json_file)	A convenient way to save current inputs to a JSON file.
set_default_terminal_output(output_type)	Set the default terminal output for CommandLine Interfaces.
version_from_command([flag, cmd])

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.
cmd	sets base command, immutable
cmdline	command plus any arguments (args) validates arguments and generates command line
resource_monitor
terminal_output
version	interfaces should implement a version property
write_cmdline