Changes between Version 25 and Version 26 of ModelConvInst

Timestamp:

Dec 21, 2015 11:35:35 AM (8 years ago)

Author:

pkienzle

Comment:

—

ModelConvInst

@@ -68 +68 @@
    - Iq.vectorized = True or False. This is used to tag the definition as accepting a Q vector, or having to compute each Q individually.
     - use functions from numpy rather than math
-    - don't use if statements.  Instead do tricks like "a = x*(q>0) + y*(q<=0)" which sets a to x if q is positive or y if q is zero 
+    - don't use if statements.  Instead do tricks like "a = x*(q>0) + y*(q<=0)" which sets a to x if q is positive or y if q is zero or negative
+    - return np.NaN if the parameters are not valid (e.g., cap_radius < radius for barbell)
   - def Iqxy.  If this model does not have an oriented form just set it equal to the square root of the sum of Iq(x) squared and Iq(y) squared.
   - [https://github.com/SasView/sasview/tree/master/src/sas/models src/sas/models] contains the pure python models, mixed together with the python + C models. 
@@ -81 +82 @@
   }}}
   - the c file must contain the form_volume, Iq, Iqxy methods. These and any other functions defined (e.g. the _cyl() helper function) must be defined as doubles in the first lines of the file.
+  - return NAN if the parameters are not valid (e.g., cap_radius < radius for barbell)
  - ''NOTE: for certain models, such as those that can be multiplied by a structure factor, the ER attribute should be set to the Equivalent Radius (of a sphere).''
  - ''NOTE: for certain models, namely core-shell type models, the VR attribute returns the volume ratio for the core-shell.''