PyOPIA 2.4.1__tar.gz → 2.4.3__tar.gz

{pyopia-2.4.1 → pyopia-2.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOPIA
-Version: 2.4.1
+Version: 2.4.3
 Summary: A Python Ocean Particle Image Analysis toolbox.
 Home-page: https://github.com/sintef/pyopia
 Keywords: Ocean,Particles,Imaging,Measurement,Size distribution

pyopia-2.4.3/pyopia/__init__.py

@@ -0,0 +1 @@
+__version__ = '2.4.3'

{pyopia-2.4.1 → pyopia-2.4.3}/pyopia/simulator/silcam.py

@@ -15,15 +15,7 @@ from pyopia.pipeline import Pipeline
 
 
 class SilcamSimulator():
-    def __init__(self, total_volume_concentration=1000,
-                 d50=1000,
-                 MinD=10,
-                 PIX_SIZE=28,
-                 PATH_LENGTH=40,
-                 imx=2048,
-                 imy=2448,
-                 nims=50):
-        '''SilCam simulator
+    '''SilCam simulator
 
         Parameters
         ----------
@@ -44,20 +36,28 @@ class SilcamSimulator():
         nims : int, optional
             number of images to simulate, by default 50
 
-        Example:
-        --------
+        Example
+        -------
 
-        ```python
-        from pyopia.simulator.silcam import SilcamSimulator
+        .. code-block:: python
 
-        sim = SilcamSimulator()
-        sim.check_convergence()
-        sim.synthesize()
-        sim.process_synthetic_image()
-        sim.plot()
-        ```
+            from pyopia.simulator.silcam import SilcamSimulator
 
-        '''
+            sim = SilcamSimulator()
+            sim.check_convergence()
+            sim.synthesize()
+            sim.process_synthetic_image()
+            sim.plot()
+
+    '''
+    def __init__(self, total_volume_concentration=1000,
+                 d50=1000,
+                 MinD=10,
+                 PIX_SIZE=28,
+                 PATH_LENGTH=40,
+                 imx=2048,
+                 imy=2448,
+                 nims=50):
         self.total_volume_concentration = total_volume_concentration
         self.d50 = d50
         self.MinD = MinD
@@ -94,6 +94,18 @@ class SilcamSimulator():
         return (a / n) * (x / n) ** (a - 1) * np.exp(-(x / n) ** a)
 
     def check_convergence(self):
+        '''Check statistical convergence of randomly selected size distributions
+        over the `nims`number of images
+
+        Parameters
+        ----------
+        data['volume_distribution'] : array
+            volume distribution of shape (nims, dias)
+        data['cumulative_volume_concentration'] : float
+            cumulative mean volume concentration of length `nims`
+        data['cumulative_d50'] : float
+            cumulative average d50 of length `nims`
+        '''
         self.data['weibull_x'] = np.linspace(np.min(self.dias), np.max(self.dias), 10000)
         self.data['weibull_y'] = self.weibull_distribution(self.data['weibull_x'])
 
@@ -150,7 +162,14 @@ class SilcamSimulator():
                                                                            self.dias)
 
     def synthesize(self):
-        '''synthesize an image and measure droplets
+        '''Synthesize an image and measure droplets
+
+        Parameters
+        ----------
+        data['synthetic_image_data']['image'] : array
+            synthetic image
+        data['synthetic_image_data']['input_volume_distribution'] : array
+            Volume distribution used to create the synthetic image
         '''
         nc = int(sum(self.data['number_distribution']))  # number concentration
 
@@ -184,6 +203,13 @@ class SilcamSimulator():
         self.data['synthetic_image_data']['input_volume_distribution'] = log_vd
 
     def process_synthetic_image(self):
+        '''Put the synthetic image `data['synthetic_image_data']['image']` through a basic pyopia processing pipeline
+
+        Parameters
+        ----------
+        data['synthetic_image_data']['pyopia_processed_volume_distribution'] : array
+            pyopia processed volume distribution associated with `dias`size classes
+        '''
         pipeline_config = {
             'general': {
                 'raw_files': '',

pyopia-2.4.3/pyopia/tests/__init__.py

@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-

pyopia-2.4.1/pyopia/__init__.py

@@ -1 +0,0 @@
-__version__ = '2.4.1'