Matlab Toolbox - Applicaties Helpdesk Water

Matlab Toolbox
versie 1.0
augustus 1999
a d v i e s

Matlab Toolbox
versie 1.0, augustus 1999
Opdrachtgever: Rijksinstituut voor Kust en Zee / RIKZ
Project: NAUTILUS
Samenstelling: ir P.J. Dekker, Xi advies
Inhoudsopgave
Xi advies bv
cairostraat 13
2622 cv delft
tel 015 2572516
fax 015 2572566
1. Matlab Toolbox ......................................................................................................................................... 5
2

2. Funkties...................................................................................................................................................... 6
2.1 bullet .................................................................................................................................................... 6
2.2 but_list ................................................................................................................................................. 6
2.3 capital................................................................................................................................................... 6
2.4 clr_uvdb ............................................................................................................................................... 7
2.5 clrspace ................................................................................................................................................ 7
2.6 clw........................................................................................................................................................ 7
2.7 clwna.................................................................................................................................................... 8
2.8 color_br................................................................................................................................................ 8
2.9 dcomment............................................................................................................................................. 8
2.10 deblanka............................................................................................................................................. 8
2.11 deblankl.............................................................................................................................................. 9
2.12 deblankr ............................................................................................................................................. 9
2.13 dist_vld .............................................................................................................................................. 9
2.14 door_vld............................................................................................................................................. 9
2.15 drs_lijn............................................................................................................................................. 10
2.16 dum2nan .......................................................................................................................................... 10
2.17 elements ........................................................................................................................................... 10
2.18 find_mn............................................................................................................................................ 11
2.19 findnnan ........................................................................................................................................... 11
2.20 findsinm........................................................................................................................................... 11
2.21 findsnim........................................................................................................................................... 12
2.22 fstrrep............................................................................................................................................... 12
2.23 grid_rct............................................................................................................................................. 12
2.24 grid_vld............................................................................................................................................ 13
2.25 grid2vld............................................................................................................................................ 13
2.26 lijn2vld............................................................................................................................................. 13
2.27 make_axs ......................................................................................................................................... 13
2.28 make_uvdb....................................................................................................................................... 14
2.29 nan2zero........................................................................................................................................... 15
2.30 new................................................................................................................................................... 15
2.31 nicetime............................................................................................................................................ 15
2.32 num_str ............................................................................................................................................ 15
2.33 num2time ......................................................................................................................................... 16
2.34 pijlpunt............................................................................................................................................. 16
2.35 plot_nan ........................................................................................................................................... 17
2.36 rand_vld ........................................................................................................................................... 17
2.37 rand2vld ........................................................................................................................................... 17
2.38 read_cmp.......................................................................................................................................... 17
2.39 redblue ............................................................................................................................................. 18
2.40 redgreen ........................................................................................................................................... 18
2.41 remove ............................................................................................................................................. 18
2.42 roteer................................................................................................................................................ 18
2.43 rotr ................................................................................................................................................... 19
2.44 spacesl.............................................................................................................................................. 19
2.45 split_ln ............................................................................................................................................. 19
2.46 splitxln ............................................................................................................................................. 19
2.47 str2labl ............................................................................................................................................. 20
2.48 str2vec.............................................................................................................................................. 20
2.49 strcmpci............................................................................................................................................ 20
3

2.50 text2str ............................................................................................................................................. 20
2.51 venwlogo.......................................................................................................................................... 21
2.52 xi_logo ............................................................................................................................................. 21
2.53 zero2nan........................................................................................................................................... 21
2.54 z_interfaces...................................................................................................................................... 21
4

1. Matlab Toolbox
In het verleden zijn door Xi, tijdens de ontwikkeling van programmatuur voor RIKZ, functies, die door
hun algemene karakter mogelijkerwijs ook door anderen gebruikt zouden kunnen worden, in een aparte
directory sources ondergebracht.
Niet iedere functie is volledig uitontwikkeld. Soms is alleen die functionaliteit die voor de betreffende
GUI noodzakelijk of nuttig was uitgewerkt, en zijn de meer algemene moeglijkheden slechts rudimentair
ontwikkeld.
Daarnaast zijn er voor de GUIMAKER, een soort vertaalmechanisme voor GUI commando’s, een aantal
specifieke functies gebouwd. Door de ontwikkeling binnen Matlab van onder andere GUIDE, de GUI
Editor, is de GUIMAKER in onbruik geraakt. De nog bruikbare functionaliteit zou daarom beter in
andere, meer algemene functies kunnen worden ondergebracht. Voor de volledigheid worden deze
functies wel genoemd, en kort toegelicht.
In het nu volgende hoofdstuk zijn alle functies opgenomen die in de directories sources van de Modellen
en de WAQAD GUI staan. In de documentatie van de betreffende GUI’s is aangegeven welke functies
daadwerkelijk worden gebruikt.
5

2. Funkties
2.1 bullet
function h_bullet = bullet(x,y,r,b_color,handle_axes)
%BULLET Place a bullet at position (x,y) with radius r.
% CALL
% BULLET(X,Y,R,B_COLOR,HANDLE_AXES) places a bullet with color B_COLOR
% at position (X,Y) with radius R in the axes with handle HANDLE_AXES.
Met bullet wordt een gevulde cirkel getekend op plaats (x,y) in een axes, met straal r, in de
coördinaten van de axes. Wordt bijvoorbeeld gebruikt in de WAQAD GUI bij het tekenen van stations.
2.2 but_list
function handle_butlist = but_list(list_pos,number,list_string,handle_figure);
%BUT_LIST Generate a list of radio buttons with an all on/off push button.
% CALL
% HANDLE_BUTLIST = BUT_LIST(LIST_POS,NUMBER,LIST_STRING,HANDLE_FIGURE)
% creates a list of Check boxes at position LIST_POS.
% LIST_POS contains the position (X,Y), width W and heigth H.
% Number of list items is NUMBER. Strings are given with LIST_STRING,
% which has length 1 or NUMBER.
% The position (X,Y) lies in the figure with handle HANDLE_FIGURE.
% Default is GCF.
% The return handle is HANDLE_BUTLIST, which is in fact a list of
% handles to the check boxes, from top to bottom.
% This can be used to set CallBacks for the
% UiControls and switch visability on/off.
%
% Layout: [ 1 ] [n/2+1]
% [ ... ] [.....]
% [ n/2 ] [ n ]
% [ sel/clr all ]
%
% See also: BOX_LIST
In de Modellen GUI is het mogelijk om één of meerdere lagen te selecteren. Het aantal lagen wordt in het
.def bestand van het scenario vastgelegd. De GUI genereert vervolgens met but_list een lijst van
radiobuttons, ter lengte van het aantal lagen, met een bijbehorende [select/clear all] knop, waarmee in één
keer alle lagen aan of uit kunnen worden gezet. Er wordt nog geen CallBack voor de knoppen
gedefinieerd.
2.3 capital
function out = capital(in)
%CAPITAL Lower all characters in string, but capitalize first
% CALL
% CAPITAL(S) lowers all characters in a string and
% capitalizes the first character.
%
% EXAMPLE
% CAPITAL('coLOr') returns 'Color'
6

capital werd gebruikt in de GUIMAKER.
2.4 clr_uvdb
function clr_uvdb(h_video);
%CLR_UVDB Clear ultimate video bar
% CALL
% CLR_UVDB(H_VIDEO) delete's all abjects off the Ultimate ViDeo Bar
%
% See also: MAKE_UVDB, MAKE_VDB, MAKE_XVDB, BUT_LIST, BOX_LIST
% INPUT
% HANDLE_VIDEO - STRUCT with handles of video bar elements
% XVDBTXT - text field
% SLIDER - slider
% MINVAL - text field for minimum value of slider
% CURVAL - text field for current value of slider
% MAXVAL - text field for maximum value of slider
% DIREC - toggle button for direction
% BACK - pushbutton for one step back
% RESET - pushbutton for reset
% FWD - pushbutton for one step forward
% PLAY - pushbutton for play all
clr_uvdb verwijdert de objecten van de Ultimate ViDeo Bar. Zie make_uvdb.
2.5 clrspace
function s_out = clrspace(s_in)
%CLRSPACE Remove all blanks (ASCII 32) from a (matrix of) string(s).
% CALL
% S_OUT = CLRSPACE(S_IN) removes all blanks (ASCII character 32)
% from a string or matrix of strings S_IN.
%
% See also ISSPACE, SETSTR, ISSTR, STRINGS.
% INPUT
% S_IN - string
% OUTPUT
% S_OUT - string
% EXAMPLE
% CLRSPACE(' Thank you ') returns 'Thankyou'.
clrspace werd gebruikt in de GUIMAKER.
2.6 clw
function clw(handle_window)
%CLW Delete all objects, except UIMENU, from window.
% CALL
% CLW(HANDLE_WINDOW) deletes all objects (axes, images, patches,
% surfaces, texts, lines and uicontrols) from the current window.
% Only uimenus are saved. Default window GCF.
%
% See also CLWNA, CLA, CLF, RESET, HOLD.
Het commando clf verwijdert alle objecten uit een figure, inclusief de uimenu’s. clw laat deze laatste
staan.
7

2.7 clwna
function clwna(handle_window)
%CLWNA CLear Window, Not Axes.
% CALL
% CLWNA deletes all objects (lines, text, patches, surfaces,
% images) of axes but NOT axes itself from the current window.
% Uimenus en uicontrols are also saved.
% CLWNA(handle_window) does the same for the figure
% with handle HANDLE_WINDOW.
%
% See also CLW, CLA, CLF, RESET, HOLD.
clwna is vergelijkbaar met clw, maar nu wordt alleen de inhoud van alle in het figure aanwezige axes
verwijderd, en blijven de axes, uimenu’s en uicontrol’s van het figure behouden.
2.8 color_br
function h_cb = color_br(cb_map, cb_label, cb_title, cb_font_size, handle_axes)
%COLOR_BR Alternative colorbar for nonlinear colormap, independent of CAXIS.
% CALL
% H_CB = COLOR_BR(CB_MAP, CB_LABEL, CB_TITLE, CB_FONT_SIZE, HANDLE_AXES)
% draws an alternative colorbar in the axes with handle HANDLE_AXES.
% Default axes is GCA.
% It does NOT use the colormap associated to the figure in which the axes
% is drawn, but merely plots the colormap defined by the (mx3) matrix
% CB_MAP.
% If the label-vector CB_LABEL has (m+1) elements, those are used,
% else a default number of 7 is applied. CB_TITLE and
% CB_FONT_SIZE are obvious.
De functie color_br maakt een alternatief soort colorbar. De standaard functie colorbar van Matlab
geeft de colormap van het current figure weer, en het bereik wordt bepaald door de instelling van caxis.
color_br geeft een colormap weer, die in feite onafhankleijk van de colormap van de figure kan zijn,
alhoewel dit niet zinvol is. De functie wordt veelal gebruikt wanneer de data nog nabewerkt moet worden,
bijvoorbeeld door er de logaritme van te nemen. Het is dan mogelijk om zelf de titel van de colorbar, de
labels van de scheidingswaarden, de grootte van het font en de plaats in te stellen. De colorbar wordt
vullend in een axes geplaatst. De colormaps kunnen bijvoorbeeld met de ColorMap Editor van de
Modellen GUI worden aangemaakt.
2.9 dcomment
function s_uit = dcomment(s_in)
%DCOMMENT Verwijder commentaar uit string.
% AANROEP
% S_UIT = DCOMMENT(S_IN) verwijdert het commentaar uit een string.
% Commentaar is alles vanaf het %-teken tot het einde van de string.
2.10 deblanka
function s1 = deblanka(s)
%DEBLANKA Strip blanks and nulls from begin and end of a string.
% CALL
% DEBLANKA(S) combines functions DEBLANKL and DEBLANKR,
% which respectively remove beginning and trailing blanks
% from a string.
%
% See also DEBLANKL, DEBLANKR.
8

2.11 deblankl
function s1 = deblankl(s)
%DEBLANKL Strip blanks from begin of a string.
% CALL
% DEBLANKL(S) removes the blanks and any null characters from
% the beginning of a string S. A null character is one that
% has an absolute value of 0.
%
% See also DEBLANKR, DEBLANKA, DEBLANK.
2.12 deblankr
function s1 = deblankr(s)
%DEBLANKR Strip trailing blanks from end of a string.
% DEBLANKR(S) removes the trailing blanks and any null characters from
% a string S. A null character is one that has an absolute value of 0.
%
% See also DEBLANKL, DEBLANKA, DEBLANK.
Deze funkties werden gebruikt door de GUIMAKER. De werking spreekt voor zich, het zijn variaties op
de Matlab funktie deblank.
2.13 dist_vld
function [u_veld,v_veld] = dist_vld(x_veld, y_veld)
%DIST_VLD Compute distances between points in parametric grid.
% CALL
% [U_VELD, V_VELD] = DIST_VLD(X_VELD, Y_VELD) computes the distances
% between the points of a parametric grid, given by the matrices
% X_VELD and Y_VELD.
% If these are (mxn) matrices then output is two (m-1xn-1) matrices
% U_VELD and V_VELD with respectively the distances in X- and
% Y-direction.
% A nice side-effect: for vectors U_VELD and V_VELD are the same,
% the function can be called with one output parameter.
De afstanden tussen de punten van een parametrisch grid worden bepaald door
2 2
d = u + v
Met dist_vld worden alle afstanden in u- en v- richting in twee regels berekend.
2.14 door_vld
function z_interp = door_vld(z_mat,z_veld,aant_laag,poly_graad)
%DOOR_VLD Interpolatie van waarden naar de z-interfaces voor verticale doorsnede
% AANROEP
% Z_INTERP = DOOR_VLD(Z_MAT,Z_VELD,AANT_LAAG,POLY_GRAAD)
% berekent de geinterpoleerde waarden op de scheidingsvlakken voor een
% vertikale doorsnede van een model. De graad van het polynoom kan
% als invoerparameter meegegeven worden.
% INVOER
% Z_MAT - matrix met scheidingsvlakken of z-interfaces
% Z_VELD - matrix met waarde van het veld per laag
% AANT_LAAG - aantal lagen
% POLY_GRAAD - graad van het polynoom voor interpolatie, default 3
% UITVOER
% Z_INTERP - geinterpoleerde waarden van de velden
9

Bij het tekenen van een vertikale doorsnede van een veld wordt gebruik gemaakt van de functie
surface. Hierdoor wordt het de doorsnede één cel kleiner in beide richtingen. Om dit te corrigeren
worden de waarden in de lagen van het model naar de scheidingsvlakken of z-interfaces geïnterpoleerd
met de functie door_vld.m.
2.15 drs_lijn
function uit = drs_lijn(door_mn,x_veld,y_veld,ori,handle_axes)
%DRS_LIJN Teken doorsnedelijnen over kromlijnig grid.
% AANROEP
% DRS_LIJN(DOOR_MN, X_VELD, Y_VELD, ORI, HANDLE_AXES)
% tekent op een kromlijnig grid bij horizontale of vertikale
% langsdoorsneden behorende lijnen.
% INVOER
% DOOR_MN - lijst met indices
% X_VELD - matrix met x-coordinaten
% Y_VELD - matrix met y-coordinaten
% ORI - orientatie: horizontaal of vertikaal
% HANDLE_AXES - handle van de axes waarin de lijnen getekend
% moeten worden. Default GCA
In de Modellen GUI kan een verticale doorsnede van een curvelineair grid berekend worden. De
gebruiker klikt met de muis een aantal punten aan (in xy-coordinaten), waarna deze vervolgens tot een
lijst van mn-coordinaten wordt omgewerkt (zie ook find_mn). Met drs_lijn wordt de mncoordinaten
tot één lijn over het xy-grid samengevoegd. De parameter ori wordt nog niet gebruikt. Het
is met dezelfde methode namelijk mogelijk ook een horizontaal gebied (gesloten, maar niet convex) in te
voeren, er wordt dan een gesloten ‘rechthoek’ getekend.
2.16 dum2nan
function y = dum2nan(x,dummy_value)
%DUM2NAN Convert the dummyvalues in a variable to Not-a-Numbers.
% CALL
% Y = DUM2NAN(X,DUMMY_VALUE) converts all dummy values of
% X to NaN's, which is useful when plotting X.
% EXAMPLE
% X = [-999 1 -999 ; 2 1 2 ; 2 -999 2];
% DUM2NAN(X,-999) returns
% [NaN 1 NaN ;
% 2 1 2 ;
% 2 NaN 2 ]
Een algemene versie van zero2nan; allebei de functies zijn bedoeld om dummy waarden in een matrix
door NaN’s te vervangen, ten behoeve van het plotten.
2.17 elements
function [elts,nelt]=elements(x)
%ELEMENTS Elements of a matrix in set theoretic sense.
% ELEMENTS(X) is a row vector containing the
% distinct elements of X.
% [ELTS,NELT] = ELEMENTS(X) produces
% the elements of X in ELTS and
% the corresponding count of the elements in NELT.
% X is treated as 1 set and may contain NaN's and Inf's
% (which are counted also). Complex arrays as well as
% sparse matrices and text strings are handled properly.
10

% ELTS is sorted.
% Enter 'elements' for a demo.
% Author: J. Rodney Jee, rodjee@delphi.com, 28-JAN-95
Een uiterst nuttige non-Xi utility om alle verschillende elementen van een vector te vinden.
2.18 find_mn
function uit_mn = find_mn(x,y,xveld,yveld)
%FIND_MN Bereken (mn)coordinaten van (xy) in kromlijnig grid (XY).
% AANROEP
% UIT_MN = FIND_MN(X, Y, XVELD, YVELD) berekent de (matrix)
% mn-coordinaten van het punt (X,Y) in de matrices XVELD en YVELD.
% INVOER
% X - x-coordinaat
% Y - y-coordinaat
% XVELD - matrix met x-coordinaten
% YVELD - matrix met y-coordinaten
% UITVOER
% UIT_MN - mn-coordinaat
Bij het aanklikken van punten in een xy-grid met de muis resulteren xy-coordinaten (mbv de Matlab
funktie ginput). Om lijnen te kunnen tekenen en doorsneden te kunnen berekenen moeten de mncoordinaten
bepaald worden. Het minimum van alle afstanden van (x,y) tot het xy-grid wordt berekend
met
met x en y het grid, en (xxy,yxy) de coordinaten van het punt.
2.19 findnnan
function y = findnnan(x)
%FINDNNAN Zoek (mn) coordinaten van niet-NaN's in matrix.
% AANROEP
% Y = FINDNNAN(X) genereert een matrix Y met als kolommen
% achtereenvolgens het rij-nummer, het kolom-nummer en
% de waarde van de niet-NaN entries van X.
% Deze notatie is gelijk aan FIND voor sparse matrices.
% INVOER
% X - matrix of vector (full)
% UITVOER
% Y - matrix met 3 kolommen
% VOORBEELD
% X = [ 1 NaN ;
% NaN 4 ;
% 0 NaN ]
% geeft als uitvoer
% Y = [ 1 1 1 ;
% 3 1 0 ;
% 2 2 4 ]
De functie findnnan maakt het mogelijk een matrix met naast 0 ook NaN om te zetten naar de sparse
representatie.
2.20 findsinm
min( ( x − x ) + ( y − y )
2 2
xy xy
function row_idx = findsinm(s,m)
%FINDSINM Find row index of a string in a matrix of strings.
11

% CALL
% ROW_IDX = FINDSINM(S,M) returns the row index of
% a string S in a matrix M of strings. The occurrence
% of S does not have to be unique.
% FINDSINM is case insensitive.
%
% See also FINDSTR, STRCMP.
%
% EXAMPLE
% m = ['Wombat '; ...
% 'Badger '; ...
% 'Rabbit ';
% 'Squirrel'];
% s = 'badger';
% findsinm(s,m) returns 2.
Nuttige zoekfunctie naar een string in een lijst van strings.
2.21 findsnim
function row_idx = findsnim(s,m)
%FINDSNIM Find rows where a string does NOT occur in a matrix of strings.
% CALL
% ROW_IDX = FINDSNIM(S,M) returns the row indices of
% a matrix M where a string S does NOT occur.
%
% See also FINDSINM, FINDSTR, STRCMP.
%
% EXAMPLE
% m = ['Wombat '; ...
% 'Badger '; ...
% 'Rabbit ';
% 'Squirrel'];
% s = 'Badger';
% findsnim(s,m) returns [1 3 4]
Nuttige zoekfunctie naar niet voorkomen van een string in een lijst van strings.
2.22 fstrrep
function fstrrep(file_in,file_out, s_search, s_replace)
%FSTRREP
% Replace all occurrences of the elements of a matrix of strings
% in a file by the elements of another matrix of strings.
%
% FSTRREP(FILE_IN,FILE_OUT, S_SEARCH, S_REPLACE)
Funktie voor GUIMAKER
2.23 grid_rct
function [x,y] = grid_rct(m,n);
%GRID_RCT Create rectangular grid for curve linear surface plot
% CALL
% [X,Y] = GRID_RCT(M,N) creates matrices X and Y for a rectangular
% grid in curvelinear plots. Matrices have size MxN.
Funktie voor met name de WAQAD GUI, om bij een rechthoekig model toch over een ‘xy’-grid te
kunnen beschikken. De funktie creëert twee matrices met de in feite de indices van een mxn matrix met
de oorsprong in de linkeronderhoek in plaats van de linkerbovenhoek.
12

2.24 grid_vld
function grid_vld(x,y,c_back,c_grid,handle_axes)
%GRID_VLD Teken alleen de gridlijnen van een kromlijnig veld.
% AANROEP
% GRID_VLD(X,Y,C_BACK,C_GRID,HANDLE_AXES) tekent gridlijnen
% met kleur C_GRID over een kromlijnig veld met kleur C_BACK,
% in de axes met handle HANDLE_AXES. Default axes is GCA.
%
% Voor het tekenen van gridlijnen OVER een bestaand veld:
% zie GRID2VLD
Functie om een curvelineair grid te tekenen, bijvoorbeeld om de gebruiker in staat te stellen een punt
hieruit te selecteren met de muis.
2.25 grid2vld
function grid2vld(handle_axes,g_color)
%GRID2VLD Teken de gridlijnen over een kromlijnig veld.
% AANROEP
% GRID2VLD(HANDLE_AXES,G_COLOR) tekent gridlijnen over een
% kromlijnig veld in de axes met handle HANDLE_AXES in de
% kleur G_COLOR. Default kleur is wit.
% Default axes is GCA.
%
% Voor het tekenen van ALLEEN gridlijnen:
% zie GRID_VLD
Voeg gridlijnen toe aan een curvelineair grid.
2.26 lijn2vld
function h_lijn = lijn2vld(door_mn,x_veld,y_veld,ori,lijn_kleur,handle_axes)
%LIJN2VLD Teken een lijn over een kromlijnig dataveld of grid
% AANROEP
% H_LIJN = LIJN2VLD(DOOR_MN,X_VELD,Y_VELD,ORI,LIJN_KLEUR,HANDLE_AXES)
% tekent een lijn gegeven door DOOR_MN over een kromlijnig dataveld of
% grid, beschreven met X_VELD en Y_VELD, in de axes met
% handle HANDLE_AXES. Default axes is GCA.
% De parameter ORI, 'v' of 'h', bepaalt of er alleen lijnen of
% een gesloten contour getekend wordt.
% INVOER
% DOOR_MN - lijst met indices
% X_VELD - matrix met x-coordinaten
% Y_VELD - matrix met y-coordinaten
% ORI - string met orientatie:
% 'h' - horizontaal, 'v' - vertikaal
% LIJN_KLEUR - kleur van de lijnen, RGB-vector
% HANDLE_AXES - handle van de axes waarin de lijnen getekend
% moeten worden. Default GCA
% UITVOER
% H_LIJN - handle van de lijn
Vrijwel gelijk aan drs_lijn, alleen nu met instelbare kleur voor de lijn. Wordt onder andere gebruikt
door de SLIB_GUI’s.
2.27 make_axs
function handle_lst = make_axs(numb,handle_fig);
13

%MAKE_AXS Create a number of axes in a figure.
% CALL
% HANDLE_LST = MAKE_AXS(NUMB, HANDLE_FIG) creates NUMB axes in
% the figure with handle HANDLE_FIG. Default handle is GCF.
% Handles of axes are stored in HANDLE_LST.
%
% NUMB can be a single number, in which case the axes are made as:
% 1 - 0 2 - 00 3 - 000
%
% 4 - 00 5 - 000 6 - 000
% 00 00 000
%
% 7 - 0000 8 - 000 9 - 000
% 000 000 000
% 00 000
% or a (2x1)-vector [VER,HOR], where VER is the vertical and HOR
% the horizontal number of axes.
% Axes are numbered from top-left to bottom-right.
Wanneer er in de Modellen GUI meerdere lagen tegelijk getoond moeten worden in één figure, dan wordt
voor ieder surface een aparte axes aangemaakt met make_axs. In de help sectie is te zien hoe de axes
over het figure verdeeld worden. Er wordt boven, onder en rechts in het figure ruimte gelaten voor
respectievelijk een titel, de datum en tijd, en de colorbar of color_br van het gehele figure.
2.28 make_uvdb
function handle_video = make_uvdb(axes_pos, handle_figure);
%MAKE_UVDB Generate ultimate video bar: [slider] +
[direc][back][reset][forward][play]
% CALL
% HANDLE_VIDEO = MAKE_UVDB(AXES_POS,HANDLE_FIGURE) creates an axes
% with an ultimate video bar. AXES_POS contains the position (X,Y),
% width W and heigth H.
% Axes lies in the figure with handle HANDLE_FIGURE. Default is GCF.
% The return handle is HANDLE_VIDEO, which is in fact a struct of
% handles to the slider and buttons. This can be used to set
% CallBacks for the UIControls and switch visability on/off.
%
% Layout:
% [ video control bar ]
% [[start][ curr][ end ]]
% [[]]
% [[->][< ][ o ][ >][->]]
%
% See also: MAKE_VDB, MAKE_XVDB, BUT_LIST, BOX_LIST
% INPUT
% AXES_POS - vector with position and size of axes
% HANDLE_FIGURE - handle of figure for ultimate video bar
% OUTPUT
% HANDLE_VIDEO - STRUCT with handles of video bar elements
% XVDBTXT - text field
% SLIDER - slider
% MINVAL - text field for minimum value of slider
% CURVAL - text field for current value of slider
% MAXVAL - text field for maximum value of slider
% DIREC - toggle button for direction
% BACK - pushbutton for one step back
% RESET - pushbutton for reset
% FWD - pushbutton for one step forward
% PLAY - pushbutton for play all
De ultimate video bar is een combinatie van knoppen en een slider waarmee een animatie bestuurd kan
worden.
14

De uitvoer van make_uvdb is een lijst van handles van de objecten. De gebruiker dient zelf de juiste
CallBack’s hieraan te koppelen.
2.29 nan2zero
function y = nan2zero(x)
%NAN2ZERO Convert the Not-a-Numbers and the Infinites in a variable to zeros.
% CALL
% Y = NAN2ZERO(X) converts all NAN and Inf entries of X to zeros,
% which is useful if X is a matrix for a parametric grid.
% EXAMPLE
% X = [NaN 1 0 ; 2 1 2 ; 2 Inf 2];
% NAN2ZERO(X) returns
% [ 0 1 0 ;
% 2 1 2 ;
% 2 0 2 ]
Inverse versie van zero2nan.
2.30 new
%NEW Clear all variables, close all figures and files, clear command window.
Uiterst handige utility om in één klap: alle variabelen, alle figures, alle functions, alle files te sluiten en te
verwijderen uit het geheugen, en het command window te resetten.
2.31 nicetime
function str = nicetime(time,itdate);
%NICETIME Format time (minutes) since start of simulation and startdate nicely
% CALL
% STR = NICETIME(TIME,ITDATE);
% M. Verlaan, 1997
Samenvoeging van alle functies van Martin Verlaan (RIKZ) om een ‘nette tijd’ te creeren aan de hand
van de start van een simulatie en een startdatum. Omvat de functies: str2dat, julian, gregor,
dat2str, div. Zie de functie zelf voor exacte functionaliteit van deze sub functions.
2.32 num_str
Figuur 1 Ultimate Video Bar
function s = num_str(x)
%NUM_STR Vector to string conversion, with one space between elements.
% CALL
% S = NUM_STR(X) converts the vector X into a string
% representation S, with spaces between the elements of X.
%
15

% See also NUM2STR, INT2STR, SPRINTF, FPRINTF.
Compactere uitvoer dan de Matlab functie num2str genereert.
2.33 num2time
function time_string = num2time(time_num)
%NUM2TIME Convert a numerical value to a time string.
% CALL
% TIME_STRING = NUM2TIME(TIME_NUM) converts the numerical
% time value TIME_NUM to a string TIME_STRING. Time is computed
% modulo 24 hours.
% Input can be a vector. Output will be a matrix of strings.
%
% EXAMPLE
% NUM2TIME(1.25) gives '01:15',
% NUM2TIME(37.17) gives '13:10'.
Conversie van een ‘decimale’ tijd naar een hh:mm formaat. Lijkt op de Matlab functie datestr, maar
nu is de invoer niet een aantal dagen, maar een aantal uren.
2.34 pijlpunt
function h_pijl = pijlpunt(x,y,ang,mag,kleur_rand,kleur_fill,handle_axes)
%PIJLPUNT Teken pijlpunten over kromlijnig grid.
% AANROEP
% H_PIJL = PIJLPUNT(X,Y,ANG,MAG,KLEUR_RAND,KLEUR_FILL,HANDLE_AXES)
% tekent pijlpunten op de punten (X,Y)
% gedraaid over een hoek ANG. De lengte van de pijlpunt is MAG,
% in eenheden van de assen. De pijlpunten worden getekend in de
% axes met handle HANDLE_AXES. Default axes is GCA.
% INVOER
% X - matrix met x-coordinaten
% Y - matrix met y-coordinaten
% ANG - matrix met hoekwaarden
% MAG - lengte van de pijlpunt
% KLEUR_RAND - kleur van rand, [] is none
% KLEUR_FILL - kleur van de pijl, [] is none
% HANDLE_AXES - axes waarin de pijlpunten getekend worden.
% UITVOER
% H_PIJL - vector met handle van de pijlen
Met de functie pijlpunt wordt een aantal driehoekige pijlpunten gegenereerd, van de volgende vorm:
Figuur 2 Een pijlpunt
Als invoer is nodig: een matrix of vector x- en y-coordinaten, de matrix of vector ang met de
respectievelijke hoekverdraaingen, en mag, een scalar met de grootte van de pijlpunten, relatief ten
opzichte van de grootte van de axes waarin het veld getekend wordt.
16

Bij het tekenen wordt er van uitgegaan het oosten de nulrichting is en dat de tegenwijzerzin positief is.
2.35 plot_nan
function plot_nan(x,handle_figure)
%PLOT_NAN Teken de NaN's van een (m,n) matrix.
% AANROEP
% PLOT_NAN(X,HANDLE_FIGURE) maakt een image-plot (plot in matrix
% coordinaten) van de matrix X in de figure met handle
% HANDLE_FIGURE. Default is GCF.
Functie om de lay-out van een curvelineair grid te inspecteren. De landpunten (dummy waarden) moeten
door NaN’s zijn vervangen.
2.36 rand_vld
function randlijn = rand_vld(x_veld,y_veld)
%RAND_VLD Compute a STRUCT of edges for a curvelinear grid.
% CALL
% RANDLIJN = RAND_VLD(X_VELD,Y_VELD)
Functie om aan de hand van een curvelineair grid de randlijnen te vinden. In ontwikkeling.
2.37 rand2vld
function rand2vld(randlijn,line_color,handle_axes)
%RAND2VLD Add contour lines to curvelinear grid
% CALL
% RAND2VLD(RANDLIJN,LINE_COLOR,HANDLE_AXES)
% INPUT
% RANDLIJN - STRUCT met lijnelementen, bestaande uit 2 vectoren
% LINE_COLOR - RGB vector met kleur voor randlijn
% HANDLE_AXES - handle van de axes voor de randlijn
Funktie om een met rand_vld gegenereerde struct met randlijnstukken over een grid of surface te
plaatsen.
2.38 read_cmp
function var_out = read_cmp(cmp_name,var_type);
%READ_CMP Read colormap or separator value vector from .CMP file
% CALL
% VAR_OUT = READ_CMP(CMP_NAME,VAR_TYPE) reads a colormap
% from the file CMP_NAME. VAR_TYPE defines whether the
% colormap itself or its separator values are transferred
% to the output variable VAR_OUT.
% A .CMP file contains a STRUCT named COLOR_MAP with fields
% COLOR_MAP.COLORS - nx3 matrix with RGB values
% COLOR_MAP.VALUES - (n+1) vector with separator values
% A.CMP file can be created or edited with the CM_EDIT
% colormap editor GUI.
% INPUT
% CMP_NAME - name or path and name of the .CMP file
% VAR_TYPE - string
% 'colors' - COLOR_MAP.COLORS
% 'values' - COLOR_MAP.VALUES
% OUTPUT
17

% VAR_OUT - matrix with the COLOR_MAP.COLORS or
% COLOR_MAP.VALUES, depending on VAR_TYPE
%
% SEE ALSO: CM_EDIT
Met de ColorMap Editor kan een gebruiker zelf een colormap samenstellen, met bijbehorende
scheidingswaarden, bijvoorbeeld ten behoeve van de color_br functie. De functie read_cmp leest
zo’n colormap .cmp bestand in en haalt er de colormap matrix of de vector met scheidingswaarden uit.
2.39 redblue
function c_map = redblue(n);
%REDBLUE Create a colormap from red through white to blue
% CALL
% C_MAP = REDBLUE(N) creates a colormap C_MAP of length N
% from red through white to blue
Matlab bevat standaard een groot aantal colormaps, eigenlijk functies die een matrix met RGB waarden
genereren ter lengte van het aantal gewenste kleuren. redblue maakt een colormap van rood via wit
naar blauw, met minimaal 2 kleuren en maximaal 256. Er moet, in tegenstelling tot de Matlab colormaps,
altijd een aantal worden meegeven.
2.40 redgreen
function c_map = redgreen(n);
%REDGREEN Create a colormap from red to green trough orange
% CALL
% C_MAP = REDGREEN(N) create a colormap C_MAP of length N
% from red to green through orange
Matlab bevat standaard een groot aantal colormaps, eigenlijk functies die een matrix met RGB waarden
genereren ter lengte van het aantal gewenste kleuren. redgreen maakt een colormap van rood via
oranje naar groen, met minimaal 2 kleuren en maximaal 256. Er moet, in tegenstelling tot de Matlab
colormaps, altijd een aantal worden meegeven.
2.41 remove
function c = remove(a,b)
%REMOVE Removes all elements of a vector A from a vector B.
% CALL
% C = REMOVE(A,B) removes all elements of the vector A from
% the vector B, if they exist in B.
%
% EXAMPLE
% a = [2:2:10];
% b = [1:10];
% REMOVE(a,b) returns [1 3 5 7 9]
Handige utility, ontwikkeld voor de GUIMAKER.
2.42 roteer
function [x,y] = roteer(phi,origin,x,y)
%ROTEER Roteer paren van punten om een gegeven punt.
% AANROEP
% [X,Y] = ROTEER(PHI, ORIGIN, X, Y) roteert de punten X(i,j), Y(i,j)
18

% om het punt ORIGIN over een hoek PHI (in radialen).
Uit cosmetisch oogpunt kan het zinvol zijn een curvelineair grid iets te verdraaien voordat het geplot
wordt. Hier kan om een vast punt ORIGIN over een hoek PHI, positief in tegenwijzerzin, gedraaid
worden.
Let er op dat ook de pijlen of pijlpunten mee moeten draaien!
2.43 rotr
function uit = rotr(A,r)
%ROTR Roteer een matrix A r stappen naar rechts
% AANROEP
% UIT = ROTR(A,R) roteert de matrix A cyclisch r stappen
% naar rechts.
Variant op Matlab funkties als flipud en fliplr.
2.44 spacesl
function spcs = spacesl(s)
%SPACESL Bepaal hoeveel spaties er aan het begin van een string staan.
% AANROEP
% SPCS = SPACESL(S) bepaalt het aantal spaties (ASCII 32) dat
% aan het eerste teken van de string S voorafgaat.
% Funktie tbv het bepalen van de diepte van UIMENU's bij de
% invoer van een GUI.
Funktie voor de GUIMAKER.
2.45 split_ln
function [sl, sr] = split_ln(s)
%SPLIT_LN Split a line in two part on the = character.
% CALL
% [SL, SR] = SPLIT_LN(S) splits the input string S
% into two strings SL and SR on the first = character.
% If not present: SL = S, S = [].
Funktie voor de GUIMAKER. Zie splitxln voor verbeterde versie.
2.46 splitxln
function [sl, sr] = splitxln(s,x)
%SPLITXLN Split a line in two parts on the x character.
% CALL
% [SL, SR] = SPLITXLN(S,X) splits the input string S
% into two strings SL and SR on the first X character.
% If not present: SL = S, S = [].
% INPUT
% S - input line, string
% X - character to plit on, string
% OUTPUT
% SL - left part of line, string
% SR - right part of line, string
Funktie om string in twee delen te splitsen. Vooral handig bij het inlezen van databestanden met
metainformatie, bijvoorbeeld .dia bestanden.
19

2.47 str2labl
function label_str = str2labl(s)
%STR2LABL Convert a string to a label
% CALL
% LABEL_STR = STR2LABL(IN_STR) splits the input string IN_STR
% on the / character into two strings, and then converts
% it to a label. One of both may be empty.
Functie om labels zoals bijvoorbeeld de titel van de color_br aan te maken. Maakt gebruik van de TeX
mogelijkheden van Matlab om fracties (zoals: mg per liter) weer te geven.
2.48 str2vec
function svec = str2vec(s)
%STR2VEC Convert a string of numbers to a string of a row vector.
% CALL
% VEC = STR2VEC(S) converts a string of numbers to
% a string of a row vector, ie it places square brackets around
% the string.
%
% EXAMPLE
% STR2VEC('2 3 4') returns '[2 3 4]'.
Variant op num2str en num_str.
2.49 strcmpci
function string_match = strcmpci(s1,s2)
%STRCMPCI STRing CoMParison, Case Insensitive.
% CALL
% STRING_MATCH = STRCMPCI(S1,S2) returns 1 if strings S1 and S2
% are the same in lower case and 0 otherwise.
% This in contrary to STRCMP, which is case sensitive.
%
% See also STRCMP, FINDSTR.
% INPUT
% S1 - string
% S2 - string
% OUTPUT
% STRING_MATCH - boolean, 1 if S1 == S2, 0 if S1 ~= S2.
% EXAMPLE
% STRCMPCI('YeS','yes') returns 1.
Variant op de Matlab functie strcmp, maar nu met een case insensitive vervelijking van strings.
2.50 text2str
function s_mat = text2str(file_name)
%TEXT2STR Read text file into a matrix of strings.
% CALL
% S_MAT = TEXT2STR(FILE_NAME)
Functie om een eenvoudige ASCII text file om te zetten naar een matrix van strings, die vervolgens in een
editable uicontrol geplaatst kan worden. Wordt bijvoorbeeld bij colofon’s gebruikt.
20

2.51 venwlogo
function venwlogo(handle_axes);
%VENWLOGO Plaats het VenW logo in een figure.
% CALL
% VENWLOGO(handle_axes) plaatst het VenW logo
% in de axes met handle HANDLE_AXES.
Functie om het Verkeer en Waterstaat logo in een axes te plaatsen van het current figure. Heeft de datafile
venwlogo.mat nodig om de patches te tekenen.
2.52 xi_logo
function h_xilogo = xi_logo(line_width,i_color,handle_axes);
%XI_LOGO Place the beautiful Xi visualisatie logo in an axes
% CALL
% H_XILOGO = XI_LOGO(LINE_WIDTH,I_COLOR,HANDLE_AXES) places the logo
% of Xi visualisatie in the axes with handle HANDLE_AXES.
% The width of the lines is LINE_WIDTH, the color of the I is I_COLOR.
% Default settings are:
% LINE_WIDTH - 2
% I_COLOR - [0 0 1]
% HANDLE_AXES - GCA
% Data is read from XI_LOGO.MAT
% Output is a STRUCT containing the handle of the individual parts
% of the logo.
Uiterst handige utility om het Xi logo in een axes te plaatsen. Heeft de datafile xi_logo.mat nodig om
de patches te tekenen.
2.53 zero2nan
function y = zero2nan(x)
%ZERO2NAN Convert the zeros in a variable to Not-a-Numbers.
% CALL
% Y = ZERO2NAN(X) converts all zero entries of X to NaN's,
% which is useful if X is a matrix for a parametric grid.
% EXAMPLE
% X = [0 1 0 ; 2 1 2 ; 2 0 2];
% ZERO2NAN(X) returns
% [NaN 1 NaN ;
% 2 1 2 ;
% 2 NaN 2 ]
De functie zero2nan verandert de dummy waarden 0 in NaN ten behoeve van het plotten.
2.54 z_interfaces
function z_mat =
z_interfaces(waterstand_veld,diepte_veld,vaste_laag,sigma_laag,aant_laag);
%Z_INTERFACES Creeer matrix met z-interfaces mbv waterstand, diepte en laagverdelingen
% AANROEP
% Z_MAT =
Z_INTERFACES(WATERSTAND_VELD,DIEPTE_VELD,VASTE_LAAG,SIGMA_LAAG,AANT_LAAG)
% berekent een matrix met scheidingsvlakken aan de hand van het
waterstandsveld,
% diepteveld, en de vectoren met de verdeling en grootte van de vaste en
21

% sigma lagen van het model. De velden worden gegeven als vectoren van de
natte
% punten van het model.
% INVOER
% WATERSTAND_VELD - vector met waterstand voor alle natte punten
% DIEPTE_VELD - vector met diepte voor alle natte punten
% VASTE_LAAG - vector met verdeling van de vaste lagen
% SIGMA_LAAG - vector met verdeling van de vaste lagen
% AANT_LAAG - aantal lagen
% UITVOER
% Z_MAT - matrix van ( x AANT_LAAG+1) elementen
% met de scheidingsvlakken of z-interfaces
De functie z_interfaces wordt gebruikt bij het maken van vertikale en horizontale doorsneden van
modellen. Het is efficienter om de scheidingsvlakken te berekenen dan deze als matrices op te slaan.
22