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 Details

    • ArrayObject

      public ArrayObject​(File parentDir, File fileObject, Array array, long offset) throws FileNotFoundException, IOException
      Creats 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
    • ArrayObject

      public ArrayObject​(URL parent, File fileObject, Array array, long offset) throws FileNotFoundException, IOException
      Creats 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

    • 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 IOException
      Gets 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
    • getLong

      public long getLong​(int row, int column) throws IOException
      Gets 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
    • getDouble

      public double getDouble​(int row, int column) throws IOException
      Gets 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
    • getInt

      public int getInt​(int i1, int i2, int i3) throws IOException
      Gets 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
    • getLong

      public long getLong​(int i1, int i2, int i3) throws IOException
      Gets 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
    • getDouble

      public double getDouble​(int i1, int i2, int i3) throws IOException
      Gets 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
    • getInt

      public int getInt​(int[] position) throws IOException
      Gets an array element, as an int.
      Parameters:
      position - the indices of the element
      Returns:
      the value of the element, as an int
      Throws:
      IOException
    • getLong

      public long getLong​(int[] position) throws IOException
      Gets an array element, as a long.
      Parameters:
      position - the indices of the element
      Returns:
      the value of the element, as a long
      Throws:
      IOException
    • getDouble

      public double getDouble​(int[] position) throws IOException
      Gets an array element, as a double.
      Parameters:
      position - the indices of the element
      Returns:
      the value of the element, as a double
      Throws:
      IOException
    • getElements2D

      public double[][] getElements2D() throws IOException
      Gets the entire 2-D array, as doubles.
      Returns:
      an array of double with all array elements
      Throws:
      IOException
    • getElements3D

      public double[][][] getElements3D() throws IOException
      Gets the entire 3-D array, as doubles.
      Returns:
      an array of double with all array elements
      Throws:
      IOException
    • isImage

      public boolean isImage()
      Checks to see whether the array is an image.
      Returns:
      true, if the array is an image
    • as2DImage

      public BufferedImage as2DImage()
      Returns a BufferedImage object with the type set to TYPE_BYTE_GRAY.
      Returns:
      a BufferedImage
    • getElementType

      public ElementType getElementType()