CADI.Viewer.Util
Class SaveFile

java.lang.Object
  CADI.Viewer.Util.SaveFile

public class SaveFile
extends java.lang.Object

This class receives a 3D array and saves in any JAI format or raw data.

Version:

1.0

Author:

Group on Interactive Coding of Images (GICI)

Constructor Summary

SaveFile()

Method Summary

static void	SaveFileExtension(float[][][] imageSamples, int[] QComponentsBits, java.lang.String imageFile, int[] imageGeometry) This functions saves the image samples to an image file with the format specified by its extension.
private static void	SaveFileFormat(float[][][] imageSamples, java.lang.String imageFile, int format) Saves image samples using specified format using JAI.
private static void	SaveFileRaw(float[][][] imageSamples, java.lang.String imageFile, int sampleType, int byteOrder) Saves image samples in raw data.

Methods inherited from class java.lang.Object

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

Constructor Detail

SaveFile

public SaveFile()

Method Detail

SaveFileExtension

public static void SaveFileExtension(float[][][] imageSamples,
                                     int[] QComponentsBits,
                                     java.lang.String imageFile,
                                     int[] imageGeometry)
                              throws WarningException

This functions saves the image samples to an image file with the format specified by its extension.

Parameters:

imageSamples - the image samples

QComponentsBits - the bit depth of each image component

imageFile - the name file

imageGeometry - image geometry needed in the case that the output file is raw or img

Throws:

WarningException - when the file can not be saved

SaveFileFormat

private static void SaveFileFormat(float[][][] imageSamples,
                                   java.lang.String imageFile,
                                   int format)
                            throws WarningException

Saves image samples using specified format using JAI. This function uses byte type to save image (because is the only allowed by JAI libraries) and it can manage only images with 1 or 3 components.

Parameters:

imageSamples - a 3D float array that contains image samples

imageFile - file name where raw data will be stored

format - format type to save image. The value indicates the following:

• 0- PNM (pgm or ppm)
• 1- TIFF
• 2- PNG
• 3- JPEG (not recommended because it degenerates image)
• 4- BMP (not recommended because it is not standard)

Throws:

WarningException - when the file cannot be saved (incorrect number of components, file format unrecognized, etc.)

SaveFileRaw

private static void SaveFileRaw(float[][][] imageSamples,
                                java.lang.String imageFile,
                                int sampleType,
                                int byteOrder)
                         throws WarningException

Saves image samples in raw data.

Parameters:

imageSamples - a 3D float array that contains image samples

imageFile - file name where raw data will be stored

sampleType - an integer representing the class of image samples type. Samples types can be:

• 0- boolean
• 1- byte
• 2- char
• 3- short
• 4- int
• 5- long
• 6- float
• 7- double

byteOrder - 0 if BIG_ENDIAN, 1 if LITTLE_ENDIAN

Throws:

WarningException - when the file cannot be saved (incorrect number of components, file format unrecognized, etc.)