Package mgui.io.standard.gifti

Class GiftiOutputOptions

java.lang.Object

mgui.interfaces.InterfaceOptions

mgui.io.InterfaceIOOptions

mgui.io.domestic.shapes.SurfaceOutputOptions

mgui.io.standard.gifti.GiftiOutputOptions

All Implemented Interfaces:

InterfaceObject, NamedObject, TreeObject, CleanableObject, XMLObject

public class GiftiOutputOptions
extends SurfaceOutputOptions

Options for writing a surface to a Gifti format file.

Since:

1.0

Version:

1.0

Author:

Andrew Reid

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GiftiOutputOptions.ByteOrder
static class	GiftiOutputOptions.ColumnFormat
static class	GiftiOutputOptions.GiftiEncoding

Nested classes/interfaces inherited from interface mgui.interfaces.xml.XMLObject

XMLObject.XMLEncoding, XMLObject.XMLType

Field Summary

Fields

Modifier and Type	Field	Description
GiftiOutputOptions.ByteOrder	byte_order
GiftiOutputOptions.ColumnFormat	column_format
int	decimal_places
GiftiOutputOptions.GiftiEncoding	encoding
java.util.ArrayList<java.lang.String>	write_columns

Fields inherited from class mgui.io.domestic.shapes.SurfaceOutputOptions

files, mesh, number_format

Constructor Summary

Constructors

Constructor	Description
GiftiOutputOptions()

Method Summary

Modifier and Type	Method	Description
void	setWriteColumns(java.util.ArrayList<java.lang.String> columns)	Sets the columns for which data will be written to the GIFTI file; an empty array, or null, indicates that no columns will be written.

Methods inherited from class mgui.io.domestic.shapes.SurfaceOutputOptions

getDisplayPanel, getFileChooser, getFileChooser, getFiles, getXML, getXMLHeader, handleXMLElementStart, setDisplayPanel, setFiles, setObject

Methods inherited from class mgui.io.InterfaceIOOptions

getDTD, getLocalName, getShortXML, getXML, getXMLSchema, handleXMLElementEnd, handleXMLString, setFromComplementaryOptions, writeXML, writeXML, writeXML

Methods inherited from class mgui.interfaces.InterfaceOptions

clean, destroy, getName, getTreeLabel, isDestroyed, issueTreeNode, setName, setTreeNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

encoding

public GiftiOutputOptions.GiftiEncoding encoding

byte_order

public GiftiOutputOptions.ByteOrder byte_order

decimal_places

public int decimal_places

write_columns

public java.util.ArrayList<java.lang.String> write_columns

column_format

public GiftiOutputOptions.ColumnFormat column_format

Constructor Details

GiftiOutputOptions

public GiftiOutputOptions()

Method Details

setWriteColumns

public void setWriteColumns(java.util.ArrayList<java.lang.String> columns)

Sets the columns for which data will be written to the GIFTI file; an empty array, or null, indicates that no columns will be written. The data will be written either as values or as their associated RGB or RGBA colours, using the current colour mapping (or both), as specified by the column_format parameter.

Parameters:

columns -