ucar.nc2.ft.point.standard.plug.SimpleTrajectory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdm Show documentation
The newest version!
/*
 * Copyright (c) 1998-2018 John Caron and University Corporation for Atmospheric Research/Unidata
 * See LICENSE for license information.
 */

package ucar.nc2.ft.point.standard.plug;

import ucar.nc2.Dimension;
import ucar.nc2.Variable;
import ucar.nc2.constants.FeatureType;
import ucar.nc2.dataset.NetcdfDataset;
import ucar.nc2.ft.point.standard.PointConfigXML;
import ucar.nc2.ft.point.standard.TableConfig;
import ucar.nc2.ft.point.standard.TableConfigurerImpl;
import ucar.nc2.units.DateUnit;
import ucar.nc2.units.SimpleUnit;

import java.io.IOException;
import java.util.Date;
import java.util.Formatter;
import java.util.List;

/**
 * SimpleTrajectory netcdf files
 *   One trajectory, one dimension (time), per file.
 *   The EOL trajectory datasets follow this simple layout.
 *
 * @author sarms
 * @since June 4, 2015
 */

public class SimpleTrajectory extends TableConfigurerImpl {

    private static String timeDimName = "time";
    private static String timeVarName = "time";
    private static String latVarName = "latitude";
    private static String lonVarName = "longitude";
    private static String elevVarName = "altitude";

    public boolean isMine(FeatureType wantFeatureType, NetcdfDataset ds) {
        List list = ds.getRootGroup().getDimensions();

        // should have only one dimension
        if ( list.size() != 1) {return false;}

        // dimension name should be "time"
        Dimension d = (Dimension) list.get(0);
        if ( ! d.getShortName().equals( timeDimName)) {return false;}

        // Check that have variable time(time) with units that are udunits time
        Variable var = ds.getRootGroup().findVariable( timeVarName);
        if ( var == null) {return false;}
        list = var.getDimensions();
        if ( list.size() != 1) {return false;}
        d = (Dimension) list.get(0);
        if ( ! d.getShortName().equals( timeDimName)) {return false;}
        String units = var.findAttribute( "units").getStringValue();
        Date date = DateUnit.getStandardDate("0 " + units);  // leave this as it doesnt throw an exception on failure
        if ( date == null)  {return false;}

        // Check for variable latitude(time) with units of "deg".
        var = ds.getRootGroup().findVariable( latVarName);
        if ( var == null ) {return false;}
        list = var.getDimensions();
        if ( list.size() != 1) {return false;}
        d = (Dimension) list.get(0);
        if ( ! d.getShortName().equals( timeDimName)) {return false;}
        units = var.findAttribute( "units").getStringValue();
        if ( ! SimpleUnit.isCompatible(units, "degrees_north")) {return false;}

        // Check for variable longitude(time) with units of "deg".
        var = ds.getRootGroup().findVariable( lonVarName);
        if ( var == null ) {return false;}
        list = var.getDimensions();
        if ( list.size() != 1) {return false;}
        d = (Dimension) list.get(0);
        if ( ! d.getShortName().equals( timeDimName)) {return false;}
        units = var.findAttribute( "units").getStringValue();
        if ( ! SimpleUnit.isCompatible( units, "degrees_east")) {return false;}


        // Check for variable altitude(time) with units of "m".
        var = ds.getRootGroup().findVariable( elevVarName);
        if ( var == null) {return false;}
        list = var.getDimensions();
        if ( list.size() != 1) {return false;}
        d = (Dimension) list.get(0);
        if ( ! d.getShortName().equals( timeDimName)) {return false;}
        units = var.findAttribute( "units").getStringValue();
        if ( ! SimpleUnit.isCompatible( units, "meters")) {return false;}

        return true;

    }

    public TableConfig getConfig(FeatureType wantFeatureType, NetcdfDataset ds, Formatter errlog) throws IOException {
        PointConfigXML reader = new PointConfigXML();
        return reader.readConfigXMLfromResource("resources/nj22/pointConfig/SimpleTrajectory.xml", wantFeatureType, ds, errlog);
    }
}