ucar.nc2.constants.CF Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of netcdf Show documentation
Show all versions of netcdf Show documentation
The NetCDF-Java Library is a Java interface to NetCDF files,
as well as to many other types of scientific data formats.
/*
* Copyright 1998-2009 University Corporation for Atmospheric Research/Unidata
*
* Portions of this software were developed by the Unidata Program at the
* University Corporation for Atmospheric Research.
*
* Access and use of this software shall impose the following obligations
* and understandings on the user. The user is granted the right, without
* any fee or cost, to use, copy, modify, alter, enhance and distribute
* this software, and any derivative works thereof, and its supporting
* documentation for any purpose whatsoever, provided that this entire
* notice appears in all copies of the software, derivative works and
* supporting documentation. Further, UCAR requests that the user credit
* UCAR/Unidata in any publications that result from the use of this
* software or in any product that includes this software. The names UCAR
* and/or Unidata, however, may not be used in any advertising or publicity
* to endorse or promote any products or commercial entity unless specific
* written permission is obtained from UCAR/Unidata. The user also
* understands that UCAR/Unidata is not obligated to provide the user with
* any support, consulting, training or assistance of any kind with regard
* to the use, operation and performance of this software nor to provide
* the user with any updates, revisions, new versions or "bug fixes."
*
* THIS SOFTWARE IS PROVIDED BY UCAR/UNIDATA "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL UCAR/UNIDATA BE LIABLE FOR ANY SPECIAL,
* INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
* FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
* NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
* WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
*/
package ucar.nc2.constants;
import ucar.nc2.NetcdfFile;
/**
* Constants used in CF Conventions.
*
* @author caron
* @since Jan 21, 2009
*/
public interface CF {
public final static String POSITIVE_UP = "up";
public final static String POSITIVE_DOWN = "down";
public static final String featureTypeAtt4 = "CF:featureType";
public static final String featureTypeAtt2 = "CF-featureType";
public static final String featureTypeAtt3 = "CFfeatureType";
public static final String featureTypeAtt = "featureType";
// standard attributes
public static final String ADD_OFFSET = "add_offset";
public final static String COORDINATES = "coordinates";
public static final String GRID_MAPPING = "grid_mapping";
public static final String GRID_MAPPING_NAME = "grid_mapping_name";
public static final String MISSING_VALUE = "missing_value";
public static final String SCALE_FACTOR = "scale_factor";
public static final String STANDARD_NAME = "standard_name";
public static final String UNITS = "units";
// proposed attributes
public static final String RAGGED_ROWSIZE = "CF:ragged_row_count";
public static final String RAGGED_PARENTINDEX = "CF:ragged_parent_index";
// proposed standard_names
public static final String STATION_ID = "station_id";
public static final String STATION_DESC = "station_desc";
public static final String STATION_ALTITUDE = "surface_altitude";
public static final String STATION_WMOID = "station_WMO_id";
public static final String TRAJ_ID = "trajectory_id";
public static final String PROFILE_ID = "profile_id";
/**
* Start of map from CF feature type names to our FeatureType enums.
* Unofficial.
*/
public enum FeatureType {
point, timeSeries, profile, trajectory, timeSeriesProfile, trajectoryProfile;
public static FeatureType convert(ucar.nc2.constants.FeatureType ft) {
switch (ft) {
case POINT:
return CF.FeatureType.point;
case STATION:
return CF.FeatureType.timeSeries;
case PROFILE:
return CF.FeatureType.profile;
case TRAJECTORY:
return CF.FeatureType.trajectory;
case STATION_PROFILE:
return CF.FeatureType.timeSeriesProfile;
case SECTION:
return CF.FeatureType.trajectoryProfile;
}
return null;
}
/*
1) The CF discrete sampling proposal will be the recommended one for point data when thats finalized. Unfortunately, it will be somewhat different from whats gone before. The CF: prefix is dropped until the namespace proposal can be completed. So those feature types are now proposed to be:
* point: one or more parameters measured at a set of points in time and space
* timeSeries: a time-series of data points at the same location, with varying time
* trajectory: a connected set of data points along a 1D curve in time and space
* profile: a set of data points along a vertical line
* timeSeriesProfile: a time-series of profiles at a named location
* trajectoryProfile: a collection of profiles which originate along a trajectory
The CDM will be backwards compatible, including:
* accepting the CF: prefix
* being case insensitive
* "station" and "stationTimeSeries"as aliases for "timeSeries"
* "stationProfile" as alias for "timeSeriesProfile"
* "section" as alias for "trajectoryProfile"
I know that CF wants to standardize on other feature types also. Its hard to anticipate what they will come with, but its likely:
* grid
* swath
maybe:
* image
* radial
* unstructuredGrid
*/
public static FeatureType getFeatureType(String s) {
if (s.equalsIgnoreCase("point")) return FeatureType.point;
if (s.equalsIgnoreCase("timeSeries")) return FeatureType.timeSeries;
if (s.equalsIgnoreCase("stationTimeSeries")) return FeatureType.timeSeries;
if (s.equalsIgnoreCase("station")) return FeatureType.timeSeries;
if (s.equalsIgnoreCase("profile")) return FeatureType.profile;
if (s.equalsIgnoreCase("trajectory")) return FeatureType.trajectory;
if (s.equalsIgnoreCase("timeSeriesProfile")) return FeatureType.timeSeriesProfile;
if (s.equalsIgnoreCase("stationProfile")) return FeatureType.timeSeriesProfile;
if (s.equalsIgnoreCase("stationProfileTimeSeries")) return FeatureType.timeSeriesProfile;
if (s.equalsIgnoreCase("trajectoryProfile")) return FeatureType.trajectoryProfile;
if (s.equalsIgnoreCase("section")) return FeatureType.trajectoryProfile;
return null;
}
public static FeatureType getFeatureTypeFromGlobalAttribute(NetcdfFile ds) {
String ftypeS = ds.findAttValueIgnoreCase(null, CF.featureTypeAtt, null);
if (ftypeS == null)
ftypeS = ds.findAttValueIgnoreCase(null, CF.featureTypeAtt2, null);
if (ftypeS == null)
ftypeS = ds.findAttValueIgnoreCase(null, CF.featureTypeAtt3, null);
if (ftypeS == null)
ftypeS = ds.findAttValueIgnoreCase(null, CF.featureTypeAtt4, null);
if (ftypeS == null)
return null;
return CF.FeatureType.getFeatureType(ftypeS);
}
}
public enum CellMethods {
point, sum, mean, maximum, minimum, mid_range, standard_deviation, variance, mode, median;
/*
static public String codeTable4_10short(int code) {
switch (code) {
case 0: return "Average";
case 1: return "Accumulation";
case 2: return "Maximum";
case 3: return "Minimum";
case 4: return "Difference"; // (Value at the end of time range minus value at the beginning)";
case 5: return "RootMeanSquare";
case 6: return "StandardDeviation";
case 7: return "Covariance"; // (Temporal variance)";
case 8: return "Difference"; // (Value at the start of time range minus value at the end)";
case 9: return "Ratio";
default: return null;
}
}
*/
public static CellMethods convertGribCodeTable4_10(int code) {
switch (code) {
case 0:
return CellMethods.mean; // "Average";
case 1:
return CellMethods.sum; // "Accumulation";
case 2:
return CellMethods.maximum; // "Maximum";
case 3:
return CellMethods.minimum; // "Minimum";
//case 4: return "Difference"; // (Value at the end of time range minus value at the beginning)";
//case 5: return "RootMeanSquare";
case 6:
return CellMethods.standard_deviation; // "StandardDeviation";
case 7:
return CellMethods.variance; // "Covariance"; // (Temporal variance)";
//case 8: return "Difference"; // (Value at the start of time range minus value at the end)";
//case 9: return "Ratio";
default:
return null;
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy