added examples

examples/ClusterFile.ipynb

@@ -0,0 +1,121 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "cc37377b",
+   "metadata": {},
+   "source": [
+    "# Using ClusterFile"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "5dcb9f4e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pathlib import Path\n",
+    "import numpy as np \n",
+    "import matplotlib.pyplot as plt\n",
+    "import boost_histogram as bh\n",
+    "import time\n",
+    "\n",
+    "#Python cluster reader\n",
+    "from creader import ClusterFile\n",
+    "path = Path('/mnt/sls_det_storage/moench_data/cluster_reader_test/')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "a1f27bec",
+   "metadata": {},
+   "source": [
+    "## Read clusters from file and plot a histogram\n",
+    "\n",
+    "- Passing chunk, to the cluster reader to set the default amount of clusters to be read\n",
+    "- Using the context manager to manage the file closing\n",
+    "- Looping over chunks in the file (reads chunksize until a zero read)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "45482025",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "<matplotlib.legend.Legend at 0x7f4b6c136d10>"
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
+    },
+    {
+     "data": {
+      "image/png": "iVBORw0KGgoAAAANSUhEUgAAAjoAAAGwCAYAAACgi8/jAAAAOXRFWHRTb2Z0d2FyZQBNYXRwbG90bGliIHZlcnNpb24zLjcuMSwgaHR0cHM6Ly9tYXRwbG90bGliLm9yZy/bCgiHAAAACXBIWXMAAA9hAAAPYQGoP6dpAAAxDUlEQVR4nO3deXRUdZ7//1dlZQsJISYhEEI4tgqGNaF7oKEFl2hAbKXbg4oBBnCGNsgSV8TWFhE4jiLtUODERnFtGQdlXDjdRBoBG5QQCIJxQwNBTIiEkA1JIPn8/vCb+k2ZgFVJVapy6/k4p86h7v3kc9/1YakXn/u599qMMUYAAAAWFOTrAgAAALyFoAMAACyLoAMAACyLoAMAACyLoAMAACyLoAMAACyLoAMAACwrxNcF+FpjY6O+++47RUREyGaz+bocAADgAmOMqqurlZCQoKCg88/bBHzQ+e6775SYmOjrMgAAQCscPXpUffr0Oe/+gA86ERERkn4cqO7du/u4GgAA4IqqqiolJiY6vsfPJ+CDTtPpqu7duxN0AADoYH5u2QmLkQEAgGURdAAAgGUFbNCx2+0aOHCgRowY4etSAACAl9iMMcbXRfhSVVWVIiMjVVlZyRodAIDHNTQ06OzZs74uo8MJDQ1VcHDwefe7+v0d8IuRAQDwBmOMSktLderUKV+X0mFFRUUpPj6+Tfe5I+gAAOAFTSEnNjZWXbp04aa0bjDG6PTp0yorK5Mk9erVq9V9EXQAAPCwhoYGR8jp2bOnr8vpkDp37ixJKisrU2xs7AVPY11IwC5GBgDAW5rW5HTp0sXHlXRsTePXljVOBB0AALyE01Vt44nxI+gAAADLIugAAADLYjEyAADtqN8D77XbsQ4vn+CRfsaOHauhQ4dq5cqVHumvPTGjAwAAPOaDDz6QzWbzm/sHEXQAAIBlEXTaWb8H3nN6AQDgT2prazV16lR169ZNvXr10lNPPeW0/5VXXlFaWpoiIiIUHx+v2267zXFjv8OHD2vcuHGSpB49eshms2n69OmSpL/97W8aPXq0oqKi1LNnT11//fX6+uuvvf55Ajbo8FBPAACau/fee7V161a99dZb2rx5sz744APl5+c79tfX1+uxxx7T/v37tXHjRhUVFTnCTGJiojZs2CBJ+uKLL1RSUqI///nPkn4MUNnZ2crLy9OWLVsUFBSkm266SY2NjV79PAG7GDkrK0tZWVmOh4IBABDoampqtHbtWr300ku65pprJEkvvvii+vTp42gzY8YMx6/79++vZ555Rr/85S9VU1Ojbt26KTo6WpIUGxurqKgoR9vf/e53Tsdau3atYmNjVVhYqJSUFK99poCd0QEAAM6+/vpr1dfXa+TIkY5t0dHRuvTSSx3v9+3bp9/+9rdKSkpSRESExo4dK0kqLi7+2b5vu+029e/fX927d1dycrJLP9dWBB0AACDpx4dpXkhtba3S09PVrVs3vfLKK8rLy9Nbb70l6cdTWhcyceJElZeX67nnntPHH3+sjz/+2KWfayuCDgAAkCRdfPHFCg0N1UcffeTYVlFRoS+//FKS9Pnnn+vEiRNavny5xowZo8suu8yxELlJWFiYpB8fbNqkvLxcn332mR566CFdddVVGjBggCoqKtrhExF0AADA/9OtWzfNnDlT9957r7Zs2aKDBw9q+vTpCgr6MS707dtXYWFh+s///E998803evvtt/XYY4859ZGUlCSbzaZ3331X33//vWpqatSjRw/17NlTOTk5OnTokP7xj38oOzu7XT5TwC5GBgDAFzx1t2Jv+Y//+A/V1NTohhtuUEREhO6++25VVlZKki666CKtW7dODz74oJ555hkNHz5cTz75pG644QbHz/fu3VuPPvqoHnjgAf3rv/6rpk6dqnXr1un111/X3LlzlZKSoksvvVTPPPOMY32PN9nMz52Qs7imq64qKyvVvXt3rx/vp/fO8fc/8AAA9505c0ZFRUVKTk5Wp06dfF1Oh3WhcXT1+5tTVwAAwLIIOgAAwLJYo+NFPOIBAADfYkYHAAAvCfBlsG3mifEj6AAA4GGhoaGSpNOnT/u4ko6tafyaxrM1OHUFAICHBQcHKyoqynEzvS5dushms/m4qo7DGKPTp0+rrKxMUVFRCg4ObnVfBB0AALwgPj5ekprdORiui4qKcoxjaxF0AADwApvNpl69eik2NlZnz571dTkdTmhoaJtmcppYIugUFRVpxowZOn78uIKDg/XRRx+pa9euvi4LAAAFBwd75AsbrWOJoDN9+nQtWbJEY8aM0cmTJxUeHu7rkgAAgB/o8EHn008/VWhoqMaMGSNJio6O9nFFAADAX/j88vLt27dr4sSJSkhIkM1m08aNG5u1Wb16teM5F6mpqdqxY4dj31dffaVu3brphhtu0PDhw7V06dJ2rB4AAPgznwed2tpaDRkyRKtWrWpx//r16zV//nwtWrRI+/bt05gxY5SRkaHi4mJJ0tmzZ7Vjxw7Z7Xbt2rVLubm5ys3NPe/x6urqVFVV5fQCAADW5POgk5GRoSVLlmjSpEkt7l+xYoVmzpypWbNmacCAAVq5cqUSExO1Zs0aSVKfPn00YsQIJSYmKjw8XOPHj1dBQcF5j7ds2TJFRkY6XomJid74WAAAwA/4POhcSH19vfLz85Wenu60PT09XTt37pQkjRgxQsePH1dFRYUaGxu1fft2DRgw4Lx9Lly4UJWVlY7X0aNHvfoZAACA7/j1YuQTJ06ooaFBcXFxTtvj4uJUWloqSQoJCdHSpUv1m9/8RsYYpaen6/rrrz9vn+Hh4VyVBQBAgPDroNPkp7fNNsY4bcvIyFBGRkZ7lwUAAPycX5+6iomJUXBwsGP2pklZWVmzWR532e12DRw4UCNGjGhTPwAAwH/5ddAJCwtTampqs6uocnNzNWrUqDb1nZWVpcLCQuXl5bWpHwAA4L98fuqqpqZGhw4dcrwvKipSQUGBoqOj1bdvX2VnZyszM1NpaWkaOXKkcnJyVFxcrNmzZ/uwagAA0BH4POjs2bNH48aNc7zPzs6WJE2bNk3r1q3T5MmTVV5ersWLF6ukpEQpKSnatGmTkpKSfFUyAADoIHwedMaOHStjzAXb3Hnnnbrzzjs9ely73S673a6GhgaP9gsAAPyHX6/R8SbW6AAAYH0BG3QAAID1EXQAAIBlBWzQ4T46AABYX8AGHdboAABgfQEbdAAAgPURdAAAgGURdAAAgGUFbNBhMTIAANYXsEGHxcgAAFhfwAYdAABgfQQdAABgWQQdAABgWQEbdFiMDACA9QVs0GExMgAA1hewQQcAAFgfQQcAAFgWQQcAAFgWQQcAAFgWQQcAAFhWwAYdLi8HAMD6AjbocHk5AADWF7BBBwAAWB9BBwAAWBZBBwAAWBZBBwAAWBZBBwAAWBZBBwAAWBZBBwAAWBZBBwAAWFbABh3ujAwAgPUFbNDhzsgAAFhfiK8LCHT9Hniv2bbDyyf4oBIAAKwnYGd0AACA9RF0AACAZRF0AACAZRF0AACAZRF0AACAZRF0AACAZRF0AACAZRF0AACAZRF0AACAZQVs0OFZVwAAWF/ABh2edQUAgPUFbNABAADWR9ABAACWxdPL/dBPn2jO08wBAGgdZnQAAIBlEXQAAIBlEXQAAIBlEXQAAIBlEXQAAIBlEXQAAIBlEXQAAIBlEXQAAIBlccPADuCnNxCUuIkgAACuYEYHAABYFkEHAABYFkEHAABYliXW6ISEhCglJUWSlJaWpr/85S8+rsj7ePAnAAA/zxJBJyoqSgUFBb4uAwAA+BlOXQEAAMvyedDZvn27Jk6cqISEBNlsNm3cuLFZm9WrVys5OVmdOnVSamqqduzY4bS/qqpKqampGj16tLZt29ZOlQMAAH/n86BTW1urIUOGaNWqVS3uX79+vebPn69FixZp3759GjNmjDIyMlRcXOxoc/jwYeXn5+vZZ5/V1KlTVVVVdd7j1dXVqaqqyukFAACsyedBJyMjQ0uWLNGkSZNa3L9ixQrNnDlTs2bN0oABA7Ry5UolJiZqzZo1jjYJCQmSpJSUFA0cOFBffvnleY+3bNkyRUZGOl6JiYme/UAAAMBv+DzoXEh9fb3y8/OVnp7utD09PV07d+6UJFVUVKiurk6S9O2336qwsFD9+/c/b58LFy5UZWWl43X06FHvfQAAAOBTfn3V1YkTJ9TQ0KC4uDin7XFxcSotLZUkffbZZ/r3f/93BQUFyWaz6c9//rOio6PP22d4eLjCw8O9WjcAAPAPfh10mthsNqf3xhjHtlGjRunAgQO+KAsAAPg5vw46MTExCg4OdszeNCkrK2s2y+Muu90uu92uhoaGNvXjL3jwJwAAzfn1Gp2wsDClpqYqNzfXaXtubq5GjRrVpr6zsrJUWFiovLy8NvUDAAD8l89ndGpqanTo0CHH+6KiIhUUFCg6Olp9+/ZVdna2MjMzlZaWppEjRyonJ0fFxcWaPXu2D6sGAAAdgc+Dzp49ezRu3DjH++zsbEnStGnTtG7dOk2ePFnl5eVavHixSkpKlJKSok2bNikpKalNx7XaqSsAANCczRhjfF2EL1VVVSkyMlKVlZXq3r27R/tuad1Me2KNDgDAqlz9/vbrNToAAABtQdABAACWFbBBx263a+DAgRoxYoSvSwEAAF4SsEGHy8sBALC+gA06AADA+gg6AADAsgg6AADAsgI26LAYGQAA6wvYoMNiZAAArC9ggw4AALA+gg4AALAsgg4AALAsgg4AALCsgA06XHUFAID1BWzQ4aorAACsL2CDDgAAsL4QVxplZ2e73fFDDz2k6Ohot38OAADAU1wKOitXrtTIkSMVFhbmUqcffvih5syZQ9ABAAA+5VLQkaS33npLsbGxLrWNiIhodUEAAACe4tIanRdeeEGRkZEud/pf//VfiouLa3VRAAAAnuDSjM60adPc6vS2225rVTHtyW63y26Line truncated
+      "text/plain": [
+       "<Figure size 640x480 with 1 Axes>"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "fname = 'beam_En700eV_-40deg_300V_10us_d0_f0_100.clust'\n",
+    "\n",
+    "# Create the histogram\n",
+    "n_bins = 100\n",
+    "xmin = -100\n",
+    "xmax = 1e4\n",
+    "hist1 = bh.Histogram(bh.axis.Regular(n_bins, xmin, xmax))\n",
+    "\n",
+    "with ClusterFile(path/fname, chunk = 10000) as f:\n",
+    "    for clusters in f:\n",
+    "        hist1.fill(clusters['data'].flat)\n",
+    "\n",
+    "\n",
+    "#Plotting\n",
+    "fig, ax = plt.subplots()\n",
+    "ax.bar(hist1.axes[0].centers, hist1.values(), width=hist1.axes[0].widths, label = 'data')\n",
+    "ax.set_yscale('log')\n",
+    "ax.set_xlabel('ADU [1]')\n",
+    "ax.set_ylabel('Intensity [a.u.]')\n",
+    "ax.legend()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "a2973368",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "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.11.3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}