xcp_d.interfaces.workbench.SurfaceGenerateInflated

class xcp_d.interfaces.workbench.SurfaceGenerateInflated(command=None, terminal_output=None, write_cmdline=False, **inputs)[source]

Wrapped executable: wb_command -surface-generate-inflated.

Generate inflated surface.

wb_command -surface-generate-inflated
<anatomical-surface-in> - the anatomical surface
<inflated-surface-out> - output - the output inflated surface
<very-inflated-surface-out> - output - the output very inflated surface

[-iterations-scale] - optional iterations scaling
    <iterations-scale-value> - iterations-scale value

Generate inflated and very inflated surfaces. The output surfaces are ‘matched’ (have same XYZ range) to the anatomical surface. In most cases, an iterations-scale of 1.0 (default) is sufficient. However, if the surface contains a large number of vertices (150,000), try an iterations-scale of 2.5.

Mandatory Inputs:

anatomical_surface_in (a pathlike object or string representing an existing file) – The anatomical surface. 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: {})
inflated_out_file (a pathlike object or string representing a file) – Output - the output inflated surface. Maps to a command-line argument: %s (position: 1).
iterations_scale_value (a float) – Iterations-scale value. Maps to a command-line argument: -iterations-scale %f (position: 3).
very_inflated_out_file (a pathlike object or string representing a file) – Output - the output very inflated surface. Maps to a command-line argument: %s (position: 2).

Outputs:

inflated_out_file (a pathlike object or string representing an existing file) – Inflated output file.
very_inflated_out_file (a pathlike object or string representing an existing file) – Very inflated output file.

__init__(command=None, terminal_output=None, write_cmdline=False, **inputs)[source]: 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`