public interface NetCDFService
extends loci.common.services.Service
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes and resets the service.
|
java.lang.Object |
getArray(java.lang.String path,
int[] origin,
int[] shape)
Retrieves an HDF path's values.
|
java.util.Vector<java.lang.String> |
getAttributeList()
Retrieves an exhaustive list of the HDF paths for all attributes in the
HDF document.
|
java.lang.String |
getAttributeValue(java.lang.String path)
Retrieves an attribute's value.
|
int |
getDimension(java.lang.String path)
Retrieves the length of a dimension.
|
java.lang.String |
getFile()
Retrieves the current initialized file path.
|
java.util.Hashtable<java.lang.String,java.lang.Object> |
getVariableAttributes(java.lang.String path)
Retrieves all of a variable's attributes.
|
java.util.Vector<java.lang.String> |
getVariableList()
Retrieves an exhaustive list of the HDF paths for all variables in the
HDF document.
|
java.lang.Object |
getVariableValue(java.lang.String path)
Retrieves a variable's value.
|
void |
setFile(java.lang.String file)
Initializes the service on a given file path.
|
void setFile(java.lang.String file) throws java.io.IOException
file
- Path to initialize the service with.java.io.IOException
- If there is an error initializing the service
with file
.java.lang.String getFile()
null
if the service
has yet to be initialized or is closed.java.util.Vector<java.lang.String> getAttributeList()
java.util.Vector<java.lang.String> getVariableList()
java.lang.String getAttributeValue(java.lang.String path)
path
- HDF path to the attribute.null
if the attribute is not a
string.java.lang.Object getVariableValue(java.lang.String path) throws loci.common.services.ServiceException
path
- HDF path to the variable.loci.common.services.ServiceException
- If there is an error with the range of values
or reading from the file.Array.copyTo1DJavaArray()
java.lang.Object getArray(java.lang.String path, int[] origin, int[] shape) throws loci.common.services.ServiceException
path
- HDF path to the values.origin
- Array specifying the starting index. If null, assume
all zeroes.shape
- Array specifying the extents in each dimension. This
becomes the shape of the returned Array.loci.common.services.ServiceException
- If there is an error with the range of values
or reading from the file.Variable.read(int[], int[])
,
Array.copyToNDJavaArray()
java.util.Hashtable<java.lang.String,java.lang.Object> getVariableAttributes(java.lang.String path)
path
- HDF path to the variable.Array.copyTo1DJavaArray()
int getDimension(java.lang.String path)
path
- HDF path to the dimension.void close() throws java.io.IOException
java.io.IOException
- If there is an error closing the file.Copyright © 2020 Open Microscopy Environment