ucar.nc2.dt.grid

Class NetcdfCFWriter

java.lang.Object

ucar.nc2.dt.grid.NetcdfCFWriter

public class NetcdfCFWriter
extends Object

Write a CF compliant Netcdf-3 or netcdf-4 file (classic mode only) from any gridded dataset. The datasets can optionally be subsetted by a lat/lon bounding box and/or a time range.

Author:

caron

Constructor Summary

Constructors

Constructor and Description
NetcdfCFWriter()

Method Summary

Methods

Modifier and Type	Method and Description
static void	main(String[] args)
static void	makeFile(String location, GridDataset gds, List<String> gridList, LatLonRect llbb, CalendarDateRange range) Write a netcdf-3 file from a subset of a grid dataset
void	makeFile(String location, GridDataset gds, List<String> gridList, LatLonRect llbb, CalendarDateRange range, boolean addLatLon, int horizStride, int stride_z, int stride_time) Write a CF compliant Netcdf-3 file from any gridded dataset.
long	makeFile(String location, GridDataset gds, List<String> gridList, LatLonRect llbb, int horizStride, Range zRange, CalendarDateRange dateRange, int stride_time, boolean addLatLon)
long	makeFile(String location, GridDataset gds, List<String> gridList, LatLonRect llbb, int horizStride, Range zRange, CalendarDateRange dateRange, int stride_time, boolean addLatLon, NetcdfFileWriter.Version version)
long	makeFile(String location, GridDataset gds, List<String> gridList, ProjectionRect llbb, int horizStride, Range zRange, CalendarDateRange dateRange, int stride_time, boolean addLatLon)
long	makeFile(String location, GridDataset gds, List<String> gridList, ProjectionRect llbb, int horizStride, Range zRange, CalendarDateRange dateRange, int stride_time, boolean addLatLon, NetcdfFileWriter.Version version)
static void	makeFileVersioned(String location, GridDataset gds, List<String> gridList, LatLonRect llbb, CalendarDateRange dateRange, NetcdfFileWriter.Version version)
long	makeGridFileSizeEstimate(GridDataset gds, List<String> gridList, LatLonRect llbb, int horizStride, Range zRange, CalendarDateRange dateRange, int stride_time, boolean addLatLon) Write a netcdf-3 file from a subset of a grid dataset, as long as it doesnt exceed a certain file size.
long	makeGridFileSizeEstimate(GridDataset gds, List<String> gridList, ProjectionRect projBB, int horizStride, Range zRange, CalendarDateRange dateRange, int stride_time, boolean addLatLon) Write a netcdf-3 file from a subset of a grid dataset (projection coordinates), as long as it doesnt exceed a certain file size.
static void	test1()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetcdfCFWriter

public NetcdfCFWriter()

Method Detail

makeFile

public static void makeFile(String location,
            GridDataset gds,
            List<String> gridList,
            LatLonRect llbb,
            CalendarDateRange range)
                     throws IOException,
                            InvalidRangeException

Write a netcdf-3 file from a subset of a grid dataset

Parameters:

location - write new file

gds - from this grid dataset

gridList - just these grids

llbb - horiz subset, may be null

range - time subset, may be null

Throws:

IOException

InvalidRangeException

makeFileVersioned

public static void makeFileVersioned(String location,
                     GridDataset gds,
                     List<String> gridList,
                     LatLonRect llbb,
                     CalendarDateRange dateRange,
                     NetcdfFileWriter.Version version)
                              throws IOException,
                                     InvalidRangeException

Throws:

IOException

InvalidRangeException

makeGridFileSizeEstimate

public long makeGridFileSizeEstimate(GridDataset gds,
                            List<String> gridList,
                            LatLonRect llbb,
                            int horizStride,
                            Range zRange,
                            CalendarDateRange dateRange,
                            int stride_time,
                            boolean addLatLon)
                              throws IOException,
                                     InvalidRangeException

Write a netcdf-3 file from a subset of a grid dataset, as long as it doesnt exceed a certain file size.

Parameters:

gds - from this grid dataset

gridList - just these grids

llbb - horiz subset, may be null

zRange - vertical subset, may be null

dateRange - time subset, may be null

stride_time - time may be strided, -1 if want all

addLatLon - optionally add a lat/lon coordinate (if dataset uses projection coords)

Returns:

file size

Throws:

IOException

InvalidRangeException

makeGridFileSizeEstimate

public long makeGridFileSizeEstimate(GridDataset gds,
                            List<String> gridList,
                            ProjectionRect projBB,
                            int horizStride,
                            Range zRange,
                            CalendarDateRange dateRange,
                            int stride_time,
                            boolean addLatLon)
                              throws IOException,
                                     InvalidRangeException

Write a netcdf-3 file from a subset of a grid dataset (projection coordinates), as long as it doesnt exceed a certain file size.

Parameters:

gds - from this grid dataset

gridList - just these grids

projBB - horiz subset in Projection coords, may be null

zRange - vertical subset, may be null

dateRange - time subset, may be null

stride_time - time may be strided, -1 if want all

addLatLon - optionally add a lat/lon coordinate (if dataset uses projection coords)

Returns:

file size

Throws:

IOException

InvalidRangeException

makeFile

public void makeFile(String location,
            GridDataset gds,
            List<String> gridList,
            LatLonRect llbb,
            CalendarDateRange range,
            boolean addLatLon,
            int horizStride,
            int stride_z,
            int stride_time)
              throws IOException,
                     InvalidRangeException

Write a CF compliant Netcdf-3 file from any gridded dataset.

Parameters:

location - write to this location on disk

gds - A gridded dataset

gridList - the list of grid names to be written, must not be empty. Full name (not short).

llbb - optional lat/lon bounding box

range - optional time range

addLatLon - should 2D lat/lon variables be added, if its a projection coordinate system?

horizStride - x,y stride

stride_z - not implemented yet

stride_time - not implemented yet

Throws:

IOException - if write or read error

InvalidRangeException - if subset is illegal

makeFile

public long makeFile(String location,
            GridDataset gds,
            List<String> gridList,
            LatLonRect llbb,
            int horizStride,
            Range zRange,
            CalendarDateRange dateRange,
            int stride_time,
            boolean addLatLon)
              throws IOException,
                     InvalidRangeException

Throws:

IOException

InvalidRangeException

makeFile

public long makeFile(String location,
            GridDataset gds,
            List<String> gridList,
            LatLonRect llbb,
            int horizStride,
            Range zRange,
            CalendarDateRange dateRange,
            int stride_time,
            boolean addLatLon,
            NetcdfFileWriter.Version version)
              throws IOException,
                     InvalidRangeException

Throws:

IOException

InvalidRangeException

makeFile

public long makeFile(String location,
            GridDataset gds,
            List<String> gridList,
            ProjectionRect llbb,
            int horizStride,
            Range zRange,
            CalendarDateRange dateRange,
            int stride_time,
            boolean addLatLon)
              throws IOException,
                     InvalidRangeException

Throws:

IOException

InvalidRangeException

makeFile

public long makeFile(String location,
            GridDataset gds,
            List<String> gridList,
            ProjectionRect llbb,
            int horizStride,
            Range zRange,
            CalendarDateRange dateRange,
            int stride_time,
            boolean addLatLon,
            NetcdfFileWriter.Version version)
              throws IOException,
                     InvalidRangeException

Throws:

IOException

InvalidRangeException

test1

public static void test1()
                  throws IOException,
                         InvalidRangeException,
                         ParseException

Throws:

IOException

InvalidRangeException

ParseException

main

public static void main(String[] args)
                 throws IOException,
                        InvalidRangeException,
                        ParseException

Throws:

IOException

InvalidRangeException

ParseException