2014-11-20 01:04:39 +03:00
.. _PixelAccess:
:py:class: `PixelAccess` Class
=============================
The PixelAccess class provides read and write access to
:py:class: `PIL.Image` data at a pixel level.
2015-10-11 13:24:35 +03:00
.. note :: Accessing individual pixels is fairly slow. If you are looping over all of the pixels in an image, there is likely a faster way using other parts of the Pillow API.
2014-11-20 01:04:39 +03:00
Example
-------
The following script loads an image, accesses one pixel from it, then
changes it.
.. code-block :: python
from PIL import Image
im = Image.open('hopper.jpg')
px = im.load()
print (px[4,4])
px[4,4] = (0,0,0)
print (px[4,4])
Results in the following::
(23, 24, 68)
(0, 0, 0)
:py:class: `PixelAccess` Class
-----------------------------------
.. class :: PixelAccess
.. method :: __setitem__(self, xy, color):
Modifies the pixel at x,y. The color is given as a single
numerical value for single band images, and a tuple for
multi-band images
:param xy: The pixel coordinate, given as (x, y).
:param value: The pixel value.
.. method :: __getitem__(self, xy):
Returns the pixel at x,y. The pixel is returned as a single
value for single band images or a tuple for multiple band
images
:param xy: The pixel coordinate, given as (x, y).
:returns: a pixel value for single band images, a tuple of
pixel values for multiband images.
.. method :: putpixel(self, xy, color):
Modifies the pixel at x,y. The color is given as a single
numerical value for single band images, and a tuple for
multi-band images
:param xy: The pixel coordinate, given as (x, y).
:param value: The pixel value.
.. method :: getpixel(self, xy):
Returns the pixel at x,y. The pixel is returned as a single
value for single band images or a tuple for multiple band
images
:param xy: The pixel coordinate, given as (x, y).
:returns: a pixel value for single band images, a tuple of
pixel values for multiband images.
