Output parameters

Below is the full description for all the parameters controlling an output in batch processing. You need to add at least one output and set its parameters.

Example

outputs.+.node = sink       # create a new output, have it use the node called 'sink'
.file = foo.pdf             # it will write to foo.pdf
.clobber = y                # existing foo.pdf will be overwritten
.annotations = y            # annotations will be output

.outputs.+.node = expr      # new output, using the 'expr' node
.file = foo.txt             # output to foo.txt
.prefix = Result of expr :  # some text to prefix with
.clobber = y                # existing file overwritten

Parameter table

outputs	node: string (default None)	node name
	output: integer (default None)	node output connection (or None for the default)
	file: string (default None)	output filename - if not provided, use previous output's value (see 'append')
	clobber: boolean (default False)	overwrite the file if it exists (else raise an exception)
	format: string (txt, csv, pdf, svg, png, jpg, jpeg, bmp, tiff, parc) (default None)	output format for image in lowercase (will determine from extension if not given)
	annotations: boolean (default None)	draw ROIs/annotations on the image (must be false for PARC). If not provided, use previous output's value (or false if first output)
	name: string (default None)	name of the datum (if a PARC is being written) - 'main' if not given
	description: string (default None)	description of the data (if a PARC is being written)
	width: integer (default 1000)	width of output image when exporting to raster formats (in pixels) if annotations is true. If annotations is false or width is negative, no resizing is done.
	append: boolean (default None)	append to a PARC or text file if it exists. If not provided, use previous output's value (or false if first output)
	prefix: string (default None)	prefix for the output (text outputs only)

---

Automatically generated by generate_autodocs.py

Date: 2025-02-17T16:09:18.986731