01_imagecleaner.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# default_exp imagecleaner"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# jmd_imagescraper.imagecleaner\n",
    "\n",
    "> Image cleaner widget for cleaning up your dataset from within your notebook"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#hide\n",
    "from nbdev import *"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#export\n",
    "from pathlib import Path\n",
    "from PIL import Image as PImage\n",
    "from PIL import ImageDraw as PImageDraw\n",
    "import ipywidgets as widgets\n",
    "from IPython.display import display\n",
    "from io import BytesIO"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Image Cleaner\n",
    "\n",
    "You can use the image cleaner from within your notebook to clean up your dataset and delete unsuitable images."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#exporti\n",
    "\n",
    "##########################################################################################\n",
    "# globals & event handlers\n",
    "##########################################################################################\n",
    "ICLN_BATCH_SZ = 8\n",
    "\n",
    "# this may look nauseating and but creating new widgets is literally about 10x slower than \n",
    "# updating existing ones so the ui gets created once and updated forever more\n",
    "icln_base_path = None\n",
    "icln_folder = None\n",
    "icln_batches = None\n",
    "icln_pager = None\n",
    "icln_grid = None\n",
    "icln_empty_folder = None\n",
    "\n",
    "def delete_on_click(btn):\n",
    "  fn, img, batch, idx = btn.tag\n",
    "  img.value = icln_deleted_img() # display red 'deleted' cross\n",
    "  icln_batches[batch][idx] = \"\"  # so we know it's deleted as we page back & forth\n",
    "  btn.disabled = True\n",
    "  try:    Path(fn).unlink()      # dbl-clicks result in us trying to delete twice\n",
    "  except: pass\n",
    "\n",
    "def paging_on_click(btn):\n",
    "  folder, batch = btn.tag\n",
    "  icln_render_batch(folder, batch)\n",
    "\n",
    "def reload_on_click(btn):\n",
    "  icln_render_batch(icln_folder, 0, force_reload=True)\n",
    "\n",
    "def folder_on_change(change):\n",
    "  if(change[\"type\"] == \"change\" and change[\"name\"] == \"value\"):\n",
    "    icln_render_batch(change[\"new\"], 0)\n",
    "  \n",
    "##########################################################################################\n",
    "# UI creation\n",
    "##########################################################################################\n",
    "def icln_deleted_img():\n",
    "  # creates the red \"deleted\" placeholder cross and caches it\n",
    "  DELETED_IMG = \"deleted_img\"\n",
    "  \n",
    "  if(DELETED_IMG not in icln_deleted_img.__dict__):\n",
    "    img = PImage.new(\"RGB\",(150,150), color=\"white\")\n",
    "\n",
    "    draw = PImageDraw.Draw(img)\n",
    "    draw.line((5, 5, 140, 140), fill=\"red\", width=10)\n",
    "    draw.line((5, 140, 140, 5), fill=\"red\", width=10)\n",
    "    \n",
    "    bio = BytesIO()\n",
    "    img.save(bio, 'JPEG')\n",
    "    icln_deleted_img.__dict__[DELETED_IMG] = bio.getvalue()\n",
    "\n",
    "  return icln_deleted_img.__dict__[DELETED_IMG]\n",
    "\n",
    "def icln_create_widgets(batch_size):\n",
    "  # create the UI widgets\n",
    "  global icln_pager\n",
    "  global icln_grid\n",
    "  global icln_empty_folder\n",
    "\n",
    "  # image/delete button pairs\n",
    "  display_items = []\n",
    "  for i in range(batch_size):\n",
    "    img = widgets.Image()\n",
    "    img.layout.width=\"150px\"\n",
    "    btn = widgets.Button(description=\"Delete\")\n",
    "    btn.on_click(delete_on_click)\n",
    "    box = widgets.VBox(children=[img,btn])\n",
    "    box.layout.margin = \"5px\"\n",
    "    display_items.append(box)\n",
    "\n",
    "  # paging\n",
    "  btnFirst = widgets.Button(description=\"|<<\") \n",
    "  btnPrev = widgets.Button(description=\"<<\")\n",
    "  lblPage = widgets.Label(value=\"Page NNN of KKK\")\n",
    "  lblPage.layout = widgets.Layout(display=\"flex\", justify_content=\"center\", width=\"100px\")\n",
    "  btnNext = widgets.Button(description=\">>\")\n",
    "  btnLast = widgets.Button(description=\">>|\")\n",
    "  \n",
    "  pgbtns = [btnFirst, btnPrev, btnNext, btnLast]\n",
    "  for btn in pgbtns: btn.on_click(paging_on_click)\n",
    "  for btn in pgbtns: btn.layout.width = \"60px\"\n",
    "\n",
    "  # folder drop down\n",
    "  folders = [f.stem for f in icln_base_path.glob(\"*\") if (f.is_dir() and f.stem[0] != \".\")]\n",
    "  folders.sort()\n",
    "  rootfiles = [f for f in icln_base_path.glob(\"*.jpg\") if f.is_file()]\n",
    "  if(len(rootfiles) > 0): folders = [\"/\"] + folders\n",
    "  ddlFolder = widgets.Dropdown(options=folders, description=\"Folder: \")\n",
    "  ddlFolder.observe(folder_on_change)\n",
    "\n",
    "  # reload button\n",
    "  btnReload = widgets.Button(description=\"↻\")\n",
    "  btnReload.layout = widgets.Layout(width=\"40px\", margin=\"0px 0px 0px 10px\")\n",
    "  btnReload.on_click(reload_on_click)\n",
    "\n",
    "  # plug it all in and display\n",
    "  icln_pager = widgets.HBox(children=[btnFirst, btnPrev, lblPage, btnNext, btnLast, \n",
    "                                      ddlFolder, btnReload])  \n",
    "  icln_grid = widgets.GridBox(display_items, \n",
    "                              layout=widgets.Layout(grid_template_columns=\"repeat(4, 25%)\",\n",
    "                                                    margin=\"15px\"))\n",
    "  icln_empty_folder = widgets.HTML(value=\"<h2>No images left to display in this folder.</h2>\")\n",
    "  icln_empty_folder.layout.visibility = \"hidden\"\n",
    "\n",
    "  display(icln_pager)\n",
    "  display(icln_empty_folder)\n",
    "  display(icln_grid)\n",
    "  \n",
    "##########################################################################################\n",
    "# UI rendering\n",
    "##########################################################################################\n",
    "def icln_render_batch(folder, batch, force_reload=False):\n",
    "  global icln_folder\n",
    "  global icln_batches\n",
    "  global icln_pager\n",
    "  global icln_grid\n",
    "\n",
    "  if(folder == \"/\"): folder = \"\"\n",
    "  path = icln_base_path/folder\n",
    "\n",
    "  if((icln_folder != folder) or (force_reload)): \n",
    "    # get the files, split into batches  \n",
    "    files = list(path.glob(\"*.jpg\"))\n",
    "    icln_batches = [files[i:i + ICLN_BATCH_SZ] for i in range(0, len(files), ICLN_BATCH_SZ)]\n",
    "    icln_folder = folder\n",
    "\n",
    "    if(len(files) == 0):\n",
    "      # fail gracefully if they've deleted every image in this folder\n",
    "      icln_empty_folder.layout.visibility = \"visible\"\n",
    "      # icln_grid.layout.visibility = \"hidden\" <-- doesn't work :-@\n",
    "      for child in icln_grid.children: child.layout.visibility = \"hidden\"\n",
    "      btnFirst, btnPrev, lblPage, btnNext, btnLast,_,_ = icln_pager.children\n",
    "      lblPage.value = \"Page 0 of 0\"\n",
    "      for btn in [btnFirst, btnPrev, btnNext, btnLast]: btn.disabled = True\n",
    "      return\n",
    "    else:\n",
    "      icln_empty_folder.layout.visibility = \"hidden\"\n",
    "      icln_grid.layout.visibility = \"visible\"\n",
    "\n",
    "  # display the images\n",
    "  for i, fp in enumerate(icln_batches[batch]):\n",
    "    icln_grid.children[i].layout.visibility = \"visible\"\n",
    "    img = icln_grid.children[i].children[0]\n",
    "    btn = icln_grid.children[i].children[1]\n",
    "\n",
    "    if(fp == \"\"):\n",
    "      img.value = icln_deleted_img()\n",
    "      btn.disabled = True\n",
    "    else:\n",
    "      img.value = open(fp, \"rb\").read()\n",
    "      btn.tag = (fp, img, batch, i)\n",
    "      btn.disabled = False\n",
    "\n",
    "  if(len(icln_batches[batch]) < ICLN_BATCH_SZ):\n",
    "    # partial batch on the last page, hide the rest of the grid\n",
    "    for i in range(len(icln_batches[batch]), ICLN_BATCH_SZ):\n",
    "      icln_grid.children[i].layout.visibility = \"hidden\"\n",
    "    \n",
    "  # update the paging controls\n",
    "  btnFirst, btnPrev, lblPage, btnNext, btnLast,_,_ = icln_pager.children\n",
    "  btnFirst.tag = (folder, 0) \n",
    "  btnPrev.tag = (folder, max(0, batch-1)) \n",
    "  btnNext.tag = (folder, min(len(icln_batches)-1, batch+1)) \n",
    "  btnLast.tag = (folder, len(icln_batches)-1) \n",
    "  lblPage.value = \"Page {} of {}\".format(batch+1, len(icln_batches))\n",
    "  for btn in [btnFirst, btnPrev, btnNext, btnLast]: btn.disabled = btn.tag[1] == batch"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#export\n",
    "def display_image_cleaner(path):\n",
    "    '''Display the image cleaner widget for the given folder'''\n",
    "    global icln_base_path; icln_base_path = Path(path)\n",
    "    \n",
    "    icln_create_widgets(ICLN_BATCH_SZ)\n",
    "    _,_,_,_,_,ddlFolder,_ = icln_pager.children\n",
    "    icln_render_batch(ddlFolder.value, 0)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "![](image_cleaner.jpg)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Converted 00_core.ipynb.\n",
      "Converted 01_imagecleaner.ipynb.\n",
      "Converted index.ipynb.\n"
     ]
    }
   ],
   "source": [
    "#hide\n",
    "from nbdev.export import *\n",
    "notebook2script()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}