Package gov.nasa.pds.label.object
Class ArrayObject
java.lang.Object
gov.nasa.pds.label.object.DataObject
gov.nasa.pds.label.object.ArrayObject
public class ArrayObject extends DataObject
Implements an object representing an array object in a
 PDS product.
- 
Constructor SummaryConstructors Constructor Description ArrayObject(File parentDir, File fileObject, Array array, long offset)Creats a new array instance.ArrayObject(URL parent, File fileObject, Array array, long offset)Creats a new array instance.
- 
Method SummaryModifier and Type Method Description BufferedImageas2DImage()Returns a BufferedImage object with the type set to TYPE_BYTE_GRAY.intgetAxes()Gets the number of dimensions.int[]getDimensions()Gets the dimensions of the array.doublegetDouble(int[] position)Gets an array element, as a double.doublegetDouble(int row, int column)Gets an element of a 2-D array, as a double.doublegetDouble(int i1, int i2, int i3)Gets an element of a 3-D array, as a double.double[][]getElements2D()Gets the entire 2-D array, as doubles.double[][][]getElements3D()Gets the entire 3-D array, as doubles.intgetElementSize()Gets the size of an array element.ElementTypegetElementType()intgetInt(int[] position)Gets an array element, as an int.intgetInt(int row, int column)Gets an element of a 2-D array, as an int.intgetInt(int i1, int i2, int i3)Gets an element of a 3-D array, as an int.longgetLong(int[] position)Gets an array element, as a long.longgetLong(int row, int column)Gets an element of a 2-D array, as a long.longgetLong(int i1, int i2, int i3)Gets an element of a 3-D array, as a long.booleanisImage()Checks to see whether the array is an image.Methods inherited from class gov.nasa.pds.label.object.DataObjectcloseChannel, getChannel, getDataFile, getInputStream, getOffset, getSize, setSize
- 
Constructor Details- 
ArrayObjectpublic ArrayObject(File parentDir, File fileObject, Array array, long offset) throws FileNotFoundException, IOExceptionCreats a new array instance.- Parameters:
- parentDir- the parent directory for the data file
- fileObject- the file object metadata
- array- the array object
- offset- the offset within the data file
- Throws:
- IOException- if there is an error opening the data file
- FileNotFoundException- if the data file is not found
 
- 
ArrayObjectpublic ArrayObject(URL parent, File fileObject, Array array, long offset) throws FileNotFoundException, IOExceptionCreats a new array instance.- Parameters:
- parent- the parent directory for the data file
- fileObject- the file object metadata
- array- the array object
- offset- the offset within the data file
- Throws:
- IOException- if there is an error opening the data file
- FileNotFoundException- if the data file is not found
 
 
- 
- 
Method Details- 
getDimensionspublic int[] getDimensions()Gets the dimensions of the array.- Returns:
- an array of dimensions
 
- 
getAxespublic int getAxes()Gets the number of dimensions.- Returns:
- the number of dimensions
 
- 
getElementSizepublic int getElementSize()Gets the size of an array element.- Returns:
- the element size, in bytes
 
- 
getIntGets an element of a 2-D array, as an int.- Parameters:
- row- the row
- column- the column
- Returns:
- the element value, as an int
- Throws:
- IOException
 
- 
getLongGets an element of a 2-D array, as a long.- Parameters:
- row- the row
- column- the column
- Returns:
- the element value, as a long
- Throws:
- IOException
 
- 
getDoubleGets an element of a 2-D array, as a double.- Parameters:
- row- the row
- column- the column
- Returns:
- the element value, as a double
- Throws:
- IOException
 
- 
getIntGets an element of a 3-D array, as an int.- Parameters:
- i1- the first index
- i2- the second index
- i3- the third index
- Returns:
- the element value, as an int
- Throws:
- IOException
 
- 
getLongGets an element of a 3-D array, as a long.- Parameters:
- i1- the first index
- i2- the second index
- i3- the third index
- Returns:
- the element value, as a long
- Throws:
- IOException
 
- 
getDoubleGets an element of a 3-D array, as a double.- Parameters:
- i1- the first index
- i2- the second index
- i3- the third index
- Returns:
- the element value, as a double
- Throws:
- IOException
 
- 
getIntGets an array element, as an int.- Parameters:
- position- the indices of the element
- Returns:
- the value of the element, as an int
- Throws:
- IOException
 
- 
getLongGets an array element, as a long.- Parameters:
- position- the indices of the element
- Returns:
- the value of the element, as a long
- Throws:
- IOException
 
- 
getDoubleGets an array element, as a double.- Parameters:
- position- the indices of the element
- Returns:
- the value of the element, as a double
- Throws:
- IOException
 
- 
getElements2DGets the entire 2-D array, as doubles.- Returns:
- an array of double with all array elements
- Throws:
- IOException
 
- 
getElements3DGets the entire 3-D array, as doubles.- Returns:
- an array of double with all array elements
- Throws:
- IOException
 
- 
isImagepublic boolean isImage()Checks to see whether the array is an image.- Returns:
- true, if the array is an image
 
- 
as2DImageReturns a BufferedImage object with the type set to TYPE_BYTE_GRAY.- Returns:
- a BufferedImage
 
- 
getElementType
 
-