/* $Header: /home/zender/cvs/nco/src/nco/ncks.c,v 1.24 2000/04/05 21:41:57 zender Exp $ */ /* ncks -- netCDF Kitchen Sink */ /* Purpose: Extract (subsets of) variables from a netCDF file Print them to screen, or copy them to a new file, or both */ /* Copyright (C) 1995--2000 Charlie Zender This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. The file LICENSE contains the GNU General Public License, version 2 It may be viewed interactively by typing, e.g., ncks -L The author of this software, Charlie Zender, would like to receive your suggestions, improvements, bug-reports, and patches for NCO. Please contact me via e-mail at zender@uci.edu or by writing Charlie Zender Department of Earth System Science University of California at Irvine Irvine, CA 92697-3100 */ /* Usage: ncks in.nc ncks -v one in.nc ncks in.nc foo.nc ncks -v one in.nc foo.nc ncks -p /ZENDER/tmp -l /data/zender/tmp h0001.nc foo.nc ncks -s "%+16.10f\n" -H -C -v three_dmn_var in.nc ncks -H -v fl_nm,fl_nm_arr ~/nc/nco/data/in.nc ncks -H -d fl_dim,1 -d char_dim,6,12 -v fl_nm,fl_nm_arr ~/nc/nco/data/in.nc ncks -H -m -v char_var_nul,char_var_space,char_var_multinul ~/nc/nco/data/in.nc ncks -H -C -v three_dmn_rec_var -d time,,,2 in.nc ncks -H -C -v lon -d lon,3,1 in.nc */ /* Standard header files */ #include /* sin cos cos sin 3.14159 */ #include /* netCDF def'ns */ #include /* stderr, FILE, NULL, etc. */ #include /* atof, atoi, malloc, getopt */ #include /* strcmp. . . */ #include /* stat() */ #include /* machine time */ #include /* all sorts of POSIX stuff */ /* #include */ /* assert() debugging macro */ /* #include */ /* errno */ /* #include */ /* malloc() stuff */ /* #define MAIN_PROGRAM_FILE MUST precede #include nc.h */ #define MAIN_PROGRAM_FILE #include "nc.h" /* global definitions */ int main(int argc,char **argv) { int cpy_var_def(int,int,int,char *); int cpy_var_def_lmt(int,int,int,char *,lmt_sct *,int); void cpy_var_val(int,int,char *); void cpy_var_val_lmt(int,int,char *,lmt_sct *,int); void prn_att(int,int); void prn_var_def(int,char *); void prn_var_val_lmt(int,char *,lmt_sct *,int,char *,bool,bool); bool ALPHABETIZE_OUTPUT=True; /* Option a */ bool EXCLUDE_INPUT_LIST=False; /* Option c */ bool FILE_RETRIEVED_FROM_REMOTE_LOCATION; bool FORCE_APPEND=False; /* Option A */ bool FORCE_OVERWRITE=False; /* Option O */ bool FORTRAN_STYLE=False; /* Option F */ bool HISTORY_APPEND=True; /* Option h */ bool OUTPUT_DATA=False; /* Option H */ bool OUTPUT_VARIABLE_METADATA=False; /* Option m */ bool OUTPUT_GLOBAL_METADATA=False; /* Option M */ bool PRINT_DIMENSIONAL_UNITS=False; /* Option u */ bool PROCESS_ALL_COORDINATES=False; /* Option c */ bool PROCESS_ASSOCIATED_COORDINATES=True; /* Option C */ bool REMOVE_REMOTE_FILES_AFTER_PROCESSING=True; /* Option R */ char **var_lst_in=NULL_CEWI; char **fl_lst_abb=NULL; /* Option a */ char **fl_lst_in; char *dlm_sng=NULL; char *fl_in=NULL; char *fl_pth_lcl=NULL; /* Option l */ char *lmt_arg[MAX_NC_DIMS]; char *opt_sng; char *fl_out; char *fl_out_tmp; char *fl_pth=NULL; /* Option p */ char *time_bfr_srt; char *cmd_ln; char CVS_Id[]="$Id: ncks.c,v 1.24 2000/04/05 21:41:57 zender Exp $"; char CVS_Revision[]="$Revision: 1.24 $"; extern char *optarg; extern int ncopts; extern int optind; int idx; int in_id; int nbr_abb_arg=0; int nbr_dmn_fl; int lmt_nbr=0; /* Option d. NB: lmt_nbr gets incremented */ int nbr_glb_att; int nbr_var_fl; int nbr_xtr=0; /* nbr_xtr won't otherwise be set for -c with no -v */ int nbr_fl=0; int opt; int rec_dmn_id; lmt_sct *lmt; nm_id_sct *xtr_lst=NULL; /* xtr_lst can get realloc()'d from NULL with -c option */ time_t clock; /* Start the clock and save the command line */ cmd_ln=cmd_ln_sng(argc,argv); clock=time((time_t *)NULL); time_bfr_srt=ctime(&clock); /* Get program name and set program enum (e.g., prg=ncra) */ prg_nm=prg_prs(argv[0],&prg); /* Parse command line arguments */ opt_sng="aACcD:d:FHhl:MmOp:rRs:uv:x"; while((opt = getopt(argc,argv,opt_sng)) != EOF){ switch(opt){ case 'a': /* Toggle ALPHABETIZE_OUTPUT */ ALPHABETIZE_OUTPUT=!ALPHABETIZE_OUTPUT; break; case 'A': /* Toggle FORCE_APPEND */ FORCE_APPEND=!FORCE_APPEND; break; case 'C': /* Extraction list should include all coordinates associated with extracted variables? */ PROCESS_ASSOCIATED_COORDINATES=False; break; case 'c': /* Add all coordinates to the extraction list? */ PROCESS_ALL_COORDINATES=True; break; case 'D': /* Debugging level. Default is 0. */ dbg_lvl=atoi(optarg); break; case 'd': /* Copy argument for later processing */ lmt_arg[lmt_nbr]=(char *)strdup(optarg); lmt_nbr++; break; case 'H': /* Print data to screen */ OUTPUT_DATA=True; break; case 'h': /* Toggle appending to history global attribute */ HISTORY_APPEND=!HISTORY_APPEND; break; case 'l': /* Local path prefix for files retrieved from remote file system */ fl_pth_lcl=optarg; break; case 'm': /* Print variable metadata to screen */ OUTPUT_VARIABLE_METADATA=True; break; case 'M': /* Print global metadata to screen */ OUTPUT_GLOBAL_METADATA=True; break; case 'O': /* Toggle FORCE_OVERWRITE */ FORCE_OVERWRITE=!FORCE_OVERWRITE; break; case 'F': /* Toggle index convention. Default is 0-based arrays (C-style). */ FORTRAN_STYLE=!FORTRAN_STYLE; break; case 'p': /* Common file path */ fl_pth=optarg; break; case 'R': /* Toggle removal of remotely-retrieved-files. Default is True. */ REMOVE_REMOTE_FILES_AFTER_PROCESSING=!REMOVE_REMOTE_FILES_AFTER_PROCESSING; break; case 'r': /* Print CVS program information and copyright notice */ (void)copyright_prn(CVS_Id,CVS_Revision); (void)nc_lib_vrs_prn(); exit(EXIT_SUCCESS); break; case 's': /* User specified delimiter string for printed output */ dlm_sng=optarg; break; case 'u': /* Turn on the printing of dimensional units. */ PRINT_DIMENSIONAL_UNITS=!PRINT_DIMENSIONAL_UNITS; break; case 'v': /* Variables to extract/exclude */ var_lst_in=lst_prs(optarg,",",&nbr_xtr); break; case 'x': /* Exclude rather than extract variables specified with -v */ EXCLUDE_INPUT_LIST=True; break; default: /* Print proper usage */ (void)usg_prn(); exit(EXIT_FAILURE); break; } /* end switch */ } /* end while loop */ /* Process positional arguments and fill in filenames */ fl_lst_in=fl_lst_mk(argv,argc,optind,&nbr_fl,&fl_out); /* Make uniform list of user-specified dimension limits */ lmt=lmt_prs(lmt_nbr,lmt_arg); /* Make netCDF errors fatal and print the diagnostic */ ncopts=NC_VERBOSE | NC_FATAL; /* Parse filename */ fl_in=fl_nm_prs(fl_in,0,&nbr_fl,fl_lst_in,nbr_abb_arg,fl_lst_abb,fl_pth); /* Make sure file is on local system and is readable or die trying */ fl_in=fl_mk_lcl(fl_in,fl_pth_lcl,&FILE_RETRIEVED_FROM_REMOTE_LOCATION); /* Open the file for reading */ in_id=ncopen(fl_in,NC_NOWRITE); /* Get the number of variables, dimensions, and global attributes in the file */ (void)ncinquire(in_id,&nbr_dmn_fl,&nbr_var_fl,&nbr_glb_att,&rec_dmn_id); /* Form initial extraction list from user input */ xtr_lst=var_lst_mk(in_id,nbr_var_fl,var_lst_in,PROCESS_ALL_COORDINATES,&nbr_xtr); /* Change included variables to excluded variables */ if(EXCLUDE_INPUT_LIST) xtr_lst=var_lst_xcl(in_id,nbr_var_fl,xtr_lst,&nbr_xtr); /* Add all coordinate variables to extraction list */ if(PROCESS_ALL_COORDINATES) xtr_lst=var_lst_add_crd(in_id,nbr_var_fl,nbr_dmn_fl,xtr_lst,&nbr_xtr); /* Make sure coordinates associated extracted variables are also on extraction list */ if(PROCESS_ASSOCIATED_COORDINATES) xtr_lst=var_lst_ass_crd_add(in_id,xtr_lst,&nbr_xtr); /* Heapsort extraction list alphabetically or by variable ID */ if(nbr_xtr > 1) xtr_lst=lst_heapsort(xtr_lst,nbr_xtr,ALPHABETIZE_OUTPUT); /* We now have final list of variables to extract. Phew. */ /* Find coordinate/dimension values associated with user-specified limits */ for(idx=0;idx 0) var_out_id=cpy_var_def_lmt(in_id,out_id,rec_dmn_id,xtr_lst[idx].nm,lmt,lmt_nbr); else var_out_id=cpy_var_def(in_id,out_id,rec_dmn_id,xtr_lst[idx].nm); /* Copy the variable's attributes */ (void)att_cpy(in_id,out_id,xtr_lst[idx].id,var_out_id); } /* end loop over idx */ /* Turn off default filling behavior to enhance efficiency */ #if ( ! defined SUN4 ) && ( ! defined SUN4SOL2 ) && ( ! defined SUNMP ) (void)ncsetfill(out_id,NC_NOFILL); #endif /* Take output file out of define mode */ (void)ncendef(out_id); /* Copy the variable data */ for(idx=0;idx 2) (void)fprintf(stderr,"%s, ",xtr_lst[idx].nm); if(dbg_lvl > 0) (void)fflush(stderr); if(lmt_nbr > 0) (void)cpy_var_val_lmt(in_id,out_id,xtr_lst[idx].nm,lmt,lmt_nbr); else (void)cpy_var_val(in_id,out_id,xtr_lst[idx].nm); } /* end loop over idx */ /* Close output file and move it from temporary to permanent location */ (void)fl_out_cls(fl_out,fl_out_tmp,out_id); } /* end if fl_out != NULL */ if(OUTPUT_GLOBAL_METADATA){ (void)fprintf(stdout,"Opened file %s: dimensions = %i, variables = %i, global atts. = %i, id = %i\n",fl_in,nbr_dmn_fl,nbr_var_fl,nbr_glb_att,in_id); if(rec_dmn_id != -1){ char rec_dmn_nm[MAX_NC_NAME]; int nbr_rec_var; long rec_dmn_sz; (void)ncdiminq(in_id,rec_dmn_id,rec_dmn_nm,&rec_dmn_sz); (void)ncrecinq(in_id,&nbr_rec_var,(int *)NULL,(long *)NULL); (void)fprintf(stdout,"Record dimension: name = %s, size = %li, record variables = %i\n\n",rec_dmn_nm,rec_dmn_sz,nbr_rec_var); } /* end if */ /* Print all global attributes */ (void)prn_att(in_id,NC_GLOBAL); } /* endif OUTPUT_GLOBAL_METADATA */ if(OUTPUT_VARIABLE_METADATA){ for(idx=0;idx nbr_dim-1){ ; }else{ /* Recursively move to the next dimension */ for(tmp_idx=min_dmn_idx[idx]; tmp_idx<=max_dmn_idx[idx]; tmp_idx++){ (void)recursive_prn(min_dmn_idx,max_dmn_idx,idx,nbr_dim,lmn); } /* end loop over tmp_idx */ } /* end else */ } /* end recursive_prn() */ void prn_att(int in_id,int var_id) /* int in_id: input netCDF input-file ID int var_id: input netCDF input-variable ID */ { /* Routine to print all the global attributes in a netCDF file, or all the attributes for a particular netCDF variable. If var_id == NC_GLOBAL ( = -1) the global attributes are printed, otherwise the variable's attributes are printed. */ att_sct *att=NULL_CEWI; char dlm_sng[3]; char src_sng[MAX_NC_NAME]; int att_lmn; int att_sz; int idx; int nbr_att; if(var_id == NC_GLOBAL){ /* Get the number of global attributes for the file */ (void)ncinquire(in_id,(int *)NULL,(int *)NULL,&nbr_att,(int *)NULL); (void)strcpy(src_sng,"Global"); }else{ /* Get the name and number of attributes for the variable */ (void)ncvarinq(in_id,var_id,src_sng,(nc_type *)NULL,(int *)NULL,(int *)NULL,&nbr_att); } /* end else */ /* Allocate space for the attribute names and types */ if(nbr_att > 0) att=(att_sct *)malloc(nbr_att*sizeof(att_sct)); /* Get the attributes' names, types, lengths, and values */ for(idx=0;idx 0) (void)free(att); } /* end prn_att() */ int cpy_var_def(int in_id,int out_id,int rec_dmn_id,char *var_nm) /* int in_id: input netCDF input-file ID int out_id: input netCDF output-file ID int rec_dmn_id: input input-file record dimension ID char *var_nm: input variable name int cpy_var_def(): output output-file variable ID */ { /* Routine to copy the variable metadata from an input netCDF file to an output netCDF file. This routine does not take into account any user-specified limits, it just copies what it finds. */ int *dmn_in_id; int *dmn_out_id; int idx; int nbr_dim; int var_in_id; int var_out_id; extern int ncopts; nc_type var_type; ncopts=0; /* See if the requested variable is already in the output file. */ var_out_id=ncvarid(out_id,var_nm); if(var_out_id != -1) return var_out_id; /* See if the requested variable is in the input file. */ var_in_id=ncvarid(in_id,var_nm); if(var_in_id == -1) (void)fprintf(stdout,"%s: ERROR unable to find variable \"%s\"\n",prg_nm_get(),var_nm); ncopts=NC_VERBOSE | NC_FATAL; /* Get the type of the variable and the number of dimensions. */ (void)ncvarinq(in_id,var_in_id,(char *)NULL,&var_type,&nbr_dim,(int *)NULL,(int *)NULL); /* Recall: 1. The dimensions must be defined before the variable. 2. The variable must be defined before the attributes. */ /* Allocate space to hold the dimension IDs */ dmn_in_id=(int *)malloc(nbr_dim*sizeof(int)); dmn_out_id=(int *)malloc(nbr_dim*sizeof(int)); /* Get the dimension IDs */ (void)ncvarinq(in_id,var_in_id,(char *)NULL,(nc_type *)NULL,(int *)NULL,dmn_in_id,(int *)NULL); /* Get the dimension sizes and names */ for(idx=0;idx lmt[lmt_idx].end) WRP=True; if(lmt[lmt_idx].srd != 1L) SRD=True; break; } /* end if */ } /* end loop over lmt_idx */ var_sz*=dmn_cnt[dmn_idx]; } /* end loop over dim */ /* Allocate enough space to hold variable */ void_ptr=(void *)malloc(var_sz*nctypelen(var_type)); if(void_ptr == NULL){ (void)fprintf(stderr,"%s: ERROR unable to malloc() %ld bytes for %s\n",prg_nm_get(),var_sz*nctypelen(var_type),var_nm); exit(EXIT_FAILURE); } /* end if */ /* Copy variable */ if(nbr_dim==0){ /* copy scalar */ ncvarget1(in_id,var_in_id,0L,void_ptr); ncvarput1(out_id,var_out_id,0L,void_ptr); }else if(!WRP){ /* copy contiguous array */ if(!SRD) ncvarget(in_id,var_in_id,dmn_in_srt,dmn_cnt,void_ptr); else ncvargetg(in_id,var_in_id,dmn_in_srt,dmn_cnt,dmn_srd,(long *)NULL,void_ptr); ncvarput(out_id,var_out_id,dmn_out_srt,dmn_cnt,void_ptr); }else if(WRP){ /* copy wrapped array */ int dmn_idx; int lmt_idx; /* For wrapped data */ long *dmn_in_srt_1=NULL; long *dmn_in_srt_2=NULL; long *dmn_out_srt_1=NULL; long *dmn_out_srt_2=NULL; long *dmn_cnt_1=NULL; long *dmn_cnt_2=NULL; dmn_in_srt_1=(long *)malloc(nbr_dim*sizeof(long)); dmn_in_srt_2=(long *)malloc(nbr_dim*sizeof(long)); dmn_out_srt_1=(long *)malloc(nbr_dim*sizeof(long)); dmn_out_srt_2=(long *)malloc(nbr_dim*sizeof(long)); dmn_cnt_1=(long *)malloc(nbr_dim*sizeof(long)); dmn_cnt_2=(long *)malloc(nbr_dim*sizeof(long)); /* Variable contains a wrapped dimension, requires two reads */ /* For each dimension in the input variable */ for(dmn_idx=0;dmn_idx lmt[lmt_idx].end){ /* WRP true for this dimension */ WRP=True; if(lmt[lmt_idx].srd != 1L){ /* SRD true for this dimension */ long greatest_srd_multiplier_1st_hyp_slb; /* greatest integer m such that srt+m*srd < dmn_sz */ long last_good_idx_1st_hyp_slb; /* C index of last valid member of 1st hyperslab (= srt+m*srd) */ long left_over_idx_1st_hyp_slb; /* # elements from first hyperslab to count towards current stride */ long first_good_idx_2nd_hyp_slb; /* C index of first valid member of 2nd hyperslab, if any */ /* NB: Perform these operations with integer arithmatic or else! */ dmn_cnt_1[dmn_idx]=1L+(dmn_sz[dmn_idx]-lmt[lmt_idx].srt-1L)/lmt[lmt_idx].srd; /* Wrapped dimensions with a stride may not start at idx 0 on second read */ greatest_srd_multiplier_1st_hyp_slb=(dmn_sz[dmn_idx]-lmt[lmt_idx].srt-1L)/lmt[lmt_idx].srd; last_good_idx_1st_hyp_slb=lmt[lmt_idx].srt+lmt[lmt_idx].srd*greatest_srd_multiplier_1st_hyp_slb; left_over_idx_1st_hyp_slb=dmn_sz[dmn_idx]-last_good_idx_1st_hyp_slb-1L; first_good_idx_2nd_hyp_slb=(last_good_idx_1st_hyp_slb+lmt[lmt_idx].srd)%dmn_sz[dmn_idx]; dmn_in_srt_2[dmn_idx]=lmt[lmt_idx].srd-left_over_idx_1st_hyp_slb-1L; }else{ /* !SRD */ dmn_in_srt_2[dmn_idx]=0L; dmn_cnt_1[dmn_idx]=dmn_sz[dmn_idx]-lmt[lmt_idx].srt; } /* end else */ dmn_cnt_2[dmn_idx]=dmn_cnt[dmn_idx]-dmn_cnt_1[dmn_idx]; dmn_out_srt_2[dmn_idx]=dmn_cnt_1[dmn_idx]; } /* end if WRP */ break; /* Move on to next dimension in variable */ } /* end if */ } /* end loop over lmt */ } /* end loop over dim */ if(dbg_lvl >= 5){ (void)fprintf(stderr,"\nvar = %s\n",var_nm); (void)fprintf(stderr,"dim\tcnt\tsrtin1\tcnt1\tsrtout1\tsrtin2\tcnt2\tsrtout2\n"); for(dmn_idx=0;dmn_idx wrp_max) val_dbl-=wrp_spn; } /* end loop over idx */ } /* endif CRD && MNT */ } /* endif False */ if(!SRD){ ncvarget(in_id,var_in_id,dmn_in_srt_1,dmn_cnt_1,void_ptr); ncvarput(out_id,var_out_id,dmn_out_srt_1,dmn_cnt_1,void_ptr); ncvarget(in_id,var_in_id,dmn_in_srt_2,dmn_cnt_2,void_ptr); ncvarput(out_id,var_out_id,dmn_out_srt_2,dmn_cnt_2,void_ptr); }else{ ncvargetg(in_id,var_in_id,dmn_in_srt_1,dmn_cnt_1,dmn_srd,(long *)NULL,void_ptr); ncvarput(out_id,var_out_id,dmn_out_srt_1,dmn_cnt_1,void_ptr); ncvargetg(in_id,var_in_id,dmn_in_srt_2,dmn_cnt_2,dmn_srd,(long *)NULL,void_ptr); ncvarput(out_id,var_out_id,dmn_out_srt_2,dmn_cnt_2,void_ptr); } /* end else */ (void)free(dmn_in_srt_1); (void)free(dmn_in_srt_2); (void)free(dmn_out_srt_1); (void)free(dmn_out_srt_2); (void)free(dmn_cnt_1); (void)free(dmn_cnt_2); } /* end if WRP */ /* Free space that held dimension IDs */ (void)free(dmn_map); (void)free(dmn_srd); (void)free(dmn_cnt); (void)free(dmn_id); (void)free(dmn_in_srt); (void)free(dmn_out_srt); (void)free(dmn_sz); /* Free space that held variable */ (void)free(void_ptr); } /* end cpy_var_val_lmt() */ void prn_var_def(int in_id,char *var_nm) /* int in_id: input netCDF input-file ID char *var_nm: input variable name */ { /* Routine to print the variable metadata. This routine does not take into account any user-specified limits, it just prints what it finds. */ extern int ncopts; int *dmn_id=NULL_CEWI; int idx; int nbr_dim; int nbr_att; int rec_dmn_id; int var_id; nc_type var_type; dmn_sct *dim=NULL_CEWI; /* See if the requested variable is in the input file. */ var_id=ncvarid(in_id,var_nm); /* Get the number of dimensions, type, and number of attributes for the variable. */ (void)ncvarinq(in_id,var_id,(char *)NULL,&var_type,&nbr_dim,(int *)NULL,&nbr_att); /* Get the ID of the record dimension, if any */ (void)ncinquire(in_id,(int *)NULL,(int *)NULL,(int *)NULL,&rec_dmn_id); /* Print the header for the variable */ (void)fprintf(stdout,"%s: # dim. = %i, %s, # att. = %i, ID = %i\n",var_nm,nbr_dim,nc_type_nm(var_type),nbr_att,var_id); if(nbr_dim > 0){ /* Allocate space for dimension info */ dim=(dmn_sct *)malloc(nbr_dim*sizeof(dmn_sct)); dmn_id=(int *)malloc(nbr_dim*sizeof(int)); } /* end if nbr_dim > 0 */ /* Get dimension IDs */ (void)ncvarinq(in_id,var_id,(char *)NULL,(nc_type *)NULL,(int *)NULL,dmn_id,(int *)NULL); /* Get dimension sizes and names */ for(idx=0;idx0){ long var_sz=1L; char sz_sng[100]; char sng_foo[200]; for(idx=0;idx 0){ (void)free(dim); (void)free(dmn_id); } /* end if nbr_dim > 0*/ } /* end prn_var_def() */ void prn_var_val_lmt(int in_id,char *var_nm,lmt_sct *lmt,int lmt_nbr,char *dlm_sng,bool FORTRAN_STYLE,bool PRINT_DIMENSIONAL_UNITS) /* int in_id: input netCDF input-file ID char *var_nm: input variable name lmt_sct *lmt: input structure from lmt_evl() holding dimension limit info. int lmt_nbr: input number of dimensions with user-specified limits char *dlm_sng: input user-specified delimiter string, if any bool FORTRAN_STYLE: input switch to determine syntactical interpretation of dimensional indices bool PRINT_DIMENSIONAL_UNITS: input switch for printing units attribute, if any. */ { /* Purpose: Print variable data Routine truncates dimensions of printed output variable in accordance with user-specified limits However, this routine is unable to correctly print hyperslabs which are wrapped, or which use the stride attribute */ bool SRD=False; bool WRP=False; char *type_fmt_sng(nc_type); char *unit_sng=""; /* fxm: strings statically allocated with MAX_LEN_FMT_SNG chars are not safe */ /* Length could be computed at run time but is a pain */ #define MAX_LEN_FMT_SNG 100 char var_sng[MAX_LEN_FMT_SNG]; extern int ncopts; int *dmn_id=NULL_CEWI; int idx; long *dmn_cnt=NULL_CEWI; long *dmn_map=NULL_CEWI; long *dmn_mod=NULL_CEWI; long *dmn_sbs_ram=NULL_CEWI; long *dmn_sbs_dsk=NULL_CEWI; long *dmn_srd=NULL_CEWI; long *dmn_srt=NULL_CEWI; long *hyp_mod=NULL_CEWI; long lmn; dmn_sct *dim=NULL_CEWI; var_sct var; /* Copy name into var structure for aesthetics. Unfortunately, Solaris machines can overwrite var.nm with next malloc(), so continue to use var_nm for output just to be safe. */ var.nm=(char *)strdup(var_nm); /* See if requested variable is in input file. */ var.id=ncvarid(in_id,var_nm); /* Get number of dimensions and type for variable. */ (void)ncvarinq(in_id,var.id,(char *)NULL,&var.type,&var.nbr_dim,(int *)NULL,(int *)NULL); if(var.nbr_dim > 0){ /* Allocate space for dimension info */ dim=(dmn_sct *)malloc(var.nbr_dim*sizeof(dmn_sct)); dmn_cnt=(long *)malloc(var.nbr_dim*sizeof(long)); dmn_id=(int *)malloc(var.nbr_dim*sizeof(int)); dmn_map=(long *)malloc(var.nbr_dim*sizeof(long)); dmn_srd=(long *)malloc(var.nbr_dim*sizeof(long)); dmn_srt=(long *)malloc(var.nbr_dim*sizeof(long)); /* Allocate space for related arrays */ dmn_mod=(long *)malloc(var.nbr_dim*sizeof(long)); dmn_sbs_ram=(long *)malloc(var.nbr_dim*sizeof(long)); dmn_sbs_dsk=(long *)malloc(var.nbr_dim*sizeof(long)); hyp_mod=(long *)malloc(var.nbr_dim*sizeof(long)); } /* end if var.nbr_dim > 0 */ /* Get dimension IDs */ (void)ncvarinq(in_id,var.id,(char *)NULL,(nc_type *)NULL,(int *)NULL,dmn_id,(int *)NULL); /* Get dimension sizes and names */ for(idx=0;idx lmt[lmt_idx].max_idx) WRP=True; break; } /* end if */ } /* end loop over lmt_idx */ if(WRP){ (void)fprintf(stdout,"%s: ERROR %s does not print variable hyperslabs where one or more of the coordinates is wrapped using the -d option (i.e., where the minimum index exceeds the maximum index such as longitude hyperslabs which cross the date-line. The workaround is to hyperslab into a new file (without -H) and then to print the values from that file (with -H).\n",prg_nm_get(),prg_nm_get()); exit(EXIT_FAILURE); } /* endif error */ /* Is dimension a coordinate, i.e., stored as a variable? */ dim[idx].val.vp=NULL; ncopts=0; dim[idx].cid=ncvarid(in_id,dim[idx].nm); ncopts=NC_VERBOSE | NC_FATAL; /* Read in coordinate dimensions */ if(dim[idx].cid != -1){ /* Find out what type of variable coordinate is */ (void)ncvarinq(in_id,dim[idx].cid,(char *)NULL,&dim[idx].type,(int *)NULL,(int *)NULL,(int *)NULL); /* Allocate enough space to hold coordinate */ dim[idx].val.vp=(void *)malloc(dmn_cnt[idx]*nctypelen(dim[idx].type)); /* Retrieve this coordinate */ if(dmn_srd[idx] == 1L) (void)ncvarget(in_id,dim[idx].cid,dmn_srt+idx,dmn_cnt+idx,dim[idx].val.vp); else ncvargetg(in_id,dim[idx].cid,dmn_srt+idx,dmn_cnt+idx,dmn_srd+idx,(long *)NULL,dim[idx].val.vp); /* Typecast pointer to values before access */ (void)cast_void_nctype(dim[idx].type,&dim[idx].val); } /* end if dimension is coordinate */ } /* end loop over dim */ /* Find total size of variable array */ var.sz=1L; for(idx=0;idx 0 && dlm_sng == NULL){ /* Generate a nicely formatted output for multidimensional arrays */ char arr_lft_dlm; char arr_rgt_dlm; char dmn_sng[MAX_LEN_FMT_SNG]; int crd_idx_crr; /* Current coordinate index */ int dmn_idx; int dmn_idx_prn_srt; /* Index of first dimension to explicitly print */ int dmn_nbr_prn; /* Number of dimensions deconvolved */ int mod_idx; long dmn_sbs_prn; /* Subscript adjusted for C-Fortran indexing convention */ long hyp_srt=0L; long idx_crr; /* Current index into equivalent 1-D array */ short ftn_idx_off; /* Variable is an array */ /* Figure out modulo masks for each index */ for(idx=0;idx 0){ for(idx=0;idx= 6)(void)fprintf(stdout,"DEBUG: format string used for chars is dmn_sng = %s, var_sng = %s\n",dmn_sng,var_sng); /* Newline separates consecutive values within given variable */ (void)fprintf(stdout,"\n"); (void)fflush(stdout); /* Skip rest of loop for this element, move to next element */ continue; } /* endif */ switch(var.type){ case NC_FLOAT: (void)fprintf(stdout,var_sng,var_nm,idx_crr,var.val.fp[lmn],unit_sng); break; case NC_DOUBLE: (void)fprintf(stdout,var_sng,var_nm,idx_crr,var.val.dp[lmn],unit_sng); break; case NC_SHORT: (void)fprintf(stdout,var_sng,var_nm,idx_crr,var.val.sp[lmn],unit_sng); break; case NC_LONG: (void)fprintf(stdout,var_sng,var_nm,idx_crr,var.val.lp[lmn],unit_sng); break; case NC_CHAR: (void)fprintf(stdout,var_sng,var_nm,idx_crr,var.val.cp[lmn],unit_sng); break; case NC_BYTE: (void)fprintf(stdout,var_sng,var_nm,idx_crr,var.val.bp[lmn],unit_sng); break; } /* end switch */ } /* end loop over element */ } /* end if variable is an array, not a scalar */ /* Additional newline between consecutive variables or final variable and prompt */ (void)fprintf(stdout,"\n"); (void)fflush(stdout); /* Free space allocated for dimension */ for(idx=0;idx 0){ (void)free(dim); (void)free(dmn_cnt); (void)free(dmn_id); (void)free(dmn_map); (void)free(dmn_mod); (void)free(dmn_sbs_ram); (void)free(dmn_sbs_dsk); (void)free(dmn_srd); (void)free(dmn_srt); (void)free(hyp_mod); } /* end if nbr_dim > 0*/ /* Free space allocated for variable */ (void)free(var.val.vp); (void)free(var.nm); if(strlen(unit_sng) > 0) (void)free(unit_sng); } /* end prn_var_val_lmt() */