/*
* 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.
*/
// $Id: RafTrajectoryObsDataset.java 63 2006-07-12 21:50:51Z edavis $
package ucar.nc2.dt.trajectory;
import ucar.ma2.*;
import ucar.nc2.Attribute;
import ucar.nc2.Variable;
import ucar.nc2.constants.FeatureType;
import ucar.nc2.dt.TypedDataset;
import ucar.nc2.dt.TypedDatasetFactoryIF;
import ucar.nc2.dataset.NetcdfDataset;
import ucar.nc2.units.DateUnit;
import ucar.nc2.units.SimpleUnit;
import ucar.nc2.units.DateFormatter;
import java.io.IOException;
import java.util.*;
/**
* Handle trajectory data files that follow the
* NCAR-RAF netCDF Conventions ("NCAR-RAF/nimbus").
*
* Documentation on this convention is available at
* http://www.eol.ucar.edu/raf/Software/netCDF.html
*
* @deprecated use ucar.nc2.ft.point
* @author edavis
* @since 2005-02-07T17:26:14-0700
*/
public class RafTrajectoryObsDataset extends SingleTrajectoryObsDataset implements TypedDatasetFactoryIF
{
private String timeDimName;
private String timeVarName;
private String latVarName;
private String lonVarName;
private String elevVarName;
static public boolean isValidFile( NetcdfDataset ds)
{
Attribute conventionsAtt = ds.findGlobalAttribute( "Conventions");
if ( conventionsAtt == null)
conventionsAtt = ds.findGlobalAttributeIgnoreCase( "Conventions");
if ( conventionsAtt == null) return( false);
if ( ! conventionsAtt.isString()) return( false);
if ( ! conventionsAtt.getStringValue().equals( "NCAR-RAF/nimbus" ) ) return( false );
Attribute versionAtt = ds.findGlobalAttributeIgnoreCase( "Version" );
if ( versionAtt == null )
{
// A bit of a hack for some UWYO KingAir files.
versionAtt = new Attribute( "Version", "1.3" );
ds.addAttribute( null, versionAtt );
ds.finish();
return ( true );
}
if ( ! versionAtt.isString() ) return ( false );
if ( versionAtt.getStringValue( ).equals( "1.2")) return( true );
if ( versionAtt.getStringValue( ).equals( "1.3")) return( true );
return( false );
}
/////////////////////////////////////////////////
// TypedDatasetFactoryIF
public boolean isMine(NetcdfDataset ds) { return isValidFile(ds); }
public TypedDataset open( NetcdfDataset ncd, ucar.nc2.util.CancelTask task, StringBuilder errlog) throws IOException {
return new RafTrajectoryObsDataset( ncd);
}
public FeatureType getScientificDataType() { return FeatureType.TRAJECTORY; }
public RafTrajectoryObsDataset() {}
public RafTrajectoryObsDataset( NetcdfDataset ncf) throws IOException
{
super( ncf );
Attribute conventionsAtt = ncf.findGlobalAttribute( "Conventions" );
if ( conventionsAtt == null )
conventionsAtt = ncf.findGlobalAttributeIgnoreCase( "Conventions" );
if ( conventionsAtt == null)
throw new IllegalArgumentException( "File <" + ncf.getId() + "> not a \"NCAR-RAF/nimbus\" convention file." );
if ( ! conventionsAtt.getStringValue().equals( "NCAR-RAF/nimbus" ) )
throw new IllegalArgumentException( "File <" + ncf.getId() + "> not a \"NCAR-RAF/nimbus\" convention file." );
Attribute versionAtt = ncf.findGlobalAttributeIgnoreCase( "Version" );
if ( versionAtt.getStringValue().equals( "1.2"))
{
timeDimName = "Time";
timeVarName = "time_offset";
latVarName = "LAT";
lonVarName = "LON";
elevVarName = "ALT";
// Determine and set the units (base time) for the time variable.
String baseTimeVarName = "base_time";
Variable baseTimeVar = netcdfDataset.findVariable( baseTimeVarName );
int baseTime = baseTimeVar.readScalarInt();
Date baseTimeDate;
if ( baseTime != 0 )
{
String baseTimeString = baseTime + " seconds since 1970-01-01T00:00:00";
baseTimeDate = DateUnit.getStandardDate( baseTimeString );
}
else
{
Calendar calendar = Calendar.getInstance( TimeZone.getTimeZone( "GMT" ), Locale.US );
// Read in start point date/time information and create java.util.Date
Array yearArray, monthArray, dayArray, hourArray, minuteArray, secondArray, tmpTimeArray;
try
{
yearArray = ncf.findVariable( "YEAR" ).read( "0" );
monthArray = ncf.findVariable( "MONTH" ).read( "0" );
dayArray = ncf.findVariable( "DAY" ).read( "0" );
hourArray = ncf.findVariable( "HOUR" ).read( "0" );
minuteArray = ncf.findVariable( "MINUTE" ).read( "0" );
secondArray = ncf.findVariable( "SECOND" ).read( "0" );
tmpTimeArray = ncf.findVariable( timeVarName).read( "0" );
}
catch ( InvalidRangeException e )
{
throw new IOException( "Failed while reading first value of YEAR, MONTH, DAY, HOUR, MINUTE, SECOND, or time_offset: " + e.getMessage() );
}
calendar.clear();
calendar.set( Calendar.YEAR, (int) yearArray.getFloat( yearArray.getIndex() ) );
calendar.set( Calendar.MONTH, (int) monthArray.getFloat( monthArray.getIndex() ) );
calendar.set( Calendar.DAY_OF_MONTH, (int) dayArray.getFloat( dayArray.getIndex() ) );
calendar.set( Calendar.HOUR_OF_DAY, (int) hourArray.getFloat( hourArray.getIndex() ) );
calendar.set( Calendar.MINUTE, (int) minuteArray.getFloat( minuteArray.getIndex() ) );
calendar.set( Calendar.SECOND, (int) secondArray.getFloat( secondArray.getIndex() ) );
calendar.set( Calendar.MILLISECOND, 0 );
// Calculating base time so subtract seconds in time variable first value.
calendar.add( Calendar.SECOND, - (int) tmpTimeArray.getFloat( tmpTimeArray.getIndex() ));
baseTimeDate = calendar.getTime();
}
DateFormatter formatter = new DateFormatter();
String timeUnitsString = "seconds since " + formatter.toDateTimeStringISO( baseTimeDate );
netcdfDataset.findVariable( timeVarName ).addAttribute( new Attribute( "units", timeUnitsString ) );
// Make sure alt units are "meters" convertible.
String elevVarUnitsString = netcdfDataset.findVariable( elevVarName ).findAttribute( "units").getStringValue();
if ( ! SimpleUnit.isCompatible( elevVarUnitsString, "meters"))
{
if ( elevVarUnitsString.equals( "M"))
netcdfDataset.findVariable( elevVarName ).addAttribute( new Attribute( "units", "meters"));
}
}
else if ( versionAtt.getStringValue().equals( "1.3" ) )
{
// Set default dimension and variable names.
timeDimName = "Time";
timeVarName = "Time";
latVarName = "LAT";
lonVarName = "LON";
elevVarName = "ALT";
// Set dimension and variable names as indicated by global attribute "coordinates".
Attribute coordsAttrib = netcdfDataset.findGlobalAttribute( "coordinates");
if ( coordsAttrib != null )
{
String coordsAttribValue = coordsAttrib.getStringValue();
if ( coordsAttribValue != null)
{
String[] varNames = coordsAttribValue.split( " ");
latVarName = varNames[ 1];
lonVarName = varNames[0];
elevVarName = varNames[2];
timeVarName = varNames[3];
timeDimName = timeVarName;
}
}
// If time variable is all zeros, set time variable to "time_offset".
if ( timeVarAllZeros() )
{
timeVarName = "time_offset";
}
String varUnitsString = this.netcdfDataset.findVariable( latVarName ).findAttributeIgnoreCase( "units" ).getStringValue();
if ( !SimpleUnit.isCompatible( varUnitsString, "degrees_north" ) )
{
throw new IllegalStateException( "Latitude variable <" + latVarName + "> units not udunits compatible w/ \"degrees_north\"." );
}
varUnitsString = this.netcdfDataset.findVariable( lonVarName ).findAttributeIgnoreCase( "units" ).getStringValue();
if ( !SimpleUnit.isCompatible( varUnitsString, "degrees_east" ) )
{
throw new IllegalStateException( "Longitude variable <" + lonVarName + "> units not udunits compatible w/ \"degrees_east\"." );
}
varUnitsString = this.netcdfDataset.findVariable( elevVarName ).findAttributeIgnoreCase( "units" ).getStringValue();
if ( !SimpleUnit.isCompatible( varUnitsString, "meters" ) )
{
throw new IllegalStateException( "Elevation variable <" + elevVarName + "> units not udunits compatible w/ \"m\"." );
}
String timeUnitsString = this.netcdfDataset.findVariable( timeVarName ).findAttributeIgnoreCase( "units" ).getStringValue();
if ( !SimpleUnit.isCompatible( timeUnitsString, "seconds since 1970-01-01 00:00:00" ) )
{
throw new IllegalStateException( "Time variable units <" + timeUnitsString + "> not udunits compatible w/ \"seconds since 1970-01-01 00:00:00\"." );
}
}
else
{
throw new IllegalArgumentException( "File <" + ncf.getId() + "> not a version 1.2 or 1.3 \"NCAR-RAF/nimbus\" convention file." );
}
Config trajConfig = new Config( "1Hz data",
ncf.getRootGroup().findDimension( timeDimName ),
ncf.getRootGroup().findVariable( timeVarName ),
ncf.getRootGroup().findVariable( latVarName ),
ncf.getRootGroup().findVariable( lonVarName ),
ncf.getRootGroup().findVariable( elevVarName ));
this.setTrajectoryInfo( trajConfig );
}
private boolean timeVarAllZeros() throws IOException
{
Variable curTimeVar = this.netcdfDataset.getRootGroup().findVariable( timeVarName);
List section = new ArrayList(1);
Array a = null;
try
{
section.add ( new Range( 0, 2));
a = curTimeVar.read( section);
}
catch ( InvalidRangeException e )
{
throw new IOException( "Invalid range (0,2): " + e.getMessage());
}
IndexIterator it = a.getIndexIterator();
for( ; it.hasNext(); )
{
if ( it.getDoubleNext() != 0.0 ) return ( false );
}
return( true);
}
}