PyOPIA 2.13.0__tar.gz → 2.13.1__tar.gz

{pyopia-2.13.0 → pyopia-2.13.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyOPIA
-Version: 2.13.0
+Version: 2.13.1
 Summary: A Python Ocean Particle Image Analysis toolbox.
 Project-URL: Repository, https://github.com/sintef/pyopia
 Project-URL: Documentation, https://pyopia.readthedocs.io

pyopia-2.13.1/pyopia/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.13.1"

{pyopia-2.13.0 → pyopia-2.13.1}/pyopia/exampledata.py

@@ -10,14 +10,18 @@ logger = logging.getLogger()
 
 
 def get_classifier_database_from_pysilcam_blob(download_directory="./"):
-    """Downloads a specified filename from the pysilcam.blob into the working dir. if it doesn't already exist
-
-    only works for known filenames that are on this blob
+    """Downloads and unzips the silcam_database of labelled example images from pysilcam.blob
+    into the working dir. if it doesn't already exist
 
     Parameters
     ----------
-    filename : string
-        known filename on the blob
+    download_directory : string
+        directory to download and unzip the silcam_database.zip into. Defaults to "./"
+
+    Returns
+    -------
+    string
+        download_directory, the directory that the silcam_database.zip was downloaded and unzipped into
 
     """
     if os.path.exists(os.path.join(download_directory)):
@@ -47,6 +51,13 @@ def get_file_from_pysilcam_blob(filename, download_directory="./"):
     ----------
     filename : string
         known filename on the blob
+    download_directory : string
+        directory to download the file into. Defaults to "./"
+
+    Returns
+    -------
+    string
+        filename of the downloaded file
 
     """
     if os.path.exists(os.path.join(download_directory, filename)):
@@ -59,10 +70,16 @@ def get_file_from_pysilcam_blob(filename, download_directory="./"):
 def get_example_silc_image(download_directory="./"):
     """calls `get_file_from_pysilcam_blob` for a silcam iamge
 
+    Parameters
+    ----------
+    download_directory : string
+        directory to download the file into. Defaults to "./"
+
     Returns
     -------
     string
-        filename
+        filename of the downloaded silcam image
+
     """
     filename = "D20181101T142731.838206.silc"
     if os.path.isfile(filename):
@@ -78,6 +95,11 @@ def get_example_model(download_directory="./"):
     Download from the pysilcam blob storage into the working dir.
     If the file exists, skip the download.
 
+    Parameters
+    ----------
+    download_directory : string
+        directory to download the file into. Defaults to "./"
+
     Returns
     -------
     string
@@ -97,6 +119,11 @@ def get_example_model(download_directory="./"):
 def get_example_hologram_and_background(download_directory="./"):
     """calls `get_file_from_pysilcam_blob` for a raw hologram, and its associated background image.
 
+    Parameters
+    ----------
+    download_directory : string
+        directory to download the file into. Defaults to "./"
+
     Returns
     -------
     string

pyopia-2.13.0/pyopia/__init__.py

@@ -1 +0,0 @@
-__version__ = "2.13.0"