Geneva Astronomical Data Centre param gui Users Manual
Contents
1. eTqeue ue Tooq eer 19399UT 193993UT 7 s eT queue GZ M AWVN N RROO IND 41 Z tA 41 P99URApe HWVN CV MOQNIM IND Ind peoueape alou e puopas qnqr qe Aue qnouqrm Azque eTtj Axque TT T F T Aue gnog3ta Azque Sutiys Azque Butazqys T s SutiIs aTnez p SBUTIIS xoq oquos pa3exqrtTes pexedexd mex Ib s oquo BUIJS oquoo 0910S107106 10 OST F xoq oquo qur Aue xguo s Z T q Tooq Aue qnogyata zqu Teer og p pez T 1 Teer so3nqr133e Aue Azque op Oz b T UT 4Tnez p qnqr qe Aue d q jo ue 9SITI S UTET OU ut payRdOT SJOSPIM y s fqesrp pur s qeu oquioo ojqeuo ow ur UR uorgIsod n pue 9ZIS un p 398prA q v qoy Sognquyyy TND rour e pue sjospim dno ie SULMOYS ojdurexo ue SI MOPULM puoo s ou Uo2anq poourape ot JO uorgdooxo n qamu siojyourered s n IOJ st 19 ye ognquigge ou pur soynquiyge iyney p ash MOPULM UPU 919 uo SJOSPLA SMOPULM UJIM JNN 8 S047891 y Iojoureied ojdurexo SULMO OH2. param gui AstroROOT Users Manual 29 May 03 11 param gui Geneva Astronomical Data Centre PARAM GUI USERS MANUAL Reference param_gui ssue 1 1 Date 29 May Geneva Astronomical Data Centre Chemin d Ecogia 16 CH 1290 Versoix Switzerland http isdc unige ch index cgi Softtastroroot Authors and Approvals param gui AstroROOT Users Manual 29 May 03 11 param gui 1 1 Prepared by R Rohlfs GADC param guiUsers Manual Issue 1 1 Document Status Sheet param gui AstroROOT Users Manual 16 MAR 03 1 0 param gui Users Manual released 29 MAY 03 1 1 New chapter Application interface 29 MAY 2003 Printed GADC param guiUsers Manual Issue 1 1 ii Contents 1 Overviews 00 1 2 How to start the param gui program 1 3 Hints for the Users p aiue Seg e ada ore h EADS dodo A o 2 S ard 1 4 Modifications of the Parameter File 2 4 1 Widsets es E rude 7 7 2 4 2 The Coordinate System or the Layout 3 4 3 Tonal Ae VY DDR SE AEE a a ee ea ee 4 4 4 Recognized Attributes 7 5 Example a cs oS bas adan a a S Ge tee du a t Q a A Sus A A 8 6 Application Interface gt ss pp l a aa a 3060660529 10 7 Extors and Warnings mss oi deare ere Grave cu YR A E 11 GADC param guiUsers Manu
3. par and without path It is assumed that the corresponding program is in one of the PATH directories 3 Hints for the User e Move the mouse on top of the parameter name to see the parameter prompt in a tool tip help balloon e The number entries for integer and real values have on their right side small buttons to increase and decrease the numerical value in the field They also support using the up and down cursor keys to change the numerical values The step size can be selected with control and shift keys no small step 1 unit factor of 3 shift medium step 10 units factor of 10 control large step 100 units factor of 30 shift control huge step 1000 units factor of 100 The steps are either linear or logarithmic The default behavior is linear but it can be changed by pressing the alt key at the same time e It is possible to select compresses FITS files fits gz with the browse button of text and file entries Select first an other file filter in the file selection window before selecting a file The filename without gz is copied into the entry field of the file and string widget e Ifthe entry field for file names or strings is too short to show the full text increase the width of the whole window This will increase the width of the entry field as well GADC param guiUsers Manual Issue 1 1 1 4 Modifications of the Parameter File The look and feel of the GUI is controlled by the parameter file of the a
4. box 16 units int entry 14 units real entry 14 units text entry is either the global attribute TEXT W or FILE W for string and file pa rameters respectively If these global attributes are not define their default values are used 31 or 81 units The button of the text entry widget is included in the width GADC param guiUsers Manual Issue 1 1 4 combo box 6 units more than the largest name of all entries in the combo box rame 16 units window 10 units this defines the width of the associated button to open the window e H Defines the height of a widget This attribute is recognized only by frames The height of all other widgets is 2 units The default value for frames is 6 units e NAME This attribute overwrites the parameter name on the GUI for entry widgets It is the title for frame widgets and the Z coordinate and the button text for window widgets This attribute is required for windows There is no default value NAME W Defines the width of the parameter name or the value of the NAME attribute on the screen If the actual text is longer it will be overwritten by the entry widget It the actual text is shorter than NAME V the entry widget will nevertheless keep space for the defined width Therefor with this attribute the widgets can be aligned The default value is define by the common attribute NAME W which by itself has a default value of 16 units e TABS This attri
5. gui GetBool default bool printf error d n int gui Error printf int hd real 412 4f string s bool d n ii dd str bb 7 Errors and Warnings e Selected files does not has any HDU or is no FITS file If the DOL attribute is defined without a DOL value the GUI reads all HDU names after a file is selected by the user This error message appears if no HDU can be opened with a DAL function Environment variable ISDC ENV is not defined Cannot find the help file When the user pressed the Help button the GUI tries to find the help file of the corresponding script or executable in the ISDC_ENV help directory e File filename is missing Cannot display help text GADC param guiUsers Manual Issue 1 1 11 The environment variable ISDC ENV is set but the help text of the script of executable is not available in the directory ISDC ENV help e Cannot open file filename Cannot display help text The help text is available in the ISDC ENV help directory but the system call to open the file failed Check the read permission of the help file GADC param guiUsers Manual Issue 1 1 12
6. ojduexy GADC param guiUsers Manual Issue 1 1 100 Z A 0 X andano z 41ns r qno IND 6 100 3nd r Z IND QOH ANOO SIgI 104 andut z SAND TUOTSISAUO UT IND it 1 104 3nduT Z mos ur IND 27489 UTIeIgTTeo UOTSISAUOD qndut T s eAIND UOTSISAUOD UT MOpUTM 4anduT T S MOS UT qndqno qndut sqyL OZ A O X Z MHQTDA IND SLIM AIA SLM IXIL 92 M HWVN N RROO IND eduez z uq ANVN 8 H Z M COTIA 29 X 2 QONA AWYU IND x S quTlTe sz Tqevu NT9YSIQ unutxeu esn AWYN S bT A 89 X Z q Sue xew IND 418 910 umururu sn IWYN I ch 89 X peoueape Z q Sue uTW IND 1eddn sq ou T q q Sue xeu ue sn s 4 T q q 3u uTu TI M HRYN N RROO IND sentea z S qur ur S UFI 8 ANVN I H OSIM S A pe X p oueape Z I DNH HHYUA IND ue TooqlTe z Tqeu 4TdySIQ xeddn G PT A GE X Z p Sue xew Ind ue TooqlTe z Tqeu H418YSIQ ITUTT E AWVN Z
7. T tA GE X pooueape z r Sue ZT IND ue rTooq Te xz Tqeu TTgVSIQ 3TUTT T 916 A GE X Z TSus TT IND ue rooq Te xz T1qeu TIgVSIQ 3TUTT HWVN L th SE X peoueape Z TSu uTu IND dada A t T Su xeu p Sue gl 1 tT Sue TI T Su uTu Azeue zeddn eutzeq ogg ose QTUTT Azeue z eutzeq oog 006 Azeue 7 urj q 0Sr osz 3ioue SUTISA 007 ooz s nTeA Te z UT SITUIT ASzeuy dWVN I H OSIM GIA T X Z ONT AWWA IND ue Tooq z 93 qur Tqeu qTgVSIq ATUTT xeddn AWYN G PT Z X peoueape z Sue xeu IND GADC param guiUsers Manual Issue 1 1 These are the two windows created with the parameter file of the previous pages E SEM 2012 234 E m 30 xl prepared em O sdcitestdata eZe f data nrt 0ps 1 scw 0026 002600010010 000 swg prp fits 1 ce T data nrt 0ps 1 c mx1 cnv imx1 conv mod 0005 fits JMX1 CONV MOD 6 Application Interface The libparam gui a library includes the class ParamGui which can be used by applications to open a GUI with all its parameters and to get the values of the parameters defined by the user class ParamGui public ParamGui int argc char argv bool Quitd int Error bool GetBoo
8. al Issue 1 1 Hi 1 Overview The param gui program is a Graphical User Interface GUI to edit the parameters of a FTOOLS parameter file The actual GUI depends on the content of the parameter file par Additional GUI comments in the parameter file can define a more user friendly GUI But it is always possible to use a standard FTOOLS parameter file to open a GUI window and to edit the parameters to save them and to start the corresponding program Beside the param gui program a library libparam gui a is available to call this GUI from an ap plication program Unfortunately the interface is not yet described Please send an email to Reiner Rohlfs obs unige ch if you want to use this library 2 How to start the param gui program After a successful installation see http isdc index cgi Soft rastroroot the program is installed in the bin sub directory of the installation directory The program has one mandatory and one optional parameter The first program parameter defines the parameter file It is not necessary to write the extension par The program will look for the parameter file in the directories defined by the environment variable PFILES The program title bar shows the the full path of the used parameter file The second the optional program parameter defines the program which can be started with the Run button of the GUI If it is not defined the GUI will start the program named as the parameter file but without extension
9. as its own X Y coordinate system where 0 0 is at the upper left corner of the tabs The actual GADC param guiUsers Manual Issue 1 1 3 coordinate values can be a fraction of a unit The third dimension called Z consist of different layers Each layer has a name A layer can be a window or a tab of a folder The main window for example has the Z coordinate main and all hidden parameters are by default located in a window with a Z coordinate named hidden The Z coordinate of a tab is the text on its card To place a widget on a specific window or tab an attribute Z name must be defined 4 3 Attributes Attributes are defined in a modification comment line see section 4 Modifications of the Parameter File Each attribute consist of an identifier and a value The last character of an identifier is always a Attributes are separated by commas in the parameter file There is nearly always a default value for each attribute Exceptions are clearly mentioned in the following description of each attribute Note not every attribute is recognize by each widget See the table in section 4 4 Recognized Attributes to verify which attributes can be used to modify a given widget X Defines the X position of the left edge of a widget on the window or on a tab To use this value also the Y attribute must be defined for the same widget If the Y attribute is not defined the default value is used See als
10. bute is used only for folder widgets It defines the names of all tabs and is a mandatory attribute The names are separated by the pipe character Blanks and tabs just before and behind the sign are ignored but the tab names can include blanks For example GUI FOLDER TABS global parameters spectra parameters image parameters e DOL This attribute is used for parameters which expect a DOL instead of a string or a filename It is the exception of all attributes and is valid without specified value But if a value is define like DOL 1 than this number is used as HDU position and automatically added to the selected file name If no value is define like DOL than after a file is selected the GUI reads all data structures in the selected FTTS file The user has to select in a list box a HDU name which is added to the selected file name e DISABLE With this attribute widgets can be disabled depending on the status of a check box widget or depending on the selected item in a combo box widget The value string of this widget has a specific syntax example for combo box GUI param name1 DISABLE depend on image GUI param name2 DISABLE depend on image timing example for check box GUI param name3 DISABLE depend 1 yes GUI param name4 DISABLE depend_oni no depend_on is the parameter name not the attribute NAME of an other widget This has to be either a check box widget or a combo box widget If in
11. fication comment line for a parameter MUST be written in the parameter file after the parameter definition line 4 1 Widgets Each parameter in the parameter file builds one widget called entry widget Beside these widgets three further widgets can be build These parameter independent widgets group several entry widgets and they are called group widgets Frame window and folder are implemented as group widgets 4 1 1 Entry Widgets e check box widget A check box widget is created for every boolean parameter b Mark the check box to set the boolean parameter to yes Depending on the state of this widget other widgets can be disabled or enabled See attribute DISABLE in section 4 3 Attributes e integer entry widget An integer entry widgets is created for integer parameters i as long as no list of accepted values are defined in the min field of the parameter definition in the parameter file See also section 3 Hints for the User e real entry widget An real entry widgets is created for real parameters r as long as no list of accepted values are defined in the min field of the parameter definition in the parameter file See also section 3 Hints for the User GADC param_guiUsers Manual Issue 1 1 2 text entry widget A text entry widget is created for string s and for file f parameters as long as no list of accepted values are defined in the min field of the parameter definition in the parameter file If the parameter i
12. is common attribute is 81 units GADC param guiUsers Manual Issue 1 1 6 p amb x x x x AODULA X X X 10P0 X X X X X X SUR x x x X X X x jiost1 xoq OQUIO x x x X X X X X JIOSs IjUo X x x x X X X 1 wor IJUO eal X X X X X X X 1 qu Anm qur Bs x x X x x 4 1004 xoq spy ATAVSIG TOG SVL M HINVN TIN VN H iM 7 Kk X wered J SDIAA SI zrusSo5 1 YOU s op TIM 1 SDIA Y 107 oynquiyye TND oy W Pope ou sey mq ffe 4 m rqold e you st oynquiyye ue SUL J93pim oy Aq p zru3oo94 7879 S9JNQLIIJY sy JOSPIM q v qoy swous qe FUmMOJJOA s qnqL 33y poziuSovoW y y GADC param guiUsers Manual Issue 1 1 ue Tooqlx S qur lqeu 4T yS1ld 3TuTT Z HNYN ZT CA Zz x peoueape 2 Suscr IND ue Tooq 19897Uf Tq2U9 JIJYSIA TWIT T aNVN 96 A peoueape z Sus TT IND ue Tooqlz S qur Tqeu 41HYSIQ TWIT AWYN L A Z X peoueape z Sus utu IND Azeue zeddn urj q o0sSs 046 T 1 Bue xeu ATUTT Azeue z eutzeq oos 00 T I Bue ZT 1 urz q 0St 042 T I Sus IT T xemoT surjeg 00y QOZ T 1 BueTuru TT M HRVN N HROO IND TAS iX peoueape Z eTqeue IND s193pTM STABSTP
13. l const char paraName int GetInt const char paraName double GetReal const char paraName const char GetString const char paraName GADC param_guiUsers Manual Issue 1 1 10 The file param api h has to be included to be able to use this class The constructor opens the GUI of the program and does not return until the user pressed the Quit or the Run button of the GUL The Quit method returns true if the user pressed the Quit button and returns false if the user pressed the Run button If the user pressed the Run button Quit returned false the application can asked for the values of the parameters with the Get methods The GetString method should be used for strings and file parameters The method Error should return O to indicate that no error occurred 1 the parameter file could not be opened 2 the requested parameter of one of the Get methods does not exist 30xx a PIL error See PIL user manual Following example demonstrates the use of this class include param api h main int argc char argv ParamGui gui argc argv opens the GUI if gui Error printf Error d n gui Error return 1 if gui Quit return 0 the user pressed the Quit button we can ask for the values of the parameters int ii gui GetInt default int double dd gui GetReal default real const char str gui GetString default string bool bb
14. o section 4 2 The Coordinate System or the Layout The default value is 0 e Y Defines the Y position of the upper edge of a widget on the window or on a tab To use this value also the X attribute must be defined for the same widget If the X attribute is not defined the default value is used See also section 4 2 The Coordinate System or the Layout The default value is 2 more than the previous widget The default value of the first widget is 0 Note first the position of all widgets for which the X and Y attributes are defined are placed on the window or tab Than the Y position of the other widgets are determined by increasing the Y coordinate by 2 starting with the largest predefined Y position e Z Defines the third dimension the window or the tab of a folder in which the widget will be visible The value of this attribute therefor is not a number as for X and Y but a name See section 4 2 The Coordinate System or the Layout for more information about the Z dimension The default value is main which is the Z coordinate of the first window As exception the default value for hidden parameters is hidden which is an other always available window This 2nd window can be opened by a button of the main window W Defines the width of the widget The parameter name in front of each widget is not included in this width The width cannot be define for folders The default value depend on the widget check
15. s of type file f or if the attribute DOL is defined for the parameter a browse button appears on the right side of the text entry field With this button a file or a DOL can be selected respectively combo box widget A combo box is created for all parameters except boolean if a list of accepted values is defined in the min field of the parameter definition in the parameter file As soon as the pipe character is part of the min field a combo box is created All in the min field listed and by separated values are available for selection in the list box of the combo box Depending on the selected item in the combo box widget other widgets can be disabled or enabled See attribute DISABLE in section 4 3 Attributes 4 1 2 Group Widgets Group widgets have in the first field of the GUI comment line an identifier instead of the parameter name for entry widgets Frame Widget A frame is just a rectangle area with a title attribute NAME It is recommended to specify the width attribute W and the height attribute H of a frame The identifier of a frame is FRAME_ Window Widget A window widget is a new window on the screen and an associated button in an other window The user can open the new window by pressing this button The attribute NAME must be defined for a window widget It is the Z coordinate of the window and the text in the button The coordinate attributes X Y and Z define the position of the a
16. ssociated button not of the window To place a widget in this window the attribute Z window_name must be defined for that widget The identifier of a window is WINDOW Folder Widget A folder widget consist of several tabs Each tab has a card with a name This name is at the same time the Z coordinate of the tab At a given time only one tab with its widget is visible while the other tabs are hidden behind this so called top tab The different tabs are defined with the TABS attribute which is required for this widget To place a widget in one of the tabs the attribute Z tab name must be defined for that widget The size of a folder widget depend on the size and position of the widgets in all the tabs of the folder Therefore the attributes W and H cannot be defined for a folder widget The identifier of a folder is FOLDER To create more than one group widget of the same type or to define attributes for a group widget in more than one line in the parameter file the widget must have a unique identifier There for it is possible to increase the widget specific identifiers by further characters For example FOLDER namel and FOLDER name2 are valid folder identifiers for two different folders 4 2 The Coordinate System or the Layout To place a widget in its window a three dimensional coordinate system is chosen The X and Y coordinates are in units of a character size 0 0 is at the upper left corner of a window A folder h
17. ssociated executable First the standard parameter lines are interpreted and for each line a widget is created The type of the widget depend on the data type of parameter See section 4 1 Widgets Beside that special comment lines modify the GUI Each of these modification comment line must start at the beginning of the line with GUI These 5 characters including the space are the key for the GUI to find more information about a widget Following this key one ore more fields are allowed The fields are separated by a comma Blanks and tabs just before and behind the comma are ignored The first field is always the parameter name Note there must be no comma between the key GUI and the parameter name Following fields define attributes for the widget of the given parameter See section 4 3 Attributes Here are some examples of these modification comment lines GUI _FOLDER_MAIN X 2 Y 0 5 TABS datasets background analysis mode GUI pointing dol Z datasets DOL 2 GUI pointing dol X 4 3 Y 19 NAME Pointing GUI FRAME X 1 Y 17 W 100 H 18 NAME modes dependent definitions GUI image err Z output DISABLE mode TIMING SPECTRAL GUI image sig Z output DISABLE mode TIMING SPECTRAL As shown above beside modification comment lines for parameters also modification lines which define group widgets like frames folders and windows are allowed For more information see section 4 1 2 Group Widgets A modi
18. the example above timing in the combo box depend on is selected than the widget for param name will be enables while the widget for param name will be disabled If disable depends on a check box widget the name behind the sign has to be either yes or no Any other string will be ignored It is not possible to define a dependency from two different widgets for one parameter The GADC param guiUsers Manual Issue 1 1 5 second definition will overwrite the previous one By default a widget does not depend on the state of any other widget and is enabled all the time 4 3 1 Common Attributes Common attributes are used to define default values These default values are applied for all parameters which are located behind the modification comment line of the common attribute in the parameter file It is possible to reset the default values several times in a parameter file The identifier for common attributes is COMMON for example GUI _COMMON_ NAME W 25 TEXT_W 80 e NAME_W Defines the default value for the NAME_W attribute of each individual widget The default value for this common attribute is 16 units TEXT_W Defines the default value for the width of a text entry widget when it is created for a string parameter s The default value for this common attribute is 31 units FILE W Defines the default value for the width of a text entry widget when it is created for a file parameter f The default value for th
Download Pdf Manuals
Related Search