# Changeset 3b349ee in sasview

Ignore:
Timestamp:
May 18, 2018 8:02:02 AM (4 years ago)
Branches:
ESS_GUI, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc
Children:
0459591
Parents:
dbba134 (diff), 3aa3351 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.
Message:

Merge branch 'ESS_GUI_doc_qresol' into ESS_GUI

Files:
9 edited

Unmodified
Removed
• ## src/sas/qtgui/Calculators/media/resolution_calculator_help.rst

 r417c03f ----------- This tool is approximately estimates the resolution of $Q$ from SAS instrumental This tool approximately estimates the resolution of $Q$ from SAS instrumental parameter values assuming that the detector is flat and normal to the incident beam. -------------- 1) Select *SAS Resolution Estimator* from the *Tool* menu on the SasView toolbar. 1) Select *Q Resolution Estimator* from the *Tool* menu on the SasView toolbar. 2) Select the source (Neutron or Photon) and source type (Monochromatic or TOF). 2) Select the source and source type (Monochromatic or TOF). *NOTE! The computational difference between the sources is only the range. Optionally, the wavelength (BUT NOT of the wavelength spread) can be extended Optionally, the wavelength (BUT NOT the wavelength spread) can be extended by adding '; nn' where the 'nn' specifies the number of the bins for the numerical integration. The default value is nn = 10. The same number of bins 7) 1D and 2D $dQ$ values will be displayed at the bottom of the panel, and a 2D resolution weight distribution (a 2D elliptical Gaussian function) will also be displayed in the plot panel even if the $Q$ inputs are outside of the detector limit (the red lines indicate the limits of the detector). be displayed in the plot panel. TOF only: green lines indicate the limits of the maximum $Q$ range accessible for the longest wavelength due to the size of the detector. Note that the effect from the beam block/stop is ignored, so in the small $Q$ Note that the effect from the beam block/stop is ignored. So, in the small $Q$ region near the beam block/stop 8) A summary of the calculation is written to the SasView *Console* at the bottom of the main SasView window. bottom of the main SasView window, below the plot. .. image:: resolution_tutor.png .. figure:: resolution_tutor.png .. 1) Define the source. Select *Photon* for X-ray. This selection only affects the gravitational contribution of the resolution 2) Select between *Monochromatic* or *TOF* 3) For *TOF*, there is the option of loading a custom spectral distribution using *Add New* in the combo box 4) *Wavelength* and *wavelength spread*: one value for *Monochromatic*, minimum and maximum of range for *TOF* 5) For *Source* and *Sample Size Aperture*, one value for a circular aperture (diameter) and two values separated by a comma (,) for a rectangular slit (side lengths) 6) One value for one ($Qx$, $Qy$) location or more values separated by a comma (,) for more locations. *Note: the $Qx$, $Qy$ input boxes should have the same number of values.* 7) Click on *Compute* button to start the calculation 8) *Sigma_x* and *Sigma_y* are the components of the 2D $dQ$ at the last ($Qx$, $Qy$) point of inputs 9) *Sigma_lamd* is the 2D $dQ_{\lambda}$ at the last point of inputs. *Note: $dQ_{\lambda}$ has only the Qr directional component* 10) *(1D Sigma)* is the 1D $dQ$ at the last ($Qx$, $Qy$) point of inputs 11) Plot of the result. For *TOF*, a green rectangle marks the limits of maximum $Q$  range accessible for the longest wavelength due to the size of the detector. .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
• ## src/sas/qtgui/Calculators/media/resolution_tutor.png

• Property mode changed from 100755 to 100644
• ## installers/sasview_qt5.spec

 raefde77 datas = [('../src/sas/sasview/images', 'images')] datas = [('../src/sas/sasview/images/ball.png', '.')] datas.append(('../src/sas/sasview/media','media')) datas.append(('../src/sas/sasview/test','test')) datas.append(('../src/sas/sasview/wxcruft.py','.')) datas.append(('../src/sas/logger_config.py','.')) datas.append(('../src/sas/logging.ini','.')) # pyinstaller gets mightily confused by upper/lower case, 'logging', 'logging.config', 'reportlab', 'reportlab.graphics', 'reportlab.graphics.barcode.common', 'reportlab.graphics.barcode.code128', 'reportlab.graphics.barcode.code93', 'reportlab.graphics.barcode.code39', 'reportlab.graphics.barcode.lto', 'reportlab.graphics.barcode.qr', 'reportlab.graphics.barcode.usps', 'reportlab.graphics.barcode.usps4s', 'reportlab.graphics.barcode.eanbc', 'reportlab.graphics.barcode.ecc200datamatrix', 'reportlab.graphics.barcode.fourstate', 'ipykernel', 'ipykernel.datapub', 'pygments', 'pygments.lexers','pygments.lexers.python',
• ## src/sas/qtgui/MainWindow/GuiManager.py

 r57be490 self.welcomePanel = WelcomePanel() self.grid_window = None self._workspace.toolBar.setVisible(LocalConfig.TOOLBAR_SHOW) self._workspace.actionHide_Toolbar.setText("Show Toolbar") # Add calculators - floating for usability
• ## src/sas/qtgui/MainWindow/UI/MainWindowUI.ui

 rd4dac80 09152226 SAS Resolution Estimator Q Resolution Estimator
• ## src/sas/qtgui/Perspectives/Fitting/media/fitting_help.rst

 rb31b7e2 The graph will update dynamically as the parameter values are changed. You can decide your own model categorizations using the :ref:Category_Manager. .. TODO: uncomment after Category_Manager done .. You can decide your own model categorizations using the :ref:Category_Manager. Once you have selected a model you can read its help documentation by right clicking .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ .. _Category_Manager: Category Manager ---------------- To change the model categorizations, either choose *Category Manager* from the *View* option on the menubar, or click on the *Modify* button on the *Fit Page*. .. image:: cat_fig0.png The categorization of all models except the user supplied Plugin Models can be reassigned, added to, and removed using *Category Manager*. Models can also be hidden from view in the drop-down menus. .. image:: cat_fig1.png Changing category ^^^^^^^^^^^^^^^^^ To change category, highlight a model in the list by left-clicking on its entry and then click the *Modify* button. Use the *Change Category* panel that appears to make the required changes. .. image:: cat_fig2.png To create a category for the selected model, click the *Add* button. In order to delete a category, select the category name and click the *Remove Selected* button. Then click *Done*. Showing/hiding models ^^^^^^^^^^^^^^^^^^^^^ Use the *Enable All / Disable All* buttons and the check boxes beside each model to select the models to show/hide. To apply the selection, click *Ok*. Otherwise click *Cancel*. *NB: It may be necessary to change to a different category and then back again* *before any changes take effect.* .. TODO: uncomment after Category_Manager done .. .. _Category_Manager: Category Manager ---------------- To change the model categorizations, either choose *Category Manager* from the *View* option on the menubar, or click on the *Modify* button on the *Fit Page*. .. image:: cat_fig0.png The categorization of all models except the user supplied Plugin Models can be reassigned, added to, and removed using *Category Manager*. Models can also be hidden from view in the drop-down menus. .. image:: cat_fig1.png Changing category ^^^^^^^^^^^^^^^^^ To change category, highlight a model in the list by left-clicking on its entry and then click the *Modify* button. Use the *Change Category* panel that appears to make the required changes. .. image:: cat_fig2.png To create a category for the selected model, click the *Add* button. In order to delete a category, select the category name and click the *Remove Selected* button. Then click *Done*. Showing/hiding models ^^^^^^^^^^^^^^^^^^^^^ Use the *Enable All / Disable All* buttons and the check boxes beside each model to select the models to show/hide. To apply the selection, click *Ok*. Otherwise click *Cancel*. *NB: It may be necessary to change to a different category and then back again* *before any changes take effect.* .. .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ them in the first place!). To tie parameters between the data sets with constraints, check the 'yes' radio button next to *Add Constraint?* in the *Fit Constraints* box. *NB: You can only constrain parameters that are set to refine.* .. image:: constraint_1.png To tie parameters between the data sets with constraints, select the data sets and right click. From the menu choose *Mutual constraint of parameters in selected models* .. image:: constraint_2.png When ready, click the *Fit* button on the *Const & Simul Fit* page, NOT the *Fit* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use the *Easy Setup* drop-down buttons in the *Const & Simul Fit* page to set up constraints between *FitPage*'s. In the *Const. & Simul. Fit* page select two data sets which are to be constrained. Right clicking in the *Source choice for simultaneous fitting* area will bring up the context menu: .. image:: constraint_2.png Here you can choose datasets for fitting and define constraints between parameters in both datasets. Selecting this option will bring up the *Complex Constraint* dialog. .. image:: complex_constraint.png Constraints will generally be of the form .. image:: restore_batch_window.png Once a batch fit is completed, all model parameters are displayed but *not* their uncertainties. To view the uncertainties, click on a given column then go to *Edit* in the menu bar, select *Insert Column Before* and choose the required data from the list. An empty column can be inserted in the same way. To remove a column from the grid, click on the column header and choose *Remove Column* under *Edit* in the menu bar. The same functionality also allows you to re-order columns. *NB: You cannot insert/remove/re-order the rows in the Grid Window.* All of the above functions are also available by right-clicking on a column label. .. image:: edit_menu.png *NB: If there is an existing Grid Window and another batch fit is performed,* .. Once a batch fit is completed, all model parameters are displayed but *not* their uncertainties. To view the uncertainties, click on a given column then go to *Edit* in the menu bar, select *Insert Column Before* and choose the required data from the list. An empty column can be inserted in the same way. To remove a column from the grid, click on the column header and choose *Remove Column* under *Edit* in the menu bar. The same functionality also allows you to re-order columns. *NB: You cannot insert/remove/re-order the rows in the Grid Window.* All of the above functions are also available by right-clicking on a column label. .. image:: edit_menu.png .. If there is an existing Grid Window and another batch fit is performed,* *an additional 'Table' tab will be added to the Grid Window.* ^^^^^^^^^^^^^^^ Any column of *numeric* parameter values can be plotted against another using the *Grid Window*. Simply select one column at the time and click the *Add* button next to the required *X/Y-axis Selection Range* text box. When both the X and Y axis boxes have been completed, click the *Plot* button. When the *Add* button is clicked, *SasView* also automatically completes the *X/Y-axis Label* text box with the heading from Row 1 of the selected table, but different labels and units can be entered manually. .. image:: plot_button.png The *X/Y-axis Selection Range* can be edited manually. The text control box recognises the operators +, -, \*, /, or 'pow', and allows the following types of expression : 1) if an axis label range is a function of 1 or more *columns*, write this type of expression constant1 * column_name1 [minimum row index :  maximum  row index] operator constant2 * column_name2 [minimum row index :  maximum  row index] Example: radius [2 : 5] -3 * scale [2 : 5] 2) if only some *values* of a given column are needed but the range between the first row and the last row used is not continuous, write this type of expression column_name1 [minimum row index1 :  maximum  row index1] , column_name1 [minimum row index2 :  maximum  row index2] Example: radius [2 : 5] , radius [10 : 25] .. Any column of *numeric* parameter values can be plotted against another using the *Grid Window*. Simply select one column at the time and click the *Add* button next to the required *X/Y-axis Selection Range* text box. When both the X and Y axis boxes have been completed, click the *Plot* button. When the *Add* button is clicked, *SasView* also automatically completes the *X/Y-axis Label* text box with the heading from Row 1 of the selected table, but different labels and units can be entered manually. .. image:: plot_button.png The *X/Y-axis Selection Range* can be edited manually. The text control box recognises the operators +, -, \*, /, or 'pow', and allows the following types of expression : 1) if an axis label range is a function of 1 or more *columns*, write this type of expression constant1 * column_name1 [minimum row index :  maximum  row index] operator constant2 * column_name2 [minimum row index :  maximum  row index] Example: radius [2 : 5] -3 * scale [2 : 5] 2) if only some *values* of a given column are needed but the range between the first row and the last row used is not continuous, write this type of expression column_name1 [minimum row index1 :  maximum  row index1] , column_name1 [minimum row index2 :  maximum  row index2] Example: radius [2 : 5] , radius [10 : 25] .. Any row (dataset) can be plotted by selecting it and either right-clicking and choosing *Plot selected fits* menu item or by clicking on the *Plot* button. .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ described in :ref:Loading_data. Next start up two or more *BatchPage* fits following the instructions in :ref:Batch_Fit_Mode but **DO NOT PRESS FIT**. At this point the *Combine Batch Fit* menu item under the *Fitting menu* should be active (if there is one or no *BatchPage* the menu item will be greyed out and inactive).  Clicking on *Combine Batch Fit* will bring up a new panel, similar to the *Const & Simult Fit* panel. In this case there will be a checkbox for each *BatchPage* instead of each *FitPage* that should be included in the fit.  Once all are selected, click the Fit button on the *BatchPage* to run each batch fit in *sequence* .. image:: combine_batch_page.png When done, select *Constrained or Simultaneous Fit* under *Fitting* in the menu bar. In the *Const & Simul Fit* page that appears, choose *Batch fits* radio button and select which data sets are to be  fitted. .. image:: simult_batch.png Once all are selected, click the Fit button on the *Const. Simult. Fitting* to run each batch fit in *sequence* The batch table will then pop up at the end as for the case of the simple Batch recognized as the same parameter. .. image:: combine_batch_grid.png In the example shown above the data is a time series with a shifting peak. The first part of the series was fitted using the *broad_peak* model, while the rest of the data were fit using the *gaussian_peak* model. Unfortunately the time is not listed in the file but the file name contains the information. As described in :ref:Grid_Window, a column can be added manually, in this case called time, and the peak position plotted against time. .. image:: combine_batch_plot.png Note the discontinuity in the peak position.  This reflects the fact that the Gaussian fit is a rather poor model for the data and is not actually finding the peak. .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ .. note::  This help document was last changed by Paul Butler, 10 September 2017 .. .. image:: combine_batch_grid.png In the example shown above the data is a time series with a shifting peak. The first part of the series was fitted using the *broad_peak* model, while the rest of the data were fit using the *gaussian_peak* model. Unfortunately the time is not listed in the file but the file name contains the information. As described in :ref:Grid_Window, a column can be added manually, in this case called time, and the peak position plotted against time. .. image:: combine_batch_plot.png Note the discontinuity in the peak position.  This reflects the fact that the Gaussian fit is a rather poor model for the data and is not actually finding the peak. .. .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ .. note::  This help document was last changed by Piotr Rozyczko, 18 May 2018
• ## src/sas/qtgui/Utilities/LocalConfig.py

 rd4dac80 WELCOME_PANEL_SHOW = False #Show or hide toolbar at the start up TOOLBAR_SHOW = True TOOLBAR_SHOW = False # set a default perspective DEFAULT_PERSPECTIVE = 'None'
Note: See TracChangeset for help on using the changeset viewer.