INDEX
changeset 3 55a8c407d38e
child 4 ff72b00b4342
equal deleted inserted replaced
2:75410953a4d5 3:55a8c407d38e
       
     1 ======================================================================
       
     2                     I N D E X 
       
     3                     doc: Wed Jun 18 09:46:58 1997
       
     4                     dlm: Tue Oct 16 09:12:43 2012
       
     5                     (c) 1997 Andreas Thurnherr
       
     6                     uE-Info: 122 0 NIL 0 0 72 2 2 4 NIL ofnI
       
     7 ======================================================================
       
     8 
       
     9 NOTES:
       
    10 	- for documentation see [doc/INDEX]
       
    11 	- utilities not in ubtest are marked with !!!
       
    12 
       
    13 =Utilities=
       
    14 
       
    15 -Oceanographic-
       
    16 
       
    17 [ARGOSfloatdrift]	split ARGOS float track into subsurface/surface portions
       
    18 [CMrecavg]			record-average velocity & stderr
       
    19 [CTD_w]				calculate w from isopycnal displacement
       
    20 [dist]				distance on Earth's surface
       
    21 [distn]				station distance / mid point btw 2 profiles
       
    22 [distcircle]		calc geographic coords a given distance from point
       
    23 [distfrom]			calculate distance to particular station
       
    24 [dreckon]			dead reckoning (calc geo coords from length displacement)
       
    25 [dynmodes]!!!		calculate dynamical modes
       
    26 [expandtrack]		build interpolate track between stations
       
    27 [gamma_n]			calculate neutral densities
       
    28 [gvel]				calculate geostrophic velocities
       
    29 [interpstn]			interpolate between 2 stations
       
    30 [isopycnal_TS]		calc TS props on isopycnal
       
    31 [LADCPfs]!!!		calculate LADCP finestructure from [binpgrams] output
       
    32 [N]!!!				calculate buoyancy frequency
       
    33 [NMEA2latlon]		extract lat/lon info from NMEA strings
       
    34 [NODCsplit]!!!		split NODC_SD2 file into components
       
    35 [repeatstations]!!!	find repeat stations
       
    36 [Ri]!!!				calculate Richardson number
       
    37 [Rrho]!!!			stability ratio profile
       
    38 [thorpe77]!!!		calc Thorpe fluctuations
       
    39 [tidalphasediff]	calc M2 & K1 phase differences between two profiles
       
    40 [trackdist]			calculate distance for track-files
       
    41 [tracksplit]		split data set into linear tracks
       
    42 [veldiff]			compare velocity profiles
       
    43 	[.interp.linear]		linear interpolation
       
    44 	[.interp.poly]			polygonal interpolation
       
    45 	[.interp.spline]		spline interpolation
       
    46 	[.interp.nnbr]			nearest-neighbor
       
    47 	[.interp.ADCP]			RDI ADCP velocity sampling (triangular instrument response)
       
    48 [waterdepth]!!!		get water depth from Smith and Sandwell topography	
       
    49 [xover]				get crossover stations
       
    50 [xpgrams]!!!		extract pgrams from [binpgrams] [LADCPfs] output for plotting
       
    51 [yoyo]				splits yoyo file into individual casts
       
    52 
       
    53 -Model Fitting-
       
    54 
       
    55 [lfit]				linear least squares
       
    56 [match]!!!			match two data sets --- UNFINISHED
       
    57 	[.interp.linear]		linear interpolation
       
    58 	[.interp.poly]			polygonal interpolation
       
    59 	[.interp.spline]		spline interpolation
       
    60 	[.interp.nnbr]			nearest-neighbor
       
    61 [mfit]!!!			robust linear regression
       
    62 [lmfit]				non-linear least-squares (Levenberg-Marquardt)
       
    63 	[.lmfit.poly]		fit polynomial
       
    64 	[.lmfit.gauss]		fit Gaussian
       
    65 	[.lmfit.exp]		fit exponential
       
    66 [lsfit]				generalized linear least-squares
       
    67 	[.lsfit.poly]		fit polynomial
       
    68 	[.lsfit.bilin]		bi-linear fit
       
    69 
       
    70 -Stats-
       
    71 
       
    72 [avg]				avg/stddev/stderr/ndata/outliers/mean-sq amp/absolute mag/rms/gaussian avg
       
    73 [avgr]				avg correlation coefficient
       
    74 [bootstrap]			calc bootstrap confidence interval
       
    75 [Hist]				histogram
       
    76 [histeq]			histogram equalization
       
    77 [max]				maximum
       
    78 [median]			median
       
    79 [min]				minimum
       
    80 [Minmax]			min/max combo
       
    81 
       
    82 -Calculations-
       
    83 
       
    84 [abc]				PERL floating point replacement for expr(1)/bc(1)
       
    85 [count]				as in 1, 2, 3, ...
       
    86 [fdiff]				first differencing
       
    87 [fillgaps]			general interpolation of missing data
       
    88 	[.nminterp.linear]
       
    89 	[.nminterp.spline]
       
    90 [integrate]			integrate data
       
    91 [sum]				calc sum of field
       
    92 !!![wdiff]			window differencing
       
    93 
       
    94 -Filters-
       
    95 
       
    96 [fftfilt]			simplistic frequency domain digital filter
       
    97 [fgauss]!!!			running Gaussian filter
       
    98 [fmean]!!!			running mean filter
       
    99 [fmedian]!!!		median filter (OBSOLETE)
       
   100 [rfilt]!!!			general running filter (mean, median, min, max, ...)
       
   101 
       
   102 -Spectral Methods-
       
   103 
       
   104 [binpgrams]!!!		calc peridograms in (possibly overlapping) bins
       
   105 [lagcorr]			(lag) correlation / autocorrelation
       
   106 [pgram]				calc periodograms (power spectra)
       
   107 
       
   108 -Data Selection/Handling-
       
   109 
       
   110 [ANTS2mat]			Matlab export
       
   111 [bindata]			bin data & calc stats
       
   112 [binmerge]!!!		merge data into binned file (e.g. from [binpgrams])
       
   113 [Cat]				ants version of cat(1) 
       
   114 [crossings]!!!		get records when specific field val is crossed
       
   115 [data]!				get info about data
       
   116 [ded]				data editor
       
   117 [distfromtrack]!!!	calculate minimum perpendicular distance to piece-wise linear track
       
   118 [Echo]				ants versions of echo(1)
       
   119 [fileavg]!!!		avg, stddev files record-by-record
       
   120 [filediff]!			calc difference between files record-by-record
       
   121 [filestats]!!!		calc arbitrary stats of files record-by-record
       
   122 [fnr]				extracts field# from header or from Layout file
       
   123 [gextrema]			select extrema
       
   124 [glist]				select records from list
       
   125 [glmax]!!!			find local maxima
       
   126 [gmonot]!!!			select monotonic records (remove spurious inversions)
       
   127 [gpoly]				select points inside a polygon
       
   128 [how]!!!			extract command sequence from ANTS header
       
   129 [importCNV]			read ASCII and binary SeaBird CNV files
       
   130 [importfixed]		import fixed-size records
       
   131 [list]				list data and metadata
       
   132 [listNC]			list netcdf(1) data and metadata
       
   133 [merge]				merge files by matching numeric values
       
   134 [NCode]				encode ANTS to netcdf
       
   135 [resample]			resample data
       
   136 	[.interp.linear]		linear interpolation
       
   137 	[.interp.poly]			polygonal interpolation
       
   138 	[.interp.spline]		spline interpolation
       
   139 	[.interp.nnbr]			nearest-neighbor
       
   140 	[.interp.fillnan]		fill with nans
       
   141 [reverse]			reverse order of records in file
       
   142 [scantext]			extract numbers from free-format text files
       
   143 [Sort]				sort data
       
   144 [Split]				split data file according to field value
       
   145 [splitCNV]			split ASCII SeaBird CNV file
       
   146 [splitNC]			extract multiple ANTS files from single netCDF
       
   147 [stackplots]		plot multiple files with offsets
       
   148 [subsample]			nearest-neighbors; does not need monotonic x field
       
   149 [varbindata]		bin data in variable-sized bins
       
   150 
       
   151 -Misc-
       
   152 
       
   153 [fixfmt]!!!			fix path in ANTS header & nan format
       
   154 [tile]!!!			tile eps-files by 8
       
   155 [tabulate]!!!		make visually pleasing table from data
       
   156 
       
   157 -Debugging-
       
   158 
       
   159 [argtest]			test argument typechecking stuff
       
   160 
       
   161 
       
   162 =ANTS Libraries=
       
   163 
       
   164 [ants.pl]			common stuff
       
   165 	[antsio.pl]		input/output handling
       
   166 	[antsusage.pl]	usage handling
       
   167 	[antsutils.pl]	miscellaneous
       
   168 [antsfilters.pl]	library for data filtering
       
   169 [antsintegrate.pl]	integrator
       
   170 
       
   171 =Libraries (for -L)=
       
   172 
       
   173 [libCPT.pl]			GMT cpt file parsing
       
   174 [libEOS83.pl]		equation of state
       
   175 [libfuns.pl]		chapter 6 from NR: special functions; own stuff
       
   176 [libgamma.pl]		Jacket + McDougall gamma_n
       
   177 [libGHP.pl]			Gregg-Henyey-Polzin parameterization
       
   178 [libGM.pl]			Garrett & Munk spectrum
       
   179 [libLADCP.pl]		LADCP-related funs
       
   180 [libNODC.pl]!!!		NODC SD2 conversions
       
   181 [libPOSIX.pl]		POSIX functions
       
   182 [libstats.pl]		significance tests
       
   183 [libubtest.pl]		testing stuff
       
   184 [libvec.pl]			vector stuff, including distance on globe
       
   185 [libWOCE.pl]		WOCE conversions
       
   186 [libconv.pl]		conversions
       
   187 
       
   188 =Numerical Recipes Routines=
       
   189 
       
   190 [covsrt.pl]			for [lmfit]
       
   191 [fft.pl]			FFT
       
   192 [gaussj.pl]			Gaussian eliminiation
       
   193 [lfit.pl]			linear least squares
       
   194 [mrqcof.pl]			for [lmfit]
       
   195 [mrqmin.pl]			for [lmfit]
       
   196 [nrutil.pl]			aux utilities (vector/matrix/macros)
       
   197 [pearsn.pl]			for [corr]
       
   198 [polint.pl]			for [.interp.poly]
       
   199 [pythag.pl]			pythagoras
       
   200 
       
   201 =GMT Utilities=
       
   202 
       
   203 [adjustROI]!!!		make ROI compatible with grd file
       
   204 [CPTcolor]!!!		extract colour from cpt-file
       
   205 [CPTcontours]!!!	extract contour-levels from cpt-file
       
   206 [grdjoin]!!!		join multiple compatible grd files
       
   207 [lmcont]!!!			linear contouring of (quasi-)monotonic data
       
   208 [mkCPT]				makecpt(l) replacement
       
   209 [rectangulate]!!!	construct GMT multiseg rectangles from x/y/z/width info
       
   210 [psbath]!!!			build bathymetric map; similar to pscoast
       
   211 [psROI]!!!			psxy frontent to plot regions of interest
       
   212 [psSamp]!!!			generate GMT-compatible PS output for pie-wedge (repeat-)station data
       
   213