xcp_d.interfaces.plotting.PNGAppend
- class xcp_d.interfaces.plotting.PNGAppend(**inputs)[source]
Wrapped executable:
pngappend
.Run pngappend.
Notes
pngappend - append PNG files horizontally and/or vertically into a new PNG (or GIF) file
Usage: pngappend <input 1> <+|-> [n] <input 2> [<+|-> [n] <input n>] output>
appends horizontally,
appends vertically (i.e. works like a linebreak)
[n] number ofgap pixels note that files with .gif extension will be input/output in GIF format
- Mandatory Inputs:
in_files (a list of items which are a pathlike object or string representing an existing file) – List of files to process.
out_file (a pathlike object or string representing a file) – Output file.
- 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:
{}
)output_type (‘NIFTI’ or ‘NIFTI_PAIR’ or ‘NIFTI_GZ’ or ‘NIFTI_PAIR_GZ’) – FSL output type.
- Outputs:
out_file (a pathlike object or string representing an existing file) – Output file.
Methods
__init__
(**inputs)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_output_type
(output_type)Set the default output type for FSL classes.
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