Skip to main content

dosertools is a Python package for analyzing dripping-onto-substrate extensional rheology (DoSER) videos.

Project description

dosertools

dosertools is a Python package for analyzing dripping-onto-substrate extensional rheology (DoSER) videos.
The software converts an input video into a series of binary images, produces a dataset of D/D0 and time values for each frame in the video, and generates values for the elongational relaxation time lambda_E, the diameter at critical time (the onset of elasto-capillary behavior) D(t_c)/D0, and a guess for the quantity of (elongational viscosity / surface tension) eta_E/sigma.

Authors

Rob Learsch and Red Lhota
Contact:
rlearsch (at) caltech (dot) edu

Installation

dosertools comes bundled with a pipfile which creates the python environment it needs to run. Use the package manager pip to install pipenv. You will need to install pipenv if your installation of python doesn't have it. You can do this by typing

pip install pipenv

in your terminal, followed by

pipenv install

in the terminal from your dosertools directory.

See the file named "example-and-settings.md" and "example_script.py" for more information on how to use this package.

Usage

dosertools is expecting experiments that contain a pair of videos - one "experimental" video that contains the fluid transitioning from needle to substrate, and one "background" video that contains only the needle and the literal background of the camera's view. In our testing, we found a background video of 100 frames gives plenty of data to overcome any noise that would be found in a single frame.

dosertools is written for DoSER videos of viscoelastic fluids. It can perform background subtraction and image processing on videos of any type. However, the data processing (calculating elongational relaxation time, elongational viscosity, etc) is done using assumptions that are only true for fluids that exhibit elastocapillary behavior.

dosertools calculates values with machine precision. It is up to the user to decide where to truncate the data produced, based on the specifics of their own experimental setup.

License

MIT License

Copyright (c) 2022 Red C. Lhota and Robert W. Learsch

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dosertools-1.0.2.tar.gz (58.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dosertools-1.0.2-py3-none-any.whl (35.9 kB view details)

Uploaded Python 3

File details

Details for the file dosertools-1.0.2.tar.gz.

File metadata

  • Download URL: dosertools-1.0.2.tar.gz
  • Upload date:
  • Size: 58.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.46.0 importlib-metadata/4.11.3 keyring/21.1.1 rfc3986/2.0.0 colorama/0.4.3 CPython/3.7.7

File hashes

Hashes for dosertools-1.0.2.tar.gz
Algorithm Hash digest
SHA256 5acceea514d121ffe9168b99ec6458a5758196d503d5e693a84d801fad3d2e33
MD5 82c5a8a2f5c2d4649a038ed18e80a764
BLAKE2b-256 85372265079a9fed03043e40664f60776603f0ed3ff9be3bf83d952b0f08e22d

See more details on using hashes here.

File details

Details for the file dosertools-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: dosertools-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 35.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.46.0 importlib-metadata/4.11.3 keyring/21.1.1 rfc3986/2.0.0 colorama/0.4.3 CPython/3.7.7

File hashes

Hashes for dosertools-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 33cc5c489ef564f4061a3163a5a69246fbbf2ac6f39be7e111f2c81b36f40558
MD5 ddc8754f11972ef3aab3d8e16d8f9b58
BLAKE2b-256 5447a43db2bc15f9721a858e677fa44f7175427423d42bb8844296b4e95a6681

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page