some basic cleaning up

notebooks/menpo.io - Importing Assets.ipynb → notebooks/Importing Assets.ipynb

@@ -1,6 +1,7 @@
 {
  "metadata": {
-  "name": ""
+  "name": "",
+  "signature": "sha256:6f95af578bcf79cc58a71583ad23ac628bb5da163e0944e4ec6915799f295688"
  },
  "nbformat": 3,
  "nbformat_minor": 0,
@@ -11,7 +12,7 @@
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "import menpo.io as pio"
+      "import menpo.io as mio"
      ],
      "language": "python",
      "metadata": {},
@@ -21,14 +22,14 @@
      "cell_type": "markdown",
      "metadata": {},
      "source": [
-      "Before we get started, Menpo has a small cache of test assets shipped with it for example and testing purposes. You can get the filepath of this folder on your system easily"
+      "Menpo has a small cache of test assets shipped with it for example and testing purposes. You can get the filepath of this folder on your system easily"
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "data_dir = pio.data_dir_path()\n",
+      "data_dir = mio.data_dir_path()\n",
       "print 'shipped data is at {}'.format(data_dir)\n",
       "import os\n",
       "os.listdir(data_dir)"
@@ -48,7 +49,7 @@
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "builtin_assets = pio.ls_builtin_assets()\n",
+      "builtin_assets = mio.ls_builtin_assets()\n",
       "print builtin_assets"
      ],
      "language": "python",
@@ -66,7 +67,7 @@
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "bunny_path = pio.data_path_to('bunny.obj')\n",
+      "bunny_path = mio.data_path_to('bunny.obj')\n",
       "print 'a bunny lives at {}'.format(bunny_path)"
      ],
      "language": "python",
@@ -108,7 +109,7 @@
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "bunny = pio.import_mesh(bunny_path)\n",
+      "bunny = mio.import_mesh(bunny_path)\n",
       "print bunny"
      ],
      "language": "python",
@@ -119,7 +120,7 @@
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "%matplotlib wx\n",
+      "%matplotlib qt\n",
       "bunny.view()"
      ],
      "language": "python",
@@ -137,7 +138,7 @@
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "same_bunny_less_hassle = pio.import_builtin_asset('bunny.obj')\n",
+      "same_bunny_less_hassle = mio.import_builtin_asset('bunny.obj')\n",
       "print same_bunny_less_hassle"
      ],
      "language": "python",
@@ -148,14 +149,14 @@
      "cell_type": "markdown",
      "metadata": {},
      "source": [
-      "All imported objects get stamped with the filepath. *Note that this API may change in time if we introduce a metadata dict on shapes - don't write code to rely on it's existance!*"
+      "All imported objects get stamped with a set of userful information - this can be found at the `ioinfo` attribute"
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "print 'this bunny came from {}'.format(bunny.filepath)"
+      "print bunny.ioinfo"
      ],
      "language": "python",
      "metadata": {},
@@ -174,7 +175,7 @@
      "input": [
       "%matplotlib inline\n",
       "# builtin asset handles both images and meshes\n",
-      "takeo = pio.import_builtin_asset('takeo.ppm') \n",
+      "takeo = mio.import_builtin_asset('takeo.ppm') \n",
       "takeo.view()"
      ],
      "language": "python",
@@ -186,7 +187,7 @@
      "collapsed": false,
      "input": [
       "%matplotlib inline\n",
-      "bb = pio.import_builtin_asset('breakingbad.jpg')\n",
+      "bb = mio.import_builtin_asset('breakingbad.jpg')\n",
       "bb.view()"
      ],
      "language": "python",
@@ -225,9 +226,9 @@
      "collapsed": false,
      "input": [
       "%matplotlib inline\n",
-      "new_mexico = pio.data_path_to('breakingbad.jpg')\n",
+      "new_mexico = mio.data_path_to('breakingbad.jpg')\n",
       "print 'Walter White lives at {}'.format(new_mexico)\n",
-      "walter_2 = pio.import_image(new_mexico)\n",
+      "walter_2 = mio.import_image(new_mexico)\n",
       "walter_2.view()  # exactly the same!"
      ],
      "language": "python",
@@ -246,7 +247,7 @@
      "collapsed": false,
      "input": [
       "try:\n",
-      "    pio.import_image('/lol/I/bet/this/isnt/an/image/on/your/system.jpg')\n",
+      "    mio.import_image('/lol/I/bet/this/isnt/an/image/on/your/system.jpg')\n",
       "except ValueError as e:\n",
       "    print e"
      ],
@@ -268,9 +269,9 @@
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "all_data_files = pio.data_dir_path() + '/*'\n",
+      "all_data_files = mio.data_dir_path() + '/*'\n",
       "print 'glob to find all inbuilt files: {}'.format(all_data_files)\n",
-      "for image in pio.import_images(all_data_files):\n",
+      "for image in mio.import_images(all_data_files):\n",
       "    print image"
      ],
      "language": "python",
@@ -288,7 +289,7 @@
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "images = list(pio.import_images(all_data_files))\n",
+      "images = list(mio.import_images(all_data_files))\n",
       "print images"
      ],
      "language": "python",
@@ -307,7 +308,7 @@
      "collapsed": false,
      "input": [
       "cropped_images = []\n",
-      "for image in pio.import_images(all_data_files):\n",
+      "for image in mio.import_images(all_data_files):\n",
       "    image.crop((0, 0), (100, 100))\n",
       "    cropped_images.append(image)\n",
       "for image in cropped_images:\n",
@@ -328,7 +329,7 @@
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "for mesh in pio.import_meshes(all_data_files):\n",
+      "for mesh in mio.import_meshes(all_data_files):\n",
       "    print mesh\n",
       "# note there is only one mesh in the data file at present!"
      ],
@@ -347,7 +348,7 @@
      "cell_type": "code",
      "collapsed": false,
      "input": [
-      "for asset in pio.import_auto(all_data_files):\n",
+      "for asset in mio.import_auto(all_data_files):\n",
       "    print asset"
      ],
      "language": "python",
@@ -358,4 +359,4 @@
    "metadata": {}
   }
  ]
-}
+}