Changeset dd5bf63 in sasview for src/sas/sasgui/plottools/LineModel.py

Timestamp:

Jul 10, 2016 9:40:42 PM (8 years ago)

Author:

butler

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:

c23f303, 77d92cd, d398285

Parents:

3409a90

Message:

close #590. A lot of problems were caused by LineModel? and LinerFit?
having different equations (ax+b vs a+bx). Further errors in
calculations, particularly of uncertainties were fixed. The fact that
the fits to not account for smearing was verified and a warning added.
Code was also modified to update the qmin and qmax to match changes in
the transformed xmin xmax. Lots of documentation was added and the
fitdialog layout was cleaned up considerably. This is now usable though
the design of the user interface (and the whole design of linear fits)
could use a rethink.

File:

• src/sas/sasgui/plottools/LineModel.py (modified) (4 diffs)

src/sas/sasgui/plottools/LineModel.py

@@ -1 +1 @@
 #!/usr/bin/env python
 """
-Provide Line function (y= A + Bx)
+Provide Line function (y= Ax + B). Until July 10, 2016 this function provided
+(y= A + Bx).  This however was contrary to all the other code using it which 
+assumed (y= mx+b) or in this nomenclature (y=Ax + B). This lead to some
+contortions in the code and worse incorrect calculations until now for at least
+some of the functions.  This seemed the easiest to fix particularly since this
+function should disappear in a future iteration (see notes in fitDialog)
+
+                -PDB   July 10, 2016
 """
 
@@ -10 +17 @@
     Class that evaluates a linear model.
 
-    f(x) = A + Bx
+    f(x) = Ax + B
 
     List of default parameters:
-    A = 0.0
-    B = 0.0
+    A = 1.0
+    B = 1.0
     """
 
@@ -53 +60 @@
 
         """
-        return  self.params['A'] + (x * self.params['B'])
+        return  (self.params['A'] * x) + self.params['B']
 
     def run(self, x=0.0):
         """
         Evaluate the model
+
+        :note: This is the function called by fitDialog to calculate the
+        the y(xmin) and y(xmax), but the only difference between this and
+        runXY is when the if statement is true. I however cannot see what that
+        function is for.  It needs to be documented here or removed.
+        -PDB 7/10/16 
 
         :param x: simple value
@@ -74 +87 @@
     def runXY(self, x=0.0):
         """
-        Evaluate the model
+        Evaluate the model.
+        
+        :note: This is to be what is called by fitDialog for the actual fit
+        but the only difference between this and run is when the if 
+        statement is true. I however cannot see what that function
+        is for.  It needs to be documented here or removed. -PDB 7/10/16 
 
         :param x: simple value