From 73884576d46c9c1fb6c5c66ecbbce63827380a7d Mon Sep 17 00:00:00 2001 From: Hugo Date: Mon, 24 Jun 2019 11:04:13 +0300 Subject: [PATCH] Some styling and wording --- docs/reference/Image.rst | 48 ++++++++++++++++++++++------------------ 1 file changed, 27 insertions(+), 21 deletions(-) diff --git a/docs/reference/Image.rst b/docs/reference/Image.rst index 3b2541d69..944a7e88e 100644 --- a/docs/reference/Image.rst +++ b/docs/reference/Image.rst @@ -16,7 +16,7 @@ Open, rotate, and display an image (using the default viewer) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The following script loads an image, rotates it 45 degrees, and displays it -using an external viewer (usually xv on Unix, and the paint program on +using an external viewer (usually xv on Unix, and the Paint program on Windows). .. code-block:: python @@ -116,61 +116,64 @@ ITU-R 709, using the D65 luminant) to the CIE XYZ color space: rgb2xyz = ( 0.412453, 0.357580, 0.180423, 0, 0.212671, 0.715160, 0.072169, 0, - 0.019334, 0.119193, 0.950227, 0 ) + 0.019334, 0.119193, 0.950227, 0) out = im.convert("RGB", rgb2xyz) .. automethod:: PIL.Image.Image.copy .. automethod:: PIL.Image.Image.crop -The following script crops the input image with the provided coordinates: +This crops the input image with the provided coordinates: .. code-block:: python from PIL import Image + im = Image.open("hopper.jpg") - # crop method from Image module takes four coordinates as input. + # The crop method from the Image module takes four coordinates as input. # The right can also be represented as (left+width) - # and lower can be represented as (upper+height) - (left, upper, right, lower) = (200, 20, 520, 260) + # and lower can be represented as (upper+height). + (left, upper, right, lower) = (20, 20, 100, 100) - # Here the image "im" is cropped and assiged to new variable im_crop + # Here the image "im" is cropped and assigned to new variable im_crop im_crop = im.crop((left, upper, right, lower)) .. automethod:: PIL.Image.Image.draft .. automethod:: PIL.Image.Image.filter -The following script blurs the input image using a filter from ImageFilter module: +This blurs the input image using a filter from the ``ImageFilter`` module: .. code-block:: python - from PIL import Image - from PIL import ImageFilter + from PIL import Image, ImageFilter + im = Image.open("hopper.jpg") - # Blur the input image using the filter ImageFilter.BLUR. + # Blur the input image using the filter ImageFilter.BLUR im_blurred = im.filter(filter=ImageFilter.BLUR) .. automethod:: PIL.Image.Image.getbands -The following script helps to get the bands of the input image: +This helps to get the bands of the input image: .. code-block:: python from PIL import Image + im = Image.open("hopper.jpg") - print (im.getbands()) # Returns ('R', 'G', 'B') + print(im.getbands()) # Returns ('R', 'G', 'B') .. automethod:: PIL.Image.Image.getbbox -The following script helps to get the bounding box coordinates of the input image: +This helps to get the bounding box coordinates of the input image: .. code-block:: python from PIL import Image + im = Image.open("hopper.jpg") - print (im.getbbox()) + prin (im.getbbox()) # Returns four coordinates in the format (left, upper, right, lower) .. automethod:: PIL.Image.Image.getcolors @@ -189,30 +192,32 @@ The following script helps to get the bounding box coordinates of the input imag .. automethod:: PIL.Image.Image.quantize .. automethod:: PIL.Image.Image.resize -The following script resizes the given image from (width, height) to (width/2, height/2): +This resizes the given image from ``(width, height)`` to ``(width/2, height/2)``: .. code-block:: python from PIL import Image + im = Image.open("hopper.jpg") # Provide the target width and height of the image - (width, height) = (width//2, height//2) + (width, height) = (im.width // 2, im.height // 2) im_resized = im.resize((width, height)) .. automethod:: PIL.Image.Image.remap_palette .. automethod:: PIL.Image.Image.rotate -The following script rotates the input image by `theta` degrees counter clockwise: +This rotates the input image by ``theta`` degrees counter clockwise: .. code-block:: python from PIL import Image + im = Image.open("hopper.jpg") - # Rotate the image by 60 degrees counter clockwise. + # Rotate the image by 60 degrees counter clockwise theta = 60 - # Angle is in degrees counter clockwise. + # Angle is in degrees counter clockwise im_rotated = im.rotate(angle=theta) .. automethod:: PIL.Image.Image.save @@ -228,11 +233,12 @@ The following script rotates the input image by `theta` degrees counter clockwis .. automethod:: PIL.Image.Image.transform .. automethod:: PIL.Image.Image.transpose -The following script flips the input image by using the method "Image.FLIP_LEFT_RIGHT". +This flips the input image by using the ``Image.FLIP_LEFT_RIGHT`` method. .. code-block:: python from PIL import Image + im = Image.open("hopper.jpg") # Flip the image from left to right