DTAT: backent.pint_definition (#309)

* Add files via upload

* fix: absolute import in docstring example

Author: Pwhsky

deeptrack/backend/pint_definition.py

@@ -49,7 +49,7 @@
 To create a unit registry with custom pixel-related units:
 
 >>> from pint import UnitRegistry
->>> from .backend.pint_definition import pint_definitions
+>>> from deeptrack.backend.pint_definition import pint_definitions
 
 >>> units = UnitRegistry(pint_definitions.split("\\n"))
 

tutorials/3-advanced-topics/DTAT399B_backend.pint_definition.ipynb

@@ -0,0 +1,158 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# deeptrack.backend.pint_definition\n",
+    "<a href=\"https://colab.research.google.com/github/DeepTrackAI/DeepTrack2/blob/develop/tutorials/3-advanced-topics/DTAT399B_backend.pint_definition.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# !pip install deeptrack  # Uncomment if running on Colab/Kaggle."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This advanced tutorial introduces the pint_definition module."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 1. What is `pint_definition`?\n",
+    "\n",
+    "The `pint_definition` module consolidates and extends the default definitions provided by Pint's \n",
+    "`default_en.txt` and `constants_en.txt` files. It defines physical constants, \n",
+    "unit systems, and project-specific adjustments necessary for DeepTrack2."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 2. Unit Quantities\n",
+    "Pint lets us include units when calculating quantities.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 21,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Wavelength: 550 nanometer\n",
+      "Frequency: 545.4545454545453 terahertz\n"
+     ]
+    }
+   ],
+   "source": [
+    "from pint import UnitRegistry\n",
+    "from deeptrack.backend.pint_definition import pint_definitions\n",
+    "\n",
+    "# Initialize UnitRegistry with microscopy-related units\n",
+    "units = UnitRegistry(pint_definitions.split(\"\\n\"))\n",
+    "\n",
+    "# Define wavelength in nanometers\n",
+    "wavelength = 550 * units.nanometer  # Green light\n",
+    "\n",
+    "c = 3e8 * units.meter / units.second\n",
+    "\n",
+    "frequency = c / wavelength\n",
+    "\n",
+    "print(f\"Wavelength: {wavelength}\")\n",
+    "print(f\"Frequency: {frequency.to(units.terahertz)}\") "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 3. Diffraction Limit"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 22,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Resolution limit: 178.57142857142858 nanometer\n"
+     ]
+    }
+   ],
+   "source": [
+    "Numerical_aperture = 1.4 \n",
+    "wavelength = 500 * units.nanometer\n",
+    "resolution = wavelength / (2 * Numerical_aperture)\n",
+    "\n",
+    "print(f\"Resolution limit: {resolution.to(units.nanometer)}\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 4. Exposure Time and Motion Blur"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Motion blur: 19.999999999999996 nanometer\n"
+     ]
+    }
+   ],
+   "source": [
+    "exposure_time = 2 * units.millisecond  \n",
+    "\n",
+    "sample_velocity = 10 * units.micrometer / units.second \n",
+    "\n",
+    "blur_distance = sample_velocity * exposure_time\n",
+    "\n",
+    "print(f\"Motion blur: {blur_distance.to(units.nanometer)}\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.13"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}