Changeset b297ba9 in sasmodels for sasmodels/mixture.py

Timestamp:

Mar 20, 2019 7:03:50 PM (5 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

4e28511

Parents:

0d362b7

Message:

lint

File:

• sasmodels/mixture.py (modified) (7 diffs)

sasmodels/mixture.py

@@ -120 +120 @@
 
     def random():
+        """Random set of model parameters for mixture model"""
         combined_pars = {}
         for k, part in enumerate(parts):
@@ -149 +150 @@
 
 class MixtureModel(KernelModel):
+    """
+    Model definition for mixture of models.
+    """
     def __init__(self, model_info, parts):
         # type: (ModelInfo, List[KernelModel]) -> None
@@ -165 +169 @@
         kernels = [part.make_kernel(q_vectors) for part in self.parts]
         return MixtureKernel(self.info, kernels)
+    make_kernel.__doc__ = KernelModel.make_kernel.__doc__
 
     def release(self):
         # type: () -> None
-        """
-        Free resources associated with the model.
-        """
+        """Free resources associated with the model."""
         for part in self.parts:
             part.release()
+    release.__doc__ = KernelModel.release.__doc__
 
 
 class MixtureKernel(Kernel):
+    """
+    Instantiated kernel for mixture of models.
+    """
     def __init__(self, model_info, kernels):
         # type: (ModelInfo, List[Kernel]) -> None
@@ -185 +192 @@
         self.results = []  # type: List[np.ndarray]
 
-    def __call__(self, call_details, values, cutoff, magnetic):
+    def Iq(self, call_details, values, cutoff, magnetic):
         # type: (CallDetails, np.ndarray, np.ndarry, float, bool) -> np.ndarray
         scale, background = values[0:2]
@@ -191 +198 @@
         # remember the parts for plotting later
         self.results = []  # type: List[np.ndarray]
-        parts = MixtureParts(self.info, self.kernels, call_details, values)
+        parts = _MixtureParts(self.info, self.kernels, call_details, values)
         for kernel, kernel_details, kernel_values in parts:
             #print("calling kernel", kernel.info.name)
@@ -208 +215 @@
         return scale*total + background
 
+    Iq.__doc__ = Kernel.Iq.__doc__
+    __call__ = Iq
+
     def release(self):
         # type: () -> None
+        """Free resources associated with the kernel."""
         for k in self.kernels:
             k.release()
 
 
-class MixtureParts(object):
+# Note: _MixtureParts doesn't implement iteration correctly, and only allows
+# a single iterator to be active at once.  It doesn't matter in this case
+# since _MixtureParts is only used in one place, but it is not clean style.
+class _MixtureParts(object):
+    """
+    Mixture component iterator.
+    """
     def __init__(self, model_info, kernels, call_details, values):
         # type: (ModelInfo, List[Kernel], CallDetails, np.ndarray) -> None
@@ -223 +240 @@
         self.values = values
         self.spin_index = model_info.parameters.npars + 2
+        # The following are redefined by __iter__, but set them here so that
+        # lint complains a little less.
+        self.part_num = -1
+        self.par_index = -1
+        self.mag_index = -1
         #call_details.show(values)