PaletteImage
This module converts possibly non-square pixels of an image to palette indices.
LogicalImage
module-attribute
A logical image, either a PaletteImage or a Window into one.
PixelSize
module-attribute
Size of logical pixels.
| ATTRIBUTE | DESCRIPTION |
|---|---|
x |
Width of logical pixels.
|
y |
Height of logical pixels.
|
PaletteImage(palette, filename=None, image=None, width=None, height=None, pixel_size=PixelSize(1, 1))
Convert image to palette indices.
| PARAMETER | DESCRIPTION |
|---|---|
palette
|
Palette to use.
TYPE:
|
filename
|
Name of file to load image from.
TYPE:
|
image
|
Image to use.
TYPE:
|
width
|
Width of image in logical pixels.
TYPE:
|
height
|
Height of image in logical pixels.
TYPE:
|
pixel_size
|
Size of logical pixels. |
get(x, y)
Get palette index of logical pixel at (x, y).
| PARAMETER | DESCRIPTION |
|---|---|
x
|
X coordinate of logical pixel.
TYPE:
|
y
|
Y coordinate of logical pixel.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
int | None
|
Palette index of logical pixel at (x, y). |
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
If (x, y) is outside image. |
FilePositionException
|
If pixel color is not in palette or logical pixel is non-uniform. |
set(x, y, color)
Set logical pixel at (x, y) to color.
| PARAMETER | DESCRIPTION |
|---|---|
x
|
X coordinate of logical pixel.
TYPE:
|
y
|
Y coordinate of logical pixel.
TYPE:
|
color
|
Palette index to set logical pixel to.
TYPE:
|
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
If (x, y) is outside image or color is not in palette. |
Window(image, x_offset, y_offset, width, height)
A window into a PaletteImage.
| PARAMETER | DESCRIPTION |
|---|---|
image
|
Image or window to create window into.
TYPE:
|
x_offset
|
X offset of window into image.
TYPE:
|
y_offset
|
Y offset of window into image.
TYPE:
|
width
|
Width of window.
TYPE:
|
height
|
Height of window.
TYPE:
|
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
If window is larger than image. |
get(x, y)
Get palette index of logical pixel at (x, y) in window.
| PARAMETER | DESCRIPTION |
|---|---|
x
|
X coordinate of logical pixel in window.
TYPE:
|
y
|
Y coordinate of logical pixel in window.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
int | None
|
Palette index of logical pixel at (x, y) in window. |
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
If (x, y) is outside window. |
FilePositionException
|
If pixel color is not in palette or logical pixel is non-uniform. |
set(x, y, color)
Set logical pixel at (x, y) to color.
| PARAMETER | DESCRIPTION |
|---|---|
x
|
X coordinate of logical pixel in window.
TYPE:
|
y
|
Y coordinate of logical pixel in window.
TYPE:
|
color
|
Palette index to set logical pixel to.
TYPE:
|
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
If (x, y) is outside window or color is not in palette. |