Skip to content

Commit

Permalink
Add spacing in novice model to make docs render correctly
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanv committed Apr 12, 2015
1 parent 8d038b7 commit 80ef48c
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 14 deletions.
16 changes: 12 additions & 4 deletions skimage/novice/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,45 +21,53 @@
Example
-------
We can create a Picture object open opening an image file:
We can create a Picture object open opening an image file
>>> from skimage import novice
>>> from skimage import data
>>> picture = novice.open(data.data_dir + '/chelsea.png')
Pictures know their format
Pictures know their format:
>>> picture.format
'png'
... and where they came from
... and where they came from:
>>> picture.path.endswith('chelsea.png')
True
... and their size
... and their size:
>>> picture.size
(451, 300)
>>> picture.width
451
Changing `size` resizes the picture.
>>> picture.size = (45, 30)
You can iterate over pixels, which have RGB values between 0 and 255,
and know their location in the picture.
>>> for pixel in picture:
... if (pixel.red > 128) and (pixel.x < picture.width):
... pixel.red /= 2
Pictures know if they've been modified from the original file
>>> picture.modified
True
>>> print(picture.path)
None
Pictures can be indexed like arrays
>>> picture[0:20, 0:20] = (0, 0, 0)
Saving the picture updates the path attribute, format, and modified state.
>>> picture.save('save-demo.jpg')
>>> picture.path.endswith('save-demo.jpg')
True
Expand Down
27 changes: 17 additions & 10 deletions skimage/novice/_novice.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import os
import imghdr
from collections import namedtuple
from io import BytesIO

import numpy as np
from .. import io, img_as_ubyte
Expand All @@ -10,7 +9,6 @@
from ..io.util import file_or_url_context, is_url

import six
from six.moves.urllib_parse import urlparse
from six.moves.urllib import request
urlopen = request.urlopen

Expand Down Expand Up @@ -207,35 +205,44 @@ class Picture(object):
Examples
--------
Load an image from a file
Load an image from a file:
>>> from skimage import novice
>>> from skimage import data
>>> picture = novice.open(data.data_dir + '/chelsea.png')
Load an image from a URL. URL must start with http(s):// or ftp(s)://
Load an image from a URL (the URL must start with ``http(s)://`` or
``ftp(s)://``):
>>> picture = novice.open('http://scikit-image.org/_static/img/logo.png')
Create a blank 100 pixel wide, 200 pixel tall white image
Create a blank 100 pixel wide, 200 pixel tall white image:
>>> pic = Picture.from_size((100, 200), color=(255, 255, 255))
Use numpy to make an RGB byte array (shape is height x width x 3)
Use numpy to make an RGB byte array (shape is height x width x 3):
>>> import numpy as np
>>> data = np.zeros(shape=(200, 100, 3), dtype=np.uint8)
>>> data[:, :, 0] = 255 # Set red component to maximum
>>> pic = Picture(array=data)
Get the bottom-left pixel
Get the bottom-left pixel:
>>> pic[0, 0]
Pixel(red=255, green=0, blue=0, alpha=255)
Get the top row of the picture
Get the top row of the picture:
>>> pic[:, pic.height-1]
Picture(100 x 1)
Set the bottom-left pixel to black
Set the bottom-left pixel to black:
>>> pic[0, 0] = (0, 0, 0)
Set the top row to red
Set the top row to red:
>>> pic[:, pic.height-1] = (255, 0, 0)
"""
Expand Down

0 comments on commit 80ef48c

Please sign in to comment.