Changeset b7c9f7d in sasview

Timestamp:

Feb 19, 2015 8:08:50 AM (10 years ago)

Author:

krzywon

Branches:

master, ESS_GUI, ESS_GUI_Docs, 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, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

4749514

Parents:

27ab091 (diff), bc9a0e1 (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 'master' of ​https://github.com/SasView/sasview/

Location:

src/sas

Files:

• perspectives/calculator/media/data_operator_help.rst (modified) (1 diff)
• perspectives/calculator/media/density_calculator_help.rst (modified) (1 diff)
• perspectives/calculator/media/image_viewer_help.rst (modified) (2 diffs)
• perspectives/calculator/media/kiessig_calculator_help.rst (modified) (2 diffs)
• perspectives/calculator/media/pycrust_example.bmp (deleted)
• perspectives/calculator/media/pycrust_example.png (added)
• perspectives/calculator/media/python_shell_help.rst (modified) (2 diffs)
• perspectives/calculator/media/resolution_calculator_help.rst (modified) (5 diffs)
• guiframe/local_perspectives/plotting/slicerpanel.py (modified) (4 diffs)

src/sas/perspectives/calculator/media/data_operator_help.rst

@@ -34 +34 @@
    available operators are:
    
-*  + (for addition)
-*  - (for subtraction), 
-*  * (for multiplication)
-*  / (for division)
-*  | (for combination of two data sets)
+*   \+ (for addition)
+*   \- (for subtraction) 
+*   \* (for multiplication)
+*   \/ (for division)
+*   \| (for combination of two data sets)
 
    If two data sets do not match, the operation will fail and the background 

src/sas/perspectives/calculator/media/density_calculator_help.rst

@@ -19 +19 @@
 ------
 
-1) Enter the empirical formula of a molecule. For mixtures, the ratio of each 
+1) Select *Density/Volume Calculator* from the *Tool* menu on the SasView toolbar.
+
+2) Enter the empirical formula of a molecule. For mixtures, the ratio of each 
    of the molecules should be used, for example, (H2O)0.5(D2O)0.5.
 
-2) Use the input combo box to choose between molar volume or mass density and 
+3) Use the input combo box to choose between molar volume or mass density and 
    then type in an input value.
 
-3) Click the 'Calculate' button to perform the calculation.
+4) Click the 'Calculate' button to perform the calculation.
 
 .. image:: density_tutor.gif

src/sas/perspectives/calculator/media/image_viewer_help.rst

@@ -14 +14 @@
 plot can also be resized by dragging the corner of the panel.
 
-Supported image formats are png, bmp, gif, or jpg. (There is currently a bug in 
-the tif loader)
+The supported input image formats are:
+
+*  BMP (bitmap format)
+*  GIF (graphical interchange format)
+*  JPG (joint photographic experts group format)
+*  PNG (portable network graphics format)
+*  TIF (tagged image format)
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -22 +27 @@
 ------
 
-1. Select 'Image Viewer' under the 'Tool' menu in the menubar.
+1) Select *Image Viewer* from the *Tool* menu on the SasView toolbar.
 
-2. Select a file type from the drop-box at the bottom of the file dialog panel, 
-choose a file of interest, and then click the 'Open' button (see the 
-picture below).
+2) Select a file and then click *Open*.
 
 .. image:: load_image.bmp
 
-3. If the loading is successful, the image will be displayed. The file name 
-will be shown in the title bar (see the picture below).
+   If the loading is successful the image will be displayed.
 
-4. Some options such as saving, printing, and copying are available from the 
-menubar, or in the context-menu (by right-clicking anywhere in the plot).
+3) To save, print, or copy the image, or to apply a grid overlay, right-click 
+   anywhere in the plot.
 
 .. image:: pic_plot.bmp
 
-5. If the image is taken from a 2D detector, it can be converted into 2D data 
-where the z values are computed as 
+4. If the image is taken from a 2D detector, SasView can attempt to convert 
+   the colour/grey scale into pseudo-intensity 2D data using 
 
-z = (0.299 x R) + (0.587 x G) + (0.114 x B)
+   z = (0.299 x R) + (0.587 x G) + (0.114 x B)
 
-unless the picture file is formatted as 8-bit grey-scale tif.
+   unless the image is formatted as 8-bit grey-scale TIF.
 
-In the "Convert to Data" dialog, set the parameters relevant to your data and 
-then click the OK button.
+5. In the *Convert to Data* dialog, set the parameters relevant to the data and 
+   then click the OK.
 
 .. image:: pic_convert.bmp
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. note::  This help document was last changed by Steve King, 18Feb2015

src/sas/perspectives/calculator/media/kiessig_calculator_help.rst

@@ -3 +3 @@
 .. This is a port of the original SasView html help file to ReSTructured text
 .. by S King, ISIS, during SasView CodeCamp-III in Feb 2015.
+
+.. |pi| unicode:: U+03C0
+.. |Ang| unicode:: U+212B
 
 Kiessig Thickness Calculator Tool
@@ -10 +13 @@
 -----------
 
-This tool is to approximately estimate the thickness of a layer or the 
-diameter of particles from the Kiessig fringe in SAS/NR data, and using the 
-Kiessig relation
+This tool is approximately estimates the thickness of a layer or the diameter 
+of particles from the position of the Kiessig fringe/Bragg peak in NR/SAS data 
+using the relation
 
-thickness = 2*Pi/fringe_width.
+(thickness *or* size) = 2 * |pi| / (fringe_width *or* peak position)
   
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
-
 
 How To
 ------
 
-To get a rough thickness or particle size, just type the Kiessig fringe width 
-(in units of 1/Angstrom) and click on the 'Compute' button. Then the output 
-value will be show up in the 'Thickness' text box.
+To get a rough thickness or particle size, simply type the fringe or peak 
+position (in units of 1/|Ang|\) and click on the *Compute* button.
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. note::  This help document was last changed by Steve King, 18Feb2015
+

src/sas/perspectives/calculator/media/python_shell_help.rst

@@ -10 +10 @@
 -----------
 
-This is a Python shell (PyCrust) provided with WxPython. An editing notebook 
-will show up when a Python file is loaded from the 'New' or 'Open' menu. 
+This is a Python shell/editor (PyCrust) provided with WxPython. An editing 
+notebook will show up when a Python file is created/loaded with the *New* or 
+*Open* options on the menu. 
 
-The 'Run' menu is added for the editor to be able to compile and run the Python 
-code.
+*Run* enables the editor to compile and run the Python code.
 
-For the details about the Python, visit the website 
-http://docs.python.org/tutorial/
+For the details about the Python, visit the website http://docs.python.org/tutorial/
 
-The numpy, scipy, matplotlib, etc, libraries are shipped with SasView. However, 
-some functionalities of those packages may or may not work.
+The NumPy, SciPy, and Matplotlib, etc, libraries are shipped with SasView. 
+However, some functionality may not work.
 
-PyCrust includes its own Help menu in the shell window.
+PyCrust has its own Help.
 
-Note: Help() and Credits() do not work on Macs.
+*NOTE! Help() and Credits() do not work on Macs.*
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -31 +30 @@
 -------
 
-An example from the matplotlib gallery:
+An example calling the Matplotlib plotting gallery:
 
-.. image:: pycrust_example.bmp
+.. image:: pycrust_example.png
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. note::  This help document was last changed by Steve King, 19Feb2015

src/sas/perspectives/calculator/media/resolution_calculator_help.rst

@@ -3 +3 @@
 .. This is a port of the original SasView html help file to ReSTructured text
 .. by S King, ISIS, during SasView CodeCamp-III in Feb 2015.
+
+.. |pi| unicode:: U+03C0
+.. |lambda| unicode:: U+03BB
+.. |Ang| unicode:: U+212B
 
 Q Resolution Estimator
@@ -10 +14 @@
 -----------
 
-This tool is to approximately estimate the resolution of Q based on the SAS 
-instrumental parameter values assuming that the detector is flat and vertical 
-to the incident beam direction.
+This tool is approximately estimates the resolution of Q from SAS instrumental 
+parameter values assuming that the detector is flat and normal to the 
+incident beam.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -19 +23 @@
 ------
 
-1. Select the source and source type (Monochromatic or TOF). Note that the 
-computational difference between the sources is only the gravitational 
-contribution due to the mass.
+1) Select *SAS Resolution Esimator* from the *Tool* menu on the SasView toolbar.
 
-2. Change the default values of the instrumental parameters as desired.
+2) Select the source (Neutron or Photon) and source type (Monochromatic or TOF).
 
-3. The input formats of wavelength and its spread (=FWHM/wavelength) depend on 
-the source type.For monochromatic wave, the inputs are just one values as shown 
-with the defaults.For TOF, the min and max values should be separated by "-" 
-to describe the wavelength band range. Optionally, the input of the wavelength 
-(NOT of the wavelength spread) could be extended by adding "; --" where the -- 
-is the number of the bins for the numerical integration. Otherwise, the 
-default value "10" bins will be used. The same number of bins will be used 
-for the corresponding wavelength spread in either cases.
+   *NOTE! The computational difference between the sources is only the 
+   gravitational contribution due to the mass of the particles.*
 
-4. For TOF, the default wavelength spectrum is flat. The custom spectrum file 
-(with 2 column text: wavelength(A) vs. intensity) can also be loaded by 
-selecting "Add new" in the combobox.
+3) Change the default values of the instrumental parameters as required. Be 
+   careful to note that distances are specified in cm!
 
-5. Once set all the input values, click the compute button. Depending on 
-computation loads the calculation time will vary.
+4) Enter values for the source wavelength(s) and its spread (= FWHM / wavelength).
+   
+   For monochromatic sources, the inputs are just one value. For TOF sources, 
+   the minimum and maximum values should be separated by a '-' to specify a 
+   range.
+   
+   Optionally, the wavelength (BUT NOT of 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 
+   will be used for the corresponding wavelength spread.
 
-6. 1D and 2D dQ will be displayed in the text-box at the bottom of the panel. 
-Two dimensional resolution weight distribution (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 (if a green lines appear (for TOF), it indicates the limits of the 
-maximum q range for the largest wavelength due to the size of the detector). 
-Note that the effect from the beam block is ignored, so in the small q region 
-near the beam block 
+5) For TOF, the default wavelength spectrum is flat. A custom spectral 
+   distribution file (2-column text: wavelength (|Ang|\) vs Intensity) can also 
+   be loaded by selecting *Add new* in the combo box.
 
-[ie., q<2*pi*(beam block diameter) / (sample to detector distance) / lamda_min] 
+6) When ready, click the *Compute* button. Depending on the computation the 
+   calculation time will vary.
 
-the variance is slightly under estimated.
+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).
+   
+   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 
+   region near the beam block/stop 
 
-7. The summary can be accessed by clicking the 'light-bulb' icon at the bottom 
-of the SasView main window.
+   [ie., Q < 2*|pi|\*(beam block diameter) / (sample-to-detector distance) / |lambda|\_min] 
+
+   the variance is slightly under estimated.
+
+8) A summary of the calculation is written to the SasView *Console* at the 
+   bottom of the main SasView window.
 
 .. image:: resolution_tutor.gif
@@ -68 +80 @@
 .. image:: q.gif
 
-In the limit of the small angle, the variance of q in the first order 
-approximation is
+In the small-angle limit, the variance of Q is to a first-order 
+approximation
 
 .. image:: sigma_q.gif
 
-In summary, the geometric and gravitational contributions depending on the 
-shape of each factors can be expressed as shown the table.
+The geometric and gravitational contributions can then be summarised as
 
 .. image:: sigma_table.gif
 
-Finally, we use a Gaussian function to describe the 2D weighting distribution 
-of the uncertainty in q.
+Finally, a Gaussian function is used to describe the 2D weighting distribution 
+of the uncertainty in Q.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -85 +96 @@
 References
 ----------
-D.F.R. Mildner and J.M. Carpenter, J. Appl. Cryst. 17, 249-256 (1984)
 
-D.F.R. Mildner, J.M. Carpenter and D.L. Worcester, J. Appl. Cryst. 19, 311-319 
-(1986)
+D.F.R. Mildner and J.M. Carpenter 
+*J. Appl. Cryst.* 17 (1984) 249-256
+
+D.F.R. Mildner, J.M. Carpenter and D.L. Worcester 
+*J. Appl. Cryst.* 19 (1986) 311-319
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. note::  This help document was last changed by Steve King, 19Feb2015

src/sas/guiframe/local_perspectives/plotting/slicerpanel.py

@@ -17 +17 @@
     #TODO: show units
     #TODO: order parameters properly
-     ## Internal name for the AUI manager
+    ## Internal name for the AUI manager
     window_name = "Slicer panel"
     ## Title to appear on top of the window
@@ -76 +76 @@
                          flag=wx.LEFT|wx.ALIGN_CENTER_VERTICAL, border=15)
         else:
-            title = wx.StaticText(self, -1, "Slicer Parameters", 
+            title_text = str(type) + "Parameters"
+            title = wx.StaticText(self, -1, title_text, 
                                   style=wx.ALIGN_LEFT)
             self.bck.Add(title, (0, 0), (1, 2), 
@@ -125 +126 @@
     def onSetFocus(self, evt):
         """
-        Hightlight the textcrtl
+        Highlight the txtcrtl
         """
+        evt.Skip()
         # Get a handle to the TextCtrl
         widget = evt.GetEventObject()
@@ -147 +149 @@
         """
         Parameters have changed
-        """ 
+        """
+        evt.Skip()
         params = {}
         has_error = False