Skip to content

Commit b6582df

Browse files
committed
readme
1 parent e11caf6 commit b6582df

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ read data from PPM/PGM file to nested image data list, where:
9999

100100
Convert nested image data list to PGM P5 or PPM P6 (binary) data structure in memory, where:
101101

102-
- `image3D` - `Y*X*Z` list (image) of lists (rows) of lists (pixels) of ints (channels);
102+
- `image3D` - `Y * X * Z` list (image) of lists (rows) of lists (pixels) of ints (channels);
103103
- `maxcolors` - number of colors per channel for current image (int);
104104
- `show_chessboard` - optional bool, set `True` to show LA and RGBA images against chessboard pattern; `False` or missing show existing L or RGB data for transparent areas as opaque. Default is `False` for backward compatibility;
105105
- `image_bytes` - PNM-structured binary data.
@@ -116,7 +116,7 @@ Note that Tkinter used for Python 3.10 displays some hight-color images incorrec
116116

117117
Write PGM P5 or PPM P6 (binary) file from nested image data list, where:
118118

119-
- `image3D` - `Y*X*Z` list (image) of lists (rows) of lists (pixels) of ints (channels);
119+
- `image3D` - `Y * X * Z` list (image) of lists (rows) of lists (pixels) of ints (channels);
120120
- `maxcolors` - number of colors per channel for current image (int);
121121
- `out_filename` - PNM file name.
122122

@@ -126,7 +126,7 @@ Write PGM P5 or PPM P6 (binary) file from nested image data list, where:
126126

127127
Write PGM P2 or PPM P3 (ASCII text) file from nested image data list, where:
128128

129-
- `image3D` - `Y*X*Z` list (image) of lists (rows) of lists (pixels) of ints (channels);
129+
- `image3D` - `Y * X * Z` list (image) of lists (rows) of lists (pixels) of ints (channels);
130130
- `maxcolors` - number of colors per channel for current image (int);
131131
- `out_filename` - PNM file name.
132132

@@ -136,18 +136,18 @@ Write PGM P2 or PPM P3 (ASCII text) file from nested image data list, where:
136136

137137
Write either binary or ASCII file from nested image data list, where:
138138

139-
- `image3D` - `Y*X*Z` list (image) of lists (rows) of lists (pixels) of ints (channels);
139+
- `image3D` - `Y * X * Z` list (image) of lists (rows) of lists (pixels) of ints (channels);
140140
- `maxcolors` - number of colors per channel for current image (int);
141141
- `bin` - switch defining whether to write binary file or ASCII (bool). Default is True, meaning binary output, to provide backward compatibility.
142142
- `out_filename` - Name of PNM file to be written.
143143

144-
Note that `list2pnm`, is merely a switch between `list2pnmbin` and `list2pnmascii`, introduced for simplifying writing "Save as..." GUI dialog functions - now you can use one function for all PNM flavours, passing `bin` via lambda, is necessary.
144+
Note that `list2pnm` is merely a switch between `list2pnmbin` and `list2pnmascii`, introduced for simplifying writing "Save as..." GUI dialog functions - now you can use one function for all PNM flavours, passing `bin` via lambda, if necessary. Default is `bin = True`.
145145

146146
### create_image
147147

148148
`image3D = create_image(X, Y, Z)`
149149

150-
Create empty 3D nested list of `X*Y*Z` sizes.
150+
Create empty 3D nested list of `X * Y * Z` sizes.
151151

152152
## viewer.py
153153

0 commit comments

Comments
 (0)