com.pacbio.secondary.vis.io.hdf.hyperslabinfo

Class HDF5HyperslabInfo

java.lang.Object

com.pacbio.secondary.vis.io.hdf.hyperslabinfo.HDF5HyperslabInfo

public class HDF5HyperslabInfo
extends java.lang.Object

Encapsulates HDF5 Hyperslab metadata

Author:

mmilletti

Field Summary

Fields

Modifier and Type	Field and Description
protected long[]	dims
protected long[]	sel
protected long[]	start
protected long[]	stride

Constructor Summary

Constructors

Constructor and Description
HDF5HyperslabInfo(long[] start, long[] sel, long[] stride, long[] dims)

Method Summary

Methods

Modifier and Type	Method and Description
long[]	getDims() Returns the array that contains the dimension sizes of the dataset.
int	getNumDimensions() returns the number of dimensions of this hyperslab
long[]	getSelectedDims() Returns the dimension sizes of the selected subset.
long[]	getStartDims() Returns the starting position of a selected subset.
long[]	getStride() Returns the selectedStride of the selected dataset.
void	setSelectedDims(long[] sel) Sets the dimension sizes of the selected subset
void	setStartDims(long[] start) Sets the starting position of a selected subset
void	setStride(long[] stride) Sets the selectedStride of the selected subset
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

start

protected long[] start

sel

protected long[] sel

stride

protected long[] stride

dims

protected long[] dims

Constructor Detail

HDF5HyperslabInfo

public HDF5HyperslabInfo(long[] start,
                 long[] sel,
                 long[] stride,
                 long[] dims)

Parameters:

start -

sel -

stride -

dims -

Method Detail

getSelectedDims

public long[] getSelectedDims()

Returns the dimension sizes of the selected subset.

The SelectedDims is the number of data points of the selected subset. Applications can use this array to change the size of selected subset. The select size must be less than or equal to the current dimension size. Combined with the starting position, selected sizes and stride, the subset of a rectangle selection is fully defined.

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};
 long[] selectedStride = {1, 1};

 then the following subset is selected by the startDims and selectedDims
     12, 13, 14
     22, 23, 24
     32, 33, 34
 

Returns:

the dimension sizes of the selected subset.

setSelectedDims

public void setSelectedDims(long[] sel)

Sets the dimension sizes of the selected subset

Parameters:

sel -

getStartDims

public long[] getStartDims()

Returns the starting position of a selected subset.

Applications can use this array to change the starting position of a selection. Combined with the selected dimensions, selected sizes and stride, the subset of a rectangle selection is fully defined.

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};
 long[] selectedStride = {1, 1};

 then the following subset is selected by the startDims and selectedDims
     12, 13, 14
     22, 23, 24
     32, 33, 34
 

Returns:

the starting position of a selected subset.

setStartDims

public void setStartDims(long[] start)

Sets the starting position of a selected subset

Parameters:

start -

getStride

public long[] getStride()

Returns the selectedStride of the selected dataset.

Applications can use this array to change how many elements to move in each dimension. Combined with the starting position and selected sizes, the subset of a rectangle selection is defined.

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 = {0, 0};
 long[] selectedDims = {2, 2};
 long[] selectedStride = {2, 3};

 then the following subset is selected by the startDims and selectedDims
     0,   3
     20, 23
 

setStride

public void setStride(long[] stride)

Sets the selectedStride of the selected subset

Parameters:

stride -

getDims

public long[] getDims()

Returns the array that contains the dimension sizes of the dataset.

Returns:

the dimension sizes of the dataset.

getNumDimensions

public int getNumDimensions()

returns the number of dimensions of this hyperslab

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object