edu.wisc.ssec.mcidasv.data

Class McIdasFrame

java.lang.Object

edu.wisc.ssec.mcidasv.data.McIdasFrame

public class McIdasFrame
extends Object

Class to hold McIdas-X frame datasets

Field Summary

Fields

Modifier and Type	Field and Description
private ColorTable	myColorTable
private int	myElementSize
private FrameDirectory	myFrameDirectory
private int	myFrameNumber frame data
private byte[]	myGraphics
private byte[]	myImage
private int	myLineSize Keep local copies of everything so we dont have to go back over the bridge unless asked to refresh
private McIdasXFrameInfo	myXFrameInfo

Constructor Summary

Constructors

Constructor and Description
McIdasFrame() Empty constructor for XML encoding
McIdasFrame(int frameNumber, McIdasXInfo xInfo) Construct a new McIdasFrame from the given frame number

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o) See if this McIdasFrame is equal to the object in question
ColorTable	getColorTable(boolean refresh) Get Color Table
int	getElementSize(boolean refresh) Get frame data
FrameDirectory	getFrameDirectory(boolean refresh) Get Frame Directory
int	getFrameNumber() Get frame number
Image	getGIF() Get image data
byte[]	getGraphicsData(boolean refresh) Get graphics data
byte[]	getImageData(boolean refresh) Get image data
int	getLineSize(boolean refresh) Get frame data
void	setRefreshData(boolean refresh) Tell the XFrameInfo to refresh the cached data
String	toString() Get a String representation of this object

Methods inherited from class java.lang.Object

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

Field Detail

myFrameNumber

private int myFrameNumber

frame data

myXFrameInfo

private McIdasXFrameInfo myXFrameInfo

myLineSize

private int myLineSize

Keep local copies of everything so we dont have to go back over the bridge unless asked to refresh

myElementSize

private int myElementSize

myFrameDirectory

private FrameDirectory myFrameDirectory

myColorTable

private ColorTable myColorTable

myImage

private byte[] myImage

myGraphics

private byte[] myGraphics

Constructor Detail

McIdasFrame

public McIdasFrame()

Empty constructor for XML encoding

McIdasFrame

public McIdasFrame(int frameNumber,
           McIdasXInfo xInfo)

Construct a new McIdasFrame from the given frame number

Parameters:

frameNumber - frame number

Method Detail

getFrameNumber

public int getFrameNumber()

Get frame number

setRefreshData

public void setRefreshData(boolean refresh)

Tell the XFrameInfo to refresh the cached data

getLineSize

public int getLineSize(boolean refresh)

Get frame data

getElementSize

public int getElementSize(boolean refresh)

Get frame data

getFrameDirectory

public FrameDirectory getFrameDirectory(boolean refresh)

Get Frame Directory

getColorTable

public ColorTable getColorTable(boolean refresh)

Get Color Table

getImageData

public byte[] getImageData(boolean refresh)

Get image data

getGraphicsData

public byte[] getGraphicsData(boolean refresh)

Get graphics data

getGIF

public Image getGIF()

Get image data

equals

public boolean equals(Object o)

See if this McIdasFrame is equal to the object in question

Overrides:

equals in class Object

Parameters:

o - object in question

Returns:

true if o is a McIdasFrame and they area equivalent

toString

public String toString()

Get a String representation of this object

Overrides:

toString in class Object

Returns:

a string representation