mds.wave.FrameData Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jscope Show documentation
MDSplus data display program for waveforms, images and more.
There is a newer version: 7.139.60
package mds.wave;

/* $Id$ */
import java.awt.Dimension;
import java.io.IOException;

/**
 * When a Frame sequence is requested to a DataProvider implementation, it is
 * returned by means of an object implementing the FrameData interface.
 * FrameData defines therefore all the access methods required to handle a
 * sequence of frames.
 *
 * @see DataProvider
 */
public interface FrameData
{
	static final int AWT_IMAGE = 8;
	static final int BITMAP_IMAGE_16 = 3;
	static final int BITMAP_IMAGE_32 = 5;
	static final int BITMAP_IMAGE_8 = 1;
	static final int BITMAP_IMAGE_F32 = 7;
	static final int BITMAP_IMAGE_U16 = 4;
	static final int BITMAP_IMAGE_U32 = 6;
	static final int BITMAP_IMAGE_U8 = 2;
	static final int JAI_IMAGE = 9;

	/**
	 * Return the frame at the given position.
	 *
	 * @param idx The index of the requested frame in the frame sequence.
	 * @return The frame as a byte array. If the frame type is
	 *         FrameData.BITMAP_IMAGE, the matrix uses row major ordering.
	 * @exception java.io.IOException
	 */
	public byte[] getFrameAt(int idx) throws IOException;

	/**
	 * Return the dimension of a frame. All the frames in the sequence must have the
	 * same dimension.
	 *
	 * @return The frame dimension.
	 * @exception java.io.IOException
	 */
	public Dimension getFrameDimension() throws Exception;

	/**
	 * Return the times associated with every frame of the sequence. This
	 * information is required to correlate the frame sequence with the other
	 * signals displayed by jScope.
	 *
	 * @return The time array for the frame sequence.
	 */
	public float[] getFrameTimes() throws Exception;

	/**
	 * Returns the type of the corresponding frames. Returned frames can have either
	 * of the following types: 

	 * -FrameData.BITMAP_IMAGE meaning that method GetFrameAt will return a byte
	 * matrix. 

	 * -FrameData.AWT_IMAGE meaning that method GetFrameAt will return a byte vector
	 * representing the binary content of a gif or jpeg file. 

	 * -FrameData.JAI_IMAGE meaning that method GetFrameAt will return a byte vector
	 * representing the binary content of every image file supported by the JAI
	 * (Java Advanced Imaging) package. The JAI package needs not to be installed
	 * unless file formats other than gif or jpeg are used. 

	 * Currently, only BITMAP_IMAGE is supported
	 *
	 * @return The type of the corresponding frame.
	 * @exception java.io.IOException
	 */
	public int getFrameType() throws Exception;

	/**
	 * Returns the number of frames in the sequence.
	 *
	 * @return The number of frames in the sequence.
	 * @exception java.io.IOException
	 */
	public int getNumFrames() throws Exception;
}