← Back to branch summary

~edwin-grubbs/python-imaging/trunk

« back to all changes in this revision

Viewing changes to Docs/pythondoc-PIL.ImageFile.html

  • Committer: effbot
  • Date: 2006-07-05 20:36:11 UTC
  • Revision ID: svn-v4:be285980-f00d-0410-a9fe-d4747b46ecd0:pil:348
Load Imaging-1.1.6b1 into pil.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Docs/pythondoc-PIL.ImageFile.html
1
 
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
2
 
<html>
3
 
<head>
4
 
<meta http-equiv='Content-Type' content='text/html; charset=us-ascii' />
5
 
<title>The PIL.ImageFile Module</title>
6
 
<link rel='stylesheet' href='effbot.css' type='text/css' />
7
 
</head>
8
 
<body>
9
 
<h1>The PIL.ImageFile Module</h1>
10
 
<dl>
11
 
<dt><b>_ParserFile(data)</b> (class) [<a href='#PIL.ImageFile._ParserFile-class'>#</a>]</dt>
12
 
<dd>
13
 
<p>(Internal) Support class for the Parser file.</p>
14
 
<p>For more information about this class, see <a href='#PIL.ImageFile._ParserFile-class'><i>The _ParserFile Class</i></a>.</p>
15
 
</dd>
16
 
<dt><a id='PIL.ImageFile._safe_read-function' name='PIL.ImageFile._safe_read-function'><b>_safe_read(fp, size)</b></a> [<a href='#PIL.ImageFile._safe_read-function'>#</a>]</dt>
17
 
<dd>
18
 
<p>Reads large blocks in a safe way.  Unlike fp.read(n), this function
19
 
doesn't trust the user.  If the requested size is larger than
20
 
SAFEBLOCK, the file is read block by block.</p>
21
 
<dl>
22
 
<dt><i>fp</i></dt>
23
 
<dd>
24
 
File handle.  Must implement a <b>read</b> method.
25
 
</dd>
26
 
<dt><i>size</i></dt>
27
 
<dd>
28
 
Number of bytes to read.</dd>
29
 
<dt>Returns:</dt>
30
 
<dd>
31
 
A string containing up to <i>size</i> bytes of data.
32
 
</dd>
33
 
</dl><br />
34
 
</dd>
35
 
<dt><a id='PIL.ImageFile._save-function' name='PIL.ImageFile._save-function'><b>_save(im, fp, tile)</b></a> [<a href='#PIL.ImageFile._save-function'>#</a>]</dt>
36
 
<dd>
37
 
<p>(Helper) Save image body to file.</p>
38
 
<dl>
39
 
<dt><i>im</i></dt>
40
 
<dd>
41
 
Image object.</dd>
42
 
<dt><i>fp</i></dt>
43
 
<dd>
44
 
File object.</dd>
45
 
<dt><i>tile</i></dt>
46
 
<dd>
47
 
Tile list.</dd>
48
 
</dl><br />
49
 
</dd>
50
 
<dt><b>ImageFile(fp=None, filename=None)</b> (class) [<a href='#PIL.ImageFile.ImageFile-class'>#</a>]</dt>
51
 
<dd>
52
 
<p>Base class for image file handlers.</p>
53
 
<p>For more information about this class, see <a href='#PIL.ImageFile.ImageFile-class'><i>The ImageFile Class</i></a>.</p>
54
 
</dd>
55
 
<dt><b>Parser</b> (class)  [<a href='#PIL.ImageFile.Parser-class'>#</a>]</dt>
56
 
<dd>
57
 
<p>Incremental image parser.</p>
58
 
<p>For more information about this class, see <a href='#PIL.ImageFile.Parser-class'><i>The Parser Class</i></a>.</p>
59
 
</dd>
60
 
<dt><b>StubImageFile</b> (class)  [<a href='#PIL.ImageFile.StubImageFile-class'>#</a>]</dt>
61
 
<dd>
62
 
<p>Base class for stub image loaders.</p>
63
 
<p>For more information about this class, see <a href='#PIL.ImageFile.StubImageFile-class'><i>The StubImageFile Class</i></a>.</p>
64
 
</dd>
65
 
</dl>
66
 
<h2><a id='PIL.ImageFile._ParserFile-class' name='PIL.ImageFile._ParserFile-class'>The _ParserFile Class</a></h2>
67
 
<dl>
68
 
<dt><b>_ParserFile(data)</b> (class) [<a href='#PIL.ImageFile._ParserFile-class'>#</a>]</dt>
69
 
<dd>
70
 
<p>(Internal) Support class for the <b>Parser</b> file.
71
 
</p></dd>
72
 
</dl>
73
 
<h2><a id='PIL.ImageFile.ImageFile-class' name='PIL.ImageFile.ImageFile-class'>The ImageFile Class</a></h2>
74
 
<dl>
75
 
<dt><b>ImageFile(fp=None, filename=None)</b> (class) [<a href='#PIL.ImageFile.ImageFile-class'>#</a>]</dt>
76
 
<dd>
77
 
<p>Base class for image file handlers.</p>
78
 
</dd>
79
 
</dl>
80
 
<h2><a id='PIL.ImageFile.Parser-class' name='PIL.ImageFile.Parser-class'>The Parser Class</a></h2>
81
 
<dl>
82
 
<dt><b>Parser</b> (class)  [<a href='#PIL.ImageFile.Parser-class'>#</a>]</dt>
83
 
<dd>
84
 
<p>Incremental image parser.  This class implements the standard
85
 
feed/close consumer interface.</p>
86
 
</dd>
87
 
<dt><a id='PIL.ImageFile.Parser.close-method' name='PIL.ImageFile.Parser.close-method'><b>close()</b></a> [<a href='#PIL.ImageFile.Parser.close-method'>#</a>]</dt>
88
 
<dd>
89
 
<p>(Consumer) Close the stream.</p>
90
 
<dl>
91
 
<dt>Returns:</dt>
92
 
<dd>
93
 
An image object.</dd>
94
 
<dt>Raises <b>IOError</b>:</dt><dd>
95
 
If the parser failed to parse the image file.</dd>
96
 
</dl><br />
97
 
</dd>
98
 
<dt><a id='PIL.ImageFile.Parser.feed-method' name='PIL.ImageFile.Parser.feed-method'><b>feed(data)</b></a> [<a href='#PIL.ImageFile.Parser.feed-method'>#</a>]</dt>
99
 
<dd>
100
 
<p>(Consumer) Feed data to the parser.</p>
101
 
<dl>
102
 
<dt><i>data</i></dt>
103
 
<dd>
104
 
A string buffer.</dd>
105
 
<dt>Raises <b>IOError</b>:</dt><dd>
106
 
If the parser failed to parse the image file.</dd>
107
 
</dl><br />
108
 
</dd>
109
 
<dt><a id='PIL.ImageFile.Parser.reset-method' name='PIL.ImageFile.Parser.reset-method'><b>reset()</b></a> [<a href='#PIL.ImageFile.Parser.reset-method'>#</a>]</dt>
110
 
<dd>
111
 
<p>(Consumer) Reset the parser.  Note that you can only call this
112
 
method immediately after you've created a parser; parser
113
 
instances cannot be reused.</p>
114
 
</dd>
115
 
</dl>
116
 
<h2><a id='PIL.ImageFile.StubImageFile-class' name='PIL.ImageFile.StubImageFile-class'>The StubImageFile Class</a></h2>
117
 
<dl>
118
 
<dt><b>StubImageFile</b> (class)  [<a href='#PIL.ImageFile.StubImageFile-class'>#</a>]</dt>
119
 
<dd>
120
 
<p>Base class for stub image loaders.
121
 
</p><p>
122
 
A stub loader is an image loader that can identify files of a
123
 
certain format, but relies on external code to load the file.
124
 
</p></dd>
125
 
<dt><a id='PIL.ImageFile.StubImageFile._load-method' name='PIL.ImageFile.StubImageFile._load-method'><b>_load()</b></a> [<a href='#PIL.ImageFile.StubImageFile._load-method'>#</a>]</dt>
126
 
<dd>
127
 
<p>(Hook) Find actual image loader.</p>
128
 
</dd>
129
 
</dl>
130
 
</body></html>
 
1
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
 
2
<html>
 
3
<head>
 
4
<meta http-equiv='Content-Type' content='text/html; charset=us-ascii' />
 
5
<title>The PIL.ImageFile Module</title>
 
6
<link rel='stylesheet' href='effbot.css' type='text/css' />
 
7
</head>
 
8
<body>
 
9
<h1>The PIL.ImageFile Module</h1>
 
10
<dl>
 
11
<dt><b>_ParserFile(data)</b> (class) [<a href='#PIL.ImageFile._ParserFile-class'>#</a>]</dt>
 
12
<dd>
 
13
<p>(Internal) Support class for the Parser file.</p>
 
14
<p>For more information about this class, see <a href='#PIL.ImageFile._ParserFile-class'><i>The _ParserFile Class</i></a>.</p>
 
15
</dd>
 
16
<dt><a id='PIL.ImageFile._safe_read-function' name='PIL.ImageFile._safe_read-function'><b>_safe_read(fp, size)</b></a> [<a href='#PIL.ImageFile._safe_read-function'>#</a>]</dt>
 
17
<dd>
 
18
<dl>
 
19
<dt><i>fp</i></dt>
 
20
<dd>
 
21
File handle.  Must implement a <b>read</b> method.
 
22
</dd>
 
23
<dt><i>size</i></dt>
 
24
<dd>
 
25
</dd>
 
26
<dt>Returns:</dt>
 
27
<dd>
 
28
A string containing up to <i>size</i> bytes of data.
 
29
</dd>
 
30
</dl><br />
 
31
</dd>
 
32
<dt><a id='PIL.ImageFile._save-function' name='PIL.ImageFile._save-function'><b>_save(im, fp, tile)</b></a> [<a href='#PIL.ImageFile._save-function'>#</a>]</dt>
 
33
<dd>
 
34
<dl>
 
35
<dt><i>im</i></dt>
 
36
<dd>
 
37
</dd>
 
38
<dt><i>fp</i></dt>
 
39
<dd>
 
40
</dd>
 
41
<dt><i>tile</i></dt>
 
42
<dd>
 
43
</dd>
 
44
</dl><br />
 
45
</dd>
 
46
<dt><b>ImageFile(fp=None, filename=None)</b> (class) [<a href='#PIL.ImageFile.ImageFile-class'>#</a>]</dt>
 
47
<dd>
 
48
<p>Base class for image file handlers.</p>
 
49
<p>For more information about this class, see <a href='#PIL.ImageFile.ImageFile-class'><i>The ImageFile Class</i></a>.</p>
 
50
</dd>
 
51
<dt><b>Parser</b> (class)  [<a href='#PIL.ImageFile.Parser-class'>#</a>]</dt>
 
52
<dd>
 
53
<p>Incremental image parser.</p>
 
54
<p>For more information about this class, see <a href='#PIL.ImageFile.Parser-class'><i>The Parser Class</i></a>.</p>
 
55
</dd>
 
56
<dt><b>StubImageFile</b> (class)  [<a href='#PIL.ImageFile.StubImageFile-class'>#</a>]</dt>
 
57
<dd>
 
58
<p>Base class for stub image loaders.</p>
 
59
<p>For more information about this class, see <a href='#PIL.ImageFile.StubImageFile-class'><i>The StubImageFile Class</i></a>.</p>
 
60
</dd>
 
61
</dl>
 
62
<h2><a id='PIL.ImageFile._ParserFile-class' name='PIL.ImageFile._ParserFile-class'>The _ParserFile Class</a></h2>
 
63
<dl>
 
64
<dt><b>_ParserFile(data)</b> (class) [<a href='#PIL.ImageFile._ParserFile-class'>#</a>]</dt>
 
65
<dd>
 
66
<p>(Internal) Support class for the <b>Parser</b> file.
 
67
</p></dd>
 
68
</dl>
 
69
<h2><a id='PIL.ImageFile.ImageFile-class' name='PIL.ImageFile.ImageFile-class'>The ImageFile Class</a></h2>
 
70
<dl>
 
71
<dt><b>ImageFile(fp=None, filename=None)</b> (class) [<a href='#PIL.ImageFile.ImageFile-class'>#</a>]</dt>
 
72
<dd>
 
73
</dd>
 
74
</dl>
 
75
<h2><a id='PIL.ImageFile.Parser-class' name='PIL.ImageFile.Parser-class'>The Parser Class</a></h2>
 
76
<dl>
 
77
<dt><b>Parser</b> (class)  [<a href='#PIL.ImageFile.Parser-class'>#</a>]</dt>
 
78
<dd>
 
79
</dd>
 
80
<dt><a id='PIL.ImageFile.Parser.close-method' name='PIL.ImageFile.Parser.close-method'><b>close()</b></a> [<a href='#PIL.ImageFile.Parser.close-method'>#</a>]</dt>
 
81
<dd>
 
82
<dl>
 
83
<dt>Returns:</dt>
 
84
<dd>
 
85
</dd>
 
86
<dt>Raises <b>IOError</b>:</dt><dd>
 
87
</dd>
 
88
</dl><br />
 
89
</dd>
 
90
<dt><a id='PIL.ImageFile.Parser.feed-method' name='PIL.ImageFile.Parser.feed-method'><b>feed(data)</b></a> [<a href='#PIL.ImageFile.Parser.feed-method'>#</a>]</dt>
 
91
<dd>
 
92
<dl>
 
93
<dt><i>data</i></dt>
 
94
<dd>
 
95
</dd>
 
96
<dt>Raises <b>IOError</b>:</dt><dd>
 
97
</dd>
 
98
</dl><br />
 
99
</dd>
 
100
<dt><a id='PIL.ImageFile.Parser.reset-method' name='PIL.ImageFile.Parser.reset-method'><b>reset()</b></a> [<a href='#PIL.ImageFile.Parser.reset-method'>#</a>]</dt>
 
101
<dd>
 
102
</dd>
 
103
</dl>
 
104
<h2><a id='PIL.ImageFile.StubImageFile-class' name='PIL.ImageFile.StubImageFile-class'>The StubImageFile Class</a></h2>
 
105
<dl>
 
106
<dt><b>StubImageFile</b> (class)  [<a href='#PIL.ImageFile.StubImageFile-class'>#</a>]</dt>
 
107
<dd>
 
108
<p>Base class for stub image loaders.
 
109
</p><p>
 
110
A stub loader is an image loader that can identify files of a
 
111
certain format, but relies on external code to load the file.
 
112
</p></dd>
 
113
<dt><a id='PIL.ImageFile.StubImageFile._load-method' name='PIL.ImageFile.StubImageFile._load-method'><b>_load()</b></a> [<a href='#PIL.ImageFile.StubImageFile._load-method'>#</a>]</dt>
 
114
<dd>
 
115
</dd>
 
116
</dl>
 
117
</body></html>