Package mgui.io.domestic.shapes

Class VolumeFileWriter

java.lang.Object
mgui.io.FileWriter
mgui.io.domestic.shapes.VolumeFileWriter
All Implemented Interfaces:
InterfaceIO, IconObject
Direct Known Subclasses:
NiftiVolumeWriter
public abstract class VolumeFileWriter
extends FileWriter
Writes a Volume3DInt to file. All volume writers should extend this class. This class also provides default implementations for writing volumes to the domestic standard, NIFTI format, using the jniftilib library. See NITRIC for details.
Since:
1.0
Version:
1.0
Author:
Andrew Reid

  • Constructor Details

    • VolumeFileWriter

      public VolumeFileWriter()

  • Method Details

    • write

      public boolean write​(InterfaceIOOptions options, ProgressUpdater progress_bar)
      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:

    • writeVolume

      public boolean writeVolume​(Volume3DInt volume) throws java.io.IOException
      Writes volume to file using default parameters.
      Parameters:
      volume -
      options -
      Returns:
      Throws:
      java.io.IOException

    • writeVolume

      public abstract boolean writeVolume​(Volume3DInt volume, VolumeOutputOptions options) throws java.io.IOException
      Writes a volume to file using the specified options.
      Parameters:
      volume -
      options -
      Returns:
      Throws:
      java.io.IOException

    • getObjectIcon

      public javax.swing.Icon getObjectIcon()
      Description copied from interface: IconObject
      Returns the Icon associated with this object.
      Specified by:
      getObjectIcon in interface IconObject
      Overrides:
      getObjectIcon in class FileWriter
      Returns:

    • getSupportedObjects

      public java.util.ArrayList<java.lang.Class<?>> getSupportedObjects()
      Description copied from interface: InterfaceIO
      Returns a list of classes for objects which are supported by this I/O interface
      Specified by:
      getSupportedObjects in interface InterfaceIO
      Overrides:
      getSupportedObjects in class FileWriter
      Returns:

    • setVolumeMetadata

      public abstract void setVolumeMetadata​(VolumeMetadata metadata)
      Sets the metadata for this volume.
      Parameters:
      metadata -