Module org.hdfgroup.object
Package hdf.object.h4

# Class H4GRImage

Object
hdf.object.HObject
hdf.object.Dataset
hdf.object.ScalarDS
hdf.object.h4.H4GRImage

All Implemented Interfaces:
  `DataFormat`, `MetaDataContainer`, `Serializable`

public class H4GRImage extends ScalarDS implements MetaDataContainer
H4GRImage describes an HDF4 general raster(GR) image and operations performed on the GR image. An HDF4 raster image is a two-dimension array of pixel values. Every GR data set must contain the following components: image array, name, pixel type, and dimensions. The name, dimensions, and pixel type must be supplied by the user at the time the GR data set is defined. An image array is a two-dimensional array of pixels. Each element in an image array corresponds to one pixel and each pixel can consist of a number of color component values or pixel components, e.g., Red-Green-Blue or RGB, Cyan-Magenta-Yellow-Black or CMYK, etc. Pixel components can be represented by different methods (8-bit lookup table or 24-bit direct representation) and may have different data types. The data type of pixel components and the number of components in each pixel are collectively known as the pixel type. How to Select a Subset Dataset defines APIs for reading, writing and subsetting a dataset. No function is defined to select a subset of a data array. The selection is done in an implicit way. Function calls to dimension information such as getSelectedDims() return an array of dimension values, which is a reference to the array in the dataset object. Changes of the array outside the dataset object directly change the values of the array in the dataset object. It is like pointers in C. The following is an example of how to make a subset. In the example, the dataset is a 4-dimension with size of [200][100][50][10], i.e. dims[0]=200; dims[1]=100; dims[2]=50; dims[3]=10;
We want to select every other data point in dims[1] and dims[2]

         int rank = dataset.getRank();   // number of dimensions of the dataset
         long[] dims = dataset.getDims(); // the dimension sizes of the dataset
         long[] selected = dataset.getSelectedDims(); // the selected size of the dataet
         long[] start = dataset.getStartDims(); // the offset of the selection
         long[] stride = dataset.getStride(); // the stride of the dataset
         int[]  selectedIndex = dataset.getSelectedIndex(); // the selected dimensions for display

         // select dim1 and dim2 as 2D data for display, and slice through dim0
         selectedIndex[0] = 1;
         selectedIndex[1] = 2;
         selectedIndex[1] = 0;

         // reset the selection arrays
         for (int i=0; i<rank; i++) {
             start[i] = 0;
             selected[i] = 1;
             stride[i] = 1;
        }

        // set stride to 2 on dim1 and dim2 so that every other data point is selected.
        stride[1] = 2;
        stride[2] = 2;

        // set the selection size of dim1 and dim2
        selected[1] = dims[1]/stride[1];
        selected[2] = dims[1]/stride[2];

        // when dataset.read() is called, the slection above will be used since
        // the dimension arrays are passed by reference. Changes of these arrays
        // outside the dataset object directly change the values of these array
        // in the dataset object.

Version:
  1.1 9/4/2007
Author:
  Peter X. Cao
See Also:
  - Serialized Form

- ## Field Summary

  ### Fields inherited from class hdf.object.ScalarDS

  `fillValue, imageDataRange, interlace, INTERLACE_LINE, INTERLACE_PIXEL, INTERLACE_PLANE, isDefaultImageOrder, isFillValueConverted, isImageDisplay, isTrueColor, palette, unsignedConverted`

  ### Fields inherited from class hdf.object.Dataset

  `chunkSize, compression, COMPRESSION_GZIP_TXT, convertByteToString, convertedBuf, data, datatype, dimNames, dims, filters, inited, isDataLoaded, isImage, isNULL, isScalar, isText, maxDims, nPoints, originalBuf, rank, selectedDims, selectedIndex, selectedStride, space_type, startDims, storage, storageLayout`

  ### Fields inherited from class hdf.object.HObject

  `fileFormat, linkTargetObjName, oid, SEPARATOR`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `H4GRImage(FileFormat theFile, String name, String path)`
  Creates a H4GRImage object with specific name and path.
  `H4GRImage(FileFormat theFile, String name, String path, long[] oid)`
  Creates a H4GRImage object with specific name, path, and object ID.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `close(long grid)`
  Closes access to the object.
  `Dataset`
  `copy(Group pgroup, String dname, long[] dims, Object buff)`
  Creates a new dataset and writes the data buffer to the new dataset.
  `static H4GRImage`
  `create(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, int ncomp, int interlace, Object data)`
  Creates a new image.
  `int`
  `getComponentCount()`
  Returns the number of components of this image data.
  `Datatype`
  `getDatatype()`
  Returns the datatype of the data object.
  `List`
  `getMetadata()`
  Retrieves the object's metadata, such as attributes, from the file.
  `List`
  `getMetadata(int... attrPropList)`
  Retrieves the object's metadata, such as attributes, from the file.
  `int`
  `getNumberOfPalettes()`
  Get the number of pallettes for this object.
  `byte[][]`
  `getPalette()`
  Returns the palette of this scalar dataset or null if palette does not exist.
  `boolean`
  `hasAttribute()`
  Check if the object has any attributes attached.
  `void`
  `init()`
  Set the initial state of all the variables
  `long`
  `open()`
  Opens an existing object such as a dataset or group for access.
  `Object`
  `read()`
  Reads the data from file.
  `byte[]`
  `readBytes()`
  Reads the raw data of the dataset from file to a byte array.
  `byte[][]`
  `readPalette(int idx)`
  Reads a specific image palette from file.
  `void`
  `removeMetadata(Object info)`
  Deletes an existing piece of metadata from this object.
  `void`
  `updateMetadata(Object info)`
  Updates an existing piece of metadata attached to this object.
  `void`
  `write(Object buf)`
  Writes a memory buffer to the object in the file.
  `void`
  `writeMetadata(Object info)`
  Writes a specific piece of metadata (such as an attribute) into the file.

  ### Methods inherited from class hdf.object.ScalarDS

  `addFilteredImageValue, clearData, convertFromUnsignedC, convertToUnsignedC, getFillValue, getFilteredImageValues, getImageDataRange, getInterlace, getPaletteName, isDefaultImageOrder, isImage, isImageDisplay, isTrueColor, setImageDataRange, setIsImage, setIsImageDisplay, setPalette`

  ### Methods inherited from class hdf.object.Dataset

  `byteToString, clear, convertFromUnsignedC, convertFromUnsignedC, convertToUnsignedC, convertToUnsignedC, getChunkSize, getCompression, getConvertByteToString, getData, getDepth, getDimNames, getDims, getFilters, getHeight, getMaxDims, getOriginalClass, getRank, getSelectedDims, getSelectedIndex, getSize, getSpaceType, getStartDims, getStorage, getStorageLayout, getStride, getVirtualFilename, getVirtualMaps, getWidth, isInited, isNULL, isScalar, isString, isVirtual, refreshData, resetSelection, setConvertByteToString, setData, stringToByte, toString, toString, toString, write`

  ### Methods inherited from class hdf.object.HObject

  `createFullname, debug, equals, equals, equalsOID, getFID, getFile, getFileFormat, getFullName, getLinkTargetObjName, getName, getOID, getPath, hashCode, setFullname, setLinkTargetObjName, setName, setPath, toString`

  ### Methods inherited from class java.lang.Object

  `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

  ### Methods inherited from interface hdf.object.MetaDataContainer

  `clear`

- ## Constructor Details

  - ### H4GRImage

    public H4GRImage(FileFormat theFile, String name, String path)
    Creates a H4GRImage object with specific name and path.
    Parameters:
      `theFile` - the HDF file.
      `name` - the name of this H4GRImage.
      `path` - the full path of this H4GRImage.

  - ### H4GRImage

    public H4GRImage(FileFormat theFile, String name, String path, long[] oid)
    Creates a H4GRImage object with specific name, path, and object ID.
    Parameters:
      `theFile` - the HDF file.
      `name` - the name of this H4GRImage.
      `path` - the full path of this H4GRImage.
      `oid` - the unique identifier of this data object.

- ## Method Details

  - ### hasAttribute

    public boolean hasAttribute()
    Description copied from interface: `MetaDataContainer`
    Check if the object has any attributes attached.
    Specified by:
      `hasAttribute` in interface `MetaDataContainer`
    Returns:
      true if it has any attributes, false otherwise.

  - ### copy

    public Dataset copy(Group pgroup, String dname, long[] dims, Object buff) throws Exception
    Description copied from class: `Dataset`
    Creates a new dataset and writes the data buffer to the new dataset. This function allows applications to create a new dataset for a given data buffer. For example, users can select a specific interesting part from a large image and create a new image with the selection. The new dataset retains the datatype and dataset creation properties of this dataset.
    Specified by:
      `copy` in class `Dataset`
    Parameters:
      `pgroup` - the group which the dataset is copied to.
      `dname` - the name of the new dataset.
      `dims` - the dimension sizes of the the new dataset.
      `buff` - the data values of the subset to be copied.
    Returns:
      the new dataset.
    Throws:
      `Exception` - if dataset can not be copied

  - ### getDatatype

    public Datatype getDatatype()
    Returns the datatype of the data object.
    Specified by:
      `getDatatype` in interface `DataFormat`
    Overrides:
      `getDatatype` in class `Dataset`
    Returns:
      the datatype of the data object.

  - ### readBytes

    public byte[] readBytes() throws hdf.hdflib.HDFException
    Description copied from class: `Dataset`
    Reads the raw data of the dataset from file to a byte array. readBytes() reads raw data to an array of bytes instead of array of its datatype. For example, for a one-dimension 32-bit integer dataset of size 5, readBytes() returns a byte array of size 20 instead of an int array of 5. readBytes() can be used to copy data from one dataset to another efficiently because the raw data is not converted to its native type, it saves memory space and CPU time.
    Specified by:
      `readBytes` in class `Dataset`
    Returns:
      the byte array of the raw data.
    Throws:
      `hdf.hdflib.HDFException`

  - ### read

    public Object read() throws hdf.hdflib.HDFException
    Reads the data from file. read() reads the data from file to a memory buffer and returns the memory buffer. The dataset object does not hold the memory buffer. To store the memory buffer in the dataset object, one must call getData(). By default, the whole dataset is read into memory. Users can also select a subset to read. Subsetting is done in an implicit way.
    Specified by:
      `read` in interface `DataFormat`
    Returns:
      the data read from file.
    Throws:
      `hdf.hdflib.HDFException` - if object can not be read
    See Also:
      - `Dataset.getData()`

  - ### write

    public void write(Object buf) throws hdf.hdflib.HDFException
    Writes a memory buffer to the object in the file.
    Specified by:
      `write` in interface `DataFormat`
    Parameters:
      `buf` - the data to write
    Throws:
      `hdf.hdflib.HDFException` - if data can not be written

  - ### getMetadata

    public List getMetadata() throws hdf.hdflib.HDFException
    Retrieves the object's metadata, such as attributes, from the file. Metadata, such as attributes, is stored in a List.
    Specified by:
      `getMetadata` in interface `MetaDataContainer`
    Returns:
      the list of metadata objects.
    Throws:
      `hdf.hdflib.HDFException` - if the metadata can not be retrieved

  - ### writeMetadata

    public void writeMetadata(Object info) throws Exception
    Writes a specific piece of metadata (such as an attribute) into the file. If an HDF(4&5) attribute exists in the file, this method updates its value. If the attribute does not exist in the file, it creates the attribute in the file and attaches it to the object. It will fail to write a new attribute to the object where an attribute with the same name already exists. To update the value of an existing attribute in the file, one needs to get the instance of the attribute by getMetadata(), change its values, then use writeMetadata() to write the value.
    Specified by:
      `writeMetadata` in interface `MetaDataContainer`
    Parameters:
      `info` - the metadata to write.
    Throws:
      `Exception` - if the metadata can not be written

  - ### removeMetadata

    public void removeMetadata(Object info) throws hdf.hdflib.HDFException
    Deletes an existing piece of metadata from this object.
    Specified by:
      `removeMetadata` in interface `MetaDataContainer`
    Parameters:
      `info` - the metadata to delete.
    Throws:
      `hdf.hdflib.HDFException` - if the metadata can not be removed

  - ### updateMetadata

    public void updateMetadata(Object info) throws Exception
    Updates an existing piece of metadata attached to this object.
    Specified by:
      `updateMetadata` in interface `MetaDataContainer`
    Parameters:
      `info` - the metadata to update.
    Throws:
      `Exception` - if the metadata can not be updated

  - ### open

    public long open()
    Description copied from class: `HObject`
    Opens an existing object such as a dataset or group for access. The return value is an object identifier obtained by implementing classes such as H5.H5Dopen(). This function is needed to allow other objects to be able to access the object. For instance, H5File class uses the open() function to obtain object identifier for copyAttributes(long src_id, long dst_id) and other purposes. The open() function should be used in pair with close(long) function.
    Specified by:
      `open` in class `HObject`
    Returns:
      the object identifier if successful; otherwise returns a negative value.
    See Also:
      - `HObject.close(long)`

  - ### close

    public void close(long grid)
    Description copied from class: `HObject`
    Closes access to the object. Sub-classes must implement this interface because different data objects have their own ways of how the data resources are closed. For example, H5Group.close() calls the hdf.hdf5lib.H5.H5Gclose() method and closes the group resource specified by the group id.
    Specified by:
      `close` in class `HObject`
    Parameters:
      `grid` - The object identifier.

  - ### init

    public void init()
    Description copied from interface: `DataFormat`
    Set the initial state of all the variables
    Specified by:
      `init` in interface `DataFormat`

  - ### readPalette

    public byte[][] readPalette(int idx)
    Description copied from class: `ScalarDS`
    Reads a specific image palette from file. A scalar dataset may have multiple palettes attached to it. readPalette(int idx) returns a specific palette identified by its index.
    Overrides:
      `readPalette` in class `ScalarDS`
    Parameters:
      `idx` - the index of the palette to read.
    Returns:
      the image palette

  - ### getNumberOfPalettes

    public int getNumberOfPalettes()
    Description copied from class: `ScalarDS`
    Get the number of pallettes for this object.
    Overrides:
      `getNumberOfPalettes` in class `ScalarDS`
    Returns:
      the number of palettes if it has any, 0 if there is no palette attribute attached to this dataset.

  - ### getPalette

    public byte[][] getPalette()
    Description copied from class: `ScalarDS`
    Returns the palette of this scalar dataset or null if palette does not exist. A Scalar dataset can be displayed as spreadsheet data or an image. When a scalar dataset is displayed as an image, the palette or color table may be needed to translate a pixel value to color components (for example, red, green, and blue). Some scalar datasets have no palette and some datasets have one or more than one palettes. If an associated palette exists but is not loaded, this interface retrieves the palette from the file and returns the palette. If the palette is loaded, it returns the palette. It returns null if there is no palette associated with the dataset. Current implementation only supports palette model of indexed RGB with 256 colors. Other models such as YUV", "CMY", "CMYK", "YCbCr", "HSV will be supported in the future. The palette values are stored in a two-dimensional byte array and are arranges by color components of red, green and blue. palette[][] = byte[3][256], where, palette[0][], palette[1][] and palette[2][] are the red, green and blue components respectively. Sub-classes have to implement this interface. HDF4 and HDF5 images use different libraries to retrieve the associated palette.
    Overrides:
      `getPalette` in class `ScalarDS`
    Returns:
      the 2D palette byte array.

  - ### getComponentCount

    public int getComponentCount()
    Returns the number of components of this image data.
    Returns:
      the number of components

  - ### create

    public static H4GRImage create(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, int ncomp, int interlace, Object data) throws Exception
    Creates a new image.
    Parameters:
      `name` - the name of the dataset to create.
      `pgroup` - the parent group of the new dataset.
      `type` - the datatype of the dataset.
      `dims` - the dimension size of the dataset.
      `maxdims` - the max dimension size of the dataset.
      `chunks` - the chunk size of the dataset.
      `gzip` - the level of the gzip compression.
      `ncomp` - number of components of the image data.
      `interlace` - the interlace mode.
      `data` - the array of data values.
    Returns:
      the new image if successful. Otherwise returns null.
    Throws:
      `Exception` - if the image can not be created

  - ### getMetadata

    public List getMetadata(int... attrPropList) throws Exception
    Retrieves the object's metadata, such as attributes, from the file. Metadata, such as attributes, is stored in a List.
    Parameters:
      `attrPropList` - the list of properties to get
    Returns:
      the list of metadata objects.
    Throws:
      `Exception` - if the metadata can not be retrieved