source: sasview/sansview/perspectives/fitting/helpPanel.py @ 08ba57d

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 08ba57d was 4faf4ba, checked in by Gervaise Alina <gervyh@…>, 15 years ago

sld calculator implemented using elements package

  • Property mode set to 100644
File size: 6.6 KB
RevLine 
[d7d143b0]1#!/usr/bin/python
2import wx
3import wx.html as html
[d292959]4import os
[b92884a]5def help():
6    """
7        Provide general online help text
8        Future work: extend this function to allow topic selection
9    """
10    info_txt  = "The inversion approach is based on Moore, J. Appl. Cryst. (1980) 13, 168-175.\n\n"
11    info_txt += "P(r) is set to be equal to an expansion of base functions of the type "
12    info_txt += "phi_n(r) = 2*r*sin(pi*n*r/D_max). The coefficient of each base functions "
13    info_txt += "in the expansion is found by performing a least square fit with the "
14    info_txt += "following fit function:\n\n"
15    info_txt += "chi**2 = sum_i[ I_meas(q_i) - I_th(q_i) ]**2/error**2 + Reg_term\n\n"
16    info_txt += "where I_meas(q) is the measured scattering intensity and I_th(q) is "
17    info_txt += "the prediction from the Fourier transform of the P(r) expansion. "
18    info_txt += "The Reg_term term is a regularization term set to the second derivative "
19    info_txt += "d**2P(r)/dr**2 integrated over r. It is used to produce a smooth P(r) output.\n\n"
20    info_txt += "The following are user inputs:\n\n"
21    info_txt += "   - Number of terms: the number of base functions in the P(r) expansion.\n\n"
22    info_txt += "   - Regularization constant: a multiplicative constant to set the size of "
23    info_txt += "the regularization term.\n\n"
24    info_txt += "   - Maximum distance: the maximum distance between any two points in the system.\n"
25     
26    return info_txt
27   
28class HelpDialog(wx.Dialog):
29    def __init__(self, parent, id):
30     
31        wx.Dialog.__init__(self, parent, id, size=(400, 420))
32        self.SetTitle("P(r) help") 
33       
34
35        vbox = wx.BoxSizer(wx.VERTICAL)
36
37        explanation = help()
38           
39        label_explain = wx.StaticText(self, -1, explanation, size=(350,320))
40           
41        vbox.Add(label_explain, 0, wx.ALL|wx.EXPAND, 15)
42
43
44        static_line = wx.StaticLine(self, -1)
45        vbox.Add(static_line, 0, wx.EXPAND, 0)
46       
47        button_OK = wx.Button(self, wx.ID_OK, "OK")
[925a30e]48
[b92884a]49        sizer_button = wx.BoxSizer(wx.HORIZONTAL)
50        sizer_button.Add((20, 20), 1, wx.EXPAND|wx.ADJUST_MINSIZE, 0)
[925a30e]51        sizer_button.Add(button_OK, 0, wx.LEFT|wx.RIGHT|wx.ADJUST_MINSIZE, 10)       
[b92884a]52        vbox.Add(sizer_button, 0, wx.EXPAND|wx.BOTTOM|wx.TOP, 10)
53
54        self.SetSizer(vbox)
55        self.SetAutoLayout(True)
56       
57        self.Layout()
58        self.Centre()
[d7d143b0]59
[2268d10]60class HelpWindow(wx.Frame):
[4faf4ba]61    def __init__(self, parent, id, title= 'HelpWindow', pageToOpen=None):
[dcd330b]62        wx.Frame.__init__(self, parent, id, title, size=(700, 450))
[925a30e]63        """
64             contains help info
65        """
[6fb01b6]66        vbox1  =wx.FlexGridSizer(1, 2,0,0)
67
[dcd330b]68        lpanel = wx.Panel(self, -1,style=wx.BORDER_SUNKEN)
[d7d143b0]69        rpanel = wx.Panel(self, -1)
70       
[6fb01b6]71        vbox1.AddMany([ (lpanel,-1,wx.EXPAND,0), 
72            (rpanel, -1,wx.EXPAND,0)])
73        vbox1.AddGrowableRow(0, 0)
74        vbox1.AddGrowableCol(0, 1)
75       
76
[d7d143b0]77        vbox = wx.BoxSizer(wx.VERTICAL)
[6fb01b6]78        header = wx.Panel(rpanel, -1)
[d7d143b0]79        header.SetBackgroundColour('#6666FF')
80        header.SetForegroundColour('WHITE')
81        hbox = wx.BoxSizer(wx.HORIZONTAL)
[2268d10]82        st = wx.StaticText(header, -1, 'Contents', (5, 5))
[d7d143b0]83        font = st.GetFont()
84        font.SetPointSize(10)
85        st.SetFont(font)
86        hbox.Add(st, 1, wx.TOP | wx.BOTTOM | wx.LEFT, 5)
87        header.SetSizer(hbox)
88        vbox.Add(header, 0, wx.EXPAND)
89       
[b92884a]90        vboxl= wx.BoxSizer(wx.VERTICAL)
91        headerl = wx.Panel(lpanel, -1, size=(-1, 20))
[d292959]92       
[b92884a]93        headerl.SetBackgroundColour('#6666FF')
94        headerl.SetForegroundColour('WHITE')
95        hboxl = wx.BoxSizer(wx.HORIZONTAL)
[2268d10]96        lst = wx.StaticText(headerl, -1, 'Menu', (5, 5))
[b92884a]97        fontl = lst.GetFont()
98        fontl.SetPointSize(10)
99        lst.SetFont(fontl)
100        hboxl.Add(lst, 1, wx.TOP | wx.BOTTOM | wx.LEFT, 5)
101        headerl.SetSizer(hboxl)
102        vboxl.Add(headerl, 0, wx.EXPAND)
103        self.lhelp = html.HtmlWindow(lpanel, -1, style=wx.NO_BORDER)
[6fb01b6]104        self.rhelp = html.HtmlWindow(rpanel, -1, style=wx.NO_BORDER, size=(500,-1))
[2268d10]105        page1="""<html>
106            <body>
107             <p>Select topic on Menu</p>
108            </body>
109            </html>"""
[b92884a]110        page="""<html>
111            <body>
112            <ul>
113            <li><a href ="doc/change_scale_help.html" target ="showframe">Change scale</a><br></li>
114            <li><a href ="doc/reset_Graph_help.html" target ="showframe">Graph Help</a><br></li>
115            <li><a href ="doc/load_data_help.html" target ="showframe">Load a File</a><br></li>
116            <li><a href ="doc/simultaneous_fit_help.html" target ="showframe">Simultaneous Fit</a><br></li>
117            <li><a href ="doc/single_fit_help.html" target ="showframe">Single Fit</a><br></li>
118            <li><a href ="doc/model_use_help.html" target ="showframe">Visualize Model</a><br></li>
[2268d10]119            <li><a href ="doc/averaging_help.html" target ="showframe">Data Averaging</a><br></li>
[4faf4ba]120            <li><a href ="doc/sld_calculator_help.html" target ="showframe">SLD Calculator</a><br></li>
[ddfcd90]121            <li><a href ="doc/model_functions.html" target ="showframe">Model Functions</a><br></li>
[b92884a]122            </ul>
123            </body>
124            </html>"""
[2268d10]125        self.rhelp.SetPage(page1)
[b92884a]126        self.lhelp.SetPage(page)
127        self.lhelp.Bind(wx.html.EVT_HTML_LINK_CLICKED,self.OnLinkClicked )
[9181512]128       
[4faf4ba]129        #open the help frame a the current page
130        if  pageToOpen!= None:
131            self.rhelp.LoadPage(str( pageToOpen))
[9181512]132           
[dcd330b]133        vbox.Add(self.rhelp,1, wx.EXPAND)
[b92884a]134        vboxl.Add(self.lhelp, 1, wx.EXPAND)
[d7d143b0]135        rpanel.SetSizer(vbox)
[b92884a]136        lpanel.SetSizer(vboxl)
137        lpanel.SetFocus()
[d7d143b0]138       
139        self.SetSizer(vbox1)
[6fb01b6]140       
[d7d143b0]141        self.Centre()
142        self.Show(True)
[925a30e]143       
[9181512]144    def OnButtonClicked(self, event):
145        """
146            Function to diplay html page related to the hyperlinktext selected
147        """
148        #link= "doc/modelfunction.html"
149        self.rhelp.LoadPage("doc/modelfunction.html")
[925a30e]150       
[b92884a]151    def OnLinkClicked(self, event):
152        """
153            Function to diplay html page related to the hyperlinktext selected
154        """
155        link= event.GetLinkInfo().GetHref()
156        self.rhelp.LoadPage(link)
157
[2268d10]158class ViewApp(wx.App):
[d7d143b0]159    def OnInit(self):
[2268d10]160        frame = HelpWindow(None, -1, 'HelpWindow')   
161        frame.Show(True)
162        self.SetTopWindow(frame)
[d7d143b0]163       
[2268d10]164        return True
[d7d143b0]165       
166
[2268d10]167if __name__ == "__main__": 
168    app = ViewApp(0)
169    app.MainLoop()     
Note: See TracBrowser for help on using the repository browser.