public class NetCDFUtilities extends Object
Modifier and Type | Class and Description |
---|---|
static class |
NetCDFUtilities.Axis
Global attribute for coordinate coverageDescriptorsCache.
|
static class |
NetCDFUtilities.CheckType |
static class |
NetCDFUtilities.FileFormat |
static class |
NetCDFUtilities.ParameterBehaviour |
Modifier and Type | Method and Description |
---|---|
static NetcdfDataset |
acquireDataset(URI uri) |
static NetcdfDataset |
acquireFeatureCollection(String path) |
static void |
addIgnoredDimension(String dimensionName)
Adds a dimension to the ignored dimensions set.
|
static SimpleFeatureType |
createFeatureType(String schemaName,
String schemaDef,
CoordinateReferenceSystem crs) |
static Array |
getArray(int[] dimensions,
DataType varDataType)
Get an Array of proper size and type.
|
static Format |
getAxisFormat(AxisType type,
String prototype)
Returns a format to use for parsing values along the specified axis type.
|
static NetCDFUtilities.CheckType |
getCheckType(NetcdfDataset dataset)
Depending on the type of model/netcdf file, we will check for the presence of some
coverageDescriptorsCache rather than some others.
|
static NetcdfDataset |
getDataset(Object input)
Returns a
NetcdfDataset given an input object |
static int |
getDimensionLength(Variable var,
int dimensionIndex) |
static File |
getFile(Object input)
Checks if the input is file based, and if yes, returns the file.
|
static NetCDFUtilities.FileFormat |
getFormat(URI uri) |
static Set<String> |
getIgnoredDimensions() |
static DataType |
getNetCDFDataType(String classDataType)
Return the propery NetCDF dataType for the input datatype class
|
static Number |
getNodata(Variable var)
Utility method for getting NoData from an input
Variable |
static NetCDFUtilities.ParameterBehaviour |
getParameterBehaviour(String parameter) |
static NumberRange |
getRange(Variable var)
Utility method for getting Range from an input
Variable |
static int |
getRawDataType(VariableIF variable)
Returns the data type which most closely represents the "raw" internal data of the variable.
|
static Set<String> |
getUnsupportedDimensions() |
static int |
getZDimensionLength(Variable var)
Get Z Dimension Lenght for standard CF variables
|
static boolean |
isATime(String classDataType)
Return true in case that dataType refers to something which need to be handled as a Time
(TimeStamp, Date)
|
static boolean |
isCheckCoordinatePlugins() |
static boolean |
isGribAvailable() |
static boolean |
isNC4CAvailable() |
static boolean |
isValidDir(File file) |
static boolean |
isVariableAccepted(String name,
NetCDFUtilities.CheckType checkType)
NetCDF files may contain a wide set of coverageDescriptorsCache.
|
static boolean |
isVariableAccepted(Variable var,
NetCDFUtilities.CheckType checkType)
NetCDF files may contains a wide set of coverageDescriptorsCache.
|
static boolean |
isVariableAccepted(Variable var,
NetCDFUtilities.CheckType checkType,
NetcdfDataset dataset)
NetCDF files may contains a wide set of coverageDescriptorsCache.
|
static void |
refreshParameterBehaviors() |
static DataType |
transcodeImageDataType(int dataType)
Transcode a DataBuffer type into a NetCDF DataType .
|
static int |
transcodeNetCDFDataType(DataType type,
boolean unsigned)
Transcode a NetCDF data type into a java2D DataBuffer type.
|
static Number |
transcodeNumber(DataType type,
Number value)
Transcode a NetCDF Number into a proper Number instance.
|
public static final boolean CHECK_COORDINATE_PLUGINS
public static final String CHECK_COORDINATE_PLUGINS_KEY
public static final String NETCDF4_MIMETYPE
public static final String NETCDF3_MIMETYPE
public static final String NETCDF
public static final String NETCDF4
public static final String NETCDF_4C
public static final String NETCDF_3
public static final String STANDARD_PARALLEL_1
public static final String STANDARD_PARALLEL_2
public static final String CENTRAL_MERIDIAN
public static final String LATITUDE_OF_ORIGIN
public static final String SCALE_FACTOR
public static final String FALSE_EASTING
public static final String FALSE_NORTHING
public static final String SEMI_MINOR
public static final String SEMI_MAJOR
public static final String INVERSE_FLATTENING
public static final String UNKNOWN
public static final double DEFAULT_EARTH_RADIUS
public static final Boolean TRACE_ENABLED
public static final String EXTERNAL_DATA_DIR
public static final String NETCDF_DATA_DIR
public static final String FILL_VALUE
public static final String MISSING_VALUE
public static final String ACTUAL_RANGE
public static final String VALID_RANGE
public static final String VALID_MIN
public static final String VALID_MAX
public static final String LOWER_LEFT_LONGITUDE
public static final String LOWER_LEFT_LATITUDE
public static final String UPPER_RIGHT_LONGITUDE
public static final String UPPER_RIGHT_LATITUDE
public static final String COORDSYS
public static final String Y
public static final String Y_COORD_PROJ
public static final String Y_PROJ_COORD
public static final String X
public static final String X_COORD_PROJ
public static final String X_PROJ_COORD
public static final String LATITUDE
public static final String LAT
public static final String LONGITUDE
public static final String LON
public static final String GRID_LATITUDE
public static final String RLAT
public static final String GRID_LONGITUDE
public static final String RLON
public static final String DEPTH
public static final String ZETA
public static final String BOUNDS
public static final String HEIGHT
public static final String TIME
public static final String POSITIVE
public static final String UNITS
public static final String NAME
public static final String LONG_NAME
public static final String ELEVATION_DIM
public static final String TIME_DIM
public static final String STANDARD_NAME
public static final String DESCRIPTION
public static final String M
public static final String BOUNDS_SUFFIX
public static final String LON_UNITS
public static final String LAT_UNITS
public static final String RLATLON_UNITS
public static final String NO_COORDS
public static final String TIME_ORIGIN
public static final long START_TIME
public static final String BOUNDARY_DIMENSION
public static final TimeZone UTC
public static final String GRID_MAPPING
public static final String GRID_MAPPING_NAME
public static final String COORDINATE_AXIS_TYPE
public static final String CONVENTIONS
public static final String COORD_SYS_BUILDER
public static final String COORD_SYS_BUILDER_CONVENTION
public static final String COORDINATE_TRANSFORM_TYPE
public static final String COORDINATES
public static final String SPATIAL_REF
public static final String GEO_TRANSFORM
public static final String CERP_ESRI_PE_STRING
public static final String UNIQUE_TIME_ATTRIBUTE
public static final String ENHANCE_COORD_SYSTEMS
public static final String ENHANCE_SCALE_MISSING
public static final String ENHANCE_CONVERT_ENUMS
public static final String ENHANCE_SCALE_MISSING_DEFER
public static boolean ENHANCE_SCALE_OFFSET
public static final String STORE_NAME
public static final int X_DIMENSION
#variable
to use as image
width. The actual dimension is variable.getRank() - X_DIMENSION
. Is hard-coded
because the loop in the read
method expects this order.public static final int Y_DIMENSION
#variable
to use as image
height. The actual dimension is variable.getRank() - Y_DIMENSION
. Is hard-coded
because the loop in the read
method expects this order.public static final int Z_DIMENSION
#variable
to use as Z
dimension. The actual dimension is variable.getRank() - Z_DIMENSION
.
public static final Set<DataType> VALID_TYPES
public static final String NC4_ERROR_MESSAGE
public static final String PARAMS_MAX_KEY
public static final String PARAMS_MIN_KEY
public static boolean isValidDir(File file)
public static int getZDimensionLength(Variable var)
var
- public static int getDimensionLength(Variable var, int dimensionIndex)
public static int getRawDataType(VariableIF variable)
NetcdfImageReader#getRawDataType
.variable
- The variable.DataBuffer.TYPE_UNDEFINED
if unknown.NetcdfImageReader#getRawDataType
public static int transcodeNetCDFDataType(DataType type, boolean unsigned)
type
- the DataType
to transcode.unsigned
- if the original data is unsigned or notpublic static boolean isVariableAccepted(Variable var, NetCDFUtilities.CheckType checkType)
true
if the specified variable is accepted.public static boolean isVariableAccepted(Variable var, NetCDFUtilities.CheckType checkType, NetcdfDataset dataset)
true
if the specified variable is accepted.public static boolean isVariableAccepted(String name, NetCDFUtilities.CheckType checkType)
true
if the specified variable is accepted.public static NetCDFUtilities.FileFormat getFormat(URI uri) throws IOException
IOException
public static NetcdfDataset acquireFeatureCollection(String path) throws IOException
IOException
public static NetcdfDataset acquireDataset(URI uri) throws IOException
IOException
public static NetcdfDataset getDataset(Object input) throws IOException
NetcdfDataset
given an input objectinput
- the input object (usually a File
, a
String
or a {@code FileImageInputStreamExt).NetcdfDataset
in case of success.IOException
- if some error occur while opening the dataset.{@link
- IllegalArgumentException}
in case the specified input is a directorypublic static File getFile(Object input) throws IOException
input
- the input to check.null
if it is not file based.IOException
public static Format getAxisFormat(AxisType type, String prototype)
DateFormat
using the "yyyy-MM-dd HH:mm:ss"
pattern in UTC timezone.
NumberFormat
.
The Canada locale is used by default for most formats because it is relatively close to ISO (for example regarding days and months order in dates) while using the English symbols.
type
- The type of the axis.prototype
- An example of the values to be parsed. Implementations may parse this
prototype when the axis type alone is not sufficient. For example the time axis type should uses the "yyyy-MM-dd"
date pattern, but some
files do not follow this convention and use the default local instead.public static NetCDFUtilities.CheckType getCheckType(NetcdfDataset dataset)
dataset
- the input dataset.NetCDFUtilities.CheckType
to be performed on the specified dataset.public static SimpleFeatureType createFeatureType(String schemaName, String schemaDef, CoordinateReferenceSystem crs)
schemaDef
- crs
- public static boolean isGribAvailable()
public static boolean isNC4CAvailable()
public static boolean isCheckCoordinatePlugins()
public static Set<String> getUnsupportedDimensions()
public static Set<String> getIgnoredDimensions()
public static void addIgnoredDimension(String dimensionName)
public static Number getNodata(Variable var)
Variable
var
- Variable instancepublic static NumberRange getRange(Variable var)
Variable
var
- Variable instancepublic static DataType getNetCDFDataType(String classDataType)
classDataType
- public static DataType transcodeImageDataType(int dataType)
type
- the beam ProductData
type to transcode.public static final boolean isATime(String classDataType)
classDataType
- public static Array getArray(int[] dimensions, DataType varDataType)
dimensions
- the dimensionsvarDataType
- the DataType of the required arraypublic static Number transcodeNumber(DataType type, Number value)
type
- the DataType
to transcode.public static void refreshParameterBehaviors()
public static NetCDFUtilities.ParameterBehaviour getParameterBehaviour(String parameter)
Copyright © 1996–2019 Geotools. All rights reserved.