| 353 | | * (optional) '''! |
| 354 | | * (mandatory) '''! |
| 355 | | * (mandatory) '''! |
| 356 | | * (optional) '''! |
| | 352 | * (optional) '''!!!ListGlobalAttribute:''' list (cell array of character strings) of the names of global attributes Att_1, Att_2... |
| | 353 | * (mandatory) '''!!!ListVarName:''' list of the variable names Var_1, Var_2....(cell array of character strings). |
| | 354 | * (mandatory) '''!!!VarDimName:''' list of the dimensions associated with each variable: this is a cell array whose number of element is equal to that of '''ListVarName'''. Each element is the dimension name for a unidimensional variable, or a cell array specifying the list of dimension names for a multidimensional variable. |
| | 355 | * (optional) '''!!!VarAttribute:''' cell array of structures of the form !VarAttribute{ivar}.key=value, defining an attribute tag name and value for the variable #ivar (variable number in the list !ListVarName]). |
| 665 | | Several input file series can be introduced simultaneously by selecting ''' [CheckAppend]''', filling the successive lines of '''!InputTable'''. Otherwise, the table of input files is fully refreshed by the browser of the menu bar command '''[Open]'''. The cells in the table can be also edited manually. Then press the button '''[REFRESH]''' to validate the input. |
| 666 | | |
| 667 | | The processing function is chosen in the menu '''[!ActionName]'''. The first option ''check_data_files'' lists the selected input file series and checks their existence. This is a good first test before starting a processing operation since all actions operate on the same input file series. The option ''aver_stat'' calculates a global average on the successive fields, while ''time_series'' provides a time series. The option ''merge_proj'' is used to project a whole series on a given grid, or to create a file series by concatenation of different fields. These processing functions are described with more details in next sub-sections. The option ''civ_series'' gives access to the PIV processsing, see section [#a11PIV:ParticleImagingVelocimetry section 11]. Finally any additional function can be called and included in the menu by selecting the option ''more...'' . The corresponding path is displayed in '''!ActionPath'''. |
| | 664 | Several input file series can be introduced simultaneously with the upper menu bar, or filling manually the successive lines of '''!InputTable'''. To get a new line, press the 'down' keyboard arrow after selecting the last existing line (this copies by default the last line content to the new line). A line can be suppressed by selecting it and pressing the key 'Suppress'. Press the button '''[REFRESH]''' to validate the input (checking the existence of the file series) after any editing. |
| | 665 | |
| | 666 | The panel [!IndexRange] specifies the range of input file or field indices to process while the panel Action specifies the processing function. New processing functions can be added by the user. The files resulting from the processing are put in a folder with the same path RootPath as the folder !SubDir containing the input files. The name of this output folder is defined in [!OuputSubdir]: the default name is the input folder SubDir, followed by an extension depending on the processing function. |
| | 667 | |
| | 668 | The same action can be performed eiither on the local Matlab session, either as background process on the same computer, either as jobs sent on a cluster. In all cases the GUI series exports its content in a xml configuration file put in a subfolder /0_XML of the result folder [!OuputSubdir]. |
| | 669 | |
| | 670 | Other panels can specifiy the input fields to process, the use of transform function, projection objects or masks. They are made visible only if necessary. |
| | 671 | |
| | 672 | === 10.2 The upper menu bar === |
| | 673 | The menu bar at the top of the GUI contains the following buttons: |
| | 674 | |
| | 675 | * '''[Open]''': Open or browse input files. It operates like for the GUI uvmat, except that there are now two possibilities: 'browse...' or 'browse_append...'. The latter appends a new input line to the table '''[!InputTable]''' while the former refreshes the table. |
| | 676 | |
| | 677 | * '''[Open campaign] ''': does the same as '''[Open] but '''scan the data organised as a project/campaign, see [https://servforge.legi.grenoble-inp.fr/#a3.7Dataorganisationinaproject section 3.7]. |
| | 678 | |
| | 679 | * '''[Display Config] ''': exports on the Matlab work space all the data stored in the GUI, in the form of a Matlab structure. |
| | 680 | |
| | 681 | * '''[Inport Config] ''': reads the xml configuration file of a previous computation (plced in a subfolder /0_XML), and fills the GUI with its content, so the calculation can be repeated. |
| | 682 | |
| | 683 | * '''[Inport Param] ''': does the same as '''[Inport Config] '''but without refreshing the input file table and indices. This is useful to repeat a previous calculation for a new series, keeping the same parameters (not however that some processing parameters may be inconsistent with the current input files, so it is less reliable than''' [Inport Config].''' |
| | 684 | |
| | 685 | * '''[Help] ''': displays this help file using the Matlab browser. |
| | 686 | |
| | 687 | === 10.3 The frame [IndexRange] === |
| | 688 | The series of file indices is set in the frame '''[!IndexRange]'''. Any action is performed from field index '''[num_first_i]''' to '''[num_last_i] ''' with increment '''[num_incr_i]''' . If this increment is empty (or not an integer number), operation is performed on all available files between ''first_i'' and ''last_i''. In case of double indexing, action is similarly performed from field index''' [num_first_j]''' to '''[num_last_j]''' with increment '''[num_incr_j]'''. Succesive file names are ordered as a matrix {j,i} with the index j varying the fastest. The box '''num_NbSlice''' can be introduced to scan the ''i'' index modulo NbSlice. |
| | 689 | |
| | 690 | The min and max indices available in the series are indicated as a guide-line, as well as the corresponding times in '''[wiki:TimeTable [TimeTable]]'''. The times for the first and last chosen indices are also indicated, as well as the source of the time information (column 'Name' in the table). |
| | 691 | |
| | 692 | When input files are indexed by pairs i1-i2 or j1-j2, as resulting for instance from PIV, the pair indexing can be chosen by pressing the button''' [wiki:SetPairs "[SetPairs]"]''' which opens an ancilliary GUI. Depending on the input file names, this can provides the choice between 'bursts', 'Di','Dj'. In mode 'bursts' a single j index pair is selected in the menu '''[!ListPairs]'''. In mode 'Di' and 'Dj' it selects a given index interval in i or j respectively. Then the first_i and last_i refer to the ''reference indices''. With the option '*-*' in '''[!ListPairs]''', available pairs are automatically chosen. In case of multiple input lines, the selection from '''[Set pairs]''' refers to the line number displayed in [[https://servforge.legi.grenoble-inp.fr/search?q=wiki%3AListView ListView]]. It is transfered to the corresponding line in the table '''[!PairString]'''. |
| | 693 | |
| | 694 | === 10.4 The frame [Fields] === |
| | 695 | The velocity type and field are automatioally chosen by default, but can be specified by the menus '''[!VelType]''' and '''[!FieldName]'''. In case of multiple input file series, these menus only refer to the first line. Then the menus '''[!VelType_1]''' and '''[!FieldName_1]''' refer to the second line, consistently with the input for the GUI '''uvmat'''. |
| | 696 | |
| | 697 | === 10.5 Field transform, projection object and mask === |
| | 698 | A transform function can be introduced by the menu '''[!TransformName]''' in the frame '''[!FieldTransform]"]'''. New transform functions can be introduced by the option 'more....'. Its path is then recorded and displayed in '''[!TransformPath]. Transform '''functions act field by field to modify the input (for instance transforming image to physical coordinates), like in the GUI uvmat, while the '''Action''' functions act on the whole series. |
| | 699 | |
| | 700 | A projection object can be introduced by selecting the check box '''[!CheckObject]'''. If a projection object has been already created the opened interface '''set_object.fig''' will be used. Otherwise a browser appears to open an object file (xml). It is possible to view the current projection object by pressing '''[view]''', edit it by selecting '''[edit]''', or delete it by pressing '''[delete]'''. |
| | 701 | |
| | 702 | Similarly the check box '''[!CheckMask]''' can be used to select a mask option. These different menus only appear if they are needed as input of the currently selected Action function. |
| | 703 | |
| | 704 | === 10.6 The frame [Action] === |
| | 705 | The processing function is chosen in the menu '''[!ActionName]'''. The first option ''check_data_files'' lists the selected input file series and checks their existence. This is a good first test before starting a processing operation since all actions operate on the same input file series. The option ''aver_stat'' calculates a global average on the successive fields, while ''time_series'' provides a time series. The option ''merge_proj'' is used to project a whole series on a given grid, or to create a file series by concatenation of different fields. These processing functions are described with more details in next sub-sections. The option ''civ_series'' gives access to the PIV processsing, see section [#Civ: section 11]. Finally any additional function can be called and included in the menu by selecting the option ''more...'' . The corresponding path is displayed in '''!ActionPath'''. |
| 673 | | The series of file indices is set in the frame '''[!IndexRange]'''. Any action is performed from field index '''[num_first_i]''' to '''[num_last_i] ''' with increment '''[num_incr_i]''' . If this increment is empty (or not an integer number), operation is performed on all available files between ''first_i'' and ''last_i''. In case of double indexing, action is similarly performed from field index''' [num_first_j]''' to '''[num_last_j]''' with increment '''[num_incr_j]'''. Succesive file names are ordered as a matrix {j,i} with the index j varying the fastest. The box '''num_NbSlice''' can be introduced to scan the ''i'' index modulo !NbSlice. |
| 674 | | |
| 675 | | When input files are indexed by pairs i1-i2 or j1-j2, as resulting from PIV, the pair indexing is chosen by the panel '''[Set Pairs]'''. The popup menu [mode] provides the choice between 'bursts', 'Di','Dj'. In mode 'bursts' a single j index pair is selected in the menu '''[!ListPairs]'''. In mode 'Di' and 'Dj' it selects a given index interval in i or j respectively. Then the first_i and last_i refer to the ''reference indices''. With the option '*-*' in '''[!ListPairs]''', available pairs are automatically chosen. In case of multiple input lines, the selection from '''[Set pairs]''' refers to the line number displayed in [ListView]. It is transfered to the corresponding line in the table '''[!PairString]'''. |
| 676 | | |
| 677 | | The velocity type and field are automatioally chosen by default, but can be specified by the menus '''[!VelType]''' and '''[!FieldName]'''. In case of multiple input file series, these menus only refer to the first line. Then the menus '''[!VelType_1]''' and '''[!FieldName_1]''' refer to the second line, consistently with the input for the GUI '''uvmat'''. |
| 678 | | |
| 679 | | A transform function can be introduced by the menu '''[!TransformName]'''. A projection object can be introduced by selecting the check box '''[!CheckObject]'''. If a projection object has been already created the opened interface '''set_object.fig''' will be used. Otherwise a browser appears to open an object file (xml). Similarly the check box '''[!CheckMask]''' can be used to select a mask option. These different menus only appear if they are needed as input of the currently selected action function. |
| 680 | | |
| 681 | | === 10.2 check_data_files === |
| | 711 | === 10.7 check_data_files === |
