The imago Reference Manual

3.1.1 imago/imago.asd

Source

imago.asd.

Parent Component

imago (system).

ASDF Systems

• imago.
• imago/bit-io.

---

3.1.2 imago/package.lisp

Source

imago.asd.

Parent Component

imago (system).

Packages

imago.

---

3.1.3 imago/conditions.lisp

Dependency

package.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

• decode-error (condition).
• encode-error (condition).
• imago-condition (condition).
• imago-error (condition).
• not-implemented (condition).
• operation-error (condition).
• unknown-format (condition).

Internals

unknown-format-pathname (reader method).

---

3.1.4 imago/utilities.lisp

Dependency

package.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Internals

• best-in-array (function).
• clamp (function).
• image-dimension (type).
• image-index (type).
• read-array-element (macro).
• read-byte-array (function).
• read-lsb-integer (function).
• read-msb-integer (function).
• skip-bytes (function).
• skip-comments (function).
• skip-line (function).
• square (function).
• write-lsb-integer (function).
• write-msb-integer (function).

---

3.1.5 imago/color.lisp

Dependency

package.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

• +black+ (constant).
• +blue+ (constant).
• +cyan+ (constant).
• +green+ (constant).
• +magenta+ (constant).
• +red+ (constant).
• +white+ (constant).
• +yellow+ (constant).
• color-alpha (function).
• color-argb (function).
• color-blue (function).
• color-green (function).
• color-intensity (function).
• color-red (function).
• color-rgb (function).
• convert-color-to-imago-format (function).
• gray-alpha (function).
• gray-intensity (function).
• grayscale-pixel (type).
• indexed-pixel (type).
• invert-color (function).
• invert-gray (function).
• make-color (function).
• make-gray (function).
• planar-pixel (type).
• rgb-pixel (type).

Internals

• +default-bit+ (constant).
• +default-gray+ (constant).
• +default-rgb+ (constant).
• binary-pixel (type).
• closest-colortable-entry (function).
• make-simple-gray-colormap (function).

---

3.1.6 imago/image.lisp

Dependency

package.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

• binary-image (class).
• grayscale-image (class).
• image (class).
• image-colormap (reader method).
• image-colormap (reader method).
• (setf image-colormap) (writer method).
• (setf image-colormap) (writer method).
• image-dimensions (function).
• image-height (function).
• image-pixel (generic function).
• (setf image-pixel) (generic function).
• image-pixels (reader method).
• image-pixels (reader method).
• image-pixels (reader method).
• image-pixels (reader method).
• image-pixels (reader method).
• (setf image-pixels) (writer method).
• (setf image-pixels) (writer method).
• (setf image-pixels) (writer method).
• (setf image-pixels) (writer method).
• (setf image-pixels) (writer method).
• image-plane-count (reader method).
• (setf image-plane-count) (writer method).
• image-width (function).
• indexed-image (class).
• initialize-instance (method).
• initialize-instance (method).
• initialize-instance (method).
• initialize-instance (method).
• initialize-instance (method).
• make-binary-image (function).
• make-binary-image-from-pixels (function).
• make-grayscale-image (function).
• make-grayscale-image-from-pixels (function).
• make-rgb-image (function).
• make-rgb-image-from-pixels (function).
• planar-image (class).
• print-object (method).
• rgb-image (class).

Internals

• add-generic-initializer (macro).
• pixel-size (generic function).

---

3.1.7 imago/image-utilities.lisp

Dependencies

• image.lisp (file).
• color.lisp (file).
• utilities.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

• do-image-pixels (macro).
• do-line-pixels (macro).
• do-region-pixels (macro).
• set-alpha (generic function).
• with-image-definition (macro).

Internals

• do-rectangle (macro).
• images-same-dimensions-p (function).
• images-same-type-p (function).
• in-image-p (function).
• in-region-p (function).
• make-similar-image (generic function).

---

3.1.8 imago/crc32.lisp

Dependency

package.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Internals

• +crc32-table+ (special variable).
• crc32 (function).
• update-crc32 (function).

---

3.1.9 imago/drawing.lisp

Dependencies

• image-utilities.lisp (file).
• color.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

• draw-bezier-curve (function).
• draw-circle (function).
• draw-line (function).
• draw-point (function).
• draw-polygon (function).
• draw-rectangle (function).

---

3.1.10 imago/convert.lisp

Dependencies

• image.lisp (file).
• color.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

• convert-to-binary (generic function).
• convert-to-grayscale (generic function).
• convert-to-indexed (generic function).
• convert-to-planar (generic function).
• convert-to-rgb (generic function).

---

3.1.11 imago/convolve.lisp

Dependencies

• image.lisp (file).
• color.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

• blur (function).
• convolve (generic function).
• edge-detect (function).
• emboss (function).
• sharpen (function).

Internals

+emboss-matrix-cell-angles+ (special variable).

---

3.1.12 imago/compose.lisp

Dependencies

• image.lisp (file).
• color.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

compose (generic function).

Internals

default-compose-operator (generic function).

---

3.1.13 imago/contrast.lisp

Dependencies

• image.lisp (file).
• color.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

enhance-contrast (generic function).

Internals

• cdt->equalization-table (function).
• do-image-pixels* (macro).
• histogram (type).
• histogram->cdt (function).
• make-histogram (function).

---

3.1.14 imago/morphology.lisp

Dependency

image.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

• *structuring-element* (special variable).
• +cross-pattern+ (constant).
• +square-pattern+ (constant).
• component-boxes (function).
• dilate (function).
• distance-transform (function).
• erode (function).
• label-components (function).
• thin (function).

Internals

• add-indices (function).
• choose-pass2 (function).
• distance-cdt (function).
• distance-edt (function).
• dropwhile (function).
• dt-helper (type).
• kernel-some (function).
• pass1! (function).
• pass2! (function).
• sep-cdt (function).
• sep-edt (function).
• thinning-pass (function).
• thinning-pass-guo (function).
• thinning-pass-zhang (function).
• thinning-type (type).
• transpose (function).

---

3.1.15 imago/interpolate.lisp

Dependencies

• image.lisp (file).
• color.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

*default-interpolation* (special variable).

Internals

• +resize-offsets+ (constant).
• cubic-interpolator (function).
• interpolator (generic function).
• linear-interpolation (function).
• linear-interpolator (function).

---

3.1.16 imago/rotate.lisp

Dependencies

• image.lisp (file).
• color.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

rotate (function).

Internals

• make-default-background-color (generic function).
• make-rotator (function).
• rotate-dimensions (function).

---

3.1.17 imago/operations.lisp

Dependencies

• image.lisp (file).
• color.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

• copy (generic function).
• crop (function).
• flip (generic function).
• invert (generic function).
• resize (function).
• scale (function).

Internals

• %resize (generic function).
• resize-pixels (function).

---

3.1.18 imago/downscale.lisp

Dependencies

• image.lisp (file).
• color.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

downscale (generic function).

Internals

• downscale-channel (function).
• downscale-pixels (function).
• pixels-in-box (function).

---

3.1.19 imago/file.lisp

Dependency

conditions.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

• def-reader-from-file (macro).
• def-writer-to-file (macro).
• read-image (function).
• register-image-io-functions (function).
• register-image-reader (function).
• register-image-writer (function).
• write-image (function).

Internals

• *image-file-readers* (special variable).
• *image-file-writers* (special variable).
• register-image-io-function (function).

---

3.1.20 imago/file-png.lisp

Dependencies

• image.lisp (file).
• color.lisp (file).
• crc32.lisp (file).
• file.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

• read-png (function).
• read-png-from-stream (function).
• write-png (function).
• write-png-to-stream (function).

Internals

• +png-idat-chunk-type+ (special variable).
• +png-iend-chunk-type+ (special variable).
• +png-ihdr-chunk-type+ (special variable).
• +png-plte-chunk-type+ (special variable).
• +png-signature+ (special variable).
• copy-png-descriptor (function).
• decode-png-colormap (function).
• decode-png-descriptor (function).
• decode-png-image (function).
• image-png-color-type (generic function).
• make-png-descriptor (function).
• png-descriptor (structure).
• png-descriptor-color-type (reader).
• (setf png-descriptor-color-type) (writer).
• png-descriptor-compression-method (reader).
• (setf png-descriptor-compression-method) (writer).
• png-descriptor-depth (reader).
• (setf png-descriptor-depth) (writer).
• png-descriptor-filter-method (reader).
• (setf png-descriptor-filter-method) (writer).
• png-descriptor-height (reader).
• (setf png-descriptor-height) (writer).
• png-descriptor-interlace-method (reader).
• (setf png-descriptor-interlace-method) (writer).
• png-descriptor-p (function).
• png-descriptor-width (reader).
• (setf png-descriptor-width) (writer).
• png-paeth (function).
• png-samples-per-pixel (function).
• read-png-chunk (function).
• read-png-sample (function).
• read-png-signature (function).
• write-png-chunk (function).
• write-png-colormap-chunk (generic function).
• write-png-data-chunk (function).
• write-png-end-chunk (function).
• write-png-header-chunk (function).
• write-png-pixel-bytes (generic function).
• write-png-signature (function).

---

3.1.21 imago/file-pnm.lisp

Dependencies

• image.lisp (file).
• color.lisp (file).
• file.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

• read-pnm (function).
• read-pnm-from-stream (function).
• write-pnm (function).
• write-pnm-to-stream (function).

Internals

• image-type+format=>magic (function).
• magic=>image-type+format (function).
• pnm-output-max-value-p (generic function).
• pnm-transform-input-stream (function).
• pnm-write-pixel (generic function).
• read-pnm-info (function).
• read-pnm-pixel (generic function).

---

3.1.22 imago/file-tga.lisp

Dependencies

• image.lisp (file).
• color.lisp (file).
• file.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

• read-tga (function).
• read-tga-from-stream (function).
• write-tga (function).
• write-tga-to-stream (generic function).

Internals

• read-tga-color (function).
• read-tga-color-index (function).
• read-tga-colormap (function).
• read-tga-data (function).
• write-tga-data (function).

---

3.1.23 imago/file-jpg.lisp

Dependencies

• image.lisp (file).
• color.lisp (file).
• file.lisp (file).

Source

imago.asd.

Parent Component

imago (system).

Public Interface

• read-jpg (function).
• read-jpg-from-stream (function).
• write-jpg (function).
• write-jpg-to-stream (function).

Internals

• read-jpg-pixel (generic function).
• write-jpg-pixel (generic function).

---

5.1.1 Constants

Constant: +black+ ¶

Package

imago.

Source

color.lisp.

Constant: +blue+ ¶

Package

imago.

Source

color.lisp.

Constant: +cross-pattern+ ¶

Neighborhood pattern for Manhattan distance. Two
pixels are considered neighbors if Manhattan distance between them is 1

Package

imago.

Source

morphology.lisp.

Constant: +cyan+ ¶

Package

imago.

Source

color.lisp.

Constant: +green+ ¶

Package

imago.

Source

color.lisp.

Constant: +magenta+ ¶

Package

imago.

Source

color.lisp.

Constant: +red+ ¶

Package

imago.

Source

color.lisp.

Constant: +square-pattern+ ¶

Neighborhood pattern for Chebyshev distance. Two
pixels are considered neighbors if Chebyshev distance between them is 1

Package

imago.

Source

morphology.lisp.

Constant: +white+ ¶

Package

imago.

Source

color.lisp.

Constant: +yellow+ ¶

Package

imago.

Source

color.lisp.

---

5.1.2 Special variables

Special Variable: *default-interpolation* ¶

Default interpolation method. See RESIZE for details.

Package

imago.

Source

interpolate.lisp.

Special Variable: *structuring-element* ¶

Default structuring element for erosion and dilation

Package

imago.

Source

morphology.lisp.

---

5.1.3 Macros

Macro: def-reader-from-file (reader-name stream-reader &optional documentation) ¶

Package

imago.

Source

file.lisp.

Macro: def-writer-to-file (writer-name stream-writer keyword-arguments &optional documentation) ¶

Package

imago.

Source

file.lisp.

Macro: do-image-pixels ((image color x y) &body body) ¶

Iterates through all pixels of an image. For each pixel, X and Y are bound to the pixel coordinates, and COLOR is a generalized variable corresponding to the pixel color.

Package

imago.

Source

image-utilities.lisp.

Macro: do-line-pixels ((image color x y x1 y1 x2 y2) &body body) ¶

Iterates through all pixels of a line segment in an image, corresponding to the X1, Y1, X2 and Y2 parameters. For each pixel, X and Y are bound to the pixel coordinates, and COLOR is a generalized variable corresponding to the pixel color.

Package

imago.

Source

image-utilities.lisp.

Macro: do-region-pixels ((image color x y region-x region-y region-width region-height) &body body) ¶

Iterates through all pixels of a rectangular region in an image.
For each pixel, X and Y are bound to the pixel coordinates, and COLOR is a generalized variable corresponding to the pixel color.

Package

imago.

Source

image-utilities.lisp.

Macro: with-image-definition ((image width height pixels) &body body) ¶

Binds the WIDTH, HEIGHT and PIXELS variables to the values corresponding to IMAGE, then evaluates the body.

Package

imago.

Source

image-utilities.lisp.

---

5.1.4 Ordinary functions

Function: blur (image) ¶

Package

imago.

Source

convolve.lisp.

Function: color-alpha (color) ¶

Package

imago.

Source

color.lisp.

Function: color-argb (color) ¶

Package

imago.

Source

color.lisp.

Function: color-blue (color) ¶

Package

imago.

Source

color.lisp.

Function: color-green (color) ¶

Package

imago.

Source

color.lisp.

Function: color-intensity (color) ¶

Package

imago.

Source

color.lisp.

Function: color-red (color) ¶

Package

imago.

Source

color.lisp.

Function: color-rgb (color) ¶

Package

imago.

Source

color.lisp.

Function: component-boxes (components) ¶

Return bounding boxes ((XMIN YMIN) (XMAX YMAX)) for connected components of an image. COMPONENTS is an array returned by LABEL-COMPONENTS

Package

imago.

Source

morphology.lisp.

Function: convert-color-to-imago-format (color depth) ¶

Package

imago.

Source

color.lisp.

Function: crop (image x y width height) ¶

Crops an image. The resulting image is WIDTHxHEIGHT
and its top left corner has coordinates (X, Y) in the original image space. If crop rectangle is exceeding dimensions of the original image, OPERATION-ERROR is signalled.

Package

imago.

Source

operations.lisp.

Function: dilate (image &optional structuring-element) ¶

Dilate binary image. STRUCTURING-ELEMENT is an optional 2D simple array of bits which serves as a structuring element and defaults to *STRUCTURING-ELEMENT*.

Package

imago.

Source

morphology.lisp.

Function: distance-transform (image &key type feature) ¶

Perform distance transform on a binary image. A distance to the closest pixels with the value FEATURE is calculate for each pixels in the image.

TYPE can be either :MDT (Manhattan distance transform), :CDT (Chessboard distance transform) or :EDT (squared Euclidean distance).

Package

imago.

Source

morphology.lisp.

Function: draw-bezier-curve (image x1 y1 x2 y2 x3 y3 x4 y4 color) ¶

Draws a cublic Bezier curve defined by a starting point, two control points, and an end point, in an image.

Package

imago.

Source

drawing.lisp.

Function: draw-circle (image center-x center-y radius color) ¶

Draws a circle in an image.

Package

imago.

Source

drawing.lisp.

Function: draw-line (image x1 y1 x2 y2 color &key dash-length dash-interval) ¶

Draws a line between two points in an image.

Package

imago.

Source

drawing.lisp.

Function: draw-point (image x y color) ¶

Draws a point in an image.

Package

imago.

Source

drawing.lisp.

Function: draw-polygon (image coord-list color &key closed dash-length dash-interval) ¶

Draws a polygon in an image.

Package

imago.

Source

drawing.lisp.

Function: draw-rectangle (image x1 y1 width height color &key dash-length dash-interval) ¶

Draws a rectangle in an image.

Package

imago.

Source

drawing.lisp.

Function: edge-detect (image) ¶

Package

imago.

Source

convolve.lisp.

Function: emboss (image &key angle depth) ¶

Package

imago.

Source

convolve.lisp.

Function: erode (image &optional structuring-element) ¶

Erode binary image. STRUCTURING-ELEMENT is an optional 2D simple array of bits which serves as a structuring element and defaults to *STRUCTURING-ELEMENT*.

Package

imago.

Source

morphology.lisp.

Function: gray-alpha (gray) ¶

Package

imago.

Source

color.lisp.

Function: gray-intensity (gray) ¶

Package

imago.

Source

color.lisp.

Function: image-dimensions (image) ¶

Package

imago.

Source

image.lisp.

Function: image-height (image) ¶

Package

imago.

Source

image.lisp.

Function: image-width (image) ¶

Package

imago.

Source

image.lisp.

Function: invert-color (color) ¶

Package

imago.

Source

color.lisp.

Function: invert-gray (gray) ¶

Package

imago.

Source

color.lisp.

Function: label-components (image &key connectivity) ¶

Perform connected components labeling on binary image. Pixels with value zero are considered background. Each cluster gets a unique integer label. The result is returned in an array of fixnums with the same dimenions as image.

Package

imago.

Source

morphology.lisp.

Function: make-binary-image (w h &optional initial-color) ¶

Create BINARY-IMAGE with dimensions WxH and fill it with INITIAL-COLOR or a suitable default if INITIAL-COLOR is not specified.

Package

imago.

Source

image.lisp.

Function: make-binary-image-from-pixels (pixels) ¶

Create BINARY-IMAGE from two dimensional simple array of pixels of type BINARY-PIXEL

Package

imago.

Source

image.lisp.

Function: make-color (r g b &optional alpha) ¶

Package

imago.

Source

color.lisp.

Function: make-gray (intensity &optional alpha) ¶

Package

imago.

Source

color.lisp.

Function: make-grayscale-image (w h &optional initial-color) ¶

Create GRAYSCALE-IMAGE with dimensions WxH and fill it with INITIAL-COLOR or a suitable default if INITIAL-COLOR is not specified.

Package

imago.

Source

image.lisp.

Function: make-grayscale-image-from-pixels (pixels) ¶

Create GRAYSCALE-IMAGE from two dimensional simple array of pixels of type GRAYSCALE-PIXEL

Package

imago.

Source

image.lisp.

Function: make-rgb-image (w h &optional initial-color) ¶

Create RGB-IMAGE with dimensions WxH and fill it with INITIAL-COLOR or a suitable default if INITIAL-COLOR is not specified.

Package

imago.

Source

image.lisp.

Function: make-rgb-image-from-pixels (pixels) ¶

Create RGB-IMAGE from two dimensional simple array of pixels of type RGB-PIXEL

Package

imago.

Source

image.lisp.

Function: read-image (filename &key errorp) ¶

Reads an image from a file. If the file format is not recognized, depending on the value of :ERRORP, either throws an error or returns NIL.

Package

imago.

Source

file.lisp.

Function: read-jpg (filename) ¶

Read grayscale or colorful jpeg image using cl-jpeg. Colorful images are converted to RGB colorspace.

Package

imago.

Source

file-jpg.lisp.

Function: read-jpg-from-stream (stream) ¶

Read grayscale or colorful jpeg image using cl-jpeg. Colorful images are converted to RGB colorspace. Stream must be a stream of unsigned octets.

Package

imago.

Source

file-jpg.lisp.

Function: read-png (filename) ¶

Package

imago.

Source

file-png.lisp.

Function: read-png-from-stream (stream) ¶

Read png image from a stream of unsigned octets.

Package

imago.

Source

file-png.lisp.

Function: read-pnm (filename) ¶

Reads data for an image in PNM format from a file, and returns a newly created image correponding to those data.

Package

imago.

Source

file-pnm.lisp.

Function: read-pnm-from-stream (stream) ¶

Read PNM image from an octet stream STREAM.

Package

imago.

Source

file-pnm.lisp.

Function: read-tga (filename) ¶

Package

imago.

Source

file-tga.lisp.

Function: read-tga-from-stream (stream) ¶

Package

imago.

Source

file-tga.lisp.

Function: register-image-io-functions (extensions &key reader writer) ¶

This function is just a shorthand for REGISTER-IMAGE-READER and REGISTER-IMAGE-WRITER. Whenever READER and WRITER are not NIL, imago registers that I/O handler for the specified EXTENSIONS.

Package

imago.

Source

file.lisp.

Function: register-image-reader (extensions function) ¶

Register a reader function for some file extensions. The FUNCTION must take a FILESPEC as argument, and return an IMAGE.

Package

imago.

Source

file.lisp.

Function: register-image-writer (extensions function) ¶

Register a writer function for some file extensions. The FUNCTION must take an IMAGE and FILESPEC as arguments. To gain full control of writing options use specific WRITE-* functions.

Package

imago.

Source

file.lisp.

Function: resize (image new-width new-height &key interpolation) ¶

Returns an newly created image corresponding to the
IMAGE image, with given dimensions. Currently supported INTERPOLATION methods are :NEAREST-NEIGHBOR, :BILINEAR,
:BICUBIC and :BOX-SAMPLING. When :BOX-SAMPLING is passed RESIZE just calls DOWNSCALE function which uses box sampling to downscale images. This last method can only be used for downscaling.

Package

imago.

Source

operations.lisp.

Function: rotate (image degree &key interpolation background-color) ¶

Rotate an image by DEGREE degrees counterclockwise (negative DEGREE gives clockwise rotation).

Package

imago.

Source

rotate.lisp.

Function: scale (image width-factor height-factor &key interpolation) ¶

Returns an newly created image corresponding to the
IMAGE image, with its dimensions multiplied by the given factors. INTERPOLATION is pixel interpolation method, see RESIZE for more details.

Package

imago.

Source

operations.lisp.

Function: sharpen (image) ¶

Package

imago.

Source

convolve.lisp.

Function: thin (image &optional type) ¶

Perform thinning (extracting topological skeleton) of binary image.

Package

imago.

Source

morphology.lisp.

Function: write-image (image filename &key errorp) ¶

Writes an image IMAGE to a file. If the file format is not recognized, depending on the value of :ERRORP, either throws an error or returns NIL.

Package

imago.

Source

file.lisp.

Function: write-jpg (image filename &key quality) ¶

Write imago image to jpeg file. QUALITY is an integer from 1 to 64 where 64 is default and the best quality.

Package

imago.

Source

file-jpg.lisp.

Function: write-jpg-to-stream (image stream &key quality) ¶

Write jpeg image IMAGE to an octet stream STREAM. QUALITY is an integer from 1 to 64 where 64 is default and the best quality.

Package

imago.

Source

file-jpg.lisp.

Function: write-png (image filename) ¶

Package

imago.

Source

file-png.lisp.

Function: write-png-to-stream (image stream) ¶

Package

imago.

Source

file-png.lisp.

Function: write-pnm (image filename &key format) ¶

Writes the image data to a file in PNM format. OUTPUT-FORMAT can be either :ASCII or :BINARY.

Package

imago.

Source

file-pnm.lisp.

Function: write-pnm-to-stream (image stream &key format) ¶

Write IMAGE to an octet stream STREAM. FORMAT can be either :BINARY or :ASCII.

Package

imago.

Source

file-pnm.lisp.

Function: write-tga (image filename &key top-down-p) ¶

Package

imago.

Source

file-tga.lisp.

---

5.1.5 Generic functions

Generic Function: compose (dest image1 image2 x y operator) ¶

Composes IMAGE1 and IMAGE2 at offset (X, Y), using
OPERATOR to compose each pixel. OPERATOR must be a function of two colors, returning a color.

Package

imago.

Source

compose.lisp.

Methods

Method: compose ((dest image) (image1 image) (image2 image) x y operator) ¶

Method: compose ((dest (eql nil)) (image1 image) (image2 image) x y operator) ¶

Generic Function: convert-to-binary (image threshold) ¶

Convert to binary image by thresholding pixels of the image

Package

imago.

Source

convert.lisp.

Methods

Method: convert-to-binary ((image grayscale-image) (threshold integer)) ¶

Method: convert-to-binary ((image rgb-image) (threshold integer)) ¶

Method: convert-to-binary ((image image) threshold) ¶

Generic Function: convert-to-grayscale (image) ¶

Package

imago.

Source

convert.lisp.

Methods

Method: convert-to-grayscale ((image binary-image)) ¶

Method: convert-to-grayscale ((image indexed-image)) ¶

Method: convert-to-grayscale ((image rgb-image)) ¶

Method: convert-to-grayscale ((image image)) ¶

Method: convert-to-grayscale ((image grayscale-image)) ¶

Generic Function: convert-to-indexed (image) ¶

Package

imago.

Source

convert.lisp.

Methods

Method: convert-to-indexed ((image grayscale-image)) ¶

Method: convert-to-indexed ((image image)) ¶

Method: convert-to-indexed ((image indexed-image)) ¶

Generic Function: convert-to-planar (image) ¶

Package

imago.

Source

convert.lisp.

Methods

Method: convert-to-planar ((image image)) ¶

Method: convert-to-planar ((image planar-image)) ¶

Generic Function: convert-to-rgb (image) ¶

Package

imago.

Source

convert.lisp.

Methods

Method: convert-to-rgb ((image binary-image)) ¶

Method: convert-to-rgb ((image grayscale-image)) ¶

Method: convert-to-rgb ((image indexed-image)) ¶

Method: convert-to-rgb ((image image)) ¶

Method: convert-to-rgb ((image rgb-image)) ¶

Generic Function: convolve (image matrix divisor offset) ¶

Applies a 5x5 convolution kernel (a 5x5 real number matrix) to an image. Returns the resulting image.

Package

imago.

Source

convolve.lisp.

Methods

Method: convolve ((image grayscale-image) matrix divisor offset) ¶

Method: convolve ((image rgb-image) matrix divisor offset) ¶

Generic Function: copy (dest src &key dest-x dest-y src-x src-y width height) ¶

Copies a rectangular region from image SRC to image DEST.
Both images must be large enough to contain the specified region at the given positions. Both images must be of same type.

Package

imago.

Source

operations.lisp.

Methods

Method: copy ((dest image) (src image) &key dest-x dest-y src-x src-y width height) ¶

Method: copy ((dest (eql nil)) (src planar-image) &key dest-x dest-y src-x src-y width height) ¶

Method: copy :around ((dest (eql nil)) (src indexed-image) &key dest-x dest-y src-x src-y width height) ¶

Method: copy ((dest (eql nil)) (src image) &key dest-x dest-y src-x src-y width height) ¶

Generic Function: downscale (image width heigth) ¶

Downscale an image using box sampling. This
function provides better results than RESIZE, but is slower.

Package

imago.

Source

downscale.lisp.

Methods

Method: downscale :before ((image image) width height) ¶

Method: downscale ((image grayscale-image) width height) ¶

Method: downscale ((image rgb-image) width height) ¶

Generic Function: enhance-contrast (image) ¶

Enhance the contrast of an image

Package

imago.

Source

contrast.lisp.

Methods

Method: enhance-contrast ((image grayscale-image)) ¶

Enhance the contrast of an IMAGE using a general histogram equalization algorithm

Generic Function: flip (dest image axis) ¶

Flips an image. AXIS may be either :HORIZONTAL or
:VERTICAL. DEST must be either an image of same type and dimensions as IMAGE, or NIL. Returns the resulting image.

Package

imago.

Source

operations.lisp.

Methods

Method: flip ((dest image) (image image) (axis (eql :vertical))) ¶

Method: flip ((dest image) (image image) (axis (eql :horizontal))) ¶

Method: flip ((dest (eql nil)) (image image) axis) ¶

Generic Reader: image-colormap (object) ¶

Package

imago.

Methods

Reader Method: image-colormap ((planar-image planar-image)) ¶

automatically generated reader method

Source

image.lisp.

Target Slot

colormap.

Reader Method: image-colormap ((indexed-image indexed-image)) ¶

automatically generated reader method

Source

image.lisp.

Target Slot

colormap.

Generic Writer: (setf image-colormap) (object) ¶

Package

imago.

Methods

Writer Method: (setf image-colormap) ((planar-image planar-image)) ¶

automatically generated writer method

Source

image.lisp.

Target Slot

colormap.

Writer Method: (setf image-colormap) ((indexed-image indexed-image)) ¶

automatically generated writer method

Source

image.lisp.

Target Slot

colormap.

Generic Function: image-pixel (image x y) ¶

Returns the color of the pixel at specified coordinates in the image.

Package

imago.

Source

image.lisp.

Methods

Method: image-pixel ((image image) x y) ¶

Generic Function: (setf image-pixel) (image x y) ¶

Sets the color of the pixel at specified coordinates in the image.

Package

imago.

Source

image.lisp.

Methods

Method: (setf image-pixel) ((image image) x y) ¶

Generic Reader: image-pixels (object) ¶

Package

imago.

Methods

Reader Method: image-pixels ((binary-image binary-image)) ¶

automatically generated reader method

Source

image.lisp.

Target Slot

pixels.

Reader Method: image-pixels ((planar-image planar-image)) ¶

automatically generated reader method

Source

image.lisp.

Target Slot

pixels.

Reader Method: image-pixels ((indexed-image indexed-image)) ¶

automatically generated reader method

Source

image.lisp.

Target Slot

pixels.

Reader Method: image-pixels ((grayscale-image grayscale-image)) ¶

automatically generated reader method

Source

image.lisp.

Target Slot

pixels.

Reader Method: image-pixels ((rgb-image rgb-image)) ¶

automatically generated reader method

Source

image.lisp.

Target Slot

pixels.

Generic Writer: (setf image-pixels) (object) ¶

Package

imago.

Methods

Writer Method: (setf image-pixels) ((binary-image binary-image)) ¶

automatically generated writer method

Source

image.lisp.

Target Slot

pixels.

Writer Method: (setf image-pixels) ((planar-image planar-image)) ¶

automatically generated writer method

Source

image.lisp.

Target Slot

pixels.

Writer Method: (setf image-pixels) ((indexed-image indexed-image)) ¶

automatically generated writer method

Source

image.lisp.

Target Slot

pixels.

Writer Method: (setf image-pixels) ((grayscale-image grayscale-image)) ¶

automatically generated writer method

Source

image.lisp.

Target Slot

pixels.

Writer Method: (setf image-pixels) ((rgb-image rgb-image)) ¶

automatically generated writer method

Source

image.lisp.

Target Slot

pixels.

Generic Reader: image-plane-count (object) ¶

Package

imago.

Methods

Reader Method: image-plane-count ((planar-image planar-image)) ¶

automatically generated reader method

Source

image.lisp.

Target Slot

plane-count.

Generic Writer: (setf image-plane-count) (object) ¶

Package

imago.

Methods

Writer Method: (setf image-plane-count) ((planar-image planar-image)) ¶

automatically generated writer method

Source

image.lisp.

Target Slot

plane-count.

Generic Function: invert (image) ¶

Create a new image with colors of the supplied image being inverted.

Package

imago.

Source

operations.lisp.

Methods

Method: invert ((image binary-image)) ¶

Method: invert ((image grayscale-image)) ¶

Method: invert ((image rgb-image)) ¶

Generic Function: set-alpha (image alpha) ¶

Sets the alpha channel value for all pixels/colors in an image.

Package

imago.

Source

image-utilities.lisp.

Methods

Method: set-alpha ((image indexed-image) alpha) ¶

Method: set-alpha ((image grayscale-image) alpha) ¶

Method: set-alpha ((image rgb-image) alpha) ¶

Generic Function: write-tga-to-stream (image stream &key top-down-p) ¶

Package

imago.

Source

file-tga.lisp.

Methods

Method: write-tga-to-stream ((image indexed-image) stream &key top-down-p) ¶

Method: write-tga-to-stream ((image rgb-image) stream &key top-down-p) ¶

---

5.1.6 Standalone methods

Method: initialize-instance :after ((image binary-image) &rest initargs &key width height pixels initial-color) ¶

Source

image.lisp.

Method: initialize-instance :after ((image grayscale-image) &rest initargs &key width height pixels initial-color) ¶

Source

image.lisp.

Method: initialize-instance :after ((image planar-image) &rest initargs &key width height plane-count pixels colormap) ¶

Source

image.lisp.

Method: initialize-instance :after ((image indexed-image) &rest initargs &key width height pixels colormap color-count) ¶

Source

image.lisp.

Method: initialize-instance :after ((image rgb-image) &rest initargs &key width height pixels initial-color) ¶

Source

image.lisp.

Method: print-object ((object image) stream) ¶

Source

image.lisp.

---

5.1.7 Conditions

Condition: decode-error ¶

Signaled when decoding process has errored

Package

imago.

Source

conditions.lisp.

Direct superclasses

• imago-error.
• simple-condition.

Condition: encode-error ¶

Signaled when encoding process has errored

Package

imago.

Source

conditions.lisp.

Direct superclasses

• imago-error.
• simple-condition.

Condition: imago-condition ¶

Generic imago condition

Package

imago.

Source

conditions.lisp.

Direct superclasses

condition.

Direct subclasses

imago-error.

Condition: imago-error ¶

Generic imago error

Package

imago.

Source

conditions.lisp.

Direct superclasses

• error.
• imago-condition.

Direct subclasses

• decode-error.
• encode-error.
• not-implemented.
• operation-error.
• unknown-format.

Condition: not-implemented ¶

Signaled when the performed action is not implemented

Package

imago.

Source

conditions.lisp.

Direct superclasses

imago-error.

Condition: operation-error ¶

Signaled when operation cannot be performed

Package

imago.

Source

conditions.lisp.

Direct superclasses

• imago-error.
• simple-condition.

Condition: unknown-format ¶

Signaled when trying to write to or read from an image with unknown format

Package

imago.

Source

conditions.lisp.

Direct superclasses

imago-error.

Direct methods

unknown-format-pathname.

Direct slots

Slot: pathname ¶

Package

common-lisp.

Initargs

:pathname

Readers

unknown-format-pathname.

Writers

This slot is read-only.

---

5.1.8 Classes

Class: binary-image ¶

The class for binary images whose pixels are just 0
or 1. Image dimensions must be provided to MAKE-INSTANCE, through the :WIDTH and :HEIGHT keyword parameters.

Package

imago.

Source

image.lisp.

Direct superclasses

image.

Direct methods

• %resize.
• convert-to-grayscale.
• convert-to-rgb.
• (setf image-pixels).
• image-pixels.
• initialize-instance.
• invert.
• make-default-background-color.
• pnm-output-max-value-p.
• pnm-write-pixel.
• read-pnm-pixel.
• read-pnm-pixel.

Direct slots

Slot: pixels ¶

Type

(simple-array bit (* *))

Readers

image-pixels.

Writers

(setf image-pixels).

Class: grayscale-image ¶

The class for grayscale images. Image dimensions must be provided to MAKE-INSTANCE, through the :WIDTH and :HEIGHT keyword parameters.

Package

imago.

Source

image.lisp.

Direct superclasses

image.

Direct methods

• %resize.
• convert-to-binary.
• convert-to-grayscale.
• convert-to-indexed.
• convert-to-rgb.
• convolve.
• downscale.
• enhance-contrast.
• (setf image-pixels).
• image-pixels.
• image-png-color-type.
• initialize-instance.
• interpolator.
• interpolator.
• invert.
• make-default-background-color.
• pixel-size.
• pnm-write-pixel.
• pnm-write-pixel.
• read-jpg-pixel.
• read-pnm-pixel.
• read-pnm-pixel.
• set-alpha.
• write-jpg-pixel.
• write-png-pixel-bytes.

Direct slots

Slot: pixels ¶

Type

(simple-array imago:grayscale-pixel (* *))

Readers

image-pixels.

Writers

(setf image-pixels).

Class: image ¶

The protocol class for images.

Package

imago.

Source

image.lisp.

Direct subclasses

• binary-image.
• grayscale-image.
• indexed-image.
• planar-image.
• rgb-image.

Direct methods

• %resize.
• compose.
• compose.
• convert-to-binary.
• convert-to-grayscale.
• convert-to-indexed.
• convert-to-planar.
• convert-to-rgb.
• copy.
• copy.
• downscale.
• flip.
• flip.
• flip.
• (setf image-pixel).
• image-pixel.
• interpolator.
• make-similar-image.
• pnm-output-max-value-p.
• print-object.
• write-png-colormap-chunk.

Class: indexed-image ¶

The class for indexed images. Image dimensions must be
provided to MAKE-INSTANCE, through the :WIDTH and :HEIGHT keyword parameters. Also accepts a :COLOR-COUNT keyword parameter, to specify the image color count (256 by default).

Package

imago.

Source

image.lisp.

Direct superclasses

image.

Direct methods

• %resize.
• convert-to-grayscale.
• convert-to-indexed.
• convert-to-rgb.
• copy.
• (setf image-colormap).
• image-colormap.
• (setf image-pixels).
• image-pixels.
• image-png-color-type.
• initialize-instance.
• pixel-size.
• set-alpha.
• write-png-colormap-chunk.
• write-png-pixel-bytes.
• write-tga-to-stream.

Direct slots

Slot: pixels ¶

Type

(simple-array imago:indexed-pixel (* *))

Readers

image-pixels.

Writers

(setf image-pixels).

Slot: colormap ¶

Initargs

:colormap

Readers

image-colormap.

Writers

(setf image-colormap).

Class: planar-image ¶

The class for planar images. Image dimensions and
plane count must be provided to MAKE-INSTANCE, through the :WIDTH, :HEIGHT, and :PLANE-COUNT keyword parameters, respectively.

Package

imago.

Source

image.lisp.

Direct superclasses

image.

Direct methods

• convert-to-planar.
• copy.
• (setf image-colormap).
• image-colormap.
• (setf image-pixels).
• image-pixels.
• (setf image-plane-count).
• image-plane-count.
• initialize-instance.
• pixel-size.

Direct slots

Slot: pixels ¶

Type

simple-array

Readers

image-pixels.

Writers

(setf image-pixels).

Slot: plane-count ¶

Type

integer

Readers

image-plane-count.

Writers

(setf image-plane-count).

Slot: colormap ¶

Initargs

:colormap

Readers

image-colormap.

Writers

(setf image-colormap).

Class: rgb-image ¶

The class for RGB images. Image dimensions must be
provided to MAKE-INSTANCE, through the :WIDTH and :HEIGHT keyword parameters.

Package

imago.

Source

image.lisp.

Direct superclasses

image.

Direct methods

• %resize.
• convert-to-binary.
• convert-to-grayscale.
• convert-to-rgb.
• convolve.
• default-compose-operator.
• downscale.
• (setf image-pixels).
• image-pixels.
• image-png-color-type.
• initialize-instance.
• interpolator.
• interpolator.
• invert.
• make-default-background-color.
• pixel-size.
• pnm-write-pixel.
• pnm-write-pixel.
• read-jpg-pixel.
• read-pnm-pixel.
• read-pnm-pixel.
• set-alpha.
• write-jpg-pixel.
• write-png-pixel-bytes.
• write-tga-to-stream.

Direct slots

Slot: pixels ¶

Type

(simple-array imago:rgb-pixel (* *))

Readers

image-pixels.

Writers

(setf image-pixels).

---

5.1.9 Types

Type: grayscale-pixel () ¶

Package

imago.

Source

color.lisp.

Type: indexed-pixel () ¶

Package

imago.

Source

color.lisp.

Type: planar-pixel (&optional plane-count) ¶

Package

imago.

Source

color.lisp.

Type: rgb-pixel () ¶

Package

imago.

Source

color.lisp.

---

5.2.1 Constants

Constant: +default-bit+ ¶

Default color for a newly created binary image

Package

imago.

Source

color.lisp.

Constant: +default-gray+ ¶

Default grayscale color for a newly created grayscale image

Package

imago.

Source

color.lisp.

Constant: +default-rgb+ ¶

Default RGB color for a newly created RGB image

Package

imago.

Source

color.lisp.

Constant: +resize-offsets+ ¶

Package

imago.

Source

interpolate.lisp.

---

5.2.2 Special variables

Special Variable: *image-file-readers* ¶

Package

imago.

Source

file.lisp.

Special Variable: *image-file-writers* ¶

Package

imago.

Source

file.lisp.

Special Variable: +crc32-table+ ¶

Package

imago.

Source

crc32.lisp.

Special Variable: +emboss-matrix-cell-angles+ ¶

Package

imago.

Source

convolve.lisp.

Special Variable: +png-idat-chunk-type+ ¶

Package

imago.

Source

file-png.lisp.

Special Variable: +png-iend-chunk-type+ ¶

Package

imago.

Source

file-png.lisp.

Special Variable: +png-ihdr-chunk-type+ ¶

Package

imago.

Source

file-png.lisp.

Special Variable: +png-plte-chunk-type+ ¶

Package

imago.

Source

file-png.lisp.

Special Variable: +png-signature+ ¶

Package

imago.

Source

file-png.lisp.

---