Serialized Form

  • Package ncsa.hdf.hdf5lib

  • Package ncsa.hdf.hdf5lib.exceptions

  • Package ncsa.hdf.hdf5lib.structs

    • Class ncsa.hdf.hdf5lib.structs.H5_ih_info_t

      class H5_ih_info_t extends Object implements Serializable
      serialVersionUID:
      -142238015615462707L
      • Serialized Fields

        • heap_size
          long heap_size
        • index_size
          long index_size
    • Class ncsa.hdf.hdf5lib.structs.H5A_info_t

      class H5A_info_t extends Object implements Serializable
      serialVersionUID:
      2791443594041667613L
      • Serialized Fields

        • corder
          long corder
        • corder_valid
          boolean corder_valid
        • cset
          int cset
        • data_size
          long data_size
    • Class ncsa.hdf.hdf5lib.structs.H5AC_cache_config_t

      class H5AC_cache_config_t extends Object implements Serializable
      serialVersionUID:
      -6748085696476149972L
      • Serialized Fields

        • apply_empty_reserve
          boolean apply_empty_reserve
        • apply_max_decrement
          boolean apply_max_decrement
        • apply_max_increment
          boolean apply_max_increment
        • close_trace_file
          boolean close_trace_file
        • decr_mode
          int decr_mode
        • decrement
          double decrement
        • dirty_bytes_threshold
          int dirty_bytes_threshold
        • empty_reserve
          double empty_reserve
        • epoch_length
          long epoch_length
        • epochs_before_eviction
          int epochs_before_eviction
        • evictions_enabled
          boolean evictions_enabled
        • flash_incr_mode
          int flash_incr_mode
        • flash_multiple
          double flash_multiple
        • flash_threshold
          double flash_threshold
        • incr_mode
          int incr_mode
        • increment
          double increment
        • initial_size
          long initial_size
        • lower_hr_threshold
          double lower_hr_threshold
        • max_decrement
          long max_decrement
        • max_increment
          long max_increment
        • max_size
          long max_size
        • metadata_write_strategy
          int metadata_write_strategy
        • min_clean_fraction
          double min_clean_fraction
        • min_size
          long min_size
        • open_trace_file
          boolean open_trace_file
        • rpt_fcn_enabled
          boolean rpt_fcn_enabled
        • set_initial_size
          boolean set_initial_size
        • trace_file_name
          String trace_file_name
        • upper_hr_threshold
          double upper_hr_threshold
        • version
          int version
    • Class ncsa.hdf.hdf5lib.structs.H5G_info_t

      class H5G_info_t extends Object implements Serializable
      serialVersionUID:
      -3746463015312132912L
      • Serialized Fields

        • max_corder
          long max_corder
        • mounted
          boolean mounted
        • nlinks
          long nlinks
        • storage_type
          int storage_type
    • Class ncsa.hdf.hdf5lib.structs.H5L_info_t

      class H5L_info_t extends Object implements Serializable
      serialVersionUID:
      -4754320605310155033L
      • Serialized Fields

        • address_val_size
          long address_val_size
        • corder
          long corder
        • corder_valid
          boolean corder_valid
        • cset
          int cset
        • type
          int type
    • Class ncsa.hdf.hdf5lib.structs.H5O_hdr_info_t

      class H5O_hdr_info_t extends Object implements Serializable
      serialVersionUID:
      7883826382952577189L
      • Serialized Fields

        • flags
          int flags
        • mesg_present
          long mesg_present
        • mesg_shared
          long mesg_shared
        • nchunks
          int nchunks
        • nmesgs
          int nmesgs
        • space_free
          long space_free
        • space_mesg
          long space_mesg
        • space_meta
          long space_meta
        • space_total
          long space_total
        • version
          int version
    • Class ncsa.hdf.hdf5lib.structs.H5O_info_t

      class H5O_info_t extends Object implements Serializable
      serialVersionUID:
      4691681163544054518L
      • Serialized Fields

        • addr
          long addr
        • atime
          long atime
        • btime
          long btime
        • ctime
          long ctime
        • fileno
          long fileno
        • hdr
          H5O_hdr_info_t hdr
        • meta_size_attr
          H5_ih_info_t meta_size_attr
        • meta_size_obj
          H5_ih_info_t meta_size_obj
        • mtime
          long mtime
        • num_attrs
          long num_attrs
        • rc
          int rc
        • type
          int type
  • Package ncsa.hdf.hdflib

  • Package ncsa.hdf.object

    • Class ncsa.hdf.object.Attribute

      class Attribute extends Object implements Serializable
      serialVersionUID:
      2072473407027648309L
      • Serialized Fields

        • dims
          long[] dims
          The dimension sizes of the attribute.
        • isScalar
          boolean isScalar
          flag to indicate if the dataset is a single scalar point
        • isUnsigned
          boolean isUnsigned
          Flag to indicate if the datatype is an unsigned integer.
        • name
          String name
          The name of the attribute.
        • properties
          Map<String,Object> properties
          additional information and properties for the attribute
        • rank
          int rank
          The rank of the data value of the attribute.
        • type
          Datatype type
          The datatype of the attribute.
        • value
          Object value
          The value of the attribute.
    • Class ncsa.hdf.object.CompoundDS

      class CompoundDS extends Dataset implements Serializable
      serialVersionUID:
      -4880399929644095662L
      • Serialized Fields

        • isMemberSelected
          boolean[] isMemberSelected
          The array to store flags to indicate if a member of compound dataset is selected for read/write.

          If a member is selected, the read/write will perform on the member. Applications such as HDFView will only display the selected members of the compound dataset.

           For example, if a compound dataset has four members
               String[] memberNames = {"X", "Y", "Z", "TIME"};
           and
               boolean[] isMemberSelected = {true, false, false, true};
           members "X" and "TIME" are selected for read and write.
           
        • memberDims
          Object[] memberDims
          The dimension sizes of each member.

          The i-th element of the Object[] is an integer array (int[]) that contains the dimension sizes of the i-th member.

        • memberNames
          String[] memberNames
          The names of members of the compound dataset.
        • memberOrders
          int[] memberOrders
          Returns array containing the total number of elements of the members of compound.

          For example, a compound dataset COMP has members of A, B and C as

               COMP {
                   int A;
                   float B[5];
                   double C[2][3];
               }
           
          memberOrders is an integer array of {1, 5, 6} to indicate that member A has one element, member B has 5 elements, and member C has 6 elements.
        • memberTypes
          Datatype[] memberTypes
          The datatypes of compound members.
        • numberOfMembers
          int numberOfMembers
          The number of members of the compound dataset.
    • Class ncsa.hdf.object.Dataset

      class Dataset extends HObject implements Serializable
      serialVersionUID:
      -3360885430038261178L
      • Serialized Fields

        • chunkSize
          long[] chunkSize
          The array of dimension sizes for a chunk.
        • compression
          String compression
          The compression information.
        • convertByteToString
          boolean convertByteToString
          Flag to indicate if the byte[] array is converted to strings
        • convertedBuf
          Object convertedBuf
          The array that holds the converted data of unsigned C-type integers.

          For example, Suppose that the original data is an array of unsigned 16-bit short integers. Since Java does not support unsigned integer, the data is converted to an array of 32-bit singed integer. In that case, the converted buffer is the array of 32-bit singed integer.

        • data
          Object data
          The memory buffer that holds the raw data of the dataset.
        • datatype
          Datatype datatype
          The datatype object of the dataset.
        • dimNames
          String[] dimNames
          Array of strings that represent the dimension names. It is null if dimension names do not exist.
        • dims
          long[] dims
          The current dimension sizes of the dataset
        • enumConverted
          boolean enumConverted
          Flag to indicate if the enum data is converted to strings.
        • filters
          String filters
          The filters information.
        • isDataLoaded
          boolean isDataLoaded
          Flag to indicate if data values are loaded into memory.
        • maxDims
          long[] maxDims
          The max dimension sizes of the dataset
        • nPoints
          long nPoints
          The number of data points in the memory buffer.
        • originalBuf
          Object originalBuf
          The data buffer that contains the raw data directly reading from file (before any data conversion).
        • rank
          int rank
          The number of dimensions of the dataset.
        • selectedDims
          long[] selectedDims
          Array that contains the number of data points selected (for read/write) in each dimension.

          The select size must be less than or equal to the current dimension size. A subset of a rectangle selection is defined by the starting position and selected sizes.

          For example, a 4 X 5 dataset

               0,  1,  2,  3,  4
              10, 11, 12, 13, 14
              20, 21, 22, 23, 24
              30, 31, 32, 33, 34
           long[] dims = {4, 5};
           long[] startDims = {1, 2};
           long[] selectedDims = {3, 3};
           then the following subset is selected by the startDims and selectedDims above
               12, 13, 14
               22, 23, 24
           32, 33, 34
        • selectedIndex
          int[] selectedIndex
          Array that contains the indices of the dimensions selected for display.

          selectedIndex[] is provided for two purpose:

          1. selectedIndex[] is used to indicate the order of dimensions for display, i.e. selectedIndex[0] = row, selectedIndex[1] = column and selectedIndex[2] = depth. For example, for a four dimension dataset, if selectedIndex[] is {1, 2, 3}, then dim[1] is selected as row index, dim[2] is selected as column index and dim[3] is selected as depth index.
          2. selectedIndex[] is also used to select dimensions for display for datasets with three or more dimensions. We assume that applications such as HDFView can only display data up to three dimensions (a 2D spreadsheet/image with a third dimension that the 2D spreadsheet/image is cut from). For dataset with more than three dimensions, we need selectedIndex[] to store which three dimensions are chosen for display. For example, for a four dimension dataset, if selectedIndex[] = {1, 2, 3}, then dim[1] is selected as row index, dim[2] is selected as column index and dim[3] is selected as depth index. dim[0] is not selected. Its location is fixed at 0 by default.
        • selectedStride
          long[] selectedStride
          The number of elements to move from the start location in each dimension. For example, if selectedStride[0] = 2, every other data point is selected along dim[0].
        • startDims
          long[] startDims
          The starting position of each dimension of a selected subset. With both the starting position and selected sizes, the subset of a rectangle selection is fully defined.
        • storage
          String storage
          The storage information.
    • Class ncsa.hdf.object.Datatype

      class Datatype extends HObject implements Serializable
      serialVersionUID:
      -581324710549963177L
      • Serialized Fields

        • baseType
          Datatype baseType
          The base datatype of every element of the array (for CLASS_ARRAY datatype).
        • datatypeClass
          int datatypeClass
          The class of the datatype.
        • datatypeOrder
          int datatypeOrder
          The byte order of the datatype. Valid values are ORDER_LE, ORDER_BE, and ORDER_VAX.
        • datatypeSign
          int datatypeSign
          The sign of the datatype.
        • datatypeSize
          int datatypeSize
          The size (in bytes) of the datatype.
        • dims
          long[] dims
        • enumMembers
          String enumMembers
          The (name, value) pairs of enum members
    • Class ncsa.hdf.object.FileFormat

      class FileFormat extends File implements Serializable
      serialVersionUID:
      -4700692313888420796L
      • Serialized Fields

        • fid
          int fid
          File identifier. -1 indicates the file is not open.
        • fullFileName
          String fullFileName
          The absolute pathname (path+name) of the file.
        • isReadOnly
          boolean isReadOnly
          Flag indicating if the file access is read-only.
        • max_members
          int max_members
          Current Java applications, such as HDFView, cannot handle files with large numbers of objects due to JVM memory limitations. For example, 1,000,000 objects is too many. max_members is defined so that applications such as HDFView will load up to max_members objects starting with the start_members -th object. The implementing class has freedom in its interpretation of how to "count" objects in the file.
        • start_members
          int start_members
    • Class ncsa.hdf.object.Group

      class Group extends HObject implements Serializable
      serialVersionUID:
      3913174542591568052L
      • Serialized Fields

        • memberList
          List<HObject> memberList
          The list of members (Groups and Datasets) of this group in memory.
        • nMembersInFile
          int nMembersInFile
          Total number of (Groups and Datasets) of this group in file.
        • parent
          Group parent
          The parent group where this group is located. The parent of the root group is null.
    • Class ncsa.hdf.object.HObject

      class HObject extends Object implements Serializable
      serialVersionUID:
      -1723666708199882519L
      • Serialized Fields

        • fileFormat
          FileFormat fileFormat
          The file which contains the object
        • filename
          String filename
          The full path of the file that contains the object.
        • fullName
          String fullName
          The full name of the data object, i.e. "path + name"
        • linkTargetObjName
          String linkTargetObjName
          The name of the Target Object that is being linked to.
        • name
          String name
          The name of the data object. The root group has its default name, a slash. The name can be changed except the root group.
        • oid
          long[] oid
          Array of long integer storing unique identifier for the object.

          HDF4 objects are uniquely identified by a (ref_id, tag_id) pair. i.e. oid[0]=tag, oid[1]=ref.
          HDF5 objects are uniquely identified by an object reference.

        • path
          String path
          The full path of the data object. The full path always starts with the root, a slash. The path cannot be changed. Also, a path must ended with a slash. For example, /arrays/ints/
    • Class ncsa.hdf.object.ScalarDS

      class ScalarDS extends Dataset implements Serializable
      serialVersionUID:
      8925371455928203981L
      • Serialized Fields

        • fillValue
          Object fillValue
          The fill value of the dataset.
        • filteredImageValues
          List<Number> filteredImageValues
        • imageDataRange
          double[] imageDataRange
          The min-max range of image data values. For example, [0, 255] indicates the min is 0, and the max is 255.
        • interlace
          int interlace
          The interlace mode of the stored raster image data. Valid values are INTERLACE_PIXEL, INTERLACE_LINE and INTERLACE_PLANE.
        • isDefaultImageOrder
          boolean isDefaultImageOrder
          Flag to indicate if the dataset is displayed as an image with default order of dimensions
        • isFillValueConverted
          boolean isFillValueConverted
          Flag to indicate if the FillValue is converted from unsigned C.
        • isImage
          boolean isImage
          True if this dataset is an image.
        • isImageDisplay
          boolean isImageDisplay
          Flag to indicate if the dataset is displayed as an image
        • isText
          boolean isText
          True if this dataset is ASCII text.
        • isTrueColor
          boolean isTrueColor
          True if this dataset is a true color image.
        • isUnsigned
          boolean isUnsigned
          Flag to indicate if the original C data is unsigned integer.
        • palette
          byte[][] palette
          The indexed RGB color model with 256 colors.

          The palette values are stored in a two-dimensional byte array and arrange 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.

        • unsignedConverted
          boolean unsignedConverted
          Flag to indicate is the original unsigned C data is converted.