retrospectiff

API Reference

retrospectiff

A library for reading and writing TIFF images

RETROSPECTIFF.CONSTANTS

  • Variable +IMAGE-WIDTH-TAG+
    256
  • Variable +IMAGE-LENGTH-TAG+
    257
  • Variable +BITS-PER-SAMPLE-TAG+
    258
  • Variable +COMPRESSION-TAG+
    259
  • Variable +PHOTOMETRIC-INTERPRETATION-TAG+
    262
  • Variable +STRIP-OFFSETS-TAG+
    273
  • Variable +SAMPLES-PER-PIXEL-TAG+
    277
  • Variable +ROWS-PER-STRIP-TAG+
    278
  • Variable +ROWS-PER-STRIP-TAG+
    278
  • Variable +STRIP-BYTE-COUNTS-TAG+
    279
  • Variable +X-RESOLUTION-TAG+
    282
  • Variable +Y-RESOLUTION-TAG+
    283
  • Variable +PLANAR-CONFIGURATION-TAG+
    284
  • Variable +RESOLUTION-UNIT-TAG+
    296
  • Variable +PREDICTOR-TAG+
    317
  • Variable +COLOR-MAP-TAG+
    320
  • Variable +JPEG-TABLES+
    347
  • Variable +PLANAR-CONFIGURATION-CHUNKY+
    1
  • Variable +PLANAR-CONFIGURATION-PLANAR+
    2
  • Variable +PHOTOMETRIC-INTERPRETATION-WHITE-IS-ZERO+
    0
  • Variable +PHOTOMETRIC-INTERPRETATION-BLACK-IS-ZERO+
    1
  • Variable +PHOTOMETRIC-INTERPRETATION-RGB+
    2
  • Variable +PHOTOMETRIC-INTERPRETATION-PALETTE-COLOR+
    3
  • Variable +HORIZONTAL-DIFFERENCING+
    2
  • Variable +NO-COMPRESSION+
    1
  • Variable +LZW-COMPRESSION+
    5
  • Variable +OLD-STYLE-JPEG-COMPRESSION+
    6
  • Variable +JPEG-COMPRESSION+
    7
  • Variable +DEFLATE-COMPRESSION+
    8
  • Variable +PACKBITS-COMPRESSION+
    32773
  • Variable +FIELD-TYPE-BYTE+
    1
  • Variable +FIELD-TYPE-ASCII+
    2
  • Variable +FIELD-TYPE-SHORT+
    3
  • Variable +FIELD-TYPE-LONG+
    4
  • Variable +FIELD-TYPE-RATIONAL+
    5
  • Variable +FIELD-TYPE-SBYTE+
    6
  • Variable +FIELD-TYPE-UNDEFINED+
    7
  • Variable +FIELD-TYPE-SSHORT+
    8
  • Variable +FIELD-TYPE-SLONG+
    9
  • Variable +FIELD-TYPE-SRATIONAL+
    10
  • Variable +FIELD-TYPE-FLOAT+
    11
  • Variable +FIELD-TYPE-DOUBLE+
    12
  • Variable +EXIF-TAG+
    34665
  • Variable +ICC-PROFILE-TAG+
    34675

RETROSPECTIFF.GLOBALS

  • Variable *BYTE-ORDER*
    :little-endian
  • Variable *TIFF-FILE-OFFSET*

RETROSPECTIFF.BINARY-TYPES

  • Function CONVERT-TO-SIGNED-INTEGER (num bits)
  • Function CONVERT-TO-UNSIGNED-INTEGER (num bits)
  • Class IFD-ENTRY
    TAG   Accessor: TAG
    FIELD-TYPE   Accessor: FIELD-TYPE
    VALUE-COUNT   Accessor: VALUE-COUNT
  • Generic-Function ENTRY-BYTES (ifd-entry)
  • Method ENTRY-BYTES ((entry ifd-entry))
  • Class BYTE-IFD-ENTRY  (IFD-ENTRY)
    DATA   Accessor: DATA
  • Class ASCII-IFD-ENTRY  (IFD-ENTRY)
    DATA   Accessor: DATA
  • Class SHORT-IFD-ENTRY  (IFD-ENTRY)
    DATA   Accessor: DATA
  • Class LONG-IFD-ENTRY  (IFD-ENTRY)
    DATA   Accessor: DATA
  • Class RATIONAL
    NUMERATOR   Accessor: NUMERATOR
    DENOMINATOR   Accessor: DENOMINATOR
  • Class RATIONAL-IFD-ENTRY  (IFD-ENTRY)
    DATA   Accessor: DATA
  • Class IFD
    ENTRY-COUNT   Accessor: ENTRY-COUNT
    ENTRIES   Accessor: ENTRIES
    NEXT-IFD-OFFSET   Accessor: NEXT-IFD-OFFSET
  • Class TIFF-FIELDS
    BYTE-ORDER   Accessor: BYTE-ORDER
    MAGIC   Accessor: MAGIC
    IFD-OFFSET   Accessor: IFD-OFFSET
    IFD-LIST   Accessor: IFD-LIST
  • Function READ-BYTES (stream count)

Also exports

  • COM.GIGAMONKEYS.BINARY-DATA:WRITE-VALUE
  • COM.GIGAMONKEYS.BINARY-DATA:READ-VALUE

RETROSPECTIFF.UTIL

  • Function STRING-CONTENTS-OF-STREAM (in)
    Returns a string with the entire contents of the specified file.
  • Function STRING-CONTENTS-OF-FILE (pathname)
  • Function VECTOR-CONTENTS-OF-STREAM (in)
    Returns a string with the entire contents of the specified file.
  • Function VECTOR-CONTENTS-OF-FILE (pathname)
  • Function ENSURE-ARRAY-SIZE-AND-SET-FILL-POINTER (array fill-pointer)
  • Function REMOVE-KEYWORD-ARGS (keywords list)

RETROSPECTIFF.BIT-ARRAY

  • Function SET-BITS (array bit-start bit-end value)
  • Function GET-BITS (array bit-start bit-end)

RETROSPECTIFF.COMPRESSION

  • Class IMAGE-INFO
    No slots.
  • Class JPEG-IMAGE-INFO  (IMAGE-INFO)
    JPEG-TABLES   Accessor: JPEG-TABLES
    JPEG-IMAGE   Accessor: JPEG-IMAGE
  • Function FIND-COMPRESSION-DECODER (compression)

RETROSPECTIFF.IMAGE

  • Class TIFF-IMAGE
    LENGTH   Accessor: TIFF-IMAGE-LENGTH
    WIDTH   Accessor: TIFF-IMAGE-WIDTH
    BITS-PER-SAMPLE   Accessor: TIFF-IMAGE-BITS-PER-SAMPLE
    SAMPLES-PER-PIXEL   Accessor: TIFF-IMAGE-SAMPLES-PER-PIXEL
    DATA   Accessor: TIFF-IMAGE-DATA
    BYTE-ORDER   Accessor: TIFF-IMAGE-BYTE-ORDER
    COLOR-MAP   Accessor: TIFF-IMAGE-COLOR-MAP
    MIN-IS-WHITE   Accessor: TIFF-IMAGE-MIN-IS-WHITE

RETROSPECTIFF.IFD

  • Function GET-IFD-VALUES (ifd key)
  • Function GET-IFD-VALUE (ifd key)
  • Function MAKE-TIFF-FIELDS (image)

RETROSPECTIFF

  • Function READ-TIFF-STREAM (stream)
  • Function READ-TIFF-FILE (pathname)
  • Function WRITE-TIFF-STREAM (stream obj &key byte-order)
  • Function WRITE-TIFF-FILE (pathname image &rest args &key (if-exists :error) &allow-other-keys)

Also exports

  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-MIN-IS-WHITE
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-BITS-PER-SAMPLE
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-DATA
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-SAMPLES-PER-PIXEL
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-WIDTH
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-LENGTH
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-COLOR-MAP
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-BYTE-ORDER

RETROSPECTIFF2

  • Function READ-TIFF-STREAM (stream)
  • Function READ-TIFF-FILE (pathname)
  • Function WRITE-TIFF-STREAM (stream image &key byte-order)
  • Function WRITE-TIFF-FILE (pathname image &rest args &key (if-exists :error) &allow-other-keys)

Also exports

  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-MIN-IS-WHITE
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-BITS-PER-SAMPLE
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-DATA
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-SAMPLES-PER-PIXEL
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-WIDTH
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-LENGTH
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-COLOR-MAP
  • RETROSPECTIFF.IMAGE:TIFF-IMAGE-BYTE-ORDER