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.
-
-
Field Summary
-
Fields inherited from class gov.nasa.pds.label.object.DataObject
channel, dataObjectLocation, fileObject, localIdentifier, name, offset, parentDir
-
-
Constructor Summary
Constructors Constructor Description ArrayObject(java.io.File parentDir, File fileObject, Array array, long offset)Deprecated.ArrayObject(java.io.File parentDir, File fileObject, Array array, long offset, DataObjectLocation location)Creats a new array instance.ArrayObject(java.net.URL parent, File fileObject, Array array, long offset)Deprecated.ArrayObject(java.net.URL parent, File fileObject, Array array, long offset, DataObjectLocation location)Creates a new array instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.awt.image.BufferedImageas2DImage()Returns a BufferedImage object with the type set to TYPE_BYTE_GRAY.voidclose()ArraygetArray()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.doublegetDouble(int i1, int i2, int i3, int i4)Gets an element of a 4-D array, as a double.double[]getElements1D()Gets the entire 1-D array, as doubles.double[][]getElements2D()Gets the entire 2-D array, as doubles.double[][][]getElements3D()Gets the entire 3-D array, as doubles.double[][][][]getElements4D()Gets the entire 4-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.intgetInt(int i1, int i2, int i3, int i4)Gets an element of a 4-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.longgetLong(int i1, int i2, int i3, int i4)Gets an element of a 4-D array, as a long.booleanisImage()Checks to see whether the array is an image.voidopen()voidsetArray(Array array)-
Methods inherited from class gov.nasa.pds.label.object.DataObject
closeChannel, getChannel, getDataFile, getDataObjectLocation, getInputStream, getLocalIdentifier, getName, getOffset, getSize, setDataObjectLocation, setLocalIdentifier, setName, setSize
-
-
-
-
Constructor Detail
-
ArrayObject
public ArrayObject(java.io.File parentDir, File fileObject, Array array, long offset, DataObjectLocation location) throws java.io.FileNotFoundException, java.io.IOException, java.net.URISyntaxExceptionCreats a new array instance.- Parameters:
parentDir- the parent directory for the data filefileObject- the file object metadataarray- the array objectoffset- the offset within the data file- Throws:
java.io.IOException- if there is an error opening the data filejava.io.FileNotFoundException- if the data file is not foundjava.net.URISyntaxException
-
ArrayObject
public ArrayObject(java.net.URL parent, File fileObject, Array array, long offset, DataObjectLocation location) throws java.io.FileNotFoundException, java.io.IOException, java.net.URISyntaxExceptionCreates a new array instance.- Parameters:
parent- the parent directory for the data filefileObject- the file object metadataarray- the array objectoffset- the offset within the data file- Throws:
java.io.IOException- if there is an error opening the data filejava.io.FileNotFoundException- if the data file is not foundjava.net.URISyntaxException
-
ArrayObject
@Deprecated public ArrayObject(java.net.URL parent, File fileObject, Array array, long offset) throws java.io.FileNotFoundException, java.io.IOException, java.net.URISyntaxExceptionDeprecated.Deprecated initializer. Missing DataObjectLocation- Throws:
java.io.FileNotFoundExceptionjava.io.IOExceptionjava.net.URISyntaxException
-
ArrayObject
@Deprecated public ArrayObject(java.io.File parentDir, File fileObject, Array array, long offset) throws java.io.FileNotFoundException, java.io.IOException, java.net.URISyntaxExceptionDeprecated.Deprecated initializer. Missing DataObjectLocation- Throws:
java.io.FileNotFoundExceptionjava.io.IOExceptionjava.net.URISyntaxException
-
-
Method Detail
-
getDimensions
public int[] getDimensions()
Gets the dimensions of the array.- Returns:
- an array of dimensions
-
getAxes
public int getAxes()
Gets the number of dimensions.- Returns:
- the number of dimensions
-
getElementSize
public int getElementSize()
Gets the size of an array element.- Returns:
- the element size, in bytes
-
getInt
public int getInt(int row, int column) throws java.io.IOExceptionGets an element of a 2-D array, as an int.- Parameters:
row- the rowcolumn- the column- Returns:
- the element value, as an int
- Throws:
java.io.IOException
-
getLong
public long getLong(int row, int column) throws java.io.IOExceptionGets an element of a 2-D array, as a long.- Parameters:
row- the rowcolumn- the column- Returns:
- the element value, as a long
- Throws:
java.io.IOException
-
getDouble
public double getDouble(int row, int column) throws java.io.IOExceptionGets an element of a 2-D array, as a double.- Parameters:
row- the rowcolumn- the column- Returns:
- the element value, as a double
- Throws:
java.io.IOException
-
getInt
public int getInt(int i1, int i2, int i3) throws java.io.IOExceptionGets an element of a 3-D array, as an int.- Parameters:
i1- the first indexi2- the second indexi3- the third index- Returns:
- the element value, as an int
- Throws:
java.io.IOException
-
getLong
public long getLong(int i1, int i2, int i3) throws java.io.IOExceptionGets an element of a 3-D array, as a long.- Parameters:
i1- the first indexi2- the second indexi3- the third index- Returns:
- the element value, as a long
- Throws:
java.io.IOException
-
getDouble
public double getDouble(int i1, int i2, int i3) throws java.io.IOExceptionGets an element of a 3-D array, as a double.- Parameters:
i1- the first indexi2- the second indexi3- the third index- Returns:
- the element value, as a double
- Throws:
java.io.IOException
-
getInt
public int getInt(int i1, int i2, int i3, int i4) throws java.io.IOExceptionGets an element of a 4-D array, as an int.- Parameters:
i1- the first indexi2- the second indexi3- the third indexi4- the fourth index- Returns:
- the element value, as an int
- Throws:
java.io.IOException
-
getLong
public long getLong(int i1, int i2, int i3, int i4) throws java.io.IOExceptionGets an element of a 4-D array, as a long.- Parameters:
i1- the first indexi2- the second indexi3- the third indexi4- the fourth index- Returns:
- the element value, as a long
- Throws:
java.io.IOException
-
getDouble
public double getDouble(int i1, int i2, int i3, int i4) throws java.io.IOExceptionGets an element of a 4-D array, as a double.- Parameters:
i1- the first indexi2- the second indexi3- the third indexi4- the fourth index- Returns:
- the element value, as a double
- Throws:
java.io.IOException
-
getInt
public int getInt(int[] position) throws java.io.IOExceptionGets an array element, as an int.- Parameters:
position- the indices of the element- Returns:
- the value of the element, as an int
- Throws:
java.io.IOException
-
getLong
public long getLong(int[] position) throws java.io.IOExceptionGets an array element, as a long.- Parameters:
position- the indices of the element- Returns:
- the value of the element, as a long
- Throws:
java.io.IOException
-
getDouble
public double getDouble(int[] position) throws java.io.IOExceptionGets an array element, as a double.- Parameters:
position- the indices of the element- Returns:
- the value of the element, as a double
- Throws:
java.io.IOException
-
getElements1D
public double[] getElements1D() throws java.io.IOExceptionGets the entire 1-D array, as doubles.- Returns:
- an array of double with all array elements
- Throws:
java.io.IOException
-
getElements2D
public double[][] getElements2D() throws java.io.IOExceptionGets the entire 2-D array, as doubles.- Returns:
- an array of double with all array elements
- Throws:
java.io.IOException
-
getElements3D
public double[][][] getElements3D() throws java.io.IOExceptionGets the entire 3-D array, as doubles.- Returns:
- an array of double with all array elements
- Throws:
java.io.IOException
-
getElements4D
public double[][][][] getElements4D() throws java.io.IOExceptionGets the entire 4-D array, as doubles.- Returns:
- an array of double with all array elements
- Throws:
java.io.IOException
-
isImage
public boolean isImage()
Checks to see whether the array is an image.- Returns:
- true, if the array is an image
-
as2DImage
public java.awt.image.BufferedImage as2DImage()
Returns a BufferedImage object with the type set to TYPE_BYTE_GRAY.- Returns:
- a BufferedImage
-
getElementType
public ElementType getElementType()
-
getArray
public Array getArray()
-
setArray
public void setArray(Array array)
-
open
public void open() throws java.io.IOException- Throws:
java.io.IOException
-
close
public void close() throws java.io.IOException- Throws:
java.io.IOException
-
-