Changeset a5b8477 in sasmodels for sasmodels/direct_model.py

Timestamp:

Apr 13, 2016 8:17:10 PM (8 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, release_v0.94, release_v0.95, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

0ce5710

Parents:

60f03de

Message:

update docs to work with the new ModelInfo/ParameterTable? classes

File:

• sasmodels/direct_model.py (modified) (8 diffs)

sasmodels/direct_model.py

@@ -32 +32 @@
 from . import details
 
-
-def call_kernel(kernel, pars, cutoff=0, mono=False):
+try:
+    from typing import Optional, Dict, Tuple
+except ImportError:
+    pass
+else:
+    from .data import Data
+    from .kernel import Kernel, KernelModel
+    from .modelinfo import Parameter, ParameterSet
+
+def call_kernel(kernel, pars, cutoff=0., mono=False):
+    # type: (Kernel, ParameterSet, float, bool) -> np.ndarray
     """
     Call *kernel* returned from *model.make_kernel* with parameters *pars*.
@@ -64 +73 @@
 
 def get_weights(parameter, values):
+    # type: (Parameter, Dict[str, float]) -> Tuple[np.ndarray, np.ndarray]
     """
     Generate the distribution for parameter *name* given the parameter values
@@ -106 +116 @@
     """
     def _interpret_data(self, data, model):
+        # type: (Data, KernelModel) -> None
         # pylint: disable=attribute-defined-outside-init
 
@@ -206 +217 @@
 
     def _set_data(self, Iq, noise=None):
+        # type: (np.ndarray, Optional[float]) -> None
         # pylint: disable=attribute-defined-outside-init
         if noise is not None:
@@ -223 +235 @@
 
     def _calc_theory(self, pars, cutoff=0.0):
+        # type: (ParameterSet, float) -> np.ndarray
         if self._kernel is None:
             self._kernel = self._model.make_kernel(self._kernel_inputs)
@@ -258 +271 @@
     """
     def __init__(self, data, model, cutoff=1e-5):
+        # type: (Data, KernelModel, float) -> None
         self.model = model
         self.cutoff = cutoff
@@ -264 +278 @@
 
     def __call__(self, **pars):
+        # type: (**float) -> np.ndarray
         return self._calc_theory(pars, cutoff=self.cutoff)
 
     def simulate_data(self, noise=None, **pars):
+        # type: (Optional[float], **float) -> None
         """
         Generate simulated data for the model.
@@ -274 +290 @@
 
 def main():
+    # type: () -> None
     """
     Program to evaluate a particular model at a set of q values.