| org.geotools.image.io.GeographicImageReadParam
 org.geotools.image.io.netcdf.NetcdfReadParam
| NetcdfReadParam | | public class NetcdfReadParam extends GeographicImageReadParam (Code) | | Default parameters for
NetcdfImageReader .
since:
2.4
version:
$Id: NetcdfReadParam.java 27071 2007-09-19 19:02:54Z desruisseaux $
author:
Martin Desruisseaux |
| Field Summary | |
| final static int | DEFAULT_INDICE
The default source band to read from the NetCDF file. |
| Method Summary | |
| public int | getBandDimension(VariableEnhanced variable)
Returns the dimension to assign to bands for the specified variable. | | public AxisType[] | getBandDimensionTypes()
Returns the dimension assigned to bands. | | public int | getSliceIndice(AxisType axis)
Returns the indice to set at the dimension of the specified axis. | | final boolean | hasNonDefaultIndices()
Returns
true if this set of parameters contains a least one indice
defined to a value different than 0. | | public void | setBandDimensionTypes(AxisType[] types)
Assigns the dimension of the specified types to bands. | | public void | setSliceIndice(AxisType dimension, int indice)
Sets the indice for the dimension of the specified axis. |
| NetcdfReadParam | | public NetcdfReadParam(ImageReader reader)(Code) | | Creates a new, initially empty, set of parameters.
Parameters:
reader - The reader for which this parameter block is created |
| getBandDimension | | public int getBandDimension(VariableEnhanced variable)(Code) | | Returns the dimension to assign to bands for the specified variable. The default
implementation returns the last dimension corresponding to one of the types specified
to
NetcdfReadParam.setBandDimensionTypes .
Example: For a NetCDF variable having dimensions in the
(t,z,y,x) order (as in CF convention), if the
and
types have
been
to bands, then this method will returns
the index of the z dimension, i.e.
1 .
Parameters:
variable - The variable for which we want to determine the dimension to assign to bands. The dimension assigned to bands, or -1 if none. |
| getBandDimensionTypes | | public AxisType[] getBandDimensionTypes()(Code) | | Returns the dimension assigned to bands. This method returns the values given
to the last call to
NetcdfReadParam.setBandDimensionTypes , or
null if none.
|
| getSliceIndice | | public int getSliceIndice(AxisType axis)(Code) | | Returns the indice to set at the dimension of the specified axis. This is relevant only
for n-dimensional data set where n>2. This method returns the
last value set by
NetcdfReadParam.setSliceIndice .
Parameters:
dimension - The axis type (typically or). The indice to set at the dimension of the specified axis (0 by default). |
| hasNonDefaultIndices | | final boolean hasNonDefaultIndices()(Code) | | Returns
true if this set of parameters contains a least one indice
defined to a value different than 0.
|
| setBandDimensionTypes | | public void setBandDimensionTypes(AxisType[] types)(Code) | | Assigns the dimension of the specified types to bands. For example in a NetCDF variable
having (t,y,x) dimensions, it may be useful to treat
the t dimension as bands. After invoking this method with the
value, users can select a time through the standard
NetcdfReadParam.setSourceBands API.
More than one type may be specified if they should be considered as synonymous. For example
in order to assign the z dimension to bands, it may be necessary to specify both
the
and
types.
Parameters:
type - The types of dimension to assign to bands. |
| setSliceIndice | | public void setSliceIndice(AxisType dimension, int indice)(Code) | | Sets the indice for the dimension of the specified axis. This is relevant only for
n-dimensional data set where n>2. For example in 4-D data
set with (x,y,z,t) axis, those indices
may be used by image readers for z and t dimensions.
The default value is 0 for all cases. This means that for the above-cited 4-D data set,
only the image at the first time (t=0) and first altitude (z=0)
is selected.
Parameters:
dimension - The axis type (typically or).
Parameters:
indice - The indice as a positive value. |
| Fields inherited from org.geotools.image.io.GeographicImageReadParam | final public static String DEFAULT_PALETTE_NAME(Code)(Java Doc)
|
|
|