python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2024-11-10 19:56:47 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add sphinx docs

Browse Source
This commit is contained in:
Alex Clark 2012-02-16 20:10:57 -05:00
parent b87851fae5
commit ea0989ad17
78 changed files with 3655 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

153
docs/Makefile Normal file
View File

@ -0,0 +1,153 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Pillowdocumentation.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Pillowdocumentation.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/Pillowdocumentation"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Pillowdocumentation"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

242
docs/conf.py Normal file
View File

@ -0,0 +1,242 @@
# -*- coding: utf-8 -*-
#
# Pillow documentation documentation build configuration file, created by
# sphinx-quickstart on Thu Feb 16 20:04:11 2012.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = []
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Pillow'
copyright = u'2012, Alex Clark (PIL fork author)'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.7.7'
# The full version, including alpha/beta/rc tags.
release = '1.7.7'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'Pillowdocumentationdoc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'Pillowdocumentation.tex', u'Pillow documentation Documentation',
u'Alex Clark (PIL fork author)', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'pillowdocumentation', u'Pillow documentation Documentation',
[u'Alex Clark (PIL fork author)'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'Pillowdocumentation', u'Pillow documentation Documentation',
u'Alex Clark (PIL fork author)', 'Pillowdocumentation', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'

180
docs/index.rst Normal file
View File

@ -0,0 +1,180 @@
==========================
The Python Imaging Library
==========================
The Python Imaging Library
==========================
Online Resources
~~~~~~~~~~~~~~~~
`*Python Imaging Library* <http://www.pythonware.com/products/pil>`_
(official product page at `pythonware.com <http://www.pythonware.com>`_)
`*Python Imaging Library* <http://effbot.org/zone/pil-index.htm>`_
(development page at `effbot.org <http://effbot.org>`_)
Package Contents
~~~~~~~~~~~~~~~~
The following pages are generated from
`**pythondoc** <http://effbot.org/zone/pythondoc.htm>`_ markup in the
source files.
`The PIL.Image Module <pythondoc-PIL.Image.html>`_
`The PIL.ImageChops Module <pythondoc-PIL.ImageChops.html>`_
`The PIL.ImageColor Module <pythondoc-PIL.ImageColor.html>`_
`The PIL.ImageDraw Module <pythondoc-PIL.ImageDraw.html>`_
`The PIL.ImageEnhance Module <pythondoc-PIL.ImageEnhance.html>`_
`The PIL.ImageFile Module <pythondoc-PIL.ImageFile.html>`_
`The PIL.ImageFileIO Module <pythondoc-PIL.ImageFileIO.html>`_
`The PIL.ImageFilter Module <pythondoc-PIL.ImageFilter.html>`_
`The PIL.ImageFont Module <pythondoc-PIL.ImageFont.html>`_
`The PIL.ImageGL Module <pythondoc-PIL.ImageGL.html>`_
`The PIL.ImageGrab Module <pythondoc-PIL.ImageGrab.html>`_
`The PIL.ImageMath Module <pythondoc-PIL.ImageMath.html>`_
`The PIL.ImageMode Module <pythondoc-PIL.ImageMode.html>`_
`The PIL.ImageOps Module <pythondoc-PIL.ImageOps.html>`_
`The PIL.ImagePalette Module <pythondoc-PIL.ImagePalette.html>`_
`The PIL.ImagePath Module <pythondoc-PIL.ImagePath.html>`_
`The PIL.ImageQt Module <pythondoc-PIL.ImageQt.html>`_
`The PIL.ImageSequence Module <pythondoc-PIL.ImageSequence.html>`_
`The PIL.ImageStat Module <pythondoc-PIL.ImageStat.html>`_
`The PIL.ImageTk Module <pythondoc-PIL.ImageTk.html>`_
`The PIL.ImageTransform Module <pythondoc-PIL.ImageTransform.html>`_
`The PIL.ImageWin Module <pythondoc-PIL.ImageWin.html>`_
`The PIL.ArgImagePlugin Module <pythondoc-PIL.ArgImagePlugin.html>`_
`The PIL.BdfFontFile Module <pythondoc-PIL.BdfFontFile.html>`_
`The PIL.BmpImagePlugin Module <pythondoc-PIL.BmpImagePlugin.html>`_
`The PIL.BufrStubImagePlugin
Module <pythondoc-PIL.BufrStubImagePlugin.html>`_
`The PIL.ContainerIO Module <pythondoc-PIL.ContainerIO.html>`_
`The PIL.CurImagePlugin Module <pythondoc-PIL.CurImagePlugin.html>`_
`The PIL.DcxImagePlugin Module <pythondoc-PIL.DcxImagePlugin.html>`_
`The PIL.EpsImagePlugin Module <pythondoc-PIL.EpsImagePlugin.html>`_
`The PIL.ExifTags Module <pythondoc-PIL.ExifTags.html>`_
`The PIL.FitsStubImagePlugin
Module <pythondoc-PIL.FitsStubImagePlugin.html>`_
`The PIL.FliImagePlugin Module <pythondoc-PIL.FliImagePlugin.html>`_
`The PIL.FontFile Module <pythondoc-PIL.FontFile.html>`_
`The PIL.FpxImagePlugin Module <pythondoc-PIL.FpxImagePlugin.html>`_
`The PIL.GbrImagePlugin Module <pythondoc-PIL.GbrImagePlugin.html>`_
`The PIL.GdImageFile Module <pythondoc-PIL.GdImageFile.html>`_
`The PIL.GifImagePlugin Module <pythondoc-PIL.GifImagePlugin.html>`_
`The PIL.GimpGradientFile Module <pythondoc-PIL.GimpGradientFile.html>`_
`The PIL.GimpPaletteFile Module <pythondoc-PIL.GimpPaletteFile.html>`_
`The PIL.GribStubImagePlugin
Module <pythondoc-PIL.GribStubImagePlugin.html>`_
`The PIL.Hdf5StubImagePlugin
Module <pythondoc-PIL.Hdf5StubImagePlugin.html>`_
`The PIL.IcnsImagePlugin Module <pythondoc-PIL.IcnsImagePlugin.html>`_
`The PIL.IcoImagePlugin Module <pythondoc-PIL.IcoImagePlugin.html>`_
`The PIL.ImImagePlugin Module <pythondoc-PIL.ImImagePlugin.html>`_
`The PIL.ImtImagePlugin Module <pythondoc-PIL.ImtImagePlugin.html>`_
`The PIL.IptcImagePlugin Module <pythondoc-PIL.IptcImagePlugin.html>`_
`The PIL.JpegImagePlugin Module <pythondoc-PIL.JpegImagePlugin.html>`_
`The PIL.McIdasImagePlugin
Module <pythondoc-PIL.McIdasImagePlugin.html>`_
`The PIL.MicImagePlugin Module <pythondoc-PIL.MicImagePlugin.html>`_
`The PIL.MpegImagePlugin Module <pythondoc-PIL.MpegImagePlugin.html>`_
`The PIL.MspImagePlugin Module <pythondoc-PIL.MspImagePlugin.html>`_
`The PIL.OleFileIO Module <pythondoc-PIL.OleFileIO.html>`_
`The PIL.PSDraw Module <pythondoc-PIL.PSDraw.html>`_
`The PIL.PaletteFile Module <pythondoc-PIL.PaletteFile.html>`_
`The PIL.PalmImagePlugin Module <pythondoc-PIL.PalmImagePlugin.html>`_
`The PIL.PcdImagePlugin Module <pythondoc-PIL.PcdImagePlugin.html>`_
`The PIL.PcfFontFile Module <pythondoc-PIL.PcfFontFile.html>`_
`The PIL.PcxImagePlugin Module <pythondoc-PIL.PcxImagePlugin.html>`_
`The PIL.PdfImagePlugin Module <pythondoc-PIL.PdfImagePlugin.html>`_
`The PIL.PixarImagePlugin Module <pythondoc-PIL.PixarImagePlugin.html>`_
`The PIL.PngImagePlugin Module <pythondoc-PIL.PngImagePlugin.html>`_
`The PIL.PpmImagePlugin Module <pythondoc-PIL.PpmImagePlugin.html>`_
`The PIL.PsdImagePlugin Module <pythondoc-PIL.PsdImagePlugin.html>`_
`The PIL.SgiImagePlugin Module <pythondoc-PIL.SgiImagePlugin.html>`_
`The PIL.SunImagePlugin Module <pythondoc-PIL.SunImagePlugin.html>`_
`The PIL.TarIO Module <pythondoc-PIL.TarIO.html>`_
`The PIL.TgaImagePlugin Module <pythondoc-PIL.TgaImagePlugin.html>`_
`The PIL.TiffImagePlugin Module <pythondoc-PIL.TiffImagePlugin.html>`_
`The PIL.TiffTags Module <pythondoc-PIL.TiffTags.html>`_
`The PIL.WalImageFile Module <pythondoc-PIL.WalImageFile.html>`_
`The PIL.WbmpImagePlugin Module <pythondoc-PIL.WbmpImagePlugin.html>`_
`The PIL.WmfImagePlugin Module <pythondoc-PIL.WmfImagePlugin.html>`_
`The PIL.XVThumbImagePlugin
Module <pythondoc-PIL.XVThumbImagePlugin.html>`_
`The PIL.XbmImagePlugin Module <pythondoc-PIL.XbmImagePlugin.html>`_
`The PIL.XpmImagePlugin Module <pythondoc-PIL.XpmImagePlugin.html>`_

190
docs/make.bat Normal file
View File

@ -0,0 +1,190 @@
@ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=_build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
set I18NSPHINXOPTS=%SPHINXOPTS% .
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^<target^>` where ^<target^> is one of
echo. html to make standalone HTML files
echo. dirhtml to make HTML files named index.html in directories
echo. singlehtml to make a single large HTML file
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
echo. qthelp to make HTML files and a qthelp project
echo. devhelp to make HTML files and a Devhelp project
echo. epub to make an epub
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Pillowdocumentation.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Pillowdocumentation.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished.
goto end
)
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
if errorlevel 1 exit /b 1
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
)
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
if "%1" == "texinfo" (
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
goto end
)
if "%1" == "gettext" (
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
if errorlevel 1 exit /b 1
echo.
echo.The overview file is in %BUILDDIR%/changes.
goto end
)
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
if errorlevel 1 exit /b 1
echo.
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
goto end
)
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
if errorlevel 1 exit /b 1
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
)
:end

17
docs/pythondoc-PIL.ArgImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.ArgImagePlugin Module
=============================
The PIL.ArgImagePlugin Module
=============================
**ArgImageFile** (class) [`# <#PIL.ArgImagePlugin.ArgImageFile-class>`_]
Image plugin for the experimental Animated Raster Graphics format.
For more information about this class, see `*The ArgImageFile
Class* <#PIL.ArgImagePlugin.ArgImageFile-class>`_.
The ArgImageFile Class
----------------------
**ArgImageFile** (class) [`# <#PIL.ArgImagePlugin.ArgImageFile-class>`_]

17
docs/pythondoc-PIL.BdfFontFile.rst Normal file
View File

@ -0,0 +1,17 @@
==========================
The PIL.BdfFontFile Module
==========================
The PIL.BdfFontFile Module
==========================
**BdfFontFile(fp)** (class) [`# <#PIL.BdfFontFile.BdfFontFile-class>`_]
Font file plugin for the X11 BDF format.
For more information about this class, see `*The BdfFontFile
Class* <#PIL.BdfFontFile.BdfFontFile-class>`_.
The BdfFontFile Class
---------------------
**BdfFontFile(fp)** (class) [`# <#PIL.BdfFontFile.BdfFontFile-class>`_]

17
docs/pythondoc-PIL.BmpImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.BmpImagePlugin Module
=============================
The PIL.BmpImagePlugin Module
=============================
**BmpImageFile** (class) [`# <#PIL.BmpImagePlugin.BmpImageFile-class>`_]
Image plugin for the Windows BMP format.
For more information about this class, see `*The BmpImageFile
Class* <#PIL.BmpImagePlugin.BmpImageFile-class>`_.
The BmpImageFile Class
----------------------
**BmpImageFile** (class) [`# <#PIL.BmpImagePlugin.BmpImageFile-class>`_]

12
docs/pythondoc-PIL.BufrStubImagePlugin.rst Normal file
View File

@ -0,0 +1,12 @@
==================================
The PIL.BufrStubImagePlugin Module
==================================
The PIL.BufrStubImagePlugin Module
==================================
**register\_handler(handler)**
[`# <#PIL.BufrStubImagePlugin.register_handler-function>`_]
*handler*

51
docs/pythondoc-PIL.ContainerIO.rst Normal file
View File

@ -0,0 +1,51 @@
==========================
The PIL.ContainerIO Module
==========================
The PIL.ContainerIO Module
==========================
**ContainerIO(file, offset, length)** (class)
[`# <#PIL.ContainerIO.ContainerIO-class>`_]
A file object that provides read access to a part of an existing
file (for example a TAR file).
For more information about this class, see `*The ContainerIO
Class* <#PIL.ContainerIO.ContainerIO-class>`_.
The ContainerIO Class
---------------------
**ContainerIO(file, offset, length)** (class)
[`# <#PIL.ContainerIO.ContainerIO-class>`_]
**\_\_init\_\_(file, offset, length)**
[`# <#PIL.ContainerIO.ContainerIO.__init__-method>`_]
*file*
*offset*
*length*
**isatty()** [`# <#PIL.ContainerIO.ContainerIO.isatty-method>`_]
**read(bytes=0)** [`# <#PIL.ContainerIO.ContainerIO.read-method>`_]
*bytes*
Returns:
**readline()** [`# <#PIL.ContainerIO.ContainerIO.readline-method>`_]
Returns:
**readlines()** [`# <#PIL.ContainerIO.ContainerIO.readlines-method>`_]
Returns:
**seek(offset, mode=0)**
[`# <#PIL.ContainerIO.ContainerIO.seek-method>`_]
*offset*
*mode*
**tell()** [`# <#PIL.ContainerIO.ContainerIO.tell-method>`_]
Returns:

17
docs/pythondoc-PIL.CurImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.CurImagePlugin Module
=============================
The PIL.CurImagePlugin Module
=============================
**CurImageFile** (class) [`# <#PIL.CurImagePlugin.CurImageFile-class>`_]
Image plugin for Windows Cursor files.
For more information about this class, see `*The CurImageFile
Class* <#PIL.CurImagePlugin.CurImageFile-class>`_.
The CurImageFile Class
----------------------
**CurImageFile** (class) [`# <#PIL.CurImagePlugin.CurImageFile-class>`_]

17
docs/pythondoc-PIL.DcxImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.DcxImagePlugin Module
=============================
The PIL.DcxImagePlugin Module
=============================
**DcxImageFile** (class) [`# <#PIL.DcxImagePlugin.DcxImageFile-class>`_]
Image plugin for the Intel DCX format.
For more information about this class, see `*The DcxImageFile
Class* <#PIL.DcxImagePlugin.DcxImageFile-class>`_.
The DcxImageFile Class
----------------------
**DcxImageFile** (class) [`# <#PIL.DcxImagePlugin.DcxImageFile-class>`_]

17
docs/pythondoc-PIL.EpsImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.EpsImagePlugin Module
=============================
The PIL.EpsImagePlugin Module
=============================
**EpsImageFile** (class) [`# <#PIL.EpsImagePlugin.EpsImageFile-class>`_]
Image plugin for Encapsulated Postscript.
For more information about this class, see `*The EpsImageFile
Class* <#PIL.EpsImagePlugin.EpsImageFile-class>`_.
The EpsImageFile Class
----------------------
**EpsImageFile** (class) [`# <#PIL.EpsImagePlugin.EpsImageFile-class>`_]

12
docs/pythondoc-PIL.ExifTags.rst Normal file
View File

@ -0,0 +1,12 @@
=======================
The PIL.ExifTags Module
=======================
The PIL.ExifTags Module
=======================
Module Contents
---------------
**GPSTAGS** (variable) [`# <#PIL.ExifTags.GPSTAGS-variable>`_]
**TAGS** (variable) [`# <#PIL.ExifTags.TAGS-variable>`_]

12
docs/pythondoc-PIL.FitsStubImagePlugin.rst Normal file
View File

@ -0,0 +1,12 @@
==================================
The PIL.FitsStubImagePlugin Module
==================================
The PIL.FitsStubImagePlugin Module
==================================
**register\_handler(handler)**
[`# <#PIL.FitsStubImagePlugin.register_handler-function>`_]
*handler*

20
docs/pythondoc-PIL.FliImagePlugin.rst Normal file
View File

@ -0,0 +1,20 @@
=============================
The PIL.FliImagePlugin Module
=============================
The PIL.FliImagePlugin Module
=============================
**FliImageFile** (class) [`# <#PIL.FliImagePlugin.FliImageFile-class>`_]
Image plugin for the FLI/FLC animation format.
For more information about this class, see `*The FliImageFile
Class* <#PIL.FliImagePlugin.FliImageFile-class>`_.
The FliImageFile Class
----------------------
**FliImageFile** (class) [`# <#PIL.FliImagePlugin.FliImageFile-class>`_]
Image plugin for the FLI/FLC animation format. Use the **seek**
method to load individual frames.

17
docs/pythondoc-PIL.FontFile.rst Normal file
View File

@ -0,0 +1,17 @@
=======================
The PIL.FontFile Module
=======================
The PIL.FontFile Module
=======================
**FontFile()** (class) [`# <#PIL.FontFile.FontFile-class>`_]
Base class for raster font file handlers.
For more information about this class, see `*The FontFile
Class* <#PIL.FontFile.FontFile-class>`_.
The FontFile Class
------------------
**FontFile()** (class) [`# <#PIL.FontFile.FontFile-class>`_]

17
docs/pythondoc-PIL.FpxImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.FpxImagePlugin Module
=============================
The PIL.FpxImagePlugin Module
=============================
**FpxImageFile** (class) [`# <#PIL.FpxImagePlugin.FpxImageFile-class>`_]
Image plugin for the FlashPix images.
For more information about this class, see `*The FpxImageFile
Class* <#PIL.FpxImagePlugin.FpxImageFile-class>`_.
The FpxImageFile Class
----------------------
**FpxImageFile** (class) [`# <#PIL.FpxImagePlugin.FpxImageFile-class>`_]

17
docs/pythondoc-PIL.GbrImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.GbrImagePlugin Module
=============================
The PIL.GbrImagePlugin Module
=============================
**GbrImageFile** (class) [`# <#PIL.GbrImagePlugin.GbrImageFile-class>`_]
Image plugin for the GIMP brush format.
For more information about this class, see `*The GbrImageFile
Class* <#PIL.GbrImagePlugin.GbrImageFile-class>`_.
The GbrImageFile Class
----------------------
**GbrImageFile** (class) [`# <#PIL.GbrImagePlugin.GbrImageFile-class>`_]

29
docs/pythondoc-PIL.GdImageFile.rst Normal file
View File

@ -0,0 +1,29 @@
==========================
The PIL.GdImageFile Module
==========================
The PIL.GdImageFile Module
==========================
**GdImageFile** (class) [`# <#PIL.GdImageFile.GdImageFile-class>`_]
Image plugin for the GD uncompressed format.
For more information about this class, see `*The GdImageFile
Class* <#PIL.GdImageFile.GdImageFile-class>`_.
**open(fp, mode="r")** [`# <#PIL.GdImageFile.open-function>`_]
*filename*
*mode*
Returns:
Raises **IOError**:
The GdImageFile Class
---------------------
**GdImageFile** (class) [`# <#PIL.GdImageFile.GdImageFile-class>`_]
Image plugin for the GD uncompressed format. Note that this format
is not supported by the standard **Image.open** function. To use
this plugin, you have to import the **GdImageFile** module and use
the **GdImageFile.open** function.

17
docs/pythondoc-PIL.GifImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.GifImagePlugin Module
=============================
The PIL.GifImagePlugin Module
=============================
**GifImageFile** (class) [`# <#PIL.GifImagePlugin.GifImageFile-class>`_]
Image plugin for GIF images.
For more information about this class, see `*The GifImageFile
Class* <#PIL.GifImagePlugin.GifImageFile-class>`_.
The GifImageFile Class
----------------------
**GifImageFile** (class) [`# <#PIL.GifImagePlugin.GifImageFile-class>`_]

19
docs/pythondoc-PIL.GimpGradientFile.rst Normal file
View File

@ -0,0 +1,19 @@
===============================
The PIL.GimpGradientFile Module
===============================
The PIL.GimpGradientFile Module
===============================
**GimpGradientFile(fp)** (class)
[`# <#PIL.GimpGradientFile.GimpGradientFile-class>`_]
File handler for GIMP's gradient format.
For more information about this class, see `*The GimpGradientFile
Class* <#PIL.GimpGradientFile.GimpGradientFile-class>`_.
The GimpGradientFile Class
--------------------------
**GimpGradientFile(fp)** (class)
[`# <#PIL.GimpGradientFile.GimpGradientFile-class>`_]

19
docs/pythondoc-PIL.GimpPaletteFile.rst Normal file
View File

@ -0,0 +1,19 @@
==============================
The PIL.GimpPaletteFile Module
==============================
The PIL.GimpPaletteFile Module
==============================
**GimpPaletteFile(fp)** (class)
[`# <#PIL.GimpPaletteFile.GimpPaletteFile-class>`_]
File handler for GIMP's palette format.
For more information about this class, see `*The GimpPaletteFile
Class* <#PIL.GimpPaletteFile.GimpPaletteFile-class>`_.
The GimpPaletteFile Class
-------------------------
**GimpPaletteFile(fp)** (class)
[`# <#PIL.GimpPaletteFile.GimpPaletteFile-class>`_]

12
docs/pythondoc-PIL.GribStubImagePlugin.rst Normal file
View File

@ -0,0 +1,12 @@
==================================
The PIL.GribStubImagePlugin Module
==================================
The PIL.GribStubImagePlugin Module
==================================
**register\_handler(handler)**
[`# <#PIL.GribStubImagePlugin.register_handler-function>`_]
*handler*

12
docs/pythondoc-PIL.Hdf5StubImagePlugin.rst Normal file
View File

@ -0,0 +1,12 @@
==================================
The PIL.Hdf5StubImagePlugin Module
==================================
The PIL.Hdf5StubImagePlugin Module
==================================
**register\_handler(handler)**
[`# <#PIL.Hdf5StubImagePlugin.register_handler-function>`_]
*handler*

19
docs/pythondoc-PIL.IcnsImagePlugin.rst Normal file
View File

@ -0,0 +1,19 @@
==============================
The PIL.IcnsImagePlugin Module
==============================
The PIL.IcnsImagePlugin Module
==============================
**IcnsImageFile** (class)
[`# <#PIL.IcnsImagePlugin.IcnsImageFile-class>`_]
Image plugin for Mac OS icons.
For more information about this class, see `*The IcnsImageFile
Class* <#PIL.IcnsImagePlugin.IcnsImageFile-class>`_.
The IcnsImageFile Class
-----------------------
**IcnsImageFile** (class)
[`# <#PIL.IcnsImagePlugin.IcnsImageFile-class>`_]

17
docs/pythondoc-PIL.IcoImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.IcoImagePlugin Module
=============================
The PIL.IcoImagePlugin Module
=============================
**IcoImageFile** (class) [`# <#PIL.IcoImagePlugin.IcoImageFile-class>`_]
Image plugin for Windows Icon files.
For more information about this class, see `*The IcoImageFile
Class* <#PIL.IcoImagePlugin.IcoImageFile-class>`_.
The IcoImageFile Class
----------------------
**IcoImageFile** (class) [`# <#PIL.IcoImagePlugin.IcoImageFile-class>`_]

17
docs/pythondoc-PIL.ImImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
============================
The PIL.ImImagePlugin Module
============================
The PIL.ImImagePlugin Module
============================
**ImImageFile** (class) [`# <#PIL.ImImagePlugin.ImImageFile-class>`_]
Image plugin for the IFUNC IM file format.
For more information about this class, see `*The ImImageFile
Class* <#PIL.ImImagePlugin.ImImageFile-class>`_.
The ImImageFile Class
---------------------
**ImImageFile** (class) [`# <#PIL.ImImagePlugin.ImImageFile-class>`_]

555
docs/pythondoc-PIL.Image.rst Normal file
View File

@ -0,0 +1,555 @@
====================
The PIL.Image Module
====================
The PIL.Image Module
====================
**blend(im1, im2, alpha)** [`# <#PIL.Image.blend-function>`_]
Creates a new image by interpolating between two input images, using
a constant alpha.
::
out = image1 * (1.0 - alpha) + image2 * alpha
*im1*
*im2*
*alpha*
Returns:
**composite(image1, image2, mask)**
[`# <#PIL.Image.composite-function>`_]
*image1*
*image2*
*mask*
**eval(image, function)** [`# <#PIL.Image.eval-function>`_]
*image*
*function*
Returns:
**frombuffer(mode, size, data, decoder\_name="raw", \*args)**
[`# <#PIL.Image.frombuffer-function>`_]
(New in 1.1.4) Creates an image memory from pixel data in a string
or byte buffer.
This function is similar to
`**fromstring** <#PIL.Image.fromstring-function>`_, but uses data in
the byte buffer, where possible. This means that changes to the
original buffer object are reflected in this image). Not all modes
can share memory; support modes include "L", "RGBX", "RGBA", and
"CMYK". For other modes, this function behaves like a corresponding
call to the **fromstring** function.
Note that this function decodes pixel data only, not entire images.
If you have an entire image file in a string, wrap it in a
**StringIO** object, and use `**open** <#PIL.Image.open-function>`_
to load it.
*mode*
*size*
*data*
*decoder\_name*
*\*args*
Returns:
**fromstring(mode, size, data, decoder\_name="raw", \*args)**
[`# <#PIL.Image.fromstring-function>`_]
Creates an image memory from pixel data in a string.
In its simplest form, this function takes three arguments (mode,
size, and unpacked pixel data).
You can also use any pixel decoder supported by PIL. For more
information on available decoders, see the section `*Writing Your
Own File Decoder* <pil-decoder.htm>`_.
Note that this function decodes pixel data only, not entire images.
If you have an entire image in a string, wrap it in a **StringIO**
object, and use `**open** <#PIL.Image.open-function>`_ to load it.
*mode*
*size*
*data*
*decoder\_name*
*\*args*
Returns:
**getmodebandnames(mode)** [`# <#PIL.Image.getmodebandnames-function>`_]
Gets a list of individual band names. Given a mode, this function
returns a tuple containing the names of individual bands (use
`**getmodetype** <#PIL.Image.getmodetype-function>`_ to get the mode
used to store each individual band.
*mode*
Returns:
Raises **KeyError**:
**getmodebands(mode)** [`# <#PIL.Image.getmodebands-function>`_]
*mode*
Returns:
Raises **KeyError**:
**getmodebase(mode)** [`# <#PIL.Image.getmodebase-function>`_]
*mode*
Returns:
Raises **KeyError**:
**getmodetype(mode)** [`# <#PIL.Image.getmodetype-function>`_]
*mode*
Returns:
Raises **KeyError**:
**Image()** (class) [`# <#PIL.Image.Image-class>`_]
This class represents an image object.
For more information about this class, see `*The Image
Class* <#PIL.Image.Image-class>`_.
**init()** [`# <#PIL.Image.init-function>`_]
**isDirectory(f)** [`# <#PIL.Image.isDirectory-function>`_]
**isImageType(t)** [`# <#PIL.Image.isImageType-function>`_]
**isStringType(t)** [`# <#PIL.Image.isStringType-function>`_]
**isTupleType(t)** [`# <#PIL.Image.isTupleType-function>`_]
**merge(mode, bands)** [`# <#PIL.Image.merge-function>`_]
*mode*
*bands*
Returns:
**new(mode, size, color=0)** [`# <#PIL.Image.new-function>`_]
*mode*
*size*
*color*
Returns:
**open(file, mode="r")** [`# <#PIL.Image.open-function>`_]
Opens and identifies the given image file.
This is a lazy operation; this function identifies the file, but the
actual image data is not read from the file until you try to process
the data (or call the `**load** <#PIL.Image.Image.load-method>`_
method).
*file*
A filename (string) or a file object. The file object must
implement **read**, **seek**, and **tell** methods, and be
opened in binary mode.
*mode*
Returns:
Raises **IOError**:
**preinit()** [`# <#PIL.Image.preinit-function>`_]
**register\_extension(id, extension)**
[`# <#PIL.Image.register_extension-function>`_]
*id*
*extension*
**register\_mime(id, mimetype)**
[`# <#PIL.Image.register_mime-function>`_]
*id*
*mimetype*
**register\_open(id, factory, accept=None)**
[`# <#PIL.Image.register_open-function>`_]
*id*
*factory*
*accept*
**register\_save(id, driver)**
[`# <#PIL.Image.register_save-function>`_]
*id*
*driver*
The Image Class
---------------
**Image()** (class) [`# <#PIL.Image.Image-class>`_]
**convert(mode, matrix=None)** [`# <#PIL.Image.Image.convert-method>`_]
Returns a converted copy of this image. For the "P" mode, this
method translates pixels through the palette. If mode is omitted, a
mode is chosen so that all information in the image and the palette
can be represented without a palette.
The current version supports all possible conversions between "L",
"RGB" and "CMYK."
When translating a colour image to black and white (mode "L"), the
library uses the ITU-R 601-2 luma transform:
**L = R \* 299/1000 + G \* 587/1000 + B \* 114/1000**
When translating a greyscale image into a bilevel image (mode "1"),
all non-zero values are set to 255 (white). To use other thresholds,
use the `**point** <#PIL.Image.Image.point-method>`_ method.
*mode*
*matrix*
Returns:
**copy()** [`# <#PIL.Image.Image.copy-method>`_]
Returns:
**crop(box=None)** [`# <#PIL.Image.Image.crop-method>`_]
Returns a rectangular region from this image. The box is a 4-tuple
defining the left, upper, right, and lower pixel coordinate.
This is a lazy operation. Changes to the source image may or may not
be reflected in the cropped image. To break the connection, call the
`**load** <#PIL.Image.Image.load-method>`_ method on the cropped
copy.
*The*
Returns:
**draft(mode, size)** [`# <#PIL.Image.Image.draft-method>`_]
Configures the image file loader so it returns a version of the
image that as closely as possible matches the given mode and size.
For example, you can use this method to convert a colour JPEG to
greyscale while loading it, or to extract a 128x192 version from a
PCD file.
Note that this method modifies the Image object in place. If the
image has already been loaded, this method has no effect.
*mode*
*size*
**filter(filter)** [`# <#PIL.Image.Image.filter-method>`_]
Filters this image using the given filter. For a list of available
filters, see the **ImageFilter** module.
*filter*
Returns:
**fromstring(data, decoder\_name="raw", \*args)**
[`# <#PIL.Image.Image.fromstring-method>`_]
Loads this image with pixel data from a string.
This method is similar to the
`**fromstring** <#PIL.Image.fromstring-function>`_ function, but
loads data into this image instead of creating a new image object.
**getbands()** [`# <#PIL.Image.Image.getbands-method>`_]
Returns a tuple containing the name of each band in this image. For
example, **getbands** on an RGB image returns ("R", "G", "B").
Returns:
**getbbox()** [`# <#PIL.Image.Image.getbbox-method>`_]
Returns:
**getcolors(maxcolors=256)** [`# <#PIL.Image.Image.getcolors-method>`_]
*maxcolors*
Returns:
**getdata(band=None)** [`# <#PIL.Image.Image.getdata-method>`_]
Returns the contents of this image as a sequence object containing
pixel values. The sequence object is flattened, so that values for
line one follow directly after the values of line zero, and so on.
Note that the sequence object returned by this method is an internal
PIL data type, which only supports certain sequence operations. To
convert it to an ordinary sequence (e.g. for printing), use
**list(im.getdata())**.
*band*
Returns:
**getextrema()** [`# <#PIL.Image.Image.getextrema-method>`_]
Returns:
**getim()** [`# <#PIL.Image.Image.getim-method>`_]
Returns:
**getpalette()** [`# <#PIL.Image.Image.getpalette-method>`_]
Returns:
**getpixel(xy)** [`# <#PIL.Image.Image.getpixel-method>`_]
*xy*
Returns:
**getprojection()** [`# <#PIL.Image.Image.getprojection-method>`_]
Returns:
**histogram(mask=None)** [`# <#PIL.Image.Image.histogram-method>`_]
Returns a histogram for the image. The histogram is returned as a
list of pixel counts, one for each pixel value in the source image.
If the image has more than one band, the histograms for all bands
are concatenated (for example, the histogram for an "RGB" image
contains 768 values).
A bilevel image (mode "1") is treated as a greyscale ("L") image by
this method.
If a mask is provided, the method returns a histogram for those
parts of the image where the mask image is non-zero. The mask image
must have the same size as the image, and be either a bi-level image
(mode "1") or a greyscale image ("L").
*mask*
Returns:
**load()** [`# <#PIL.Image.Image.load-method>`_]
Returns:
**offset(xoffset, yoffset=None)**
[`# <#PIL.Image.Image.offset-method>`_]
(Deprecated) Returns a copy of the image where the data has been
offset by the given distances. Data wraps around the edges. If
yoffset is omitted, it is assumed to be equal to xoffset.
This method is deprecated. New code should use the **offset**
function in the **ImageChops** module.
*xoffset*
*yoffset*
Returns:
**paste(im, box=None, mask=None)**
[`# <#PIL.Image.Image.paste-method>`_]
Pastes another image into this image. The box argument is either a
2-tuple giving the upper left corner, a 4-tuple defining the left,
upper, right, and lower pixel coordinate, or None (same as (0, 0)).
If a 4-tuple is given, the size of the pasted image must match the
size of the region.
If the modes don't match, the pasted image is converted to the mode
of this image (see the
`**convert** <#PIL.Image.Image.convert-method>`_ method for
details).
Instead of an image, the source can be a integer or tuple containing
pixel values. The method then fills the region with the given
colour. When creating RGB images, you can also use colour strings as
supported by the ImageColor module.
If a mask is given, this method updates only the regions indicated
by the mask. You can use either "1", "L" or "RGBA" images (in the
latter case, the alpha band is used as mask). Where the mask is 255,
the given image is copied as is. Where the mask is 0, the current
value is preserved. Intermediate values can be used for transparency
effects.
Note that if you paste an "RGBA" image, the alpha band is ignored.
You can work around this by using the same image as both source
image and mask.
*im*
*box*
An optional 4-tuple giving the region to paste into. If a
2-tuple is used instead, it's treated as the upper left corner.
If omitted or None, the source is pasted into the upper left
corner.
If an image is given as the second argument and there is no
third, the box defaults to (0, 0), and the second argument is
interpreted as a mask image.
*mask*
Returns:
**point(lut, mode=None)** [`# <#PIL.Image.Image.point-method>`_]
*lut*
*mode*
Returns:
**putalpha(alpha)** [`# <#PIL.Image.Image.putalpha-method>`_]
*im*
**putdata(data, scale=1.0, offset=0.0)**
[`# <#PIL.Image.Image.putdata-method>`_]
Copies pixel data to this image. This method copies data from a
sequence object into the image, starting at the upper left corner
(0, 0), and continuing until either the image or the sequence ends.
The scale and offset values are used to adjust the sequence values:
**pixel = value\*scale + offset**.
*data*
*scale*
*offset*
**putpalette(data)** [`# <#PIL.Image.Image.putpalette-method>`_]
*data*
**putpixel(xy, value)** [`# <#PIL.Image.Image.putpixel-method>`_]
Modifies the pixel at the given position. The colour is given as a
single numerical value for single-band images, and a tuple for
multi-band images.
Note that this method is relatively slow. For more extensive
changes, use `**paste** <#PIL.Image.Image.paste-method>`_ or the
**ImageDraw** module instead.
*xy*
*value*
**resize(size, filter=NEAREST)** [`# <#PIL.Image.Image.resize-method>`_]
*size*
*filter*
An optional resampling filter. This can be one of **NEAREST**
(use nearest neighbour), **BILINEAR** (linear interpolation in a
2x2 environment), **BICUBIC** (cubic spline interpolation in a
4x4 environment), or **ANTIALIAS** (a high-quality downsampling
filter). If omitted, or if the image has mode "1" or "P", it is
set **NEAREST**.
Returns:
**rotate(angle, filter=NEAREST)**
[`# <#PIL.Image.Image.rotate-method>`_]
*angle*
*filter*
An optional resampling filter. This can be one of **NEAREST**
(use nearest neighbour), **BILINEAR** (linear interpolation in a
2x2 environment), or **BICUBIC** (cubic spline interpolation in
a 4x4 environment). If omitted, or if the image has mode "1" or
"P", it is set **NEAREST**.
Returns:
**save(file, format=None, \*\*options)**
[`# <#PIL.Image.Image.save-method>`_]
Saves this image under the given filename. If no format is
specified, the format to use is determined from the filename
extension, if possible.
Keyword options can be used to provide additional instructions to
the writer. If a writer doesn't recognise an option, it is silently
ignored. The available options are described later in this handbook.
You can use a file object instead of a filename. In this case, you
must always specify the format. The file object must implement the
**seek**, **tell**, and **write** methods, and be opened in binary
mode.
*file*
*format*
*\*\*options*
Returns:
Raises **KeyError**:
Raises **IOError**:
**seek(frame)** [`# <#PIL.Image.Image.seek-method>`_]
Seeks to the given frame in this sequence file. If you seek beyond
the end of the sequence, the method raises an **EOFError**
exception. When a sequence file is opened, the library automatically
seeks to frame 0.
Note that in the current version of the library, most sequence
formats only allows you to seek to the next frame.
*frame*
Raises **EOFError**:
**show(title=None)** [`# <#PIL.Image.Image.show-method>`_]
Displays this image. This method is mainly intended for debugging
purposes.
On Unix platforms, this method saves the image to a temporary PPM
file, and calls the **xv** utility.
On Windows, it saves the image to a temporary BMP file, and uses the
standard BMP display utility to show it (usually Paint).
*title*
**split()** [`# <#PIL.Image.Image.split-method>`_]
Returns:
**tell()** [`# <#PIL.Image.Image.tell-method>`_]
Returns:
**thumbnail(size, resample=NEAREST)**
[`# <#PIL.Image.Image.thumbnail-method>`_]
Make this image into a thumbnail. This method modifies the image to
contain a thumbnail version of itself, no larger than the given
size. This method calculates an appropriate thumbnail size to
preserve the aspect of the image, calls the
`**draft** <#PIL.Image.Image.draft-method>`_ method to configure the
file reader (where applicable), and finally resizes the image.
Note that the bilinear and bicubic filters in the current version of
PIL are not well-suited for thumbnail generation. You should use
**ANTIALIAS** unless speed is much more important than quality.
Also note that this function modifies the Image object in place. If
you need to use the full resolution image as well, apply this method
to a `**copy** <#PIL.Image.Image.copy-method>`_ of the original
image.
*size*
*resample*
Optional resampling filter. This can be one of **NEAREST**,
**BILINEAR**, **BICUBIC**, or **ANTIALIAS** (best quality). If
omitted, it defaults to **NEAREST** (this will be changed to
ANTIALIAS in a future version).
Returns:
**tobitmap(name="image")** [`# <#PIL.Image.Image.tobitmap-method>`_]
*name*
Returns:
Raises **ValueError**:
**tostring(encoder\_name="raw", \*args)**
[`# <#PIL.Image.Image.tostring-method>`_]
*encoder\_name*
*\*args*
Returns:
**transform(size, method, data, resample=NEAREST)**
[`# <#PIL.Image.Image.transform-method>`_]
Transforms this image. This method creates a new image with the
given size, and the same mode as the original, and copies data to
the new image using the given transform.
*size*
*method*
The transformation method. This is one of **EXTENT** (cut out a
rectangular subregion), **AFFINE** (affine transform),
**PERSPECTIVE** (perspective transform), **QUAD** (map a
quadrilateral to a rectangle), or **MESH** (map a number of
source quadrilaterals in one operation).
*data*
*resample*
Optional resampling filter. It can be one of **NEAREST** (use
nearest neighbour), **BILINEAR** (linear interpolation in a 2x2
environment), or **BICUBIC** (cubic spline interpolation in a
4x4 environment). If omitted, or if the image has mode "1" or
"P", it is set to **NEAREST**.
Returns:
**transpose(method)** [`# <#PIL.Image.Image.transpose-method>`_]
*method*
One of **FLIP\_LEFT\_RIGHT**, **FLIP\_TOP\_BOTTOM**,
**ROTATE\_90**, **ROTATE\_180**, or **ROTATE\_270**.
**verify()** [`# <#PIL.Image.Image.verify-method>`_]

163
docs/pythondoc-PIL.ImageChops.rst Normal file
View File

@ -0,0 +1,163 @@
=========================
The PIL.ImageChops Module
=========================
The PIL.ImageChops Module
=========================
The **ImageChops** module contains a number of arithmetical image
operations, called *channel operations* ("chops"). These can be used for
various purposes, including special effects, image compositions,
algorithmic painting, and more.
At this time, channel operations are only implemented for 8-bit images
(e.g. "L" and "RGB").
Most channel operations take one or two image arguments and returns a
new image. Unless otherwise noted, the result of a channel operation is
always clipped to the range 0 to MAX (which is 255 for all modes
supported by the operations in this module).
Module Contents
---------------
**add(image1, image2, scale=1.0, offset=0)**
[`# <#PIL.ImageChops.add-function>`_]
Add images ((image1 + image2) / scale + offset).
Adds two images, dividing the result by scale and adding the offset.
If omitted, scale defaults to 1.0, and offset to 0.0.
*image1*
*image1*
Returns:
**add\_modulo(image1, image2)**
[`# <#PIL.ImageChops.add_modulo-function>`_]
Add images without clipping ((image1 + image2) % MAX).
Adds two images, without clipping the result.
*image1*
*image1*
Returns:
**blend(image1, image2, alpha)** [`# <#PIL.ImageChops.blend-function>`_]
Blend images using constant transparency weight.
Same as the **blend** function in the **Image** module.
**composite(image1, image2, mask)**
[`# <#PIL.ImageChops.composite-function>`_]
Create composite using transparency mask.
Same as the **composite** function in the **Image** module.
**constant(image, value)** [`# <#PIL.ImageChops.constant-function>`_]
*image*
*value*
Returns:
**darker(image1, image2)** [`# <#PIL.ImageChops.darker-function>`_]
Compare images, and return darker pixel value (min(image1, image2)).
Compares the two images, pixel by pixel, and returns a new image
containing the darker values.
*image1*
*image1*
Returns:
**difference(image1, image2)**
[`# <#PIL.ImageChops.difference-function>`_]
Calculate absolute difference (abs(image1 - image2)).
Returns the absolute value of the difference between the two images.
*image1*
*image1*
Returns:
**duplicate(image)** [`# <#PIL.ImageChops.duplicate-function>`_]
*image*
Returns:
**invert(image)** [`# <#PIL.ImageChops.invert-function>`_]
*image*
Returns:
**lighter(image1, image2)** [`# <#PIL.ImageChops.lighter-function>`_]
Compare images, and return lighter pixel value (max(image1,
image2)).
Compares the two images, pixel by pixel, and returns a new image
containing the lighter values.
*image1*
*image1*
Returns:
**logical\_and(image1, image2)**
[`# <#PIL.ImageChops.logical_and-function>`_]
**logical\_or(image1, image2)**
[`# <#PIL.ImageChops.logical_or-function>`_]
**logical\_xor(image1, image2)**
[`# <#PIL.ImageChops.logical_xor-function>`_]
**multiply(image1, image2)** [`# <#PIL.ImageChops.multiply-function>`_]
Superimpose positive images (image1 \* image2 / MAX).
Superimposes two images on top of each other. If you multiply an
image with a solid black image, the result is black. If you multiply
with a solid white image, the image is unaffected.
*image1*
*image1*
Returns:
**offset(image, xoffset, yoffset=None)**
[`# <#PIL.ImageChops.offset-function>`_]
Offset image data.
Returns a copy of the image where data has been offset by the given
distances. Data wraps around the edges. If yoffset is omitted, it is
assumed to be equal to xoffset.
*image*
*xoffset*
*yoffset*
Returns:
**screen(image1, image2)** [`# <#PIL.ImageChops.screen-function>`_]
Superimpose negative images (MAX - ((MAX - image1) \* (MAX - image2)
/ MAX)).
Superimposes two inverted images on top of each other.
*image1*
*image1*
Returns:
**subtract(image1, image2, scale=1.0, offset=0)**
[`# <#PIL.ImageChops.subtract-function>`_]
Subtract images ((image1 - image2) / scale + offset).
Subtracts two images, dividing the result by scale and adding the
offset. If omitted, scale defaults to 1.0, and offset to 0.0.
*image1*
*image1*
Returns:
**subtract\_modulo(image1, image2)**
[`# <#PIL.ImageChops.subtract_modulo-function>`_]
Subtract images without clipping ((image1 - image2) % MAX).
Subtracts two images, without clipping the result.
*image1*
*image1*
Returns:

13
docs/pythondoc-PIL.ImageColor.rst Normal file
View File

@ -0,0 +1,13 @@
=========================
The PIL.ImageColor Module
=========================
The PIL.ImageColor Module
=========================
**getrgb(color)** [`# <#PIL.ImageColor.getrgb-function>`_]
*color*
Returns:
Raises **ValueError**:

69
docs/pythondoc-PIL.ImageDraw.rst Normal file
View File

@ -0,0 +1,69 @@
========================
The PIL.ImageDraw Module
========================
The PIL.ImageDraw Module
========================
**Draw(im, mode=None)** [`# <#PIL.ImageDraw.Draw-function>`_]
*im*
*mode*
**getdraw(im=None, hints=None)**
[`# <#PIL.ImageDraw.getdraw-function>`_]
*im*
*hints*
Returns:
**ImageDraw(im, mode=None)** (class)
[`# <#PIL.ImageDraw.ImageDraw-class>`_]
A simple 2D drawing interface for PIL images.
For more information about this class, see `*The ImageDraw
Class* <#PIL.ImageDraw.ImageDraw-class>`_.
The ImageDraw Class
-------------------
**ImageDraw(im, mode=None)** (class)
[`# <#PIL.ImageDraw.ImageDraw-class>`_]
A simple 2D drawing interface for PIL images.
Application code should use the **Draw** factory, instead of
directly.
**\_\_init\_\_(im, mode=None)**
[`# <#PIL.ImageDraw.ImageDraw.__init__-method>`_]
*im*
*mode*
**arc(xy, start, end, fill=None)**
[`# <#PIL.ImageDraw.ImageDraw.arc-method>`_]
**bitmap(xy, bitmap, fill=None)**
[`# <#PIL.ImageDraw.ImageDraw.bitmap-method>`_]
**chord(xy, start, end, fill=None, outline=None)**
[`# <#PIL.ImageDraw.ImageDraw.chord-method>`_]
**ellipse(xy, fill=None, outline=None)**
[`# <#PIL.ImageDraw.ImageDraw.ellipse-method>`_]
**getfont()** [`# <#PIL.ImageDraw.ImageDraw.getfont-method>`_]
**line(xy, fill=None, width=0)**
[`# <#PIL.ImageDraw.ImageDraw.line-method>`_]
**pieslice(xy, start, end, fill=None, outline=None)**
[`# <#PIL.ImageDraw.ImageDraw.pieslice-method>`_]
**point(xy, fill=None)** [`# <#PIL.ImageDraw.ImageDraw.point-method>`_]
**polygon(xy, fill=None, outline=None)**
[`# <#PIL.ImageDraw.ImageDraw.polygon-method>`_]
**rectangle(xy, fill=None, outline=None)**
[`# <#PIL.ImageDraw.ImageDraw.rectangle-method>`_]
**setfill(onoff)** [`# <#PIL.ImageDraw.ImageDraw.setfill-method>`_]
**setfont(font)** [`# <#PIL.ImageDraw.ImageDraw.setfont-method>`_]
**setink(ink)** [`# <#PIL.ImageDraw.ImageDraw.setink-method>`_]
**shape(shape, fill=None, outline=None)**
[`# <#PIL.ImageDraw.ImageDraw.shape-method>`_]
**text(xy, text, fill=None, font=None, anchor=None)**
[`# <#PIL.ImageDraw.ImageDraw.text-method>`_]
**textsize(text, font=None)**
[`# <#PIL.ImageDraw.ImageDraw.textsize-method>`_]

74
docs/pythondoc-PIL.ImageEnhance.rst Normal file
View File

@ -0,0 +1,74 @@
===========================
The PIL.ImageEnhance Module
===========================
The PIL.ImageEnhance Module
===========================
**Brightness(image)** (class)
[`# <#PIL.ImageEnhance.Brightness-class>`_]
Brightness enhancement object.
For more information about this class, see `*The Brightness
Class* <#PIL.ImageEnhance.Brightness-class>`_.
**Color(image)** (class) [`# <#PIL.ImageEnhance.Color-class>`_]
Color enhancement object.
For more information about this class, see `*The Color
Class* <#PIL.ImageEnhance.Color-class>`_.
**Contrast(image)** (class) [`# <#PIL.ImageEnhance.Contrast-class>`_]
Contrast enhancement object.
For more information about this class, see `*The Contrast
Class* <#PIL.ImageEnhance.Contrast-class>`_.
**Sharpness(image)** (class) [`# <#PIL.ImageEnhance.Sharpness-class>`_]
Sharpness enhancement object.
For more information about this class, see `*The Sharpness
Class* <#PIL.ImageEnhance.Sharpness-class>`_.
The Brightness Class
--------------------
**Brightness(image)** (class)
[`# <#PIL.ImageEnhance.Brightness-class>`_]
Brightness enhancement object.
This class can be used to control the brighntess of an image. An
enhancement factor of 0.0 gives a black image, factor 1.0 gives the
original image.
The Color Class
---------------
**Color(image)** (class) [`# <#PIL.ImageEnhance.Color-class>`_]
Color enhancement object.
This class can be used to adjust the colour balance of an image, in
a manner similar to the controls on a colour TV set. An enhancement
factor of 0.0 gives a black and white image, a factor of 1.0 gives
the original image.
The Contrast Class
------------------
**Contrast(image)** (class) [`# <#PIL.ImageEnhance.Contrast-class>`_]
Contrast enhancement object.
This class can be used to control the contrast of an image, similar
to the contrast control on a TV set. An enhancement factor of 0.0
gives an solid grey image, factor 1.0 gives the original image.
The Sharpness Class
-------------------
**Sharpness(image)** (class) [`# <#PIL.ImageEnhance.Sharpness-class>`_]
Sharpness enhancement object.
This class can be used to adjust the sharpness of an image. The
enhancement factor 0.0 gives a blurred image, 1.0 gives the original
image, and a factor of 2.0 gives a sharpened image.

84
docs/pythondoc-PIL.ImageFile.rst Normal file
View File

@ -0,0 +1,84 @@
========================
The PIL.ImageFile Module
========================
The PIL.ImageFile Module
========================
**\_ParserFile(data)** (class) [`# <#PIL.ImageFile._ParserFile-class>`_]
(Internal) Support class for the Parser file.
For more information about this class, see `*The \_ParserFile
Class* <#PIL.ImageFile._ParserFile-class>`_.
**\_safe\_read(fp, size)** [`# <#PIL.ImageFile._safe_read-function>`_]
*fp*
File handle. Must implement a **read** method.
*size*
Returns:
A string containing up to *size* bytes of data.
**\_save(im, fp, tile)** [`# <#PIL.ImageFile._save-function>`_]
*im*
*fp*
*tile*
**ImageFile(fp=None, filename=None)** (class)
[`# <#PIL.ImageFile.ImageFile-class>`_]
Base class for image file handlers.
For more information about this class, see `*The ImageFile
Class* <#PIL.ImageFile.ImageFile-class>`_.
**Parser** (class) [`# <#PIL.ImageFile.Parser-class>`_]
Incremental image parser.
For more information about this class, see `*The Parser
Class* <#PIL.ImageFile.Parser-class>`_.
**StubImageFile** (class) [`# <#PIL.ImageFile.StubImageFile-class>`_]
Base class for stub image loaders.
For more information about this class, see `*The StubImageFile
Class* <#PIL.ImageFile.StubImageFile-class>`_.
The \_ParserFile Class
----------------------
**\_ParserFile(data)** (class) [`# <#PIL.ImageFile._ParserFile-class>`_]
(Internal) Support class for the **Parser** file.
The ImageFile Class
-------------------
**ImageFile(fp=None, filename=None)** (class)
[`# <#PIL.ImageFile.ImageFile-class>`_]
The Parser Class
----------------
**Parser** (class) [`# <#PIL.ImageFile.Parser-class>`_]
**close()** [`# <#PIL.ImageFile.Parser.close-method>`_]
Returns:
Raises **IOError**:
**feed(data)** [`# <#PIL.ImageFile.Parser.feed-method>`_]
*data*
Raises **IOError**:
**reset()** [`# <#PIL.ImageFile.Parser.reset-method>`_]
The StubImageFile Class
-----------------------
**StubImageFile** (class) [`# <#PIL.ImageFile.StubImageFile-class>`_]
Base class for stub image loaders.
A stub loader is an image loader that can identify files of a
certain format, but relies on external code to load the file.
**\_load()** [`# <#PIL.ImageFile.StubImageFile._load-method>`_]

32
docs/pythondoc-PIL.ImageFileIO.rst Normal file
View File

@ -0,0 +1,32 @@
==========================
The PIL.ImageFileIO Module
==========================
The PIL.ImageFileIO Module
==========================
**ImageFileIO(fp)** (class) [`# <#PIL.ImageFileIO.ImageFileIO-class>`_]
The ImageFileIO module can be used to read an image from a socket,
or any other stream device.
For more information about this class, see `*The ImageFileIO
Class* <#PIL.ImageFileIO.ImageFileIO-class>`_.
The ImageFileIO Class
---------------------
**ImageFileIO(fp)** (class) [`# <#PIL.ImageFileIO.ImageFileIO-class>`_]
The **ImageFileIO** module can be used to read an image from a
socket, or any other stream device.
This module is deprecated. New code should use the **Parser** class
in the `ImageFile <imagefile>`_ module instead.
**\_\_init\_\_(fp)**
[`# <#PIL.ImageFileIO.ImageFileIO.__init__-method>`_]
Adds buffering to a stream file object, in order to provide **seek**
and **tell** methods required by the **Image.open** method. The
stream object must implement **read** and **close** methods.
*fp*

226
docs/pythondoc-PIL.ImageFilter.rst Normal file
View File

@ -0,0 +1,226 @@
==========================
The PIL.ImageFilter Module
==========================
The PIL.ImageFilter Module
==========================
**BLUR** (class) [`# <#PIL.ImageFilter.BLUR-class>`_]
Blur filter.
For more information about this class, see `*The BLUR
Class* <#PIL.ImageFilter.BLUR-class>`_.
**CONTOUR** (class) [`# <#PIL.ImageFilter.CONTOUR-class>`_]
Contour filter.
For more information about this class, see `*The CONTOUR
Class* <#PIL.ImageFilter.CONTOUR-class>`_.
**DETAIL** (class) [`# <#PIL.ImageFilter.DETAIL-class>`_]
Detail filter.
For more information about this class, see `*The DETAIL
Class* <#PIL.ImageFilter.DETAIL-class>`_.
**EDGE\_ENHANCE** (class) [`# <#PIL.ImageFilter.EDGE_ENHANCE-class>`_]
Edge enhancement filter.
For more information about this class, see `*The EDGE\_ENHANCE
Class* <#PIL.ImageFilter.EDGE_ENHANCE-class>`_.
**EDGE\_ENHANCE\_MORE** (class)
[`# <#PIL.ImageFilter.EDGE_ENHANCE_MORE-class>`_]
Stronger edge enhancement filter.
For more information about this class, see `*The EDGE\_ENHANCE\_MORE
Class* <#PIL.ImageFilter.EDGE_ENHANCE_MORE-class>`_.
**EMBOSS** (class) [`# <#PIL.ImageFilter.EMBOSS-class>`_]
Embossing filter.
For more information about this class, see `*The EMBOSS
Class* <#PIL.ImageFilter.EMBOSS-class>`_.
**FIND\_EDGES** (class) [`# <#PIL.ImageFilter.FIND_EDGES-class>`_]
Edge-finding filter.
For more information about this class, see `*The FIND\_EDGES
Class* <#PIL.ImageFilter.FIND_EDGES-class>`_.
**Kernel(size, kernel, \*\*options)** (class)
[`# <#PIL.ImageFilter.Kernel-class>`_]
Convolution filter kernel.
For more information about this class, see `*The Kernel
Class* <#PIL.ImageFilter.Kernel-class>`_.
**MaxFilter(size=3)** (class) [`# <#PIL.ImageFilter.MaxFilter-class>`_]
Max filter.
For more information about this class, see `*The MaxFilter
Class* <#PIL.ImageFilter.MaxFilter-class>`_.
**MedianFilter(size=3)** (class)
[`# <#PIL.ImageFilter.MedianFilter-class>`_]
Median filter.
For more information about this class, see `*The MedianFilter
Class* <#PIL.ImageFilter.MedianFilter-class>`_.
**MinFilter(size=3)** (class) [`# <#PIL.ImageFilter.MinFilter-class>`_]
Min filter.
For more information about this class, see `*The MinFilter
Class* <#PIL.ImageFilter.MinFilter-class>`_.
**ModeFilter(size=3)** (class)
[`# <#PIL.ImageFilter.ModeFilter-class>`_]
Mode filter.
For more information about this class, see `*The ModeFilter
Class* <#PIL.ImageFilter.ModeFilter-class>`_.
**RankFilter(size, rank)** (class)
[`# <#PIL.ImageFilter.RankFilter-class>`_]
Rank filter.
For more information about this class, see `*The RankFilter
Class* <#PIL.ImageFilter.RankFilter-class>`_.
**SHARPEN** (class) [`# <#PIL.ImageFilter.SHARPEN-class>`_]
Sharpening filter.
For more information about this class, see `*The SHARPEN
Class* <#PIL.ImageFilter.SHARPEN-class>`_.
**SMOOTH** (class) [`# <#PIL.ImageFilter.SMOOTH-class>`_]
Smoothing filter.
For more information about this class, see `*The SMOOTH
Class* <#PIL.ImageFilter.SMOOTH-class>`_.
**SMOOTH\_MORE** (class) [`# <#PIL.ImageFilter.SMOOTH_MORE-class>`_]
Stronger smoothing filter.
For more information about this class, see `*The SMOOTH\_MORE
Class* <#PIL.ImageFilter.SMOOTH_MORE-class>`_.
The BLUR Class
--------------
**BLUR** (class) [`# <#PIL.ImageFilter.BLUR-class>`_]
The CONTOUR Class
-----------------
**CONTOUR** (class) [`# <#PIL.ImageFilter.CONTOUR-class>`_]
The DETAIL Class
----------------
**DETAIL** (class) [`# <#PIL.ImageFilter.DETAIL-class>`_]
The EDGE\_ENHANCE Class
-----------------------
**EDGE\_ENHANCE** (class) [`# <#PIL.ImageFilter.EDGE_ENHANCE-class>`_]
The EDGE\_ENHANCE\_MORE Class
-----------------------------
**EDGE\_ENHANCE\_MORE** (class)
[`# <#PIL.ImageFilter.EDGE_ENHANCE_MORE-class>`_]
The EMBOSS Class
----------------
**EMBOSS** (class) [`# <#PIL.ImageFilter.EMBOSS-class>`_]
The FIND\_EDGES Class
---------------------
**FIND\_EDGES** (class) [`# <#PIL.ImageFilter.FIND_EDGES-class>`_]
The Kernel Class
----------------
**Kernel(size, kernel, \*\*options)** (class)
[`# <#PIL.ImageFilter.Kernel-class>`_]
**\_\_init\_\_(size, kernel, \*\*options)**
[`# <#PIL.ImageFilter.Kernel.__init__-method>`_]
Create a convolution kernel. The current version only supports 3x3
and 5x5 integer and floating point kernels.
In the current version, kernels can only be applied to "L" and "RGB"
images.
*size*
*kernel*
*\*\*options*
*scale=*
*offset=*
The MaxFilter Class
-------------------
**MaxFilter(size=3)** (class) [`# <#PIL.ImageFilter.MaxFilter-class>`_]
**\_\_init\_\_(size=3)**
[`# <#PIL.ImageFilter.MaxFilter.__init__-method>`_]
*size*
The MedianFilter Class
----------------------
**MedianFilter(size=3)** (class)
[`# <#PIL.ImageFilter.MedianFilter-class>`_]
**\_\_init\_\_(size=3)**
[`# <#PIL.ImageFilter.MedianFilter.__init__-method>`_]
*size*
The MinFilter Class
-------------------
**MinFilter(size=3)** (class) [`# <#PIL.ImageFilter.MinFilter-class>`_]
**\_\_init\_\_(size=3)**
[`# <#PIL.ImageFilter.MinFilter.__init__-method>`_]
*size*
The ModeFilter Class
--------------------
**ModeFilter(size=3)** (class)
[`# <#PIL.ImageFilter.ModeFilter-class>`_]
**\_\_init\_\_(size=3)**
[`# <#PIL.ImageFilter.ModeFilter.__init__-method>`_]
*size*
The RankFilter Class
--------------------
**RankFilter(size, rank)** (class)
[`# <#PIL.ImageFilter.RankFilter-class>`_]
**\_\_init\_\_(size, rank)**
[`# <#PIL.ImageFilter.RankFilter.__init__-method>`_]
*size*
*rank*
The SHARPEN Class
-----------------
**SHARPEN** (class) [`# <#PIL.ImageFilter.SHARPEN-class>`_]
The SMOOTH Class
----------------
**SMOOTH** (class) [`# <#PIL.ImageFilter.SMOOTH-class>`_]
The SMOOTH\_MORE Class
----------------------
**SMOOTH\_MORE** (class) [`# <#PIL.ImageFilter.SMOOTH_MORE-class>`_]

98
docs/pythondoc-PIL.ImageFont.rst Normal file
View File

@ -0,0 +1,98 @@
========================
The PIL.ImageFont Module
========================
The PIL.ImageFont Module
========================
**FreeTypeFont(file, size, index=0, encoding="")** (class)
[`# <#PIL.ImageFont.FreeTypeFont-class>`_]
Wrapper for FreeType fonts.
For more information about this class, see `*The FreeTypeFont
Class* <#PIL.ImageFont.FreeTypeFont-class>`_.
**ImageFont** (class) [`# <#PIL.ImageFont.ImageFont-class>`_]
The ImageFont module defines a class with the same name.
For more information about this class, see `*The ImageFont
Class* <#PIL.ImageFont.ImageFont-class>`_.
**load(filename)** [`# <#PIL.ImageFont.load-function>`_]
*filename*
Returns:
Raises **IOError**:
**load\_default()** [`# <#PIL.ImageFont.load_default-function>`_]
Returns:
**load\_path(filename)** [`# <#PIL.ImageFont.load_path-function>`_]
*filename*
Returns:
Raises **IOError**:
**TransposedFont(font, orientation=None)** (class)
[`# <#PIL.ImageFont.TransposedFont-class>`_]
Wrapper that creates a transposed font from any existing font
object.
*font*
*orientation*
For more information about this class, see `*The TransposedFont
Class* <#PIL.ImageFont.TransposedFont-class>`_.
**truetype(filename, size, index=0, encoding="")**
[`# <#PIL.ImageFont.truetype-function>`_]
Load a TrueType or OpenType font file, and create a font object.
This function loads a font object from the given file, and creates a
font object for a font of the given size.
This function requires the \_imagingft service.
*filename*
A truetype font file. Under Windows, if the file is not found in
this filename, the loader also looks in Windows **fonts**
directory
*size*
*index*
*encoding*
Returns:
Raises **IOError**:
The FreeTypeFont Class
----------------------
**FreeTypeFont(file, size, index=0, encoding="")** (class)
[`# <#PIL.ImageFont.FreeTypeFont-class>`_]
Wrapper for FreeType fonts. Application code should use the
**truetype** factory function to create font objects.
The ImageFont Class
-------------------
**ImageFont** (class) [`# <#PIL.ImageFont.ImageFont-class>`_]
The **ImageFont** module defines a class with the same name.
Instances of this class store bitmap fonts, and are used with the
**text** method of the **ImageDraw** class.
PIL uses it's own font file format to store bitmap fonts. You can
use the **pilfont** utility to convert BDF and PCF font descriptors
(X window font formats) to this format.
Starting with version 1.1.4, PIL can be configured to support
TrueType and OpenType fonts. For earlier version, TrueType support
is only available as part of the imToolkit package
The TransposedFont Class
------------------------
**TransposedFont(font, orientation=None)** (class)
[`# <#PIL.ImageFont.TransposedFont-class>`_]
*font*
*orientation*

20
docs/pythondoc-PIL.ImageGL.rst Normal file
View File

@ -0,0 +1,20 @@
======================
The PIL.ImageGL Module
======================
The PIL.ImageGL Module
======================
Module Contents
---------------
**TextureFactory** (class) [`# <#PIL.ImageGL.TextureFactory-class>`_]
Texture factory.
For more information about this class, see `*The TextureFactory
Class* <#PIL.ImageGL.TextureFactory-class>`_.
The TextureFactory Class
------------------------
**TextureFactory** (class) [`# <#PIL.ImageGL.TextureFactory-class>`_]

24
docs/pythondoc-PIL.ImageGrab.rst Normal file
View File

@ -0,0 +1,24 @@
========================
The PIL.ImageGrab Module
========================
The PIL.ImageGrab Module
========================
(New in 1.1.3) The **ImageGrab** module can be used to copy the contents
of the screen to a PIL image memory.
The current version works on Windows only.
Module Contents
---------------
**grab(bbox=None)** [`# <#PIL.ImageGrab.grab-function>`_]
*bbox*
Returns:
**grabclipboard()** [`# <#PIL.ImageGrab.grabclipboard-function>`_]
Returns:

113
docs/pythondoc-PIL.ImageOps.rst Normal file
View File

@ -0,0 +1,113 @@
=======================
The PIL.ImageOps Module
=======================
The PIL.ImageOps Module
=======================
(New in 1.1.3) The **ImageOps** module contains a number of 'ready-made'
image processing operations. This module is somewhat experimental, and
most operators only work on L and RGB images.
Module Contents
---------------
**autocontrast(image, cutoff=0, ignore=None)**
[`# <#PIL.ImageOps.autocontrast-function>`_]
Maximize (normalize) image contrast. This function calculates a
histogram of the input image, removes *cutoff* percent of the
lightest and darkest pixels from the histogram, and remaps the image
so that the darkest pixel becomes black (0), and the lightest
becomes white (255).
*image*
*cutoff*
*ignore*
Returns:
**colorize(image, black, white)**
[`# <#PIL.ImageOps.colorize-function>`_]
Colorize grayscale image. The *black* and *white* arguments should
be RGB tuples; this function calculates a colour wedge mapping all
black pixels in the source image to the first colour, and all white
pixels to the second colour.
*image*
*black*
*white*
Returns:
**crop(image, border=0)** [`# <#PIL.ImageOps.crop-function>`_]
*image*
*border*
Returns:
**deform(image, deformer, resample=Image.BILINEAR)**
[`# <#PIL.ImageOps.deform-function>`_]
*image*
*deformer*
*resample*
Returns:
**equalize(image, mask=None)** [`# <#PIL.ImageOps.equalize-function>`_]
*image*
*mask*
Returns:
**expand(image, border=0, fill=0)**
[`# <#PIL.ImageOps.expand-function>`_]
*image*
*border*
*fill*
Returns:
**fit(image, size, method=Image.NEAREST, bleed=0.0, centering=(0.5,
0.5))** [`# <#PIL.ImageOps.fit-function>`_]
Returns a sized and cropped version of the image, cropped to the
requested aspect ratio and size.
The **fit** function was contributed by Kevin Cazabon.
*size*
*method*
*bleed*
*centering*
Returns:
**flip(image)** [`# <#PIL.ImageOps.flip-function>`_]
*image*
Returns:
**grayscale(image)** [`# <#PIL.ImageOps.grayscale-function>`_]
*image*
Returns:
**invert(image)** [`# <#PIL.ImageOps.invert-function>`_]
*image*
Returns:
**mirror(image)** [`# <#PIL.ImageOps.mirror-function>`_]
*image*
Returns:
**posterize(image, bits)** [`# <#PIL.ImageOps.posterize-function>`_]
*image*
*bits*
Returns:
**solarize(image, threshold=128)**
[`# <#PIL.ImageOps.solarize-function>`_]
*image*
*threshold*
Returns:

19
docs/pythondoc-PIL.ImagePalette.rst Normal file
View File

@ -0,0 +1,19 @@
===========================
The PIL.ImagePalette Module
===========================
The PIL.ImagePalette Module
===========================
**ImagePalette(mode="RGB", palette=None)** (class)
[`# <#PIL.ImagePalette.ImagePalette-class>`_]
Colour palette wrapper for palette mapped images.
For more information about this class, see `*The ImagePalette
Class* <#PIL.ImagePalette.ImagePalette-class>`_.
The ImagePalette Class
----------------------
**ImagePalette(mode="RGB", palette=None)** (class)
[`# <#PIL.ImagePalette.ImagePalette-class>`_]

30
docs/pythondoc-PIL.ImagePath.rst Normal file
View File

@ -0,0 +1,30 @@
========================
The PIL.ImagePath Module
========================
The PIL.ImagePath Module
========================
**Path(xy)** (class) [`# <#PIL.ImagePath.Path-class>`_]
Path wrapper.
For more information about this class, see `*The Path
Class* <#PIL.ImagePath.Path-class>`_.
The Path Class
--------------
**Path(xy)** (class) [`# <#PIL.ImagePath.Path-class>`_]
**\_\_init\_\_(xy)** [`# <#PIL.ImagePath.Path.__init__-method>`_]
*xy*
**compact(distance=2)** [`# <#PIL.ImagePath.Path.compact-method>`_]
**getbbox()** [`# <#PIL.ImagePath.Path.getbbox-method>`_]
**map(function)** [`# <#PIL.ImagePath.Path.map-method>`_]
**tolist(flat=0)** [`# <#PIL.ImagePath.Path.tolist-method>`_]
*flat*
Returns:
**transform(matrix)** [`# <#PIL.ImagePath.Path.transform-method>`_]

23
docs/pythondoc-PIL.ImageSequence.rst Normal file
View File

@ -0,0 +1,23 @@
============================
The PIL.ImageSequence Module
============================
The PIL.ImageSequence Module
============================
**Iterator(im)** (class) [`# <#PIL.ImageSequence.Iterator-class>`_]
This class implements an iterator object that can be used to loop
over an image sequence.
For more information about this class, see `*The Iterator
Class* <#PIL.ImageSequence.Iterator-class>`_.
The Iterator Class
------------------
**Iterator(im)** (class) [`# <#PIL.ImageSequence.Iterator-class>`_]
**\_\_init\_\_(im)**
[`# <#PIL.ImageSequence.Iterator.__init__-method>`_]
*im*

29
docs/pythondoc-PIL.ImageStat.rst Normal file
View File

@ -0,0 +1,29 @@
========================
The PIL.ImageStat Module
========================
The PIL.ImageStat Module
========================
The **ImageStat** module calculates global statistics for an image, or a
region of an image.
Module Contents
---------------
**Stat(image, mask=None)** (class) [`# <#PIL.ImageStat.Stat-class>`_]
Calculate statistics for the given image.
For more information about this class, see `*The Stat
Class* <#PIL.ImageStat.Stat-class>`_.
The Stat Class
--------------
**Stat(image, mask=None)** (class) [`# <#PIL.ImageStat.Stat-class>`_]
**\_\_init\_\_(image, mask=None)**
[`# <#PIL.ImageStat.Stat.__init__-method>`_]
*image*
*mask*

92
docs/pythondoc-PIL.ImageTk.rst Normal file
View File

@ -0,0 +1,92 @@
======================
The PIL.ImageTk Module
======================
The PIL.ImageTk Module
======================
The **ImageTk** module contains support to create and modify Tkinter
**BitmapImage** and **PhotoImage** objects.
For examples, see the demo programs in the *Scripts* directory.
Module Contents
---------------
**BitmapImage(image=None, \*\*options)** (class)
[`# <#PIL.ImageTk.BitmapImage-class>`_]
Create a Tkinter-compatible bitmap image.
For more information about this class, see `*The BitmapImage
Class* <#PIL.ImageTk.BitmapImage-class>`_.
**getimage(photo)** [`# <#PIL.ImageTk.getimage-function>`_]
**PhotoImage(image=None, size=None, \*\*options)** (class)
[`# <#PIL.ImageTk.PhotoImage-class>`_]
Creates a Tkinter-compatible photo image.
For more information about this class, see `*The PhotoImage
Class* <#PIL.ImageTk.PhotoImage-class>`_.
The BitmapImage Class
---------------------
**BitmapImage(image=None, \*\*options)** (class)
[`# <#PIL.ImageTk.BitmapImage-class>`_]
**\_\_init\_\_(image=None, \*\*options)**
[`# <#PIL.ImageTk.BitmapImage.__init__-method>`_]
Create a Tkinter-compatible bitmap image.
The given image must have mode "1". Pixels having value 0 are
treated as transparent. Options, if any, are passed on to Tkinter.
The most commonly used option is **foreground**, which is used to
specify the colour for the non-transparent parts. See the Tkinter
documentation for information on how to specify colours.
*image*
**\_\_str\_\_()** [`# <#PIL.ImageTk.BitmapImage.__str__-method>`_]
Returns:
**height()** [`# <#PIL.ImageTk.BitmapImage.height-method>`_]
Returns:
**width()** [`# <#PIL.ImageTk.BitmapImage.width-method>`_]
Returns:
The PhotoImage Class
--------------------
**PhotoImage(image=None, size=None, \*\*options)** (class)
[`# <#PIL.ImageTk.PhotoImage-class>`_]
**\_\_init\_\_(image=None, size=None, \*\*options)**
[`# <#PIL.ImageTk.PhotoImage.__init__-method>`_]
Create a photo image object. The constructor takes either a PIL
image, or a mode and a size. Alternatively, you can use the **file**
or **data** options to initialize the photo image object.
*image*
*size*
*file=*
*data=*
**\_\_str\_\_()** [`# <#PIL.ImageTk.PhotoImage.__str__-method>`_]
Returns:
**height()** [`# <#PIL.ImageTk.PhotoImage.height-method>`_]
Returns:
**paste(im, box=None)** [`# <#PIL.ImageTk.PhotoImage.paste-method>`_]
*im*
*box*
**width()** [`# <#PIL.ImageTk.PhotoImage.width-method>`_]
Returns:

114
docs/pythondoc-PIL.ImageTransform.rst Normal file
View File

@ -0,0 +1,114 @@
=============================
The PIL.ImageTransform Module
=============================
The PIL.ImageTransform Module
=============================
**AffineTransform** (class)
[`# <#PIL.ImageTransform.AffineTransform-class>`_]
Define an affine image transform.
*matrix*
A 6-tuple (*a, b, c, d, e, f*) containing the first two rows
from an affine transform matrix.
For more information about this class, see `*The AffineTransform
Class* <#PIL.ImageTransform.AffineTransform-class>`_.
**ExtentTransform** (class)
[`# <#PIL.ImageTransform.ExtentTransform-class>`_]
Define a transform to extract a subregion from an image.
*bbox*
A 4-tuple (*x0, y0, x1, y1*) which specifies two points in the
input image's coordinate system.
For more information about this class, see `*The ExtentTransform
Class* <#PIL.ImageTransform.ExtentTransform-class>`_.
**MeshTransform** (class)
[`# <#PIL.ImageTransform.MeshTransform-class>`_]
Define an mesh image transform.
*data*
For more information about this class, see `*The MeshTransform
Class* <#PIL.ImageTransform.MeshTransform-class>`_.
**QuadTransform** (class)
[`# <#PIL.ImageTransform.QuadTransform-class>`_]
Define an quad image transform.
*xy*
An 8-tuple (*x0, y0, x1, y1, x2, y2, y3, y3*) which contain the
upper left, lower left, lower right, and upper right corner of
the source quadrilateral.
For more information about this class, see `*The QuadTransform
Class* <#PIL.ImageTransform.QuadTransform-class>`_.
The AffineTransform Class
-------------------------
**AffineTransform** (class)
[`# <#PIL.ImageTransform.AffineTransform-class>`_]
Define an affine image transform.
This function takes a 6-tuple (*a, b, c, d, e, f*) which contain the
first two rows from an affine transform matrix. For each pixel (*x,
y*) in the output image, the new value is taken from a position (a
*x* + b *y* + c, d *x* + e *y* + f) in the input image, rounded to
nearest pixel.
This function can be used to scale, translate, rotate, and shear the
original image.
*matrix*
A 6-tuple (*a, b, c, d, e, f*) containing the first two rows
from an affine transform matrix.
The ExtentTransform Class
-------------------------
**ExtentTransform** (class)
[`# <#PIL.ImageTransform.ExtentTransform-class>`_]
Define a transform to extract a subregion from an image.
Maps a rectangle (defined by two corners) from the image to a
rectangle of the given size. The resulting image will contain data
sampled from between the corners, such that (*x0, y0*) in the input
image will end up at (0,0) in the output image, and (*x1, y1*) at
*size*.
This method can be used to crop, stretch, shrink, or mirror an
arbitrary rectangle in the current image. It is slightly slower than
**crop**, but about as fast as a corresponding **resize** operation.
*bbox*
A 4-tuple (*x0, y0, x1, y1*) which specifies two points in the
input image's coordinate system.
The MeshTransform Class
-----------------------
**MeshTransform** (class)
[`# <#PIL.ImageTransform.MeshTransform-class>`_]
*data*
The QuadTransform Class
-----------------------
**QuadTransform** (class)
[`# <#PIL.ImageTransform.QuadTransform-class>`_]
Define an quad image transform.
Maps a quadrilateral (a region defined by four corners) from the
image to a rectangle of the given size.
*xy*
An 8-tuple (*x0, y0, x1, y1, x2, y2, y3, y3*) which contain the
upper left, lower left, lower right, and upper right corner of
the source quadrilateral.

106
docs/pythondoc-PIL.ImageWin.rst Normal file
View File

@ -0,0 +1,106 @@
=======================
The PIL.ImageWin Module
=======================
The PIL.ImageWin Module
=======================
**Dib(image, size=None)** (class) [`# <#PIL.ImageWin.Dib-class>`_]
Create a Windows bitmap with the given mode and size.
For more information about this class, see `*The Dib
Class* <#PIL.ImageWin.Dib-class>`_.
**HDC(dc)** (class) [`# <#PIL.ImageWin.HDC-class>`_]
The ImageWin module contains support to create and display images
under Windows 95/98, NT, 2000 and later.
For more information about this class, see `*The HDC
Class* <#PIL.ImageWin.HDC-class>`_.
**ImageWindow(image, title="PIL")** (class)
[`# <#PIL.ImageWin.ImageWindow-class>`_]
Create an image window which displays the given image.
For more information about this class, see `*The ImageWindow
Class* <#PIL.ImageWin.ImageWindow-class>`_.
**Window(title="PIL", width=None, height=None)** (class)
[`# <#PIL.ImageWin.Window-class>`_]
Create a Window with the given title size.
For more information about this class, see `*The Window
Class* <#PIL.ImageWin.Window-class>`_.
The Dib Class
-------------
**Dib(image, size=None)** (class) [`# <#PIL.ImageWin.Dib-class>`_]
Create a Windows bitmap with the given mode and size. The mode can
be one of "1", "L", "P", or "RGB". If the display requires a
palette, this constructor creates a suitable palette and associates
it with the image. For an "L" image, 128 greylevels are allocated.
For an "RGB" image, a 6x6x6 colour cube is used, together with 20
greylevels. To make sure that palettes work properly under Windows,
you must call the **palette** method upon certain events from
Windows.
**\_\_init\_\_(image, size=None)**
[`# <#PIL.ImageWin.Dib.__init__-method>`_]
*image*
*size*
**expose(handle)** [`# <#PIL.ImageWin.Dib.expose-method>`_]
*handle*
Device context (HDC), cast to a Python integer, or a HDC or HWND
instance. In PythonWin, you can use the **GetHandleAttrib**
method of the **CDC** class to get a suitable handle.
**fromstring(buffer)** [`# <#PIL.ImageWin.Dib.fromstring-method>`_]
*buffer*
A string buffer containing display data (usually data returned
from **tostring**)
**paste(im, box=None)** [`# <#PIL.ImageWin.Dib.paste-method>`_]
*im*
*box*
**query\_palette(handle)**
[`# <#PIL.ImageWin.Dib.query_palette-method>`_]
Installs the palette associated with the image in the given device
context.
This method should be called upon **QUERYNEWPALETTE** and
**PALETTECHANGED** events from Windows. If this method returns a
non-zero value, one or more display palette entries were changed,
and the image should be redrawn.
*handle*
Returns:
**tostring()** [`# <#PIL.ImageWin.Dib.tostring-method>`_]
Returns:
The HDC Class
-------------
**HDC(dc)** (class) [`# <#PIL.ImageWin.HDC-class>`_]
The **ImageWin** module contains support to create and display
images under Windows 95/98, NT, 2000 and later.
The ImageWindow Class
---------------------
**ImageWindow(image, title="PIL")** (class)
[`# <#PIL.ImageWin.ImageWindow-class>`_]
The Window Class
----------------
**Window(title="PIL", width=None, height=None)** (class)
[`# <#PIL.ImageWin.Window-class>`_]

17
docs/pythondoc-PIL.ImtImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.ImtImagePlugin Module
=============================
The PIL.ImtImagePlugin Module
=============================
**ImtImageFile** (class) [`# <#PIL.ImtImagePlugin.ImtImageFile-class>`_]
Image plugin for IM Tools images.
For more information about this class, see `*The ImtImageFile
Class* <#PIL.ImtImagePlugin.ImtImageFile-class>`_.
The ImtImageFile Class
----------------------
**ImtImageFile** (class) [`# <#PIL.ImtImagePlugin.ImtImageFile-class>`_]

27
docs/pythondoc-PIL.IptcImagePlugin.rst Normal file
View File

@ -0,0 +1,27 @@
==============================
The PIL.IptcImagePlugin Module
==============================
The PIL.IptcImagePlugin Module
==============================
**getiptcinfo(im)** [`# <#PIL.IptcImagePlugin.getiptcinfo-function>`_]
*im*
Returns:
**IptcImageFile** (class)
[`# <#PIL.IptcImagePlugin.IptcImageFile-class>`_]
Image plugin for IPTC/NAA datastreams.
For more information about this class, see `*The IptcImageFile
Class* <#PIL.IptcImagePlugin.IptcImageFile-class>`_.
The IptcImageFile Class
-----------------------
**IptcImageFile** (class)
[`# <#PIL.IptcImagePlugin.IptcImageFile-class>`_]
Image plugin for IPTC/NAA datastreams. To read IPTC/NAA fields from
TIFF and JPEG files, use the **getiptcinfo** function.

19
docs/pythondoc-PIL.JpegImagePlugin.rst Normal file
View File

@ -0,0 +1,19 @@
==============================
The PIL.JpegImagePlugin Module
==============================
The PIL.JpegImagePlugin Module
==============================
**JpegImageFile** (class)
[`# <#PIL.JpegImagePlugin.JpegImageFile-class>`_]
Image plugin for JPEG and JFIF images.
For more information about this class, see `*The JpegImageFile
Class* <#PIL.JpegImagePlugin.JpegImageFile-class>`_.
The JpegImageFile Class
-----------------------
**JpegImageFile** (class)
[`# <#PIL.JpegImagePlugin.JpegImageFile-class>`_]

19
docs/pythondoc-PIL.McIdasImagePlugin.rst Normal file
View File

@ -0,0 +1,19 @@
================================
The PIL.McIdasImagePlugin Module
================================
The PIL.McIdasImagePlugin Module
================================
**McIdasImageFile** (class)
[`# <#PIL.McIdasImagePlugin.McIdasImageFile-class>`_]
Image plugin for McIdas area images.
For more information about this class, see `*The McIdasImageFile
Class* <#PIL.McIdasImagePlugin.McIdasImageFile-class>`_.
The McIdasImageFile Class
-------------------------
**McIdasImageFile** (class)
[`# <#PIL.McIdasImagePlugin.McIdasImageFile-class>`_]

17
docs/pythondoc-PIL.MicImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.MicImagePlugin Module
=============================
The PIL.MicImagePlugin Module
=============================
**MicImageFile** (class) [`# <#PIL.MicImagePlugin.MicImageFile-class>`_]
Image plugin for Microsoft's Image Composer file format.
For more information about this class, see `*The MicImageFile
Class* <#PIL.MicImagePlugin.MicImageFile-class>`_.
The MicImageFile Class
----------------------
**MicImageFile** (class) [`# <#PIL.MicImagePlugin.MicImageFile-class>`_]

19
docs/pythondoc-PIL.MpegImagePlugin.rst Normal file
View File

@ -0,0 +1,19 @@
==============================
The PIL.MpegImagePlugin Module
==============================
The PIL.MpegImagePlugin Module
==============================
**MpegImageFile** (class)
[`# <#PIL.MpegImagePlugin.MpegImageFile-class>`_]
Image plugin for MPEG streams.
For more information about this class, see `*The MpegImageFile
Class* <#PIL.MpegImagePlugin.MpegImageFile-class>`_.
The MpegImageFile Class
-----------------------
**MpegImageFile** (class)
[`# <#PIL.MpegImagePlugin.MpegImageFile-class>`_]

17
docs/pythondoc-PIL.MspImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.MspImagePlugin Module
=============================
The PIL.MspImagePlugin Module
=============================
**MspImageFile** (class) [`# <#PIL.MspImagePlugin.MspImageFile-class>`_]
Image plugin for Windows MSP images.
For more information about this class, see `*The MspImageFile
Class* <#PIL.MspImagePlugin.MspImageFile-class>`_.
The MspImageFile Class
----------------------
**MspImageFile** (class) [`# <#PIL.MspImagePlugin.MspImageFile-class>`_]

31
docs/pythondoc-PIL.OleFileIO.rst Normal file
View File

@ -0,0 +1,31 @@
========================
The PIL.OleFileIO Module
========================
The PIL.OleFileIO Module
========================
**OleFileIO(filename=None)** (class)
[`# <#PIL.OleFileIO.OleFileIO-class>`_]
This class encapsulates the interface to an OLE 2 structured storage
file.
For more information about this class, see `*The OleFileIO
Class* <#PIL.OleFileIO.OleFileIO-class>`_.
The OleFileIO Class
-------------------
**OleFileIO(filename=None)** (class)
[`# <#PIL.OleFileIO.OleFileIO-class>`_]
This class encapsulates the interface to an OLE 2 structured storage
file. Use the `**listdir** <link:listdir>`_ and
`**openstream** <link:openstream>`_ methods to access the contents
of this file.
**getproperties(filename)**
[`# <#PIL.OleFileIO.OleFileIO.getproperties-method>`_]
**listdir()** [`# <#PIL.OleFileIO.OleFileIO.listdir-method>`_]
**open(filename)** [`# <#PIL.OleFileIO.OleFileIO.open-method>`_]
**openstream(filename)**
[`# <#PIL.OleFileIO.OleFileIO.openstream-method>`_]

17
docs/pythondoc-PIL.PSDraw.rst Normal file
View File

@ -0,0 +1,17 @@
=====================
The PIL.PSDraw Module
=====================
The PIL.PSDraw Module
=====================
**PSDraw(fp=None)** (class) [`# <#PIL.PSDraw.PSDraw-class>`_]
Simple Postscript graphics interface.
For more information about this class, see `*The PSDraw
Class* <#PIL.PSDraw.PSDraw-class>`_.
The PSDraw Class
----------------
**PSDraw(fp=None)** (class) [`# <#PIL.PSDraw.PSDraw-class>`_]

17
docs/pythondoc-PIL.PaletteFile.rst Normal file
View File

@ -0,0 +1,17 @@
==========================
The PIL.PaletteFile Module
==========================
The PIL.PaletteFile Module
==========================
**PaletteFile(fp)** (class) [`# <#PIL.PaletteFile.PaletteFile-class>`_]
File handler for Teragon-style palette files.
For more information about this class, see `*The PaletteFile
Class* <#PIL.PaletteFile.PaletteFile-class>`_.
The PaletteFile Class
---------------------
**PaletteFile(fp)** (class) [`# <#PIL.PaletteFile.PaletteFile-class>`_]

12
docs/pythondoc-PIL.PalmImagePlugin.rst Normal file
View File

@ -0,0 +1,12 @@
==============================
The PIL.PalmImagePlugin Module
==============================
The PIL.PalmImagePlugin Module
==============================
Module Contents
---------------
**\_save(im, fp, filename, check=0)**
[`# <#PIL.PalmImagePlugin._save-function>`_]

17
docs/pythondoc-PIL.PcdImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.PcdImagePlugin Module
=============================
The PIL.PcdImagePlugin Module
=============================
**PcdImageFile** (class) [`# <#PIL.PcdImagePlugin.PcdImageFile-class>`_]
Image plugin for PhotoCD images.
For more information about this class, see `*The PcdImageFile
Class* <#PIL.PcdImagePlugin.PcdImageFile-class>`_.
The PcdImageFile Class
----------------------
**PcdImageFile** (class) [`# <#PIL.PcdImagePlugin.PcdImageFile-class>`_]

17
docs/pythondoc-PIL.PcfFontFile.rst Normal file
View File

@ -0,0 +1,17 @@
==========================
The PIL.PcfFontFile Module
==========================
The PIL.PcfFontFile Module
==========================
**PcfFontFile(fp)** (class) [`# <#PIL.PcfFontFile.PcfFontFile-class>`_]
Font file plugin for the X11 PCF format.
For more information about this class, see `*The PcfFontFile
Class* <#PIL.PcfFontFile.PcfFontFile-class>`_.
The PcfFontFile Class
---------------------
**PcfFontFile(fp)** (class) [`# <#PIL.PcfFontFile.PcfFontFile-class>`_]

17
docs/pythondoc-PIL.PcxImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.PcxImagePlugin Module
=============================
The PIL.PcxImagePlugin Module
=============================
**PcxImageFile** (class) [`# <#PIL.PcxImagePlugin.PcxImageFile-class>`_]
Image plugin for Paintbrush images.
For more information about this class, see `*The PcxImageFile
Class* <#PIL.PcxImagePlugin.PcxImageFile-class>`_.
The PcxImageFile Class
----------------------
**PcxImageFile** (class) [`# <#PIL.PcxImagePlugin.PcxImageFile-class>`_]

11
docs/pythondoc-PIL.PdfImagePlugin.rst Normal file
View File

@ -0,0 +1,11 @@
=============================
The PIL.PdfImagePlugin Module
=============================
The PIL.PdfImagePlugin Module
=============================
Module Contents
---------------
**\_save(im, fp, filename)** [`# <#PIL.PdfImagePlugin._save-function>`_]

19
docs/pythondoc-PIL.PixarImagePlugin.rst Normal file
View File

@ -0,0 +1,19 @@
===============================
The PIL.PixarImagePlugin Module
===============================
The PIL.PixarImagePlugin Module
===============================
**PixarImageFile** (class)
[`# <#PIL.PixarImagePlugin.PixarImageFile-class>`_]
Image plugin for PIXAR raster images.
For more information about this class, see `*The PixarImageFile
Class* <#PIL.PixarImagePlugin.PixarImageFile-class>`_.
The PixarImageFile Class
------------------------
**PixarImageFile** (class)
[`# <#PIL.PixarImagePlugin.PixarImageFile-class>`_]

17
docs/pythondoc-PIL.PngImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.PngImagePlugin Module
=============================
The PIL.PngImagePlugin Module
=============================
**PngImageFile** (class) [`# <#PIL.PngImagePlugin.PngImageFile-class>`_]
Image plugin for PNG images.
For more information about this class, see `*The PngImageFile
Class* <#PIL.PngImagePlugin.PngImageFile-class>`_.
The PngImageFile Class
----------------------
**PngImageFile** (class) [`# <#PIL.PngImagePlugin.PngImageFile-class>`_]

17
docs/pythondoc-PIL.PpmImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.PpmImagePlugin Module
=============================
The PIL.PpmImagePlugin Module
=============================
**PpmImageFile** (class) [`# <#PIL.PpmImagePlugin.PpmImageFile-class>`_]
Image plugin for PBM, PGM, and PPM images.
For more information about this class, see `*The PpmImageFile
Class* <#PIL.PpmImagePlugin.PpmImageFile-class>`_.
The PpmImageFile Class
----------------------
**PpmImageFile** (class) [`# <#PIL.PpmImagePlugin.PpmImageFile-class>`_]

17
docs/pythondoc-PIL.PsdImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.PsdImagePlugin Module
=============================
The PIL.PsdImagePlugin Module
=============================
**PsdImageFile** (class) [`# <#PIL.PsdImagePlugin.PsdImageFile-class>`_]
Image plugin for Photoshop images.
For more information about this class, see `*The PsdImageFile
Class* <#PIL.PsdImagePlugin.PsdImageFile-class>`_.
The PsdImageFile Class
----------------------
**PsdImageFile** (class) [`# <#PIL.PsdImagePlugin.PsdImageFile-class>`_]

17
docs/pythondoc-PIL.SgiImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.SgiImagePlugin Module
=============================
The PIL.SgiImagePlugin Module
=============================
**SgiImageFile** (class) [`# <#PIL.SgiImagePlugin.SgiImageFile-class>`_]
Image plugin for SGI images.
For more information about this class, see `*The SgiImageFile
Class* <#PIL.SgiImagePlugin.SgiImageFile-class>`_.
The SgiImageFile Class
----------------------
**SgiImageFile** (class) [`# <#PIL.SgiImagePlugin.SgiImageFile-class>`_]

28
docs/pythondoc-PIL.SpiderImagePlugin.rst Normal file
View File

@ -0,0 +1,28 @@
================================
The PIL.SpiderImagePlugin Module
================================
The PIL.SpiderImagePlugin Module
================================
Image plugin for the Spider image format. This format is is used by the
SPIDER software, in processing image data from electron microscopy and
tomography.
Module Contents
---------------
**SpiderImageFile** (class)
[`# <#PIL.SpiderImagePlugin.SpiderImageFile-class>`_]
Image plugin for the SPIDER format.
For more information about this class, see `*The SpiderImageFile
Class* <#PIL.SpiderImagePlugin.SpiderImageFile-class>`_.
The SpiderImageFile Class
-------------------------
**SpiderImageFile** (class)
[`# <#PIL.SpiderImagePlugin.SpiderImageFile-class>`_]
Image plugin for the SPIDER format.

17
docs/pythondoc-PIL.SunImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.SunImagePlugin Module
=============================
The PIL.SunImagePlugin Module
=============================
**SunImageFile** (class) [`# <#PIL.SunImagePlugin.SunImageFile-class>`_]
Image plugin for Sun raster files.
For more information about this class, see `*The SunImageFile
Class* <#PIL.SunImagePlugin.SunImageFile-class>`_.
The SunImageFile Class
----------------------
**SunImageFile** (class) [`# <#PIL.SunImagePlugin.SunImageFile-class>`_]

24
docs/pythondoc-PIL.TarIO.rst Normal file
View File

@ -0,0 +1,24 @@
====================
The PIL.TarIO Module
====================
The PIL.TarIO Module
====================
**TarIO(tarfile, file)** (class) [`# <#PIL.TarIO.TarIO-class>`_]
A file object that provides read access to a given member of a TAR
file.
For more information about this class, see `*The TarIO
Class* <#PIL.TarIO.TarIO-class>`_.
The TarIO Class
---------------
**TarIO(tarfile, file)** (class) [`# <#PIL.TarIO.TarIO-class>`_]
**\_\_init\_\_(tarfile, file)**
[`# <#PIL.TarIO.TarIO.__init__-method>`_]
*tarfile*
*file*

17
docs/pythondoc-PIL.TgaImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.TgaImagePlugin Module
=============================
The PIL.TgaImagePlugin Module
=============================
**TgaImageFile** (class) [`# <#PIL.TgaImagePlugin.TgaImageFile-class>`_]
Image plugin for Targa files.
For more information about this class, see `*The TgaImageFile
Class* <#PIL.TgaImagePlugin.TgaImageFile-class>`_.
The TgaImageFile Class
----------------------
**TgaImageFile** (class) [`# <#PIL.TgaImagePlugin.TgaImageFile-class>`_]

32
docs/pythondoc-PIL.TiffImagePlugin.rst Normal file
View File

@ -0,0 +1,32 @@
==============================
The PIL.TiffImagePlugin Module
==============================
The PIL.TiffImagePlugin Module
==============================
**ImageFileDirectory(prefix="II")** (class)
[`# <#PIL.TiffImagePlugin.ImageFileDirectory-class>`_]
Wrapper for TIFF IFDs.
For more information about this class, see `*The ImageFileDirectory
Class* <#PIL.TiffImagePlugin.ImageFileDirectory-class>`_.
**TiffImageFile** (class)
[`# <#PIL.TiffImagePlugin.TiffImageFile-class>`_]
Image plugin for TIFF files.
For more information about this class, see `*The TiffImageFile
Class* <#PIL.TiffImagePlugin.TiffImageFile-class>`_.
The ImageFileDirectory Class
----------------------------
**ImageFileDirectory(prefix="II")** (class)
[`# <#PIL.TiffImagePlugin.ImageFileDirectory-class>`_]
The TiffImageFile Class
-----------------------
**TiffImageFile** (class)
[`# <#PIL.TiffImagePlugin.TiffImageFile-class>`_]

12
docs/pythondoc-PIL.TiffTags.rst Normal file
View File

@ -0,0 +1,12 @@
=======================
The PIL.TiffTags Module
=======================
The PIL.TiffTags Module
=======================
Module Contents
---------------
**TAGS** (variable) [`# <#PIL.TiffTags.TAGS-variable>`_]
**TYPES** (variable) [`# <#PIL.TiffTags.TYPES-variable>`_]

16
docs/pythondoc-PIL.WalImageFile.rst Normal file
View File

@ -0,0 +1,16 @@
===========================
The PIL.WalImageFile Module
===========================
The PIL.WalImageFile Module
===========================
**open(filename)** [`# <#PIL.WalImageFile.open-function>`_]
Load texture from a Quake2 WAL texture file.
By default, a Quake2 standard palette is attached to the texture. To
override the palette, use the **putpalette** method.
*filename*
Returns:

24
docs/pythondoc-PIL.WmfImagePlugin.rst Normal file
View File

@ -0,0 +1,24 @@
=============================
The PIL.WmfImagePlugin Module
=============================
The PIL.WmfImagePlugin Module
=============================
**register\_handler(handler)**
[`# <#PIL.WmfImagePlugin.register_handler-function>`_]
*handler*
**WmfStubImageFile** (class)
[`# <#PIL.WmfImagePlugin.WmfStubImageFile-class>`_]
Image plugin for Windows metafiles.
For more information about this class, see `*The WmfStubImageFile
Class* <#PIL.WmfImagePlugin.WmfStubImageFile-class>`_.
The WmfStubImageFile Class
--------------------------
**WmfStubImageFile** (class)
[`# <#PIL.WmfImagePlugin.WmfStubImageFile-class>`_]

19
docs/pythondoc-PIL.XVThumbImagePlugin.rst Normal file
View File

@ -0,0 +1,19 @@
=================================
The PIL.XVThumbImagePlugin Module
=================================
The PIL.XVThumbImagePlugin Module
=================================
**XVThumbImageFile** (class)
[`# <#PIL.XVThumbImagePlugin.XVThumbImageFile-class>`_]
Image plugin for XV thumbnail images.
For more information about this class, see `*The XVThumbImageFile
Class* <#PIL.XVThumbImagePlugin.XVThumbImageFile-class>`_.
The XVThumbImageFile Class
--------------------------
**XVThumbImageFile** (class)
[`# <#PIL.XVThumbImagePlugin.XVThumbImageFile-class>`_]

17
docs/pythondoc-PIL.XbmImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.XbmImagePlugin Module
=============================
The PIL.XbmImagePlugin Module
=============================
**XbmImageFile** (class) [`# <#PIL.XbmImagePlugin.XbmImageFile-class>`_]
Image plugin for X11 bitmaps.
For more information about this class, see `*The XbmImageFile
Class* <#PIL.XbmImagePlugin.XbmImageFile-class>`_.
The XbmImageFile Class
----------------------
**XbmImageFile** (class) [`# <#PIL.XbmImagePlugin.XbmImageFile-class>`_]

17
docs/pythondoc-PIL.XpmImagePlugin.rst Normal file
View File

@ -0,0 +1,17 @@
=============================
The PIL.XpmImagePlugin Module
=============================
The PIL.XpmImagePlugin Module
=============================
**XpmImageFile** (class) [`# <#PIL.XpmImagePlugin.XpmImageFile-class>`_]
Image plugin for X11 pixel maps.
For more information about this class, see `*The XpmImageFile
Class* <#PIL.XpmImagePlugin.XpmImageFile-class>`_.
The XpmImageFile Class
----------------------
**XpmImageFile** (class) [`# <#PIL.XpmImagePlugin.XpmImageFile-class>`_]

2
setup.py
View File

@ -71,7 +71,7 @@ except ImportError:
NAME = 'Pillow'
VERSION = '1.7.6'
VERSION = '1.7.7'
PIL_VERSION = '1.1.7'
TCL_ROOT = None
JPEG_ROOT = None