Package mgui.io.foreign.caret

Class CaretAreaColourWriter

java.lang.Object

mgui.io.FileWriter

mgui.io.foreign.caret.CaretAreaColourWriter

All Implemented Interfaces:

InterfaceIO, IconObject

public class CaretAreaColourWriter
extends FileWriter

Writes a DiscreteColourMap to a Caret area colour file, which associates colours (RGB) with names.

See http://brainvis.wustl.edu/CaretHelpAccount/caret5_help/file_formats/file_formats.html#areaColor

Since:

1.0

Version:

1.0

Author:

Andrew Reid

Field Summary

Fields inherited from class mgui.io.FileWriter

dataFile, dataURL, failure_message, options, success_message

Constructor Summary

Constructors

Constructor	Description
CaretAreaColourWriter()

Method Summary

Modifier and Type	Method	Description
boolean	write(InterfaceIOOptions options, ProgressUpdater progressBar)	Writes this object according to the given options.
boolean	writeColourMap(DiscreteColourMap colour_map)	Writes colour_map to file.

Methods inherited from class mgui.io.FileWriter

getComplementIOType, getFailureMessage, getFile, getIOType, getLoaderComplement, getObjectIcon, getOptions, getProgressMessage, getSuccessMessage, getSupportedObjects, getTitle, getURL, setFile, setOptions, setURL, toString, write, write

Methods inherited from class java.lang.Object

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

Constructor Details

CaretAreaColourWriter

public CaretAreaColourWriter()

Method Details

write

public boolean write(InterfaceIOOptions options,
ProgressUpdater progressBar)

Description copied from class: FileWriter

Writes this object according to the given options. If loaded object is of type PersistentObject, this method should also set the file writer and reference URL for the object.

Specified by:

write in class FileWriter

Returns:

writeColourMap

public boolean writeColourMap(DiscreteColourMap colour_map)

Writes colour_map to file. The map should have an associated name map; otherwise its indices will be used as names.

Parameters:

colour_map - The colour map to write

Returns: