This toolkit aids in analyzing drop sliding on tilted plates, allowing researchers to study various variables and their correlations in detail.
Project description
Deep Learning to Analyze Sliding Drops (Cite Us)
The SFOF4S toolkit is designed to solve existing challenges in analyzing the sliding motion of drops on tilted plates. It enables researchers to conduct detailed studies by considering a wide range of variables and their correlations.
Key features include:
- Super-Resolution Enhancement: The toolkit enlarges images by an up-scale ratio of 3 using a super-resolution model trained on a dataset of 14,000 sliding drop images.
- Comprehensive Analysis: Extracts various criteria from the super-resolution images to provide precise insights into drop behavior.
- Optimized Contact Angle Measurement: Contact angles are measured using an optimized polynomial method, as described in the accompanying manuscript.
This toolkit streamlines complex image processing tasks, empowering researchers with high-quality data for in-depth analysis.
General inforamtion
The original implementation had dependency issues, so a new version was introduced to resolve them by migrating to the PyTorch framework. Please note that installing this package requires CUDA libraries and may occupy up to 3 GB of storage. Check a simple implementation "https://github.com/yriyazi/SFOF4S-Documentation
Drop Profile Video
-
File:
drop_profile.mp4This video illustrates a sliding drop on a sample with a defect in the middle:
- The first drop in the upper part of the video is the real drop image after preprocessing. Key preprocessing steps include:
- Calculating the tilt angle and aligning frames horizontally.
- Removing noise and background.
- Detecting the drop position (marked by red lines).
- The second drop (larger image) represents the drop after applying a super-resolution model.
- Below that, the drop contour is extracted, and parameters such as contact angles (CAs), drop height, and drop length are displayed.
- On the left, four plots analyze how the drop slides over a defected sample.
- The first drop in the upper part of the video is the real drop image after preprocessing. Key preprocessing steps include:
Instructions
-
File:
instructions.mdThis file is a comprehensive guide designed to assist researchers in setting up and using the analysis toolkit. It has two general sections: one focused on setting up the environment and another on effectively using the code.
-
How to Set Up:
This section guides you through the installation of Python, Anaconda, and Jupyter Notebook. It explains how to download the code repository, prepare your working directory, and ensure all necessary libraries are installed for a seamless setup. -
How to Use:
This section provides detailed steps for preparing video frames, creating and marking the slope folder, and running the analysis code. It also explains how to configure experiment-specific variables and interpret the generated outputs, such asresult.xlsxand analyzed frame outputs.
-
Control Panel
-
File:
Control Panel.ipynbThis file contains the main executable code for the toolkit. It acts as a central hub, calling other
.pyfiles and libraries to perform the analysis. The code processes the video frames, extracts features, and generates the finalresult.xlsxfile containing the analyzed time-series data. It integrates all steps of the workflow, making it easy to convert raw video frames into meaningful results.
Tutorial
- tutorial:
tutorial.ipynband dataset HERE
Dataset
- Description: The dataset contains 14,000 sliding drop images used to train the modified super-resolution model.
- Access: Download the dataset
ESPCN Super-Resolution Model Weights
-
File:
SuperRes_weights.h5This file contains the weights for the modified ESPCN super-resolution model, trained on 14,000 sliding drop images.
Python Files
The following .py files are included in the toolkit and provide functions for related image processing tasks:
angle_detection.pybaseline_detection.pycriteria_definition.pyedge_superres.pytools.pyvisualization.py
These scripts are essential for researchers working with this toolkit.
Citation
If you find "Deep Learning to Analyze Sliding Drops" useful for your research, please consider citing the paper using the following information:
@article{shumaly2023deep,
title={Deep learning to analyze sliding drops},
author={Shumaly, Sajjad and Darvish, Fahimeh and Li, Xiaomei and Saal, Alexander and Hinduja, Chirag and Steffen, Werner and Kukharenko, Oleksandra and Butt, Hans-J{\"u}rgen and Berger, R{\"u}diger},
journal={Langmuir},
volume={39},
number={3},
pages={1111--1122},
year={2023},
publisher={ACS Publications}
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sfof4s-1.0.13.tar.gz.
File metadata
- Download URL: sfof4s-1.0.13.tar.gz
- Upload date:
- Size: 32.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0aa71e08f4edfbc53c56ed327dbff0d4fff191c3904f6c2bee372b4c9b5c3a23
|
|
| MD5 |
4aba8c96f8f97964163e1340dff0728f
|
|
| BLAKE2b-256 |
6dd78ec8a58409762b199dd3dea96b18c8cb92075097e170ca6b096ab640f08f
|
File details
Details for the file SFOF4S-1.0.13-py3-none-any.whl.
File metadata
- Download URL: SFOF4S-1.0.13-py3-none-any.whl
- Upload date:
- Size: 32.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9042a68e7a2bd67a98becc7c9560a07d70d9f87a2d0da7e120d89b4aaa47dfbf
|
|
| MD5 |
b41f48d846f16cb59aa31264059d0186
|
|
| BLAKE2b-256 |
91639d80943d82d5b971ffc81cfd3e2da436c1240a945a30475b35471b4ca6c6
|