netcdf-c/ncdump/ncdump.h

89 lines
3.2 KiB
C
Raw Normal View History

2010-06-03 21:24:43 +08:00
/*********************************************************************
* Copyright 2018, UCAR/Unidata
2010-06-03 21:24:43 +08:00
* See netcdf/COPYRIGHT file for copying and redistribution conditions.
* $Header: /upc/share/CVS/netcdf-3/ncdump/ncdump.h,v 1.34 2009/12/02 20:03:43 russ Exp $
*********************************************************************/
#ifndef _NCDUMP_H_
#define _NCDUMP_H_
typedef
enum {LANG_C, LANG_F} Nclang;
typedef struct { /* specification for how to format dump */
char *name; /* name specified with -n or derived from
* file name */
bool_t header_only; /* if true, don't print any variable data */
2010-06-03 21:24:43 +08:00
bool_t coord_vals; /* if true, print header and coordinate
2010-06-03 21:24:43 +08:00
* dimension values (values of variables
* that are also dimensions), but no other
* variable data */
bool_t brief_data_cmnts; /* if true, put // comments in data section
2010-06-03 21:24:43 +08:00
* identifying variable and indices, useful
* for navigating through large
* multi-dimensional data lists. */
bool_t full_data_cmnts; /* if true, put // comments in data section
2010-06-03 21:24:43 +08:00
* identifying every value, useful for
* navigating through large
* multi-dimensional data lists. */
bool_t string_times; /* if true, output date-time values as
2010-06-03 21:24:43 +08:00
* human-readable strings. */
bool_t iso_separator; /* if true, use 'T' separator between
* date and time components of
* human-readable strings, otherwise
* use ' ' */
bool_t special_atts; /* if true, output special attributes
2010-06-03 21:24:43 +08:00
* for optimization characteristics:
* _Compression, _Chunking,
* _Endianness, _Format, _Checksum,
* _NoFill, _NetCDF4 */
2010-06-03 21:24:43 +08:00
Enhance/Fix filter support re: Discussion https://github.com/Unidata/netcdf-c/discussions/2214 The primary change is to support so-called "standard filters". A standard filter is one that is defined by the following netcdf-c API: ```` int nc_def_var_XXX(int ncid, int varid, size_t nparams, unsigned* params); int nc_inq_var_XXXX(int ncid, int varid, int* usefilterp, unsigned* params); ```` So for example, zstandard would be a standard filter by defining the functions *nc_def_var_zstandard* and *nc_inq_var_zstandard*. In order to define these functions, we need a new dispatch function: ```` int nc_inq_filter_avail(int ncid, unsigned filterid); ```` This function, combined with the existing filter API can be used to implement arbitrary standard filters using a simple code pattern. Note that I would have preferred that this function return a list of all available filters, but HDF5 does not support that functionality. So this PR implements the dispatch function and implements the following standard functions: + bzip2 + zstandard + blosc Specific test cases are also provided for HDF5 and NCZarr. Over time, other specific standard filters will be defined. ## Primary Changes * Add nc_inq_filter_avail() to netcdf-c API. * Add standard filter implementations to test use of *nc_inq_filter_avail*. * Bump the dispatch table version number and add to all the relevant dispatch tables (libsrc, libsrcp, etc). * Create a program to invoke nc_inq_filter_avail so that it is accessible to shell scripts. * Cleanup szip support to properly support szip when HDF5 is disabled. This involves detecting libsz separately from testing if HDF5 supports szip. * Integrate shuffle and fletcher32 into the existing filter API. This means that, for example, nc_def_var_fletcher32 is now a wrapper around nc_def_var_filter. * Extend the Codec defaulting to allow multiple default shared libraries. ## Misc. Changes * Modify configure.ac/CMakeLists.txt to look for the relevant libraries implementing standard filters. * Modify libnetcdf.settings to list available standard filters (including deflate and szip). * Add CMake test modules to locate libbz2 and libzstd. * Cleanup the HDF5 memory manager function use in the plugins. * remove unused file include//ncfilter.h * remove tests for the HDF5 memory operations e.g. H5allocate_memory. * Add flag to ncdump to force use of _Filter instead of _Deflate or _Shuffle or _Fletcher32. Used for testing.
2022-03-15 02:39:37 +08:00
bool_t filter_atts; /* if true, output filters using _Filter in place of
* _Fletcher32, _Shuffle, and _Deflate. */
2010-06-03 21:24:43 +08:00
Nclang data_lang; /* Specifies index conventions used in data
* comments, either LANG_C (C, 0-based,
* column major) or LANG_F (Fortran,
* 1-based, row major) */
bool_t with_cache; /* For DAP URLs, get data with client-side
2010-06-03 21:24:43 +08:00
* caching when each variable is first accessed */
2011-09-22 07:10:03 +08:00
int nlvars; /* Number of variables specified with -v
* option on command line */
2010-06-03 21:24:43 +08:00
char** lvars; /* list of variable names specified with -v
* option on command line */
2011-08-26 11:54:25 +08:00
int nlgrps; /* Number of groups specified with -g
* option on command line */
char** lgrps; /* list of group names specified with -g
* option on command line */
2011-09-22 07:10:03 +08:00
idnode_t* grpids; /* list of grpids matching list specified with -g option */
int nc_kind; /* kind of netCDF file named on
* command line, 1 (classic), 2
* (64-bit offset), 3 (netCDF-4), 4
* (netCDF-4 classic model), 5 (64-bit data)
*/
int nc_extended; /* extended format info fornetCDF file named
* on command line.
*/
int nc_mode; /* mode as reported by inq_format_extended */
int xopt_inmemory; /* Use in-memory option; testing only */
Cleanup DAP4 testing NOTE: This PR should not be included in 4.9.1 since additional DAP4 related PRs will be forthcoming. This PR makes major changes to libdap4 and dap4_test driven by changes to TDS. * Enable DAP4 * Clean up the test input files and the test baseline comparison files. This entails: * Remove a multitude of unused test input and baseline data files; among them are dap4_test/: daptestfiles, dmrtestfiles, nctestfiles, and misctestfiles. * Define a canonical set of test input files and record in dap4_test/cdltestfiles. * Use the cdltestfiles to generate the .nc test inputs. This set of .nc files is then moved to the d4ts (DAP4 test server) war file in the tds repository. This set then becomes the canonical set of DAP4 test sources. * Scrape d4ts to obtain copies of the raw streams of DAP4 encoded data. The .dmr and .dap streams are then stored in dap4_test/rawtestfiles. * Disable some remote server tests until those servers are fixed. * Add an option to ncdump (-XF) that forces the type of the _FillValue attribute; this is primarily to simplify testing of fill mismatch. * Minor bug fixes to ncgen. * Changes to libdap4: * Replace old checksum hack with the dap4.checksum flag. * Support the dap4.XXX controls. * Cleanup _FillValue handling, especially var-attribute type mismatches. * Fix enum handling based on changes to netcdf-java. * Changes to dap4_test: * Add getopt support to various test support programs. * Remove unneeded shell scripts. * Add new scripts: test_curlopt.sh
2022-11-14 04:15:11 +08:00
int xopt_props; /* 1=>Unconditionally Suppress properties attribute */
int xopt_filltype; /* 1=>Unconditionally print _FillValue attribute type */
2010-06-03 21:24:43 +08:00
} fspec_t;
#endif /*_NCDUMP_H_ */