Home

Basic Radar Altimetry Toolbox User Manual

1. ERVALS DV OESS_CUTOFF DV lt x xX Pees lt x x X ELD ra2_wind_sp ELD NAME my_first_field ELD TYPE Data ELD_UNIT mm s 32 Basic Radar Altimetry Toolbox User Manual FIELD E Altimeter wind speed modulus FIELD FILTER DV FIELD FIELD FIELD INTERVALS DV FIELD LOESS CUTOFF DV FIELD alt cog ellip ku ocean range mod dry tropo corr inv barom corr tot geocen ocn tide ht soll tidal load ht long period ocn tide ht solid earth tide ht geocen pole tide ht Sea bias ku ra2 ion corr ku mwr wet tropo corr FIELD NAME SSH FIELD TYPE Data FIELD UNIT m FIELD TITLE my second field FIELD FILTER DV FIELD MIN DV FIELD MAX DV ELD INTERVALS DV ESS CUTOFF DV ELEC UTPU OUTPUT output file nc Example command file to create a Z F X Y output You create the NetCDF file by typing BratCreateZFXY exe command_file cmd or BratCreateYFX exe command_file cmd You ll then have a NetCDF file that you can either visualise through the tool provided within BRAT or with some other tools reading NetCDF 7 2 Visualising an output NetCDF file through BRAT To visualise an output file you have to write a second command file This kind of file is simpler than the one needed to create a NetCDF Basicall
2. Plot Hide Plot color ESI Opacity 0 60 r Lines attributes Draw Stipple pattern Fui Line width 0 80 m Points attributes Draw Point glyph circle 7 Point size 1 00 Fill point Figure 22 Datasets tab of the visualisation tool First tab datasets recalls the name of the field as it appears in the Display Field properties of the Views tab When a field is selected in this datasets tab you have some options to choose the color and style full dots etc of the line and of the points none by default circles crosses etc If there are several fields to plot you can thus enhance the legibility of your plot Second tab properties enable to choose several options some being already available within the views tab fowever modifications done only in the visualisation window will not be saved as part of the workspace and thus cannot be recalled for future use We thus strongly recommend that you choose options as min max of both axis units plot title and axis name within the Operations and Views tabs Datasets Properties The label of each axis includes by default the name of the plotted Plot Title The title of my plot Y Axis Label range_mss nUnit tm Derive from Data C User specified Min 3 9295 005 8 1325e 005 r Current Range Min 3 9295 005 Max 8 1325 005
3. 46 Basic Radar Altimetry Toolbox User Manual Unit KW1 KW2 KW3 KW4 KS1 Unit string conforming to Udunits package and the special keyword DATE which means that the data is a date Keywords X Y Z T Latitude Longitude Data Keywords FIRST LAST MIN MAX MEAN STDDEV COUNT Keywords EXACT NEAREST EXACT Measures which are exactly on boundaries grid lines are keeped others are ignored NEAREST Get the nearest boundary Keywords STRICT RELAXED BLACK HOLE STRICT Measure outside limits are ignored RELAXED Measure outside limits are ignored if they are farther than a half step from the limit BLACK HOLE Everything outside the limit is considered to be on the limit Set of keywords from NONE LOESS SMOOTH LOESS EXTRAPOLATE LOESS LOESS means LOESS SMOOTH and LOESS EXTRAPOLATE 47 Basic Radar Altimetry Toolbox User Manual AnnexD Display command file keys NOTE A help on command file keywords can be obtained by BratDisplay k FILE FIELD Type Str Count 1 n Input file name Type Expr Count 1 23 X Expression of fields of RECORD to take into account FIELD GROUP Int Count X Group id from where belongs FIELD generally used to group many fields in one plot DISPLAY PROPERTIES Type Bool Count 0 1 Indicates if property panel is shown Default No DISPLAY_TITLE Type Str Count 0 1 Title of the plot to be displayed Default DISPLAY AN
4. 5 2 3 6 Data expression When your dataset and the type of operation are chosen you have access to the definition of the Data expression You have two or three tabs Fields X and Y depending on the type of operation The dropdown list contains the names of all the expressions while the text box below allows the value of the expression to be edited A data expression can be only one field in a dataset typically for a map longitude as x axis latitude as y axis a combination of fields either and or by using the available functions in the list right of the data box see 5 2 3 4 a pre set combination of fields among the ones you will find in the formulas box see 5 2 3 5 12 Basic Radar Altimetry Toolbox User Manual r Data expression F Data fields x Field Y field l range_ku Check Save As Reset Comment New data field Unit 10 4 m Data type Field options Figure 9 A data expression box with a field included one data field only to define this expression in the Z F X Y case Note the Unit default unit as defined in the dataset if prefered youcould type in m or km The New data field button enables you to define more than one field to process with respect to the defined X and Y axis Give a name to your data expression let s say my_first_field Note that if you change the name it renames your expression This name will be
5. If you click on one of the selected data field ight hand list you can see in the Display field properties box below the name of the represented field is also given By default it is the title of the field given in the options of the data expression or the name of the field dataexpression Field group is used to group the selected fields or not in a same plot Typically if checked default you will have each field as a curve of a given color overlaid in the same plot 19 Basic Radar Altimetry Toolbox User Manual 5 2 4 2 Z F lon lat Brat my workspace YWorkopsce lt Vm Operations Mews uses Name O cpap 3 ie of e meh j C vernm Name end Sirig remor ren S ertet CilDocuments and Settings D ku ess cim Sectiegslvcosmor nn C Docunrects and Sectngslwoamor ny fest epea CriDocuneetz and Sertingsiwoemer fest opes rion CDocunents and Settingslwnsmor my second fid S Figure 20 Example of a views tab when Z F lon lat is chosen You can choose your projection in a list of pre defined projection it can be also changed in the visualisation interface Default is a 3D projection Group by file can be used to animate a series of maps If you have several identical field names from
6. Standard deviation of the valid data Minimum value of the valid data Maximum value of the valid data in defaultValue value to use for default missing values This is the value you want to indicate that a valueis missing or invalid return O or error code Syntax see Annex E IDL 8 2 Cycle date conversion functions Two functions are available to convert between cycle pass and date Syntax see Annex E IDL BRATHL CYCLE2YMDHMSM Converts a cyle pass into a date Arguments of this function are in mission 0 Topex Poseidon 1 Jason 1 36 Basic Radar Altimetry Toolbox User Manual ERS2 Envisat ERS1 A ERS1 B GFO in cycle number of cycle in pass number of pass in the cycle WP Outputs are out dateYMDHMSM date to convert BRATHL YMDHMSM2CYCLE Converts a date into a cycle pass Arguments of this function are in mission mission type 0 Topex Poseidon Jason 1 ERS2 Envisat ERS1 A ERS1 B GFO in dateYMDHMSM date to convert Outputs out cycle number of cycle out pass number of pass in the cycle 8 3 Date conversion computation functions A set of functions is available to convert between the different kinds of date formats days seconds microseconds dates Julian decimal dates year month day hour minute second microsecond dates Syntax see Annex E IDL BRATHL_DAYOFYEAR BRATHL_NOWYMDHMSM BRATHL SETREF
7. field and its unit with n for line break and t for space Fallback range enables you to select in a more restricted range e g you selected a whole ground track but finally wish to look only at a 10 10 N range You can also zoom in on a portion of curve using middle button of Logarithmic Scale your mouse Nr of Ticks 6 Base 10 0 i iiai Current range indicates the min max of your current view r Fallback Range To go back to the first opened view type on r Figure 23 Y axis properties of a Y F X plot with only one field selected for view Label including the unit number of ticks in the axis min and max of the axis are shown X axis properties are similar 23 Basic Radar Altimetry Toolbox User Manual Agi xl File View Datasets Properties The title of my plot Plot Tie The ttie of my piot y axis Label src_pack_cnt nUnit teount Logarithmic Scale Nr of Ticks 6 Base 10 0 FRA Range ee Derive from Data 7 884e 005 0 Ma Current Range 1 Min 4503 8 Max 4660 7 7 875 005 N range_mss I eL Unit m I Lu 7 866 005 AW 7 857e 005 IM 4530 4560 4590 4620 4650 src pack cnt Unit count Figure 24 Zoom of the same curve than above 6 2 Z F lon lat Note that even if Z F X Y with any data field as X and as Y is possible to proces
8. in refDate date reference conversion out dateYMDHMSM result of the conversion return O or error code see Date error codes in brathl general documentation Example dinZ BRATHL DATEDSM din REFDATE 3 din DAYS 423 din SECONDS 5 din MUSECONDS 0 dOut BRATHL_DATEYMDHMSM refDateDestination 0 r BRATHL DSM2YMDHMSN dln dOut print dOut YEAR dOut JULIAN dOut MONTH dOut DAY dOut HOUR dOut MINUTE dOut SECOND dOut MUSECOND BRATHL_JULIAN2DSM Converts a decimal julian date into a days seconds microseconds date according to refDate parameter BRATHL JULIAN2DSM BRATHL DATEJULIAN dateJulian INT refDate BRATHL DATEDSM dateDSM in dateJulian date to convert in refDate date reference conversion out dateDSM result of conversion return O or error code see Date error codes in brathl general documentation BRATHL DSM2YMDHMSM BRATHL DATEDSM dateDSM BRATHL_DATEYMDHMSM dateYMDHMSM in dateDSM date to convert in refDate date reference conversion out dateYMDHMSM result of the conversion return 0 or error code see Date error codes in brathl general documentation 57 Basic Radar Altimetry Toolbox User Manual Example see BRATHL DSM2JULIAN BRATHL JULIAN2SECONDS Converts a decimal julian date into seconds according to refDate parameter BRATHL JULIAN2SECONDS BRATHL DATEJULIAN dateJulian INT refDate BRATHL DATESECOND dateSeconds in dateJulian date to convert in
9. Basic Radar Altimetry Toolbox User Manual Other items in the Workspace menu are new open open a previously saved workspace save or ctrl s save the current workspace and all its datasets operations formulas and displays views import import all datasets operations formulas and or displays of a previously saved workspace rename rename the current workspace delete delete the current workspace Recent workspaces list the 2 most recently used workspaces 5 2 2 Create a dataset First opened tab is datasets yen ee Malpas hwre Vet Hn ww Desses lun x f Pies Dente e rmm del met Figure 2 Create a new dataset Choose new in the datasets menu if no dataset exists or if you wish to work on other data than the one already selected The Name dropdown list contains all the defined dataset names and allows the dataset selection and renaming You can delete an existing dataset by choosing delete in the datasets menu but note that you can only work with BRATGUI with a dataset defined and so have to create a new one if none exists Basic Radar Altimetry Toolbox User Manual You have to give the dataset a name with no space or special characters in the name If you change the name within the name box it renames your dataset Note that only coherent datasets are possible i e same format same data product The Check file
10. Convert unit to radians for expression 1 latitude longitude units 0 radians No unit conversion for expression 2 swh ku result will be in SI unit units 1 Create results array dimension is number of expression dataResults DINDGEN 2 ignoreOutOfrange 0 No statistics statistics 0 Default value is 0 defaultValue 0 Call ReadData function r BRATHL READDATA files record selection expr units dataResults ignoreOutOfrange statistics defaultValue print return code r print size dataResults print NDIMS size dataResults N_DIMENSIONS print DIMS size dataResults DIMENSIONS print NELTS size dataResults N ELEMENTS print TYPE size dataResults TYPE dim size dataResults DIMENSIONS Print data value on the screen for i 0 1 do begin for j 0 dim 1 1 do begin print Data i j datali j endfor endfor 64
11. see BRATHL DATEDSM NBSECONDS decimal numbers of seconds seconds microseconds Example MyDate BRATHL_DATESECONDS MyDate REFDATE 0 MyDate NBSECONDS 56236 0253 BRATHL DATEJULIAN named structure This structure represents a decimal julian date structure REFDATE reference date see BRATHL DATEDSM JULIAN decimal julian day Example MyDate BRATHL_DATESECONDS MyDate REFDATE 0 MyDate JULIAN 1 23 569 Date conversion computation functions BRATHL_DAYOFYEAR BRATHL_DIFFDSM BRATHL_DIFFJULIAN BRATHL_DIFFYMDHMSM 53 Basic Radar Altimetry Toolbox User Manual BRATHL DSM2JULIAN BRATHL DSM2SECONDS BRATHL DSM2YMDHMSM BRATHL JULIAN2DSM BRATHL JULIAN2SECONDS BRATHL JULIAN2YMDHMSM BRATHL SECONDS2DSM BRATHL SECONDS2JULIAN BRATHL SECONDS2YMDHMSM BRATHL NOWYMDHMSM BRATHL YMDHMSM2DSM BRATHL YMDHMSM2JULIAN BRATHL YMDHMSM2SECONDS BRATHL SETREFUSER 1 BRATHL SETREFUSER2 BRATHL CYCLE2YMDHMSM BRATHL YMDHMSM2CYCLE BRATHL READDATA BRATHL DAYOFYEAR Retrieves the day of year of a date BRATHL DAYOFYEAR BRATHL DATEYMDHMSM dateYMDHMSM ULONG dayOfYear in dateYMDHMSM date out dayOfYear day of year of the date parameter returns 0 or error code see Date erra codes in brathl general documentation Example MyDate BRATHL_DATEYMDHMSM MyDate YEAR 2003 MyDate MONTH 12 MyDate DAY 5 MyDate HOUR 18 MyDate MINUTE 0 MyDate SECOND 21 MyDate MUSECOND 1069 dayOfYear 0L 54 Basic
12. RedToGreen WhiteToBlack or name of a file containing the color table definition absolute or relative path Default Aerosol DISPLAY COLORCURVE Type KW5 Count 0 or W Set the color table on a specific curve Default Linear DISPLAY_CONTOUR Type Bool Count 0 or W Indicates if the contour layer of the field is shown or not Default No DISPLAY CONTOUR NUMBER Type Int Count 0 or W Number of contour lines to generate equally spaced contour values between specified range See DISPLAY CONTOUR MINVALUE and DISPLAY CONTOUR MAXVALUE 49 Basic Radar Altimetry Toolbox User Manual Default 5 DISPLAY CONTOUR LABEL Bool Count 0 or W Indicate if the contour labels value are shown or not Default No DISPLAY CONTOUR LABEL NUMBER Type Int Number of labels on each contour Default 1 DISPLAY_CONTOUR_MINVALUE Type Fit Minimum value to use to contour calculation Default values are the same as the color scale one Default min of data values DISPLAY_CONTOUR_MAXVALUE Type Fit Maximum value to use to contour calculation Default values are the same as the color scale one Default max of data values DISPLAY SOLID COLOR Bool Count 0 or W Indicates if color layer of the field is shown or not Default Yes DISPLAY COLOR Type KW7 Count 0 or W Color name of the XY plot field Default randow color DISPLAY POINTS Type Bool Count 0 or W Indicates if points are displayed in a XY plot for the
13. at them at the same time not successive ones Execute will execute the request as it is in the defined view request that is written in the command file which name is shown left of the execute button and launch the visualisation tool see chapter 6 for a description of this interface You can see in the Log tab the current executions both operations and views and the errors 21 Basic Radar Altimetry Toolbox User Manual 6 Visualisation interface The visualisation interface is called by executing a command file from the views tab of the GUI It can also be used with a command file The visualisation options are quite different for an Y f X curve than for a Z F on lat 6 1 Y F X File View Datasets properties The title of my plot tange mss 000 00 cuc a iN L DN A N Deselect 7 200e 005 6 400e 005 range_mss Unit m 5 600e 005 4 800e 005 4 000e 005 0 0000 3000 6000 9000 1 200e 004 1 500e 004 src pack cnt Unit count Figure 21 An example Y F X visualisation In the File menu you can save your plot in different image format bmp windows bitmap jpeg png pnm or tiff or export it to gnuplot The View menu enables you to display or not the right hand panel with the properties 22 Basic Radar Altimetry Toolbox User Manual Datasets Properties Range Mean Sea Surface Deselect
14. data gdr_jason cycle_ CYCL Launch Brat create Z F X Y process atCreateZFXY C BRAT MyCmdPath BratCreateZFXYJasonSLASample Set another cycle number CYCLE 110 Set the data source path SRC DATA DIR D NVdataNgdr jasonNcycle CYCL EM Launch Brat create Z F X Y process BratCreateZFXY C BRAT MyCmdPath BratCreateZFXYJasonSLASample An example script for DOS to be inserted in a bat file to launch a command file over several cycles bin bash BratCreateZFXYJasonSLASample sh Set the cycle number export CYCLE 109 Set the data source path export SRC DATA DIR data gdr jason cycle CYCL Launch Brat create Z F X Y process BratCreateZFXY BRAT MyCmdPath BratCreateZFXYJasonSLASample cmd Set the cycle number export CYCLE 110 Set the data source path export SRC DATA DIR data gdr jason cycle CYCL Launch Brat create Z F X Y process BratCreateZFXY BRAT MyCmdPath BratCreateZFXYJasonSLASample cmd An example Shell script for Linux to launch a command file over several cycles 35 Basic Radar Altimetry Toolbox User Manual 8 BRAT Application Programming Interfaces APIs Some functions of BRAT are not available through the GUI but through IDL and Matlab APIs 8 1 Data reading function BRATHL READDATA read data from a set of files each measure for a data is a scalar value a single number Possible arguments of this function are
15. field Default No DISPLAY LINES Type Bool Count 0 or W Indicates if line is displayed in a XY plot for the field Default Yes DISPLAY_POINTSIZE Type Fit Count 0 or W Size of the points XY plot for the field Default 1 0 DISPLAY_LINEWIDTH Type Fit Count Oor W Width of the line XY plot for the field Default 0 8 DISPLAY_STIPPLEPATTERN Type KW10 Count 0 or W Stipple pattern for the line field XY plot Default Full DISPLAY POINTGLYPH KW8 Count 0 or W Glyph of the points field XY plot Default Circle DISPLAY POINTFILLED Type Bool Count 0 or W Indicates if points are filled or not Default Yes ALIAS_NAME Type Name Count O n ZN Name of an alias An alias is a value which can be used anywhere in another value of field by mean of NAME construct Names are case sensitive If a name reference XXX does not correspond to an actually defined alias the expansion is an empty string Default None ALIAS_ VALUE Type Str Count The value of the alias ALIAS VALUE keyword must have at least as many occurences as the ALIAS NAME one VERBOSE Type Int Count 0 1 Amount of output 0 None 5 Debug Default 0 Count 0 or W Count 0 or W Count 0 or W 50 Basic Radar Altimetry Toolbox User Manual Description of types Name Bool FIt Int Expr Str KW5 KW6 KW7 KW8 KW9 KW10 String beginning with a letter and containing only lette
16. field is given below when you click on a particular field The F and S button are used to insert a field in either the selected data expression F or the selected Select expression S Basic Radar Altimetry Toolbox User Manual 5 2 3 2 Created type You can then choose if you prefer a Y F X or a Z f X Y type of operation i e Y F X if you wish to work with one or several field s with respect to another one typically this leads to a curve kind of view It is the BRATCreateYFX program which will generdes the output of the operation Z f X Y if you wish to work with one or several field s with respect to two others typically with X longitude and Y latitude this leads to a map any field can be thus processed with respect to any two others but for now only maps are possible to display within BRAT It is the BRATCreateZFXY program which will generates the output of the operation Figure 6 An Operations tab when Z F X Y type is selected Note the difference in the Data Expression box tabs at the middle of the window see section 15 2 3 6 in Figure 5 above only two tabs were available when Y F X was choosen data field and X field Here a third is visible to define Y field Basic Radar Altimetry Toolbox User Manual Figure 7 Choice of the data mode Data mode is used when you have several values of a field for a same X or X Y This is typically the c
17. in fileNames file name string one file or file names array in recordName Name of the fields record for netCdf files recordName is data in selection Expression involving data fields which has to be true to select returned data if empty string no selection is done all data is selected in dataExpressions Expression string one expression or expressions array applied to data fields to build the wanted value in units Wanted unit for each expression string unit units if empty string no unit conversion is applied to the data of the corresponding expression When a unit conversion has to be applied the result of the expression is considered to be the base unit S For example if the wanted unit is gram l the unit of the expression is supposed to be kilogram m3 internaly all data are converted to base unit of the actual fields unit which is coherent with the above assumption in out results Data read Must be an array dim number of dataExpressions to values to read in ignoreOutOfRange Skip excess data O false other true Must be false if statistics is true in statistics returns statistics on data instead of data themselves O false other true If statistics is true ignoreOutOfRange must be false The returned values 5 values for each expression are Count of valid data taken into account Invalid data are those which are equal to the default missing value Mean of the valid data
18. is used For instance 2530 230 4569 2000 850 2536985 9 1990 850 2536985 9 1950 is equal to 850 2536985 Dates prior to 1950 01 01 00 00 00 0 are invalid The logical OR operator returns the boolean value expr1 expr2 boolean true if either or both operands is true and returns false otherwise Logical OR has left to right associativity 42 Basic Radar Altimetry Toolbox User Manual Annex B Y F X command file keys NOTE A help on command file keywords can be obtained by BratCreate YFX k FILE RECORD OUTPUT OUTPUT TITLE SELECT FIELD FIELD NAME FIELD TYPE FIELD UNIT FIELD TITLE DATA MODE X X_NAME X_TYPE X_UNIT X_TITLE ALIAS_NAME ALIAS_VALUE VERBOSE Type Str Count 1 n Input file name Type Str Count 1 Record set name to take into account for a file Type Str Count 1 Name of created modified file Type Str Count 0 1 Title of created modified file string describing the content and which should appear as a graphic title for example Default Type Expr Count 0 n True for record values selected Default 1 Type Expr Count 1 20 X Expression of fields of RECORD to take into account Type Name Count X Name of the FIELD data 1 Count X of FIELD data Type Unit Count X Unit of FIELD expression Type Str Count X Long name describing FIELD The one which should app
19. no space nor special characters in the name Choose new in the Operations menu You can delete an existing operation by choosing delete in the Operations menu but note that you can only process data with BRATGUI with an operation defined and so have to create a new one if none exists Otherwise you can work with a previously saved operation The Name dropdown list contains all the defined operations names and allows the operation selection and renaming If you change the name within the name box it renames your operation and erases the command file that was created with the previous name but not the output NetCDF file if the operation was executed If you want to apply the same operation to different datasets you have to recreate it as many time as needed or use the command files directly with a script see section 7 3 5 2 3 1 Data iran nstastaca mey matapaa VENE 99 Mowie Deene revere Geet Deimas Opuerra Deme lisp ire epar xl ELI Cini re i e uan EM PR 3 2 Ford E al P Las e LETT Data expressis F Cos Sei Joris wj peste f zi onse Salnzi nxpesmtun 5 zl np Figure 5 Choosing a record within the selected dataset Choose a dataset in the list of existing dataset to apply the operation to Choose a record within the dataset where the data fields you re interested in are The description of each
20. param1 para m2 Calculates the floating point remainder mod param1 par am2 rad2deg Translates Radian to Degree rad2deg param1 Calculates the rounded value round param1 Checks the sign of a value 1 negative 1 positive or sign param1 zero MN Calculates the sine radian of a value sinfparam1 Calculates the sine degreee of a value sind param __ i esl Calculates the square of a value sqr param1 Calculates the square root of a value sqrt param1 Calculates the tangent radian of a value tan param1 Calculates the tangent degree of a value tand param1 to_date Translates a string value into a date value to_date param1 conversion Allowed format are YYYY MM DD HH MN SS MS string For instance 1995 12 05 12 02 10 1230 1995 12 05 12 02 10 41 Basic Radar Altimetry Toolbox User Manual 1995 12 05 a julian string format positive Days Seconds Microseconds Seconds must be stricty less 86400 and Microseconds must be stricty less than 1000000 For instance 2530 230 4569 a julian string format positive decimal julian day For instance 850 2536985 For julian string it can contain its reference date at the end by specifying YYYY where YYYY is the reference year that s must be one of 1950 1958 1985 1990 2000 The reference year YYYY stands for YYYY 01 01 00 00 00 0 If no reference date is specified the default reference date 1950
21. to set Loess cut fF on X and Y Fields cma Figure 10 Option for a data field in the Z F X Y case For the Y F X case only the top two boxes exist You can define as many fields as you wish clicking on the new data field button and repeating the sequence above Note that you must have at least one field defined The choice of X and Y axis and their options apply to all the fields within the current operation You cannot choose e g different resolutions for X and Y for different fields within the same operation The data mode is also the same for all the fields 13 Basic Radar Altimetry Toolbox User Manual Data expression F Data fields X field v field longitude Check Save As Reset Comment New data field Unit degrees east Datatype Longitude Field options Figure 11 A data expression box with a X field included in the Z F X Y case Note the Unit default unit as defined in the dataset and the data type used to define default values min step and max For the choice of the field to use as X axis click on the X tab choose aname my_x_axis enter your expression or choose it in the lists same than for the field click on field options The option window enable you to choose o the title of the axis If you choose a Z F X Y type you can also choose o the minimum and maximum of the axis typically this can be used to define a geographical sub se
22. which name begins by one or several letters by typing them while in this box Basic Radar Altimetry Toolbox User Manual The list of all the fields of the currently selected file is divided into 6 columns Name the field short name Record the record containing the field Many files have header and data records while others have much more e g Envisat ones Full name the fully qualified name in the file structure hierarchy and related to the record Unit the unit of the field Format the format of the field inside the file In BRAT all fields are read as floating point values double Dim Dimension of the field the number values of the indicated type in the field Under the list there is a text box which show a detailed description of the currently selected field as extracted from the data dictionary You can define as many dataset as you wish Note that if you want the same operation to be applied to several files separately you will have to define several datasets or use the command files directly with a script see section 7 3 5 2 3 Create an operation Second tab is operations Dets vede is j expression F taii gt Salnzi mxgesminn 5 Deets e rmm parte Figure 4 Creating a new operation Basic Radar Altimetry Toolbox User Manual If none exists you have to create a new operation name it as you prefer with
23. 00 BRATHL_CYCLE2YMDHMSM Converts a cyle pass into a date BRATHL_CYCLE2YMDHMSM INT mission ULONG cycle ULONG pass BRATHL_DATEYMDHMSM dateYMDHMSM in mission mission type Topex Poseidon Jason 1 ERS2 Envisat ERS1 A ERS1 B Ten 6 GFO in cycle number of cycle to convert in pass number of pass in the cycle to cinvert out dateYMDHMSM date corresponding to the cycle pass return 0 or error code see Cycle date conversion error codes in brathl general documentation Example cycle 120L pass 153L mission 3 dOut BRATHL_DATEYMDHMSM 61 Basic Radar Altimetry Toolbox User Manual r BRATHL_CYCLE2YMDHMSM mission cycle pass dOut print result r print mission mission cycle cycle pass pass print Y dOut year M dOut month D dOut day H dOut hour MN dOut minute S dOut second MS dOut muSecond BRATHL YMDHMSM2CYCLE Converts a date into a cycle pass BRATHL YMDHMSM2CYCLE INT mission BRATHL DATEYMDHMSM dateYMDHMSM ULONG cycle ULONG pass in mission mission type Topex Poseidon Jason 1 ERS2 Envisat ERS1 A ERS1 B 91 E LU E 6 GFO in dateYMDHMSM date to convert out cycle number of cycle out pass number of pass in the cycle return 0 or error code see Cycle date conversion error codes in brathl general documentation Example cycle 0L pass 0L mission 1 dinZ BRA
24. Altimetry Toolbox User Manual 1 Introduction Basic Radar Altimetry Toolbox User Manual 2 BRAT overview The Basic Radar Altimetry Toolbox is made of several parts data dictionary Several Applications Programming Interfaces with data reading date and cycle pass conversion functions executable files Graphical User Interface GUI which calls the executable files For a beginner we recommend using the GUI Basic Radar Altimetry Toolbox User Manual 3 Howto install BRAT BRAT binaries are available for Windows XP and Linux Redhat 9 0 and Mandrake 2006 The software is delivered two way a single installation package file for windows or for linux or a cdrom version containing all the platforms but only one version of the common files The names of the installation packages have the format brat VERSION PLATFORM installer extension where VERSION is the version of brat PLATFORM is the destination platform windows or linux and extension is a more or less platform specific extension exe for windows bin for linux In the CD ROM the names of the installation programs have the format setup PLATFORM extension with the same convention as above 3 1 Windows binaries Double click on the installation package or installation program and follow the installer instructions By default the software will be put in C Program Files brat VERSION if you have write access to this directory or in your user profile normall
25. Basic Radar Altimetry Toolbox User Manual for BRAT v1 0 0b2 d v0 0 0 July 2006 Basic Radar Altimetry Toolbox User Manual Basic Radar Altimetry Toolbox User Manual Contents 1 Introduction 2 BRAT overview 3 How to install BRAT 3 1 Windows binaries 3 2 Linux binaries 3 3 From source 4 How to uninstall BRAT 4 1 Windows binaries 4 2 Linux binaries 4 3 From source 5 BRAT Graphical User Interface GUI 5 1 Overview A UC WwW 5 2 Starting with BRATGUI 5 2 1 Create a Workspace 5 2 2 Create a dataset 5 2 3 Create an operation 5 2 4 Create a view ANNUAL em 6 Visualisation interface 6 1 YzF X 6 2 Z F lon lat 6 2 1 Display properties N N N N N OR 6 2 2 Color table editor N 6 2 3 Contour table editor Ww 7 Using BRAT as commands 7 1 Creating an output NetCDF file 7 2 Visualising an output NetCDF file through BRAT 7 3 Using the command files to process many datasets 8 BRAT Application Programming Interfaces APIs 8 1 Data reading function 8 2 Cycle date conversion functions 8 3 Date conversion computation functions 8 4 Named structures Annex A Function lists and syntax Annex B Y F X command file keys Annex C Zz F X Y command file keys Annex D Display command file keys Annex E BRATHL IDL API WR C WwW HR UU Q Basic Radar
26. Date error codes in brathl general documentation Example see BRATHL_DSM2JULIAN BRATHL NOWYMDHMSM Gets the current date time LIBRATHL_API int32 t brathl NowYMDHMSM brathl DateYMDHMSM dateYMDHMSM out dateYMDHMSM current date time BRATHL NOWYMDHMSM BRATHL DATEYMDHMSM dateYMDHMSM Example see BRATHL_DSM2JULIAN dOut BRATHL_DATEYMDHMSMM r BRATHL_NOWYMDHMSM dOut print r dOut YEAR dOUut JULIAN dOut MONTH dOut DAY dOut HOUR dOutMINUTE dOut SECOND dOut MUSECOND BRATHL_YMDHMSM2DSM Converts a year month day hour minute second microsecond date into a daysseconds microseconds date according to refDate parameter BRATHL_YMDHMSM2DSM BRATHL_DATEYMDHMSM dateYMDHMSM INT refDate BRATHL_DATEDSM dateDSM in dateYMDHMSM date to convert in refDate date reference conversion out dateDSM result of the conversion return O or error code see Date error codes in brathl general documentation Example see BRATHL_DSM2JULIAN BRATHL_YMDHMSM2JULIAN 59 Basic Radar Altimetry Toolbox User Manual Converts a year month day hour minute second microsecond date into a decimal julian date according to refDate parameter BRATHL YMDHMSM2JULIAN BRATHL DATEYMDHMSM dateYMDHMSM INT refDate BRATHL DATEJULIAN dateJulian in dateYMDHMSM date to convert in refDate date reference conversion out dateJulian result of the conversion return 0 or error code see Date error codes in brathl general doc
27. IMATIONBAR Type Bool Count 0 1 Keyword to indicate if property panel is shown Default No DISPLAY_COLORBAR Type Bool Count 0 1 Keyword to indicate if color bar legend is shown Default Yes DISPLAY CENTERLAT _ Type Flt Count 0 1 Latitude of the projection s center point Default 0 DISPLAY CENTERLON _ Type Flt Count 0 1 Longitude of the projection s center point Default 0 DISPLAY_PROJECTION Type KW9 Count 0 1 Projection to use for mapping the world globe Default 3D DISPLAY_COASTRESOLUTION Type KW6 Count 0 1 Resolution of the coast line drawm on the map Recommended value low Default low DISPLAY ZOOM LON1 Flt Count 0 1 Zoom area west side Default 180 DISPLAY ZOOM LON2 Flt Count 0 1 Zoom area east side Default 1 80 DISPLAY_ZOOM_LAT1 Type Fit Count 0 1 Zoom area south side Default 90 DISPLAY_ZOOM_LAT2 Type Fit Count 0 1 Zoom area north side Default 90 DISPLAY_GROUPBY_FILE Type Bool Count 0 1 For world plot When several files are in input this parameter indicates if fields are displayed in the same plot group field by file or in different plots one plot by file Default Yes DISPLAY_XMINVALUE Type Fit Count 0 1 Minimum X coordinate value to use in XY plot Default min of data values for X axis DISPLAY XMAXVALUE Flt Count 0 1 Maximum X coordinate valu
28. Int Count 1 Number of intervals between Min and Max for X Default 180 for lat 360 for lon X MIN Type Fit Count 1 Min value for X expression storage Default 90 for lat 180 for lon X_MAX Type Fit Count 1 Max value for X expression storage Default 90 for lat 180 for lon X_LOESS_CUTOFF Type Int Count 1 Distance in dots where LOESS filter reaches 0 along X axis Must be an odd integer If 1 or 0 Distance computation is disabled Needed only if at least one filter is asked Default 0 Y Type Expr Count 1 Expression of fields of RECORD to take into account Y INTERVALS Type Int Count 1 Number of intervals between Min and Max for Y Default 180 for lat 360 for lon Y NAME Type Name Count 1 45 Basic Radar Altimetry Toolbox User Manual Y TYPE Y UNIT Y TITLE Y MIN Y MAX Name of the Y data KW1 Count 1 Type of Y data normally X T or longitude Type Unit Count 1 Unit of Y expression Type Str Count 1 Long name describing Y The one which should appear in graphics on axis or legends for example Type Fit Count 1 Min value for Y expression storage Default 90 for lat 180 for lon Type Fit Count 1 Max value for Y expression storage Default 90 for lat 180 for lon Y_LOESS_CUTOFF Type Int Count 1 FIELD FIELD NAME FIELD TYPE FIELD UNIT FIELD TITLE FIELD FILTER ALIAS NAME ALIAS VALUE VERBOSE Dist
29. Radar Altimetry Toolbox User Manual r BRATHL DAYOFYEAR MyDate dayOfYear print r dayOfYear BRATHL DIFFDSM Computes the difference between two dates date1 date2 the result is expressed in a decimal number of seconds BRATHL DIFFDSM BRATHL DATEDSM date1 BRATHL DATEDSM date2 DOUBLE diff in date1 in date2 out diff difference in seconds date1 date2 return 0 or error code see Date error codes in brathl general documentation Example d1 BRATHL DATEDSM d1 REFDATE 3 d1 DAYS 423 d1 SECONDS 5 d1 MUSECONDS 0 d2 BRATHL_DATEDSM d2 REFDATE 2 d2 DAYS 36 d2 SECONDS 54 d2 MUSECONDS 2536 diff 0 0D r BRATHL DIFFYMDHMSM d1 d2 diff print r diff BRATHL_DIFFJULIAN Computes the difference between two dates date1 date2 the result is expressed in a decimal number of seconds BRATHL DIFFJULIAN BRATHL DIFFJULIAN date1 BRATHL_DIFFJULIAN date2 DOUBLE diff in date1 in date2 out diff difference in seconds date1 date2 return O or error code see Date error codes in brathl general documentation Example see BRATHL DIFFDSM BRATHL DIFFYMDHMSM 55 Basic Radar Altimetry Toolbox User Manual Computes the difference between two dates date1 date2 the result is expressed in a decimal number of seconds BRATHL DIFFYMDHMSM BRATHL DIFFYMDHMSM datei BRATHL DIFFYMDHMSM date2 DOUBLE diff in date1 in date2 out diff difference in seconds date1 date2 return O or erro
30. THL DATEYMDHMSM din YEAR 2003 din MONTH 12 din DAY 5 din HOUR 18 din MINUTE 0 din SECOND 21 din MUSECOND 1069 r BRATHL_YMDHMSM2CYCLE mission din cycle pass print result print Y dOut year M dOut month D dOut day H dOut hour MN dOut minute S dOut second MS dOut muSecond print mission mission cycle cycle pass pass BRATHL READDATA 62 Basic Radar Altimetry Toolbox User Manual Read data from a set of files Each measure for a data is a scalar value a single number in fileNames file name string one file or file names array in recordName Name of the fields record for netCdf files recordName is data in selection Expression involving data fields which has to be true to select returned data if empty string no selection is done all data is selected in dataExpressions Expression string one expression or expressions array gplied to data fields to build the wanted value in units Wanted unit for each expression string one unit or units array if empty string no unit conversion is applied to the data of the corresponding expression When a unit conversion has to be applied the result of the expression is considered to be the base unit SI For example if the wanted unit is gram l the unit of the expression is supposed to be kilogram m3 internaly all data are converted to base unit of the actual fields unit which is coherent wi
31. USER 1 BRATHL SETREFUSER2 BRATHL DIFFDSM BRATHL DIFFJULIAN BRATHL DIFFYMDHMSM BRATHL DSM2JULIAN Retrieves the day of year of a date Gets the current date time Set user defined reference dates Set user defined reference dates Computes the difference between two days seconds microseconds dates date1 date2 the result is expressed in a decimal number of seconds Computes the difference between two decimal julian dates date1 date2 the result is expressed in a decimal number of seconds Computes the difference between two year month day hour minute second microsecond dates date1 date2 the result is expressed in a decimal number of seconds Converts a days seconds microseconds date into a decimal julian date according to refDate parameter 37 Basic Radar Altimetry Toolbox User Manual BRATHL DSM2SECONDS BRATHL DSM2YMDHMSM BRATHL JULIAN2DSM BRATHL JULIAN2SECONDS BRATHL JULIAN2YMDHMSM BRATHL SECONDS2DSM BRATHL SECONDS2JULIAN BRATHL SECONDS2YMDHMSM BRATHL YMDHMSM2DSM BRATHL YMDHMSM2JULIAN BRATHL YMDHMSM2SECONDS 8 4 Named structures Converts a days seconds microseconds date into seconds according to refDate parameter Converts a days seconds microseconds date into a year month day hour minute second microsecond date Converts a decimal julian date into a days seconds microseconds date according to refDate parameter Converts a decimal julian date into seconds according to refDate p
32. a command file and open the visualisation tool see chapter 6 It can be saved and recalled Some or all elements of a workspace can be imported into another workspace The Logs tab displays the state of the programmes being run Code 0 at the end of the execution of a command means the output is OK When launched the GUI recalls the last used Workspace or asks for a new one if none exists or is valid There is no specific tab for the Workspace only the leftmost menu 5 2 Starting with BRATGUI 5 2 1 Create a Workspace When you open BRATGUI the software asks for the name and location of the workspace you will be working in If one or more workspace already exists the last used one is open by default You can open another one or create a new one by choosing new in the workspace menu leftmost menu Create a new workspace D Location C Program Filesibrat 1 0 0b1 Browse Figure 1 Create a new workspace window It is highly recommended to save the workspace ctrl s or save in the workspace menu while working The workspace is otherwise saved when you quit BRATGUI or at least the question of whether you wish to save the workspace or not is asked then You can delete an existing workspace by choosing delete in the workspace menu but note that you can only work with BRATGUI within a workspace and so have to create a new one if none exists
33. a list of cycle number through a script usr bin env BratCreateZFXY SRC DATA DIR and CYCLE are environment variables that can be set in a shell 4 DIR JA1 GDR 2PAPS CYCLE 001 CNES _DIR JA1_GDR_2PAP CYCLE _002 CNES DIR JA1 GDR 2PAPS CYCLE 003 CNES ta E SLA_JASON ALIAS VALUE altitud range_ku model_dry_tropo_corr inv bar corr ocean tide soll ocean tide equil load tide soll solid earth tide pole tide sea state bias ku iono corr alt ku rad wet tropo corr mss longitude longitude Longitude DY Longitude DV DV ERVALS 1800 X X X X X X X X latitude latitude Latitude DV Latitude DV DV KK KKK KKK Basic Radar Altimetry Toolbox User Manual SLA JASON is an alias see ALIAS NAME and ALIAS VALU FIELD SLA JASON FIELD TYPE data FIELD NAME SLA FIELD UNIT FIELD TITLE Sea Level Anomalies Cycle CYCL FIELD FILTER LOESS EXTRAPOLATE X LOESS CUTOFE 5 Y LOESS 5 is bounded 1 0 SLA_JASON 1 0 PU BRATHL DATA _DIR JasonSLA CYCL PU Jason Cycle CYCLE Set the cycle number CYCLE 109 Set the data source path SRC_DATA_DIR D
34. ance in dots where LOESS filter reaches 0 along Y axis Must be an odd integer If 1 or 0 Distance computation is disabled Needed only if at least one filter is asked Default 0 Type Expr Count 1 20 X Expression of fields of RECORD to take into account Type Name Count X Name of the FIELD data Type KW1 Count X Type of FIELD data Type Unit Count X Unit of FIELD expression Type Str Count X Long name describing FIELD The one which should appear in graphics on axis or legends for example KS1 Count X How to filter the data Type Name Count 0 Name of an alias An alias is a value which can be used anywhere in another value of field by mean of NAME construct Names are case sensitive If a name reference XXX does not correspond to an actually defined alias the expansion is an empty string Default None Type Str Count The value of the alias ALIAS VALUE keyword must have at least as many occurences as the ALIAS NAME one Type Int Count 0 1 Amount of output O None 5 Debug Default 0 Description of types Name Fit Int Expr Str String beginning with a letter and containing only letters digits and Floating point number Integer Combination of fields of the current record An expression which can contain function calls like trigonometric conversion test String Leading and trailing blanks are ignored
35. arameter Converts a decimal julian date into a year month day hour minute second microsecond date Converts seconds into a days seconds microseconds date according to refDate parameter Converts seconds into a decimal julian date according to refDate parameter Converts seconds into a a decimal julian date according to refDate parameter Converts a year month day hour minute second microsecond date into a days seconds microseconds date according to refDate parameter Converts a year month day hour minute second microsecond date into a decimal julian date according to refDate parameter Converts a year month day hour minute second microsecond date into a seconds according to refDate parameter Several structures are also available to represent the different kinds of date formats Syntax see Annex E IDL BRATHL DATEYMDHMSM BRATHL DATEDSM YYYY MM DD HH MN SS MS date structure YEAR MONTH DAY HOUR MINUTE SECOND MUSECOND day seconds microseconds date structure REFDATE reference date DAYS numbers of days SECONDS numbers of seconds MUSECONDS numbers of microseconds REFDATE is the reference date i e 1950 01 01 00 00 00 0 1958 01 01 00 00 00 0 1985 01 01 00 00 00 0 1990 01 01 00 00 00 0 2000 01 01 00 00 00 0 user reference 1 user reference 2 values of 5 and 6 allow the user to set two specifics reference date 38 Basic Radar Altimetry Toolbox Us
36. ase for crossover points between tracks Several files available for different dates Sub sample data The possible values are MEAN default computes the mean over every values of the field within the dataset at each X or X Y COUNT returns the number of values of the field within the dataset at each X or X Y FIRST returns the first encountered value of the field within the dataset in the order of the list of files as it appears in the dataset tab LAST returns the last encountered value of the field within the dataset in the order of the list of files as it appears in the dataset tab MIN gives the minimum value of the field within the dataset MAX gives the maximum value of the field within the dataset STDDEV computes the standard deviation over every values of the field within the dataset at each X or X Y Data mode can be used to compute statistics They are also of use for the display except for standard deviation if you prefer to visualise e g the last value to the mean one 10 Basic Radar Altimetry Toolbox User Manual 5 2 3 4 Functions The Functions area provides a simple way to include and to know the available functions and constants which can be included in formulas By default no function is visible but they appear in the dropdown list if you click on it For each function if selected you will see a short explanation of what it does They are available to
37. compute or select a data expression See Annex A for more details about each function Description Names Description O ogicalnegationoperatorNOT gt o notequaHMooperaor o logical OR operator equal to operator Calculates the radian of a value Calculates the cosine degree of a value exp oor rac iif iif gt is_bounded is bounded strict is default 0010 Calculates the sine radian of a value Calculates the sine degreee of a value Calculates the tangent degree of a value to date Translates a string value into a date value expressed in seconds Typically this can be used to translate a calendar date or julian day in seconds exp flor iif is bounded is bounded strict is defaut flog max 3 3 11 Basic Radar Altimetry Toolbox User Manual The F and S button are used to insert a function in either the selected data expression F or the selected Select expression S The function will appear there with the correct syntaxto be filled e g function param1 param2 you will have to replace param1 param2 etc by the fields or numbers you wish to apply the function to You can use those functions for e g a test on a flag Surface type will returns you only the open ocean flagged Jason 1 GDR data boundaries is_bounde
38. d 100 SSH 100 or SSH gt 100 amp amp SSH lt 100 5 2 3 5 Formula In the Formula box you will find predefined formulas 6 g Sea Surface Height formulas from the different satellites GDR fields and also Data expressions or Selections previously saved by you within the current workspace or imported from another workspace The F and S button are used to insert a formula in either the selected data expression F or the Select expression S The formula will appear there either as an alias if you leave the as alias checked or complete if you un check as alias r Data expression F Data fields x Field v Field Check zj Save As ENVISAT_SSH Comment New data Field Delete data field Unit count Data type Y Field options r Data expression F Data fields x field v field SSH Save alt cog ellip ku band ocean range mod_dry_tropo_corr inv_barom_corr tot_geocen_ocn_tide_ht_sol1 tidal_load_ht long period ocn tide ht solid_earth_tide_ht geocen_pole_tide_ht sea_bias_ku ra2_ion_corr_ku mwr wet tropo corr New data Field Delete data field Unit count Data type Field options Figure 8 use of a pre defined formula Envisat SSH by its alias top and developed bottom Note the unit put by default at count that you will have to change manually m or a sub unit of the metre
39. e to use in XY plot 48 Basic Radar Altimetry Toolbox User Manual Default max of data values for X axis DISPLAY YMINVALUE Type Fit Count 0 1 Minimum Y coordinate value to use in XY plot Default min of data values for Y axis DISPLAY YMAXVALUE Flt Count 0 1 Maximum Y coordinate value to use in XY plot Default max of data values for Y axis DISPLAY XLABEL Type Str Count 0 1 X axis label to be displayed Default field title or field name DISPLAY YLABEL Type Str Count 0 1 Y axis label to be displayed Default field title or field name DISPLAY XTICKS Type Int Count 0 1 Number of ticks for the X axis Default 6 DISPLAY_YTICKS Type Int Count 0 1 Number of ticks for the Y axis Default 6 DISPLAY NAME Type Str Count 0 Field name to be displayed DISPLAY OPACITY Type Fit Count 0 or W Opacity of the color value map image 1 0 color is totally opaque 0 0 is completely transparent Default 0 7 DISPLAY_MINVALUE Type Fit Count 0 or W Minimum color table value to use in plot Default min of data values DISPLAY_MAXVALUE Type Fit Count 0 or W Maximum color table value to use in plot Default max of data values DISPLAY NUMCOLORLABELS Type Int Count 0 or W Number of labels shown on the plot s color bar Default 2 DISPLAY_COLORTABLE Type Str Count 0 or W Name of a predefined color table Aerosol Blackbody BlackToWhite Cloud Ozone GreenToRed Rainbow
40. ear in graphics on axis or legends for example Type 2 Count 0 1 Keyword to indicate how data are stored computed DefaultZMEAN Type Expr Count 1 Expression of fields of RECORD to take into account Type Name Count 1 Name of the X data 1 Count 1 Type of X data normally X or longitude Type Unit Count 1 Unit of X expression Type Str Count 1 Long name describing X The one which should appear in graphics on axis or legends for example Type Name Count 0 Name of an alias An alias is a value which can be used anywhere in another value of field by mean of NAME construct Names are case sensitive If a name reference XXX does not correspond to an actually defined alias the expansion is an empty string Default None Type Str Count N The value of the alias ALIAS VALUE keyword must have at least as many occurences as the ALIAS NAME one Type Int Count 0 1 Amount of output O None 5 Debug Default 0 43 Basic Radar Altimetry Toolbox User Manual Description of types Name Int Expr Str Unit KW1 KW2 String beginning with a letter and containing only letters digits and Integer Combination of fields of the current record An expression which can contain function calls like trigonometric conversion test String Leading and trailing blanks are ignored Unit string conforming to Udunits package and t
41. er Manual BRATHL DATESECOND BRATHL DATEJULIAN of his choice see BRATHL SETREFUSER 1 and BRATHL SETREFUSERe functions decimal seconds date structure REFDATE reference date see BRATHL DATEDSM NBSECONDS decimal numbers of seconds seconds microseconds decimal julian date structure REFDATE reference date see BRATHL DATEDSM JULIAN decimal julian day 39 Basic Radar Altimetry Toolbox User Manual AnnexA Function lists and syntax NOTE Every expression involving a default value also called missing value is a default value A true expression is an expression which is not 0 and not a default value The descriptions below are for expressions which do not contain default value to simplify their writing For example the result of A B A or B is a default value if B is one even if A is true There is two exceptions to this is default and iif3 which are the only way to check for default values The logical negation operator reverses the meaning expr1 expr2 boolean of its operand The result is true if the converted operand is false the result is false if the converted operand is true uM The not equal to operator returns true if the operands do not have the same value otherwise it returns false amp amp The logical AND operator amp amp returns the boolean expr1 amp amp expr2 boolean value true if both operands are true and returns false otherwise Logical AND has left to right associati
42. fault values min step and max r Data expression F Data fields s fiel v field Check Save As Reset Comment New data field Delete data field Unit 10 4 m Datatype M Field options Figure 14 The dropdown list for a data expression with two data fields one X field one Y field Beware of what is your unit you need to have a valid unit i e one that is defined in the data dictionary as such If you choose a pre saved formula a default count will appear as unit If you select one field in the dataset list and insert it by using the F button it will be automatically filled with the correct unit but if you finally write your own formula the final unit might be different If the unit you defined does not fit the unit of the data an error will be generated in the Log tab However note that every operation is computed using SI units even if a sub unit is defined for the data e g metres instead of cm mm or km Thus you can put cm as unit even if the data are in mm and end with correct values Right of the Data expression box Four buttons are available Check to check if the expression is wellformed i e if the syntax is correct but NOT if it is scientifically or even dimensionally correct Save as save the current data expression for future use within the workspace It will then be available in the formulas box Reset empties the whole box Commen
43. he special keyword DATE which means that the data is a date Keywords X Y Z T Latitude Longitude Data Keywords FIRST LAST MIN MAX MEAN STDDEV COUNT 44 Basic Radar Altimetry Toolbox User Manual Annex C ZzF X Y command file keys NOTE A help on command file keywords can be obtained by BratCreateZFXY k FILE Type Str Count 1 n Input file name OUTPUT Type Str Count 1 Name of created modified file OUTPUT TITLE Type Str Count 0 1 Title of created modified file string describing the content and which should appear as a graphic title for example Default SELECT Type Expr Count 0 n True for record values selected Default 1 RECORD Type Str Count 1 Record set name to take into account for a file DATA_MODE 2 Count 0 1 Keyword to indicate how data are stored computed DefaultZMEAN POSITION MODE Type Count 0 1 How position is computed DefaultZNEAREST OUTSIDE MODE Type KWA4 Count 0 1 How data outside limits are managed Default STRICT X Type Expr Count 1 Expression of fields of RECORD to take into account X NAME Type Name Count 1 Name of the X data X TYPE 1 Count 1 Type of X data normally X or longitude X UNIT Type Unit Count 1 Unit of X expression X TITLE Type Str Count 1 Long name describing X The one which should appear in graphics on axis or legends for example X INTERVALS Type
44. iare T mnn F DU 7 0 078 Mac m wm Figure 28 Visualisation with color and contour for the same field View 3 tabs are available o State enables to save a particular display for the duration of the session and to recall it by its number Clear erases all the saved displays Full goes back to a full sized view of the chosen area if a zoom had been made o Zoom enables to visualise a specified area defined by its longitude and latitude minimum and maximum this does not work on the 3D projection o Zheight only available for the 3D projection enables to render field values at the surface as bumpyness radius gives the height factor the scale factor 6 2 2 Color table editor Several color tables are available within BRAT You can use any one of them You can also make your own color table 27 Basic Radar Altimetry Toolbox User Manual BRAT Color Table for sigma ni File Edit Mode Predefined Color Tables BlackTowhite RedToGreen WhiteToBlack Figure 29 The color table editor with the list of predefined tables In the File menu of the color table editor Load color table load a previously made color table Recent color table recall recently used ones and save as to save the one you ve just done The Edit menu enables to change the number of color within an existing color table and the in
45. onversion aram1 param2 sd I Inline if iif param1 If the first parameter is true not 0 and not default param2 param3 40 value the second parameter is returned otherwise it is the Basic Radar Altimetry Toolbox User Manual third one Logically equivalent to if param1 is true return param2 else return param3 end if Inline if with default value case iif3 param1 If the first parameter is true not 0 and not default param2 param3 value param4 the second parameter is returned If is is 0 the third one is returned otherwise it is a default value the fourth one is returned Logically equivalent to if param1 is default value return param4 else if param1 is true return param2 else return param3 end if end if Calculates the integer parts of a value int param1 is bounded Checks if a value x is included between two value is bounded para min max is bounded min x max m1 param2 para m3 is bounded st Checks if a value x is stricly included between two is bounded strict rict value min max param1 param2 is bounded strict min x max param3 NE is default Checks if a value is a default value 1 yes 0 no is default param Eo 1 DESEE E Calculates the logarithm of a value log param1 log10 Calculates the base 10 logarithm of a value log10 param1 Calculates the larger of two values max param1 am2 Calculates the smaller of two values min
46. osition y position z position x velocity y velocity Fields contained in the selected product file vector source utc sbt time sat binary time ERREUR Fields description rel orbi umber If not used set to 0 Add Files Add Dir Check Files Welcome Figure 3 A dataset Left the list of files right up the list of available field within the selected file format bottom the description of the selected field as it appears in the data dictionary When you have created your dataset and named it you can then add files chosen on your hard drive CD DVD driver local network If you wish to add a long list of files the add dir button provides you the possibility of choosing dl the files within a directory Clear will empty the whole list You can delete selected file s by using the delete key on your keyboard Up Down and Sort can be used to re arrange the list Files will be processed in this order It can be used to check for doublet or missing files or to remove unwanted files from a list In this tab e Left you have the selected files names e Right the list of all fields defined for this kind of data and below a more detailed description of the selected field extracted from the data dictionary You can sort alphabetically the fields by clicking name record unit format dim at the top of the box or view a field
47. oved Note that a shortcut is also in the installation directory which you can click to do the same thing 4 2 Linux binaries In the installation directory the default one or the one chosen there is a script called uninstallbrat VERSION linux which can be executed to remove everything created during installation There is also a shortcut called Uninstall Basic Radar Altimetry Toolbox desktop which can be used from within your desktop manager KDE GNOME and do the same thing 4 3 From source If you have build BRAT from source you may have to remove everything by hand The directory containing the source files may be removed entirely Basic Radar Altimetry Toolbox User Manual 5 BRAT Graphical User Interface GUI 5 1 Overview BRAT Graphical User Interface GUI is a windowed interface to the BRAT Tools Note that everything possible with the tools is not included in the GUI some options are only available using directly the command files The GUI manipulates objects called workspaces A workspace contains e Datasets collection of files of the same kind e Operations to read and or compute and or select data within a dataset An operation produces an intermediate file NetCDF and a command file e Formulas that enables to use predefined combinations of data fields or to define them yourself and re used them afterwards e Views that results of one or operations and them A view produces
48. r code see Date error codes brathl general documentation Example see BRATHL_DIFFDSM BRATHL DSM2JULIAN Converts a days seconds microseconds date into a decimal julian date according to refDate parameter BRATHL DSM2JULIAN BRATHL DATEDSM dateDSM refDate BRATHL_DATEJULIAN dateJulian in dateDSM date to convert in refDate date reference conversion out dateJulian result of the conversion return 0 or error code see Date error codes brathl general documentation Example dinZ BRATHL DATEDSM din REFDATE 3 din DAYS 423 din SECONDS 5 din MUSECONDS 0 dOut BRATHL_DATEJULIAN refDateDestination 0 r BRATHL DSM2JULIAN dIn refDateDestination dOut print dOut REFDATE dOut JULIAN BRATHL DSM2SECONDS Converts a days seconds microseconds date into secnods according to refDate parameter BRATHL DSM2SECONDS BRATHL DATEDSM dateDSM INT refDate BRATHL DATESECOND dateSeconds in dateDSM date to convert in refDate date reference conversion out dateSeconds result of the conversion 56 Basic Radar Altimetry Toolbox User Manual return O or error code see Date error codes in brathl general documentation Example see BRATHL_DSM2JULIAN BRATHL DSM2YMDHMSM Converts a days seconds microseconds date into a year month day hour minute second microsecond date BRATHL DSM2YMDHMSM BRATHL DATEDSM dateDSM BRATHL DATEYMDHMSM dateYMDHMSM in dateDSM date to convert
49. refDate date reference conversion out dateSeconds result of conversion return O or error code see Date error codes in brathl general documentation Example see BRATHL DSM2JULIAN BRATHL JULIAN2YMDHMSM Converts a decimal julian date into a year month day hour minute second microsecond date BRATHL JULIAN2YMDHMSM BRATHL DATEJULIAN dateJulian BRATHL DATEYMDHMSM dateYMDHMSM in dateJulian date to convert in refDate date reference conversion out dateYMDHMSM result of conversion return 0 or error code see Date error codes in brathl general documentation Example see BRATHL_DSM2YMDHMSM BRATHL_SECONDS2DSM Converts seconds into a days seconds microseconds date according to refDate parameter BRATHL_SECONDS2DSM BRATHL_DATESECOND dateSeconds INT refDate BRATHL_DATEDSM dateDSM in dateSeconds date to convert in refDate date reference conversion out dateDSM result of the conversion return O or error code see Date error codes brathl general documentation Example see BRATHL DSM2JULIAN BRATHL SECONDS2YMDHMSM Converts seconds into a a decimal julian date according to refDate parameter 58 Basic Radar Altimetry Toolbox User Manual BRATHL SECONDS2YMDHMSM BRATHL DATESECOND dateSeconds INT refDate BRATHL DATEJULIAN dateJulian in dateSeconds date to convert in refDate date reference conversion out dateJulian result of the conversion return 0 or error code see
50. rs digits and Boolean true if YES Y TRUE T OUI O VRAI V 1 false if NO N FALSE F NON N FAUX O Floating point number Integer Combination of fields of the current record An expression which can contain function calls like trigonometric conversion test String Leading and trailing blanks are ignored Keywords cosine linear sqrt square root Keywords In incresing resolution crude low intermediate full Keywords AQUAMARINE BLACK BLUE BLUE VIOLET BROWN CADET BLUE CORAL CORNFLOWER BLUE CYAN DARK GREY DARK GREEN DARK OLIVE GREEN DARK ORCHID DARK SLATE BLUE DARK SLATE GREY DARK TURQUOISE DIM GREY FIREBRICK FOREST GREEN GOLD GOLDENROD GREY GREEN GREEN YELLOW NDIAN RED KHAKI LIGHT BLUE LIGHT GREY LIGHT STEEL BLUE LIME GREEN MAGENTA MAROON MEDIUM AQUAMARINE MEDIUM BLUE MEDIUM FOREST GREEN MEDIUM GOLDENROD MEDIUM ORCHID MEDIUM SEA GREEN MEDIUM SLATE BLUE MEDIUM SPRING GREEN MEDIUM TURQUOISE MEDIUM VIOLET RED MIDNIGHT BLUE NAVY ORANGE ORANGE RED ORCHID PALE GREEN PINK PLUM PURPLE RED SALMON SEA GREEN SIENNA SKY BLUE SLATE BLUE SPRING GREEN STEEL BLUE TAN THISTLE TURQUOISE VIOLET VIOLET RED WHEAT WHITE YELLOW YELLOW GREEN Keywords ARROW CIRCLE CROSS DASH DIAMOND HOOKEDARROW SQUARE THICKARROW THICKCROSS TRIANGLE Keywords 3D Azimuthal Equidistant Lambert Cylindrical Lambert Azimuthal Mercator Mollweide Plate Caree Robinson Key
51. s button at the bottom of the window check this coherency mm Interface my workspace E i 5 x Workspace Datasets Operations Views Help Datasets Operations Views Logs Name Product ENVISAT RA2_GDR_2P ane QWQW Fea ee fat nage ES Files in dataset C TestBrat DEMODATA Envisat_38 RA2_GDR_2POF P20050606_ 213432 000030184 C TestBrat DEMODATA Envisat_38 R42_GDR_2POF P20050606_222451_00003017A C TestBratiDEMODATA Envisat_38 RA2_GDR_2POF P20050606 231509_00003017A C TestBrat DEMODATA Envisat_38 RA42_GDR_2POF P20050607_000527_00003017A C TestBrat DEMODATA Envisat_38 RA2_GDR_2POF P20050607 _005544_00003017A C TestBrat DEMODATA Envisat_38 RA42_GDR_2POF P20050607 014602 00003017A C TestBrat DEMODATA Envisat_38 RA2_GDR_2POF P20050607 023620 D0003017A C TestBrat DEMODATA Envisat 381RA2 GDR 2POF P20050607 032638 D00003017A C TestBrat DEMODATA Envisat_38 R42_GDR_2POF P20050607_041656_00003017A product proc_stage ref_doc acquisition_station proc center proc time software ver sensing start sensing stop phase cycle rel orbit abs orbit state vector time delta uti x position y position z position x velocity y velocity z velocity vector source utc sbt time sat binary time product proc stage ref doc acquisition station prac center proc time software ver sensing start sensing stop phase cycle rel orbit abs orbit state vector time delta uti x p
52. s within the operations tab only the case Z F longitude latitude i e a map is possible for now in BRAT In the File menu you can save your plot in different image format bmp windows bitmap jpeg png pnm or tiff or export it to gnuplot The View menu enables you display or not the right hand panel with the properties display the color bar or not display the animation toolbar if relevant i e if you are visualising a series of fields with the same name and chose the option group by file Once in this toolbar you can launch the animation of the fields stop it and control its speed to open the color table editor and the contour table editor M lm FP dim Figure 25 Animation toolbar available for a series of fields with the same name option group by file chosen The animation is available as visualisation not to be saved Animate launch the animation Reset reset the animation to the first frame The number after is the number of the frame Loop enables to loop the animation and Speed to choose its speed in frames per second 24 Basic Radar Altimetry Toolbox User Manual BRAT Wadd Plot cep amp 2 E i xi fa Ven bordo 0 zj Carter Fort ujio botes 27 Db Sonitus Teminy of Verde Calpe siqma_O_k Figure 26 An example Z F lon lat visuali
53. sation with default projection 3D and the Ozone color table 6 2 1 Display properties Available display properties are the projection Several of them are available see Create a view You can change it on the fly even if you decided on another one in the view tab of the GUI but your choice won t be saved 25 Basic Radar Altimetry Toolbox User Manual 22 Db son inia w Teminy of ends Cairbar fE Ax ons fo Stee ce ra me ot he pot siama O0 ku sigma 0 ku Unit dB 12 5 25 37 5 50 Figure 27 Same plot than above but with a different projection Plate Carree Centre point define the centre of the display only relevant for 2D maps not for the 3D projection Data layers lists the different fields visualised and if each one is visualised as solid color or as contours Edit open either the color table or the contour table editor see section 6 2 2 and 6 2 3 below You can change your mind there with respect to what you defined previously but there also your choices won t be saved If two fields are overlaid you can switch contours and color That s why in that case you wil have two color table in your plot one for each field The number of label and the range define those for the color table 26 Basic Radar Altimetry Toolbox User Manual a ifti xi popise Cart Dere tav 7 7 Dots
54. se your data with BRATGUI with a view defined and so have to create a new one if none exists 17 Basic Radar Altimetry Toolbox User Manual loxi Wyki 5 Opercbons views Heb Dizclsy Field Properties ne Sera sevenducy Mer m x nzpootdesia vs Lucia mz 2 Treske a lor dake dich Figure 18 Create a view to launch the visualisation tool First thing after naming your view is to choose between Y F X and Z F lon lat When it is done you will have access in the Data box to the available fields corresponding to either choice outputs from operations computed within the workspace They are given by operation file name field name You can refresh the list to update it with respect to the latest operations In the Data box select one or several data fields by clicking on them ctrl click for several fields and use the arrow to switch it or them from available left to selected right X axis and Y has been pre defined in the operation tab You can give your display a title just below the name of the view 18 Basic Radar Altimetry Toolbox User Manual 5 2 4 1 Y F X Ci pocunents and rangs met Operations C pocunents ed Settirgsiwosnor s ho n Figure 19 Example of a views tab when Y F X is chosen For such a plot you can define a sub set to be plotted by X min X max Y field min Y field max
55. several operations e g if you have computed the same field at different dates if you check this option you will have access to the animation toolbar in the visualisation interface If you dick on one of the selected data field ight hand list you can see in the Display field properties box below the name of the represented field By default it is the title of the field given in the options of the data expression or the name of the field data expression if no title was given Achoice between solid color and contour representation It is of course highly recommended to choose at most two different fields to be displayed on the same plot one represented in solid colors the other in contours to be able to see something on the plot Min and max of the color scale The color scale among a pre defined list of color scales or in previously made and saved color scale see 6 2 2 All those options can also be changed in the visualisation interface 20 Basic Radar Altimetry Toolbox User Manual Field group is used to group the selected fields or not in a same plot Typically if all fields have 1 default you will have a color and a contour map plotted one overlaying the other If you put a different number for each field you will have as many separate plot windows as you have typed numbers The difference with group by file is that you will have adjacent plot i e you can look
56. st alphabetically in each column or type in the first letters to find the right one and then click on the S button to have it inserted where your cursor was in the selection expression box or a ready made expression by selecting it in the formulas list and then click on the S button or type the alias Boolean operators are available to combine the conditions 16 Basic Radar Altimetry Toolbox User Manual Select expression 5 is_bounded 100 ENVISAT_SSH 100 check Comment Figure 17 Another selection using a formula alias to edit values of SSH higher or lower than 100m This expression could also have been written ENVISAT_SSH lt 100 amp amp ENVISAT_SSH gt 100 where amp amp is the boolean operator AND see function list for the complete list of operators The selection operates on all available fields within the dataset you can put in that you wish your Xfield between min amp max your Y one between min amp max and e g your field between 100 and 100 Right of the Selection expression box Four buttons are available Check to check if the expression is well formed i e if the syntax is correct but NOT if it is scientifically or even dimensionally correct Save as save the current Selection expression for future use within the workspace It will then be available in the formulas box Reset empties the whole box Comment The Comment bu
57. t o Step to define the resolution longitude latitude of the output file Default is 1 5 However note that the smallest the resolution the longest the operation will take to be executed o the Loess cut off value i e the number of grid points before the Loess filter equals to zero odd number Set options for longitude xj Name longitude Title Field options Min 180 00 Step ns 180 00 Mumber of intervals 1800 Loess cut off Figure 12 Option for a X field in the Z F X Y case Note the min max and step Loess cutoff is used when a filter has been defined in the data field options For the Y F X case only the top two boxes Name and Title exist If you choose a Y F X type you can also choose the data type of the axis lat lon time or X for any other kind of data used as X axis Note that you must have one X axis defined If relevant Z F X Y do the same also for the Y axis Note that if you choose Z F X Y you must have one Y axis defined 14 Basic Radar Altimetry Toolbox User Manual Data expression F Data fields field latitude E Check latitude Save As Reset Comment irl Unit degrees_north Datatype Latitude Field options New data field Figure 13 A data expression box with a Y field included Note the Unit default unit as defined in the dataset and the data type used to define de
58. t The Comment button allows associating a more detailed comment with the expression for convenience it only appears as comments in files and is never used for computing viewing for future reference 15 Basic Radar Altimetry Toolbox User Manual Set a comment for time I X Name time Comment Figure 15 A Comment window It can be used as a reminder of the expression and its meaning and if need be of its unit for future use 5 2 3 7 Select expression This box is made to select data within the dataset e g by date boundaries to make some data editing or selection As there is only one selection expression there is no dropdown list with the name just the text box which allows the value of the expression to be edited It is in this text area that fields functions formulas are inserted when clicking on the S buttons A data measurement in the Dataset files is selected only if the result of this expression if not 0 and not a missing default value Defining no selection expression is like selecting everything the expression value is 1 r Select expression S surface type 0 check Save As Reset Comment zi Figure 16 A Selection expression test on a flag which value is 0 over open ocean Type in your selection expression Alternatively to appear in the same box you can select either a field within the dataset record by selecting it in the list you can sort the li
59. terpolation between the different colors The Mode menu enables to choose between predefined color tables two color gradient color tables or multi color gradient color tables 6 2 2 1 two color gradient color tables The two color gradient color table editor enables to make a color table by defining its first and last colors Colors are defined by their Red Green and Blue components and Alpha channel for transparency Default is black RGB 0 0 0 for both and no transparency 255 You can click apply look at the way it shows on your plot When you are satisfied of your color table you can save it and recall it in future sessions 28 Basic Radar Altimetry Toolbox User Manual File Edit Mode First Color Last Color Figure 30 Two color gradient color table editor 6 2 2 2 Multi color gradient color tables The multi color gradient colot table editor works much as the two color one except that you have to define not only the first and last values but that you can also define intermediate one s Definition of the colors is the same Red Green Blue Alpha channel and you also have a cursor beneath the preview of the table that enables you to place your new color in the range To add a new color click on 0 in the values list then on Insert color You will then have a new value 1 that you can change by moving the cursor When you have placed your new value in the range define
60. th the above assumption in out results Data read Must be an array dim number of dataExpressions to values to read in ignoreOutOfRange Skip excess data O false other true Must be false if statistics is true in statistics returns statistics on data instead of data themselves O false other true If statistics is true ignoreOutOfRange must be false The returned values 5 values for each expression are Count of valid data taken into account Invalid data are those which are equal to the default missing value Mean of the valid data Standard deviation of the valid data Minimum value of the valid data Maximum value of the valid data in defaultValue value to use for default missing values This is the value you want to indicate that a value is missing or invalid return O or error code Example Set data input file files SINDGEN 3 files 0 data samples JA1 GDR 2PaP124 001 CNES files 1 data samples JA1 GDR 2PaP124 002 CNES files 2 data samples JA1 GDR 2PaP124 003 CNES Set record name record data Set data selection set selection to retrieve all data row selection latitude gt 20 amp amp latitude lt 30 63 Basic Radar Altimetry Toolbox User Manual Set expressions here 2 expressions expr SINDGEN 2 Acompute expression expr 0 latitude longitude A single expression expr 1 swh_ku Set units for each expression units SINDGEN 2
61. the one that will be written by default on the plots near to the scale if you do not give a title to your field in the options Type your expression the name of one data field or a combination of several ones of them in the box below Alternatively to appear in the same box you can select either 4 field within the dataset record by selecting it in the list you can sort the list alphabetically in each column or type in the first letters to find the right one and then click on the F button right of the data fields list to have it inserted where your cursor was in the data expression box ready made expression by selecting it in the formulas list and then click on the F button right of the formulas box or type in the alias Then click on field options There you can type in a title for your field The title will be displayed as default name of the field in the plots if no title it is the data expression name If you choose a Z F X Y type you can also choose to smooth and or extrapolate by a Loess filter the data so as to have a fully colored plot and not individual tracks or points In that case you will have to fill in the corresponding information in the X and Y fields too Set options for range_c Name frange c Title r Filber G 6255 smooth Logs extrapolate loess l Fillin between tracks If you set Filter don t Forget
62. tton allows associating a more detailed comment with the expression for convenience it only appears as comments in files and is never used for computing viewing for future reference 5 2 3 8 Output Output gives the name of the output netCDF file It is predefined using he name you gave to your operation and cannot be changed within the GUI Execute down at the right process the defined operation on the whole selected dataset You can execute several different operations at the same time i e execute one while arother is being processed or an operation and a view provided you re not trying to visualise the file you re processing However this will slow down each individual execution You can see in the Log tab the current tasks being executed both operations and views the comments during execution verbose mode and the errors Code 0 indicates that the execution went OK 5 2 4 Create a view Third tab is Views If none exists you have to create a new view name it as you prefer with no space nor specid characters in the name Choose new in the Views menu The name is used to call the command file that will be executed to display the data and if need be to retrieve your view in the future The Name dropdown list contains all the defined views names and allows the view selection and renaming You can delete an existing view by choosing delete in the Views menu but note that you can only visuali
63. umentation Example see BRATHL_DSM2JULIAN BRATHL YMDHMSM2SECONDS Converts a year month day hour minute second microsecond date into a seconds according to refDate parameter BRATHL YMDHMSM2SECONDS BRATHL DATEYMDHMSM dateYMDHMSM INT refDate BRATHL DATESECOND dateSeconds in dateYMDHMSM date to convert in refDate date reference conversion out dateSeconds result of the conversion return O or error code see Date error codes in brathl general documentation Example see BRATHL_DSM2JULIAN BRATHL SETREFUSER 1 BRATHL SETREFUSER2 Set user defined reference dates BRATHL_SETREFUSER1 STRING dateRef in dateRef date to set format YYYY MM DD HH MN SS MS return 0 or error code see Date error codes in brathl general documentation Example dateRefUser1 2001 01 12 14 57 23 1456 dateRefUser2 2005 11 14 brathl_setrefuser1 dateRefUser1 60 Basic Radar Altimetry Toolbox User Manual brathl setrefuser2 dateRefUser2 MyDate BRATHL DATEDSM Set user defined ref date 2001 01 12 14 57 23 1456 MyDate REFDATE 5 MyDate DAYS 423 MyDate SECONDS 5 MyDate MUSECONDS 0 AnotherDate BRATHL_DATEDSM Set user defined ref date 2005 11 14 AnotherDate REFDATE 6 AnotherDate DAYS 423 AnotherDate SECONDS 5 AnotherDate MUSECONDS 0 ref date for MyDate is now 2005 11 14 MyDate REFDATE 6 brathl_setrefuser2 2005 05 18 13 08 00 ref date for MyDate and AnotherDate is now 2005 05 18 13 08
64. use of BRAT However everything made with the GUI can be made directly by writing command files and execute them and more than what can be done with the GUI is possible with command files Dictionaries of key functions that can be called within command file are available in Annex B Y F X Annex C Z F X Y and Annex D Display command file keys 7 1 Creating an output NetCDF file A Create command file typically consist in the definition of a dataset list of files that will be processed the name of the record within this dataset where the data you are interested in are stored then the definition of an X axis and of one or several Field s in the Z F X Y case also the definition of an Y axis a selection expression if need be the name and localisation of the NetCDF output file The definition of the axis or of a field include the name of an existing data field or the expression that you wish to compute from several of them a name with no space nor special characters a unit a title that can have space or special characters min and a max and information about a possible filter ERAL PROPE ECORD ra2 mds E Filel E File2 E 1lat E Latitude T degrees north i Latitude ER DV Y MIN DV Y MAX DV Y INTERVALS DV Y LOESS CUTOFF DV E E lon PE Longitude T degrees east E Longitude
65. vity Less than arithmetic expr1 relational It yields values of Boolean type The value returned is arithmetic operators false 0 if the relationship in the expression is false expr2 otherwise the value returned is true 1 Less than or equal to arithmetic expr1 relational It yields values of Boolean type The value returned is lt arithmetic operators false 0 if the relationship in the expression is false expr2 otherwise the value returned is true 1 The equal to operator returns true 1 if both operands LAN have the same value otherwise it returns false 0 operators Greater than arithmetic expr1 relational It yields values of Boolean type The value returned is arithmetic operators false 0 if the relationship in the expression is false expr2 otherwise the value returned is true 1 Greater than or equal to arithmetic expr1 relational It yields values of Boolean type The value returned is gt arithmetic operators false 0 if the relationship in the expression is false expr2 otherwise the value returned is true 1 DV PI jPlvdu _ J Pl O PI2 4 abs Calculates the absolute value _ cel Calculates the ceiling ofa value ceiparami Calculates the cosine radian of a value cos param1 Calculates the cosine degree of a value cosd param1 deg_normalize Normalizes longitude degree deg normalize p c
66. words DASHTINY DASH DASHDOT DOT FULL 51 Basic Radar Altimetry Toolbox User Manual Annex BRATHL IDL The BRAT IDL API consists of a handful of IDL named structures and functions BRATHL DATEYMDHMSM BRATHL DATEDSM BRATHL DATESECOND BRATHL DATEJULIAN BRATHL DATEYMDHMSM named structure This structure represents a YYYY MM DD HH MN SS MS date structure YEAR MONTH DAY HOUR MINUTE SECOND MUSECOND Example MyDate BRATHL DATEYMDHMSM MyDate YEAR 2003 MyDate MONTH 12 MyDate DAY 5 MyDate HOUR 18 MyDate MINUTE 0 MyDate SECOND 21 MyDate MUSECOND 1069 BRATHL DATEDSM named structure This structure represents a day seconds microseconds date structure REFDATE reference date DAYS numbers of days SECONDS numbers of seconds MUSECONDS numbers of microseconds REFDATE is the reference date i e 1950 01 01 00 00 00 0 1958 01 01 00 00 00 0 1985 01 01 00 00 00 0 1990 01 01 00 00 00 0 2000 01 01 00 00 00 0 user reference 1 52 Basic Radar Altimetry Toolbox User Manual 6 user reference 2 values of 5 and 6 allow the user to set two specifics reference date of his choice see BRATHL SETREFUSER1 and BRATHL SETREFUSER2 functions Example MyDate BRATHL DATEDSM MyDate REFDATE 3 MyDate DAYS 423 MyDate SECONDS 5 MyDate MUSECONDS 0 BRATHL DATESECONDS named structure This structure represents a decimal seconds date structure REFDATE reference date
67. y the needed commands are the name of the file s to be displayed the tile projection The name of the field s to be displayed And some information about the display min max name contour or not color table usr bin env BratCreateZFXY Type Z F X Y E Createenvisat_cycle nc NERAL PROPERTIE DISPLAY_TITLE title of the plot DISPLAY GROUPBY FILE Y DISPLAY PROJECTION 3D 33 Basic Radar Altimetry Toolbox User Manual sigma O0 ku FI ELD sigma O ku sigma 0 ku FIELDS PROP AY NAME FIELD GROUP 1 DISPLAY MINVALUE 0 00000 DISPLAY MAXVALUE 50 000 DISPLAY CONTOUR N DISPLAY SOLID COLOR Y DISPLAY COLORTABLE DV Example display command file sigma O0 ku You open the visualisation tool by typing BratDisplay exe command file cmd 7 3 Using the command files to process many datasets A typical case when using the command files will be much easier than using the GUI is when you will want to process the same operation on all or a long series of altimetry satellite cycles Command files enable you to write a script that will process the same operation on a number of files You can either write directly the command file or you can make the command file through the GUI test it on one cycle and then modify it right click by replacing the cycle number by a character that will be replaced consecutively by
68. y C Documents and settings ACCOUNT brat VERSION You can choose another directory if you wish to 3 2 Linux binaries Execute the installation package or installation program from your file ravigator or a console window and follow the installer instructions If you have got the installation package by a network it may not be set as executable so you can issue the command chmod x brat VERSION linux installer bin in order to make it runable By default the software will be put in usr local if you have root permissions or in HOME brat VERSION You can choose another directory if you wish to 3 3 From source All installation package have the source files delivered If you want or need to rebuild BRAT you may install only the source files The have a look in the chosen directory and read the files README and INSTALL The last one gives you information about the dependencies what must be installed before and the specific options which may be used As a convenience a cdrom may have been given to you containing almost all the tools needed but everything can be downloaded from the site of each software 4 How to uninstall BRAT While BRAT is installed the whole installation process is registered and everything created can be removed not what may be created after that 4 1 Windows binaries Go to the control panel the click on Add Remove programs and select the Brat entry Everything created during installation will be rem
69. your color Repeat the operation a many time as you wish to add colors Note that you do not have to define 255 colors f you want a 255 color table one by one since the software interpolates between the values you are giving so choosing 5 or 7 of them is usually a maximum You can click on apply to look at the way it shows on your plot When you are satisfied of you color table you can save it and recall it in future sessions 29 Basic Radar Altimetry Toolbox User Manual BRAT Color Table for sigma 0 ku E ioj xj Fie Edit Mode X Values 0 64 E 128 L m 256 Hc 256 Ja Insert Color Deselect Color Insert Color Deselect Color Remoy Remove Color Figure 31 Multi color gradient color table editor When first opening it left and after defining 5 colors over the whole range equally distributed 6 2 3 Contour table editor The contour table editor enable you to choose the range and number of contours that you wsh to see on your plot the width and color of the lines and if you want labels on the contours or not and their style if SO Note that your contour table cannot be saved and re used for future use 30 Basic Radar Altimetry Toolbox User Manual BRAT Contour Properties for sigma 0 ku Figure 32 Contour table editor 31 Basic Radar Altimetry Toolbox User Manual 7 Using BRAT as commands The GUI is there to ease the

Basic Radar Altimetry Toolbox User Manual

Contents

Download Pdf Manuals

Related Search

Related Contents