[med-svn] r9051 - in trunk/packages/openslide/tags: . 3.2.5-1/debian
Mathieu Malaterre
malat-guest at alioth.debian.org
Mon Dec 19 17:09:14 UTC 2011
Author: malat-guest
Date: 2011-12-19 17:09:14 +0000 (Mon, 19 Dec 2011)
New Revision: 9051
Added:
trunk/packages/openslide/tags/3.2.5-1/
trunk/packages/openslide/tags/3.2.5-1/debian/changelog
trunk/packages/openslide/tags/3.2.5-1/debian/openslide-quickhash1sum.1
trunk/packages/openslide/tags/3.2.5-1/debian/openslide-quickhash1sum.1.in
trunk/packages/openslide/tags/3.2.5-1/debian/openslide-show-properties.1
trunk/packages/openslide/tags/3.2.5-1/debian/openslide-show-properties.1.xml
trunk/packages/openslide/tags/3.2.5-1/debian/openslide-write-png.1
trunk/packages/openslide/tags/3.2.5-1/debian/openslide-write-png.1.in
trunk/packages/openslide/tags/3.2.5-1/debian/process.xsl
trunk/packages/openslide/tags/3.2.5-1/debian/rules
Removed:
trunk/packages/openslide/tags/3.2.5-1/debian/changelog
trunk/packages/openslide/tags/3.2.5-1/debian/openslide-quickhash1sum.1
trunk/packages/openslide/tags/3.2.5-1/debian/openslide-show-properties.1
trunk/packages/openslide/tags/3.2.5-1/debian/openslide-write-png.1
trunk/packages/openslide/tags/3.2.5-1/debian/rules
Log:
[svn-buildpackage] Tagging openslide 3.2.5-1
Deleted: trunk/packages/openslide/tags/3.2.5-1/debian/changelog
===================================================================
--- trunk/packages/openslide/trunk/debian/changelog 2011-12-19 15:19:23 UTC (rev 9045)
+++ trunk/packages/openslide/tags/3.2.5-1/debian/changelog 2011-12-19 17:09:14 UTC (rev 9051)
@@ -1,19 +0,0 @@
-openslide (3.2.5-1) UNRELEASED; urgency=low
-
- * New upstream
-
- -- Mathieu Malaterre <mathieu.malaterre at gmail.com> Sat, 17 Dec 2011 09:56:13 +0100
-
-openslide (3.2.4-2) unstable; urgency=low
-
- * Fix Vcs-Browser URL
- * Update man pages
- * Fix lintian warnings about d/copyright
-
- -- Mathieu Malaterre <mathieu.malaterre at gmail.com> Wed, 07 Dec 2011 22:18:43 +0100
-
-openslide (3.2.4-1) unstable; urgency=low
-
- * Initial release (Closes: #640027)
-
- -- Mathieu Malaterre <mathieu.malaterre at gmail.com> Thu, 01 Sep 2011 17:18:40 +0200
Copied: trunk/packages/openslide/tags/3.2.5-1/debian/changelog (from rev 9050, trunk/packages/openslide/trunk/debian/changelog)
===================================================================
--- trunk/packages/openslide/tags/3.2.5-1/debian/changelog (rev 0)
+++ trunk/packages/openslide/tags/3.2.5-1/debian/changelog 2011-12-19 17:09:14 UTC (rev 9051)
@@ -0,0 +1,20 @@
+openslide (3.2.5-1) unstable; urgency=low
+
+ * New upstream
+ * Redo the man page directly using docbook.
+
+ -- Mathieu Malaterre <mathieu.malaterre at gmail.com> Mon, 19 Dec 2011 17:53:33 +0100
+
+openslide (3.2.4-2) unstable; urgency=low
+
+ * Fix Vcs-Browser URL
+ * Update man pages
+ * Fix lintian warnings about d/copyright
+
+ -- Mathieu Malaterre <mathieu.malaterre at gmail.com> Wed, 07 Dec 2011 22:18:43 +0100
+
+openslide (3.2.4-1) unstable; urgency=low
+
+ * Initial release (Closes: #640027)
+
+ -- Mathieu Malaterre <mathieu.malaterre at gmail.com> Thu, 01 Sep 2011 17:18:40 +0200
Deleted: trunk/packages/openslide/tags/3.2.5-1/debian/openslide-quickhash1sum.1
===================================================================
--- trunk/packages/openslide/trunk/debian/openslide-quickhash1sum.1 2011-12-19 15:19:23 UTC (rev 9045)
+++ trunk/packages/openslide/tags/3.2.5-1/debian/openslide-quickhash1sum.1 2011-12-19 17:09:14 UTC (rev 9051)
@@ -1,22 +0,0 @@
-.\" Originally generated by help2man 1.38.2.
-.TH OPENSLIDE-QUICKHASH1SUM "1" "September 2011" "3.2.4" "OpenSlide"
-.SH NAME
-openslide-quickhash1sum \- Print OpenSlide quickhash-1 (256-bit) checksums
-.SH SYNOPSIS
-.B openslide-quickhash
-.I infile
-
-.SH DESCRIPTION
-Print OpenSlide quickhash-1 (256-bit) checksums.
-
-.SH "SEE ALSO"
-
-.IR openslide-write-png(1),
-.IR openslide-show-properties(1)
-.PP
-
-.SH AUTHORS
-The Carnegie Mellon School of Computer Science.
-
-This manual page was written by Mathieu Malaterre
-<mathieu.malaterre at gmail.com> for the Debian GNU/Linux system (but may be used by others).
Copied: trunk/packages/openslide/tags/3.2.5-1/debian/openslide-quickhash1sum.1 (from rev 9050, trunk/packages/openslide/trunk/debian/openslide-quickhash1sum.1)
===================================================================
--- trunk/packages/openslide/tags/3.2.5-1/debian/openslide-quickhash1sum.1 (rev 0)
+++ trunk/packages/openslide/tags/3.2.5-1/debian/openslide-quickhash1sum.1 2011-12-19 17:09:14 UTC (rev 9051)
@@ -0,0 +1,22 @@
+.\" Originally generated by help2man 1.38.2.
+.TH OPENSLIDE-QUICKHASH1SUM "1" "September 2011" "3.2.5" "OpenSlide"
+.SH NAME
+openslide-quickhash1sum \- Print OpenSlide quickhash-1 (256-bit) checksums
+.SH SYNOPSIS
+.B openslide-quickhash
+.I infile
+
+.SH DESCRIPTION
+Print OpenSlide quickhash-1 (256-bit) checksums.
+
+.SH "SEE ALSO"
+
+.IR openslide-write-png(1),
+.IR openslide-show-properties(1)
+.PP
+
+.SH AUTHORS
+The Carnegie Mellon School of Computer Science.
+
+This manual page was written by Mathieu Malaterre
+<mathieu.malaterre at gmail.com> for the Debian GNU/Linux system (but may be used by others).
Copied: trunk/packages/openslide/tags/3.2.5-1/debian/openslide-quickhash1sum.1.in (from rev 9050, trunk/packages/openslide/trunk/debian/openslide-quickhash1sum.1.in)
===================================================================
--- trunk/packages/openslide/tags/3.2.5-1/debian/openslide-quickhash1sum.1.in (rev 0)
+++ trunk/packages/openslide/tags/3.2.5-1/debian/openslide-quickhash1sum.1.in 2011-12-19 17:09:14 UTC (rev 9051)
@@ -0,0 +1,12 @@
+[NAME]
+Print OpenSlide quickhash-1 (256-bit) checksums
+
+[SEE ALSO]
+.IR openslide-write-png(1),
+.IR openslide-show-properties(1)
+
+[AUTHOR]
+The Carnegie Mellon School of Computer Science.
+
+This manual page was written by Mathieu Malaterre <mathieu.malaterre at gmail.com> for
+the Debian GNU/Linux system, but may be used by others.
Deleted: trunk/packages/openslide/tags/3.2.5-1/debian/openslide-show-properties.1
===================================================================
--- trunk/packages/openslide/trunk/debian/openslide-show-properties.1 2011-12-19 15:19:23 UTC (rev 9045)
+++ trunk/packages/openslide/tags/3.2.5-1/debian/openslide-show-properties.1 2011-12-19 17:09:14 UTC (rev 9051)
@@ -1,689 +0,0 @@
-.\" Originally generated by help2man 1.38.2.
-.TH OPENSLIDE-SHOW-PROPERTIES "1" "September 2011" "3.2.4" "OpenSlide"
-.SH NAME
-openslide-show-properties \- Print OpenSlide properties
-.SH SYNOPSIS
-.B openslide-show-properties
-.I infile
-
-.SH DESCRIPTION
-Print OpenSlide properties.
-
-.SH "List of Known Properties"
-.PP
-.SS "Properties generated by OpenSlide"
-.PP
-.IP openslide.vendor
-The name of the vendor backend.
-.IP openslide.comment
-A free-form text comment, the same as returned from openslide_get_comment.
-.IP openslide.quickhash-1
-A non-cryptographic hash of a subset of the slide data. It can be used to
-uniquely identify a particular virtual slide, but cannot be used to detect file
-corruption or modification.
-.IP openslide.background-color
-The background color of the slide, given as an RGB hex triplet. This property
-is not always present.
-.PP
-.SS "Properties from the JPEG backend"
-
-No properties defined.
-
-.SS "Properties from the TIFF backend"
-.PP
-.IP tiff.ImageDescription
-The contents of the TIFF ImageDescripton tag.
-.IP tiff.Make
-The contents of the TIFF Make tag.
-.IP tiff.Model
-The contents of the TIFF Model tag.
-.IP tiff.Software
-The contents of the TIFF Software tag.
-.IP tiff.DateTime
-The contents of the TIFF DateTime tag.
-.IP tiff.Artist
-The contents of the TIFF Artist tag.
-.IP tiff.HostComputer
-The contents of the TIFF HostComputer tag.
-.IP tiff.Copyright
-The contents of the TIFF Copyright tag.
-.IP tiff.DocumentName
-The contents of the TIFF DocumentName tag.
-.IP tiff.XResolution
-The contents of the TIFF XResolution tag.
-.IP tiff.YResolution
-The contents of the TIFF yResolution tag.
-.IP tiff.XPosition
-The contents of the TIFF XPosition tag.
-.IP tiff.YPosition
-The contents of the TIFF YPosition tag.
-.IP tiff.ResolutionUnit
-The contents of the TIFF ResolutionUnit tag.
-.PP
-.SH Vendor-specific properties
-.SH Trestle format
-
-.IP Format 0.4i
-single-file pyramidal tiled TIFF, with non-standard metadata and overlaps;
-additional files can contain more metadata and detailed overlap info
-.IP "File extensions"
-\&.tif
-.IP "OpenSlide vendor backend"
-trestle
-.IP "OpenSlide ops backend"
-tiff
-
-.SS Detection
-
-.nr step 1 1
-Trestle slides are stored in single-file TIFF format. OpenSlide will detect a
-file as Trestle if:
-.IP \n[step] 3
-The file is TIFF.
-.IP \n+[step]
-The TIFF Software tag starts with \*(lqMedScan\*(rq.
-.IP \n+[step]
-The ImageDescription tag is present.
-
-.SS Relevant TIFF tags
-
-.TS
-allbox, tab(^); ll.
- \fBTag\fR^\fBDescription\fR
- ImageDescription^Stores some important key-value pairs, see below
- Software^Starts with \*(lqMedScan\*(rq
- XResolution, YResolution^T{
-Seems to store microns-per-pixel (MPP), which may or may not take into account
-the correct objective power. Note that this is inverted from standard TIFF,
-which stores pixels-per-unit, not units-per-pixel.
-T}
-.TE
-
-.SS Extra data stored in ImageDescription
-
-The ImageDescription tag contains semicolon-delimited key-value pairs. A
-key-value pair is equals-delimited. We use the OverlapsXY and Background Color
-keys from the ImageDescription, and ignore the rest. All of these values are
-stored as properties starting with \*(lqtrestle.\*(rq.
-
-.TS
-allbox, tab(^); ll.
- \fBKey\fR^\fBDescription\fR
- Background Color^Hex-encoded background color info, assumed to be in the format RRGGBB.
- White Balance^Hex-encoded white balance
- Objective Power^Reported objective power, often incorrect.
- JPEG Quality^The JPEG quality value.
- OverlapsXY^Overlaps, see below.
-.TE
-
-.SS TIFF Image Directory Organization
-
-The first image in the TIFF file is the full-resolution image. The subsequent
-images are assumed to be decreasingly sized reduced-resolution images.
-
-.SS Overlaps
-
-The OverlapsXY pseudo-field encodes a list of tile overlap values as ASCII.
-
-Example: \*(lq 64 64 32 32 16 16\*(rq (note the initial space).
-
-These values are assumed to represent the amount of overlap between adjacent
-tiles in pixels, in both X and Y. This example encodes 3 levels worth of
-overlaps. Further overlaps are assumed to have the value 0.
-
-.SS Associated Images
-
-None.
-
-.SS Known Properties
-
-All data encoded in the ImageDescription TIFF field is represented as
-properties prefixed with \*(lqtrestle.\*(rq.
-
-.SH Hamamatsu format
-
-.IP Format 0.4i
-multi-file JPEG/NGR with proprietary metadata and index file formats
-.IP "File extensions"
-\&.vms, .vmu
-.IP "OpenSlide vendor backend"
-hamamatsu
-.IP "OpenSlide ops backend"
-jpeg for .vms, ngr for .vmu
-
-.SS Detection
-
-.nr step 1 1
-OpenSlide will detect a file as Hamamatsu if:
-.IP \n[step] 3
-The file given is a INI-style text file.
-.IP \n+[step]
-It has a [Virtual Microscope Specimen] (VMS) or [Uncompressed Virtual Microscope Specimen] (VMU) group.
-.IP \n+[step]
-The file specifies a positive number of layer (NoLayers>=1). Currently, only one of these focal plane layers is read.
-.IP \n+[step]
-If VMS, there are at least 1 row and 1 column of JPEG images (NoJpegColumns and NoJpegRows).
-.IP \n+[step]
-The mapfile given by MapFile is a valid readable file in the same directory as the VMS file.
-.IP \n+[step]
-The files given by the various ImageFile lines do not exceed the number of rows and columns as specified above.
-.IP \n+[step]
-The mapfile and image files are all valid JPEG files or all valid NGR files.
-.IP \n+[step]
-The restart interval in each JPEG file is zero, or evenly divides into the number of MCUs per row.
-.IP \n+[step]
-The image files (except the map file) all have the same \*(lqtile\*(rq sizes (see below).
-
-.SS Overview
-
-The Hamamatsu format consists of an index file (VMS or VMU), 2 or more image
-files, and (in the case of VMS) an \*(lqoptimisation\*(rq file.
-
-Multiple focal planes are ignored, only focal plane 0 is read.
-
-Because JPEG does not allow for large files, multiple JPEG files are needed to
-encode large images. To avoid having many files, the Hamamatsu format uses
-close to maximum size (65K by 65K) JPEG files.
-
-Unfortunately, (unlike TIFF) JPEG provides very poor support for random-access
-decoding of parts of a file. To get around this, JPEG restart markers are
-placed at regular intervals, and these offsets are specified in the
-optimisation file. With restart markers identified, OpenSlide can treat JPEG as
-a tiled format, where the height is the height of an MCU row, and the width is
-the number of MCUs per row divided by the restart marker interval times the
-width of an MCU. (This often leads to oddly-shaped and inefficient tiles of
-8x2048, for example.)
-
-Unfortunately, the optimisation file does not give the location of every
-restart marker, only the ones found at the beginning of an MCU row. It also
-seems that the file ends early, and does not give the location of the restart
-marker at the last MCU row of the last image file.
-
-Thus, the optimisation file can only be taken as a hint, and cannot be trusted.
-The entire set of JPEG files must be scanned for restart markers in order to
-facilitate random access. OpenSlide does this lazily as needed, and also in a
-background thread that runs only when OpenSlide is otherwise idle.
-
-The map file is a lower-resolution version of the other images, and can be used
-to make a 2-level JPEG pyramid. JPEG also allows for lower-resolution decoding,
-so further pyramid levels are synthesized from each JPEG file.
-
-.SS VMS File
-
-The .vms file is the main index file for the VMS format. It is a Windows
-INI-style key-value pair file, with sections. Only keys in the Virtual
-Microscope Specimen group are read by OpenSlide.
-
-Here are known keys from the file:
-
-.TS
-allbox, tab(^); ll.
- \fBKey\fR^\fBDescription\fR
- NoLayers^Number of layers, currently must be 1 to be accepted
- NoJpegColumns^Number of JPEG files across, given in ImageFile attributes
- NoJpegRows^Number of JPEG files down, given in ImageFile attributes
- ImageFile^T{
-Semantically equivalent to ImageFile(0,0,0), though not specified that way. The
-image in position (0,0,0) of the set of images
-T}
- ImageFile(x,y)^T{
-Semantically equivalent to ImageFile(0,x,y), though not specified that way. The
-image in position (0,x,y) of the set of images
-T}
- ImageFile(z,x,y)^T{
-Where x and y are non-negative integers. Both x and y cannot be 0. z is a
-positive integer. These are the images that make up the virtual slide, as a
-concatenation of JPEG images. x and y specify the location of each JPEG, z
-specifies the focal plane
-T}
- MapFile^A lower-resolution version of all the ImageFiles
- OptimisationFile^File specifying some of the restart marker offsets in each ImageFile
- AuthCode^Unknown
- SourceLens^Possibly the magnification
- PhysicalWidth^Width of the slide in some unit?
- PhysicalHeight^Height of the slide in some unit?
- LayerSpacing^Unknown
- MacroImage^Image file for the \*(lqmacro\*(rq associated image
- PhysicalMacroWidth^Unknown
- PhysicalMacroHeight^Unknown
- XOffsetFromSlideCentre^Unknown
- YOffsetFromSlideCentre^Unknown
-.TE
-
-.SS VMU File
-
-The .vmu file is the main index file for the VMU format. Only keys in the
-Uncompressed Virtual Microscope Specimen group are read by OpenSlide.
-
-Here are known keys from the file:
-
-.TS H
-allbox, tab(^); ll.
- \fBKey\fR^\fBDescription\fR
- NoLayers^(see VMS above)
- ImageFile^(see VMS above)
- ImageFile(x,y)^(see VMS above)
- ImageFile(z,x,y)^(see VMS above)
- MapFile^(see VMS above)
- MapScale^Seems to be the downsample factor of the map
- AuthCode^(see VMS above)
- SourceLens^(see VMS above)
- PixelWidth^Width of the image in pixels
- PixelHeight^Height of the image in pixels
- PhysicalWidth^(see VMS above)
- PhysicalHeight^(see VMS above)
- LayerSpacing^(see VMS above)
- LayerOffset^Unknown
- MacroImage^(see VMS above)
- PhysicalMacroWidth^(see VMS above)
- PhysicalMacroHeight^(see VMS above)
- XOffsetFromSlideCentre^(see VMS above)
- YOffsetFromSlideCentre^(see VMS above)
- Reference^Unknown
- BitsPerPixel^Bits per pixel, currently expected to be 36
- PixelOrder^Currently expected to be RGB
- Creator^String describing the software creating this image
- IlluminationMode^Unknown
- ExposureMultiplier^Unknown, possibly the multiplier used to scale to 15 bits?
- GainRed^Unknown
- GainGreen^Unknown
- GainBlue^Unknown
- FocalPlaneTolerance^Unknown
- NMP^Unknown
- MacroIllumination^Unknown
- FocusOffset^Unknown
- RefocusInterval^Unknown
- CubeName^Unknown
- HardwareModel^Name of the hardware
- HardwareSerial^Serial number of the hardware
- NoFocusPoints^Unknown
- FocusPoint0X^Unknown
- FocusPoint0Y^Unknown
- FocusPoint0Z^Unknown
- FocusPoint1X^Unknown
- FocusPoint1Y^Unknown
- FocusPoint1Z^Unknown
- FocusPoint2X^Unknown
- FocusPoint2Y^Unknown
- FocusPoint2Z^Unknown
- FocusPoint3X^Unknown
- FocusPoint3Y^Unknown
- FocusPoint3Z^Unknown
- NoBlobPoints^Unknown
- BlobPoint0Blob^Unknown
- BlobPoint0FocusPoint^Unknown
- BlobPoint1Blob^Unknown
- BlobPoint1FocusPoint^Unknown
- BlobPoint2Blob^Unknown
- BlobPoint2FocusPoint^Unknown
- BlobPoint3Blob^Unknown
- BlobPoint3FocusPoint^Unknown
- BlobMapWidth^Unknown
- BlobMapHeight^Unknown
-.TE
-
-.SS Optimisation File (only for VMS)
-
-The optimisation file contains a list of 32- (or 64- or 320- ?) bit little
-endian values, giving the file offset into an MCU row, each offset starts at a
-40-byte alignment, and the last row (of the entire file, not each image) seems
-to be missing. The offsets are all packed into 1 file, even with multiple
-images. The order of images is left-to-right, top-to-bottom.
-
-.SS Map File
-
-The VMS map file is a standard JPEG file. Its restart markers (if any) are not
-included in the optimisation file. The VMU map file is in NGR format. This file
-can be used to provide a lower-resolution view of the slide.
-
-.SS Image Files
-
-These files are given by the various ImageFile keys. They are assumed to have a
-height which is a multiple of the MCU height. They are assumed to have a width
-which is a multiple of MCUs per row divided by the restart interval.
-
-For VMS, these files are in JPEG, for VMU they are in NGR format.
-
-.SS NGR Format
-
-The NGR file contains uncompressed 16-bit RGB data, with a small header. The
-files we have encountered start with GN, two more bytes, and then width,
-height, and column width in little endian 32-bit format. The column width must
-divide evenly into the width. Column width is important, since NGR files are
-generated in columns, where the first column comes first in the file, followed
-by subsequent files. Columns are painted left-to-right.
-
-At offset 24 is another 32-bit integer which gives the offset in the file to
-the start of the image data. The image data we have encountered is in 16-bit
-little endian format.
-
-.SS Associated Images
-
-macro
-the image file given by the MacroImage value in the VMS/VMU file
-
-.SS Known Properties
-
-All key-value data stored in the VMS/VMU file are encoded as properties
-prefixed with \*(lqhamamatsu.\*(rq.
-
-.SS Preliminary NDPI Notes
-
-NDPI is basically VMS stuffed into a broken TIFF file. libtiff cannot read the
-headers of a TIFF file, because NDPI specifies the RowsPerStrip as the height
-of the file, and after doing out the multiplication, this typically overflows
-libtiff and it refuses to open the file. Also, the TIFF tags are not stored in
-sorted order (sometimes, they may have fixed this in later versions).
-
-Unlike the VMS format, the NDPI is stored in a pyramid format as TIFF directory
-entries. The macro image seems to come last.
-
-If one just reads the TIFF tags directly, perhaps using tiffdump, one will
-find:
-
-.TS
-allbox, tab(^); ll.
- \fBTag\fR^\fBDescription\fR
- ImageWidth^Width of the image
- ImageHeight^Height of the image
- Make^\*(lqHamamatsu\*(rq
- Model^\*(lqNanoZoomer\*(rq or \*(lqC9600-12\*(rq, etc
- XResolution^Seemingly correct X resolution, when interpreted with ResolutionUnit
- YResolution^Seemingly correct Y resolution, when interpreted with ResolutionUnit
- ResolutionUnit^Seemingly correct resolution unit
- Software^\*(lqNDP.scan\*(rq, sometimes with a version number
- StripOffsets^The offset of the JPEG file for this layer
- StripByteCounts^The length of the JPEG file for this layer
- 65420^Unknown, always 1?
- 65421^T{
-Magnification? SourceLens from VMS? Seems correctly downsampled for each entry.
-(-1 for macro image, -2 for some sort of mask?)
-T}
- 65422^XOffsetFromSlideCentre
- 65423^YOffsetFromSlideCentre
- 65424^Unknown, always 0?
- 65425^Unknown, always 0?
- 65426^Optimisation entries, as above
- 65428^Unknown, AuthCode?
- 65433^Unknown, I have seen 1500 in this tag
- 65439^Unknown, perhaps some polygon ROI?
- 65440^T{
-Unknown, I have seen this: <0 0 0 1 0 2 0 3 0 4 0 5 0 6 0 7 0 8 1 9 1 10 1 11 1
-12 1 13 1 14 1 15 1 16 1 17>
-T}
- 65441^Unknown, always 0?
- 65442^Seems to be Model
- 65443^Unknown, always 0?
- 65444^Unknown, always 80?
- 65445^Unknown, always 2?
- 65446^Unknown, always 0?
-.TE
-
-Unlike in VMS, JPEG files in NDPI are not necessarily valid. If ImageWidth or
-ImageHeight exceeds the JPEG limit of 65535, then the width or height as stored
-in the JPEG file is 0. JPEG files are not split into validly-sized files like
-in VMS. libjpeg will refuse to read the header of such a file, so the JPEG data
-stream must be altered when fed into libjpeg. Since a random access source
-manager is already required to read VMS JPEG files, this change is not too bad.
-
-.SH Aperio format
-.PP
-.IP Format
-single-file pyramidal tiled TIFF, with non-standard metadata and compression
-.IP "File extensions"
-\&.svs, .tif
-.IP "OpenSlide vendor backend"
-aperio
-.IP "OpenSlide ops backend"
-tiff
-.PP
-
-.SS Vendor Documentation
-
-http://www.aperio.com/documents/api/Aperio_Digital_Slides_and_Third-party_data_interchange.pdf
-
-.SS Detection
-
-.nr step 1 1
-Aperio slides are stored in single-file TIFF format. OpenSlide will detect a
-file as Aperio if:
-.IP \n[step] 3
-The file is TIFF.
-.IP \n+[step]
-The ImageDescription tag starts with Aperio.
-
-.SS Relevant TIFF tags
-
-One can also use tiffinfo or tiffdump to dump information on those TIFF files.
-
-.TS
-allbox, tab(^); ll.
- \fBTag\fR^\fBDescription\fR
- ImageDescription^Stores some important key-value pairs and other information, see below
- Compression^T{
-May be 33003 or 33005, which represent specific kinds of JPEG 2000 compression,
-see below
-T}
-.TE
-
-.SS Extra data stored in ImageDescription
-
-For tiled images, the ImageDescription tag contains some dimensional downsample
-information as well as what look like offsets. Additionally, vertical
-line-delimited key-value pairs are stored, in at least the full-resolution
-image. A key-value pair is equals-delimited. These key-values are stored as
-properties starting with \*(lqaperio.\*(rq. Currently, OpenSlide does not use any of
-the information present in these key-value fields.
-
-For stripped images, the ImageDescription tag may contain a name, followed by a
-carriage return. This is used for naming the associated images. The second
-image in the file does not have a name, though it is an associated image.
-
-.SS TIFF Image Directory Organization
-
-From
-
-http://www.aperio.com/documents/api/Aperio_Digital_Slides_and_Third-party_data_interchange.pdf
-
-page 14:
- The first image in an SVS file is always the baseline image (full resolution).
- This image is always tiled, usually with a tile size of 240x240 pixels. The
- second image is always a thumbnail, typically with dimensions of about 1024x768
- pixels. Unlike the other slide images, the thumbnail image is always stripped.
- Following the thumbnail there may be one or more intermediate \*(lqpyramid\*(rq images.
- These are always compressed with the same type of compression as the baseline
- image, and have a tiled organization with the same tile size.
-
- Optionally at the end of an SVS file there may be a slide label image, which is
- a low resolution picture taken of the slide's label, and/or a macro camera
- image, which is a low resolution picture taken of the entire slide. The label
- and macro images are always stripped.
-
-.SS JPEG 2000 (compression types 33003 or 33005)
-
-Some Aperio files use compression type 33003 or 33005. Images using this
-compression need to be decoded as a JPEG 2000 codestream. For 33003: YCbCr
-format, possibly with a chroma subsampling of 4:2:2. For 33005: RGB format.
-Note that the TIFF file may not encode the colorspace or subsampling parameters
-in the PhotometricInterpretation field, nor the YCbCrSubsampling field, even
-though the TIFF standard seems to require this. The correct subsampling can be
-found in the JPEG 2000 codestream.
-
-.SS Associated Images
-.PP
-.IP thumbnail
-the second image in the file
-.IP label
-optional, the name \*(lqlabel\*(rq is given in ImageDescription
-.IP macro
-optional, the name \*(lqmacro\*(rq is given in ImageDescription
-.PP
-.SS Known Properties
-
-All key-value data encoded in the ImageDescription TIFF field is represented as
-properties prefixed with \*(lqaperio.\*(rq.
-
-.SH MIRAX format
-.PP
-.IP Format
-multi-file JPEG with very complicated proprietary metadata and indexes
-.IP "File extensions"
-\&.mrxs
-.IP "OpenSlide vendor backend"
-mirax
-.IP "OpenSlide ops backend"
-jpeg
-
-.SS Detection
-
-.B Note: MIRAX is incredibly complicated. These detection steps are probably not complete.
-
-.nr step 1 1
-OpenSlide will detect a file as MIRAX if:
-.IP \n[step] 3
-The file ends with .mrxs.
-.IP \n+[step]
-A directory exists in the same location as the file, with the same name as the
-file minus the extension.
-.IP \n+[step]
-A file named Slidedat.ini exists in the directory.
-.IP \n+[step]
-The slidedat file is readable as a Windows INI-style file.
-.IP \n+[step]
-The slidedat file has a [GENERAL] section with the following keys:
-SLIDE_VERSION, SLIDE_ID, IMAGENUMBER_X, IMAGENUMBER_Y,
-CameraImageDivisionsPerSide.
-.IP \n+[step]
-The slidedat file has a [HIERARCHICAL] section with the following keys:
-HIER_COUNT, NONHIER_COUNT, INDEXFILE.
-.IP \n+[step]
-A key exists in the [HIERARCHICAL] section with the value of Slide zoom level.
-The key matches this printf-style template: HIER_%d_NAME. The %d is bound to
-the variable zoom_level. Currently, zoom_level must be 0.
-.IP \n+[step]
-The [HIERARCHICAL] section has a key with the name HIER_%d_COUNT where %d is
-the value of zoom_level in the previous step. The value must be an integer,
-interpreted as zoom_count.
-.IP \n+[step]
-Setting x to zoom_level and y from 0 to zoom_count, the [HIERARCHICAL] section
-has a key with the name HIER_x_VAL_y_SECTION. Let section_names[] be an array
-of length zoom_count, holding the values for each key.
-.IP \n+[step]
-The [DATAFILE] section must exist, with the following keys: FILE_COUNT.
-.IP \n+[step]
-There are FILE_COUNT keys in the [DATAFILE] section with the following names:
-FILE_%d, where %d goes from 0 to FILE_COUNT-1.
-.IP \n+[step]
-For each value in section_names, a group must exist with that name. Each group
-must contain the keys: OVERLAP_X, OVERLAP_Y, IMAGE_FILL_COLOR_BGR,
-DIGITIZER_WIDTH, DIGITIZER_HEIGHT. The overlap values must be parseable as
-doubles, the rest as integers. The key IMAGE_FORMAT must exist, with the value
-JPEG.
-.IP \n+[step]
-Each section_names section must have the key IMAGE_CONCAT_FACTOR. The value of
-the first section's IMAGE_CONCAT_FACTOR must be 0, the rest 1.
-.IP \n+[step]
-The [HIERARCHICAL] section has a key with the name NONHIER_%d_NAME (%d is an
-integer) and with the value VIMSLIDE_POSITION_BUFFER. Bind %d to the variable
-position_nonhier_offset.
-.IP \n+[step]
-The [HIERARCHICAL] section has a key with the name NONHIER_%d_NAME (%d is an
-integer) and with the value Scan data layer. Bind %d to the variable
-scan_nonhier_offset.
-.IP \n+[step]
-The [HIERARCHICAL] section has a key with the name NONHIER_%d_VAL_%d where the
-first %d is the value of scan_nonhier_offset. The key has a value of
-ScanDataLayer_SlideThumbnail.
-.IP \n+[step]
-The [HIERARCHICAL] section has a key with the name NONHIER_%d_VAL_%d where the
-first %d is the value of scan_nonhier_offset. The key has a value of
-ScanDataLayer_SlideBarcode.
-.IP \n+[step]
-The [HIERARCHICAL] section has a key with the name NONHIER_%d_VAL_%d where the
-first %d is the value of scan_nonhier_offset. The key has a value of
-ScanDataLayer_SlidePreview.
-.IP \n+[step]
-The value of the INDEXFILE key above is the name of a readable file.
-.IP \n+[step]
-The index file is of a valid format, and all data referred to by it is valid
-(see below).
-
-.SS Overview
-
-Because JPEG does not allow for large files, multiple JPEG files are needed to
-encode large images.
-
-Unfortunately, (unlike TIFF) JPEG provides very poor support for random-access
-decoding of parts of a file. To avoid having many individual files, MIRAX packs
-JPEG files into a small number of data files. The index file provides offsets
-into the data files for each required piece of data.
-
-.SS Index File
-
-The index file is a crazy beast.
-
-It starts with ASCII strings matching the SLIDE_VERSION and SLIDE_ID values
-from the slidedat file. Then, all hell breaks loose. The rest of the file
-consists of 32-bit little-endian integers (unaligned) with seemingly no
-structure.
-
-More info coming, for now see misc/print-mirax.py.
-
-.SS Data Files
-
-.SS Slide Position File
-
-.SS Associated Images
-
-.SS Known Properties
-
-.SH Generic tiled TIFF format
-.PP
-.IP Format
-single-file pyramidal tiled TIFF
-.IP "File extensions"
-\&.tif
-.IP "OpenSlide vendor backend"
-generic-tiff
-.IP "OpenSlide ops backend"
-tiff
-.PP
-
-.SS Detection
-
-.nr step 1 1
-OpenSlide will detect a file as generic TIFF if:
-.IP \n[step] 3
-No other detections succeed.
-.IP \n+[step]
-The file is TIFF.
-.IP \n+[step]
-The initial image is tiled.
-
-.SS TIFF Image Directory Organization
-
-The first image in the TIFF file is the full-resolution image. Any other tiled
-images in the file with the \*(lqreduced resolution\*(rq bit set are assumed to
-be reduced-resolution versions of the original.
-
-.SS Associated Images
-
-None.
-
-.SS Known Properties
-
-Many TIFF tags are encoded as properties starting with \*(lqtiff.\*(rq.
-
-.SH "SEE ALSO"
-
-.IR openslide-write-png(1),
-.IR openslide-quickhash1sum(1),
-.IR tiffinfo(1),
-.IR tiffdump(1)
-.PP
-
-.SH AUTHORS
-The Carnegie Mellon School of Computer Science.
-
-This manual page was written by Mathieu Malaterre
-<mathieu.malaterre at gmail.com> for the Debian GNU/Linux system (but may be used by others).
Copied: trunk/packages/openslide/tags/3.2.5-1/debian/openslide-show-properties.1 (from rev 9050, trunk/packages/openslide/trunk/debian/openslide-show-properties.1)
===================================================================
--- trunk/packages/openslide/tags/3.2.5-1/debian/openslide-show-properties.1 (rev 0)
+++ trunk/packages/openslide/tags/3.2.5-1/debian/openslide-show-properties.1 2011-12-19 17:09:14 UTC (rev 9051)
@@ -0,0 +1,1802 @@
+'\" t
+.\" Title: OPENSLIDE-SHOW-PROPERTIES
+.\" Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\" Date: 12/19/2011
+.\" Manual: Users Commands
+.\" Source: OpenSlide 3.2.5
+.\" Language: English
+.\"
+.TH "OPENSLIDE\-SHOW\-PRO" "1" "12/19/2011" "OpenSlide 3\&.2\&.5" "Users Commands"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+openslide-show-properties \- Print OpenSlide properties
+.SH "SYNOPSIS"
+.HP \w'\fBopenslide\-show\-properties\fR\ 'u
+\fBopenslide\-show\-properties\fR \fIinfile\fR
+.br
+
+.SH "DESCRIPTION"
+.PP
+Print OpenSlide properties\&.
+.SH "LIST OF KNOWN PROPERTIES"
+.SS "Properties generated by OpenSlide"
+.PP
+openslide\&.vendor
+.RS 4
+The name of the vendor backend\&.
+.RE
+.PP
+openslide\&.comment
+.RS 4
+A free\-form text comment, the same as returned from openslide_get_comment\&.
+.RE
+.PP
+openslide\&.quickhash\-1
+.RS 4
+A non\-cryptographic hash of a subset of the slide data\&. It can be used to uniquely identify a particular virtual slide, but cannot be used to detect file corruption or modification\&.
+.RE
+.PP
+openslide\&.background\-color
+.RS 4
+The background color of the slide, given as an RGB hex triplet\&. This property is not always present\&.
+.RE
+.SS "Properties from the JPEG backend"
+.PP
+No properties defined\&.
+.SS "Properties from the TIFF backend"
+.PP
+tiff\&.ImageDescription
+.RS 4
+The contents of the TIFF ImageDescripton tag\&.
+.RE
+.PP
+tiff\&.Make
+.RS 4
+The contents of the TIFF Make tag\&.
+.RE
+.PP
+tiff\&.Model
+.RS 4
+The contents of the TIFF Model tag\&.
+.RE
+.PP
+tiff\&.Software
+.RS 4
+The contents of the TIFF Software tag\&.
+.RE
+.PP
+tiff\&.DateTime
+.RS 4
+The contents of the TIFF DateTime tag\&.
+.RE
+.PP
+tiff\&.Artist
+.RS 4
+The contents of the TIFF Artist tag\&.
+.RE
+.PP
+tiff\&.HostComputer
+.RS 4
+The contents of the TIFF HostComputer tag\&.
+.RE
+.PP
+tiff\&.Copyright
+.RS 4
+The contents of the TIFF Copyright tag\&.
+.RE
+.PP
+tiff\&.DocumentName
+.RS 4
+The contents of the TIFF DocumentName tag\&.
+.RE
+.PP
+tiff\&.XResolution
+.RS 4
+The contents of the TIFF XResolution tag\&.
+.RE
+.PP
+tiff\&.YResolution
+.RS 4
+The contents of the TIFF yResolution tag\&.
+.RE
+.PP
+tiff\&.XPosition
+.RS 4
+The contents of the TIFF XPosition tag\&.
+.RE
+.PP
+tiff\&.YPosition
+.RS 4
+The contents of the TIFF YPosition tag\&.
+.RE
+.PP
+tiff\&.ResolutionUnit
+.RS 4
+The contents of the TIFF ResolutionUnit tag\&.
+.RE
+.SS "Vendor\-specific properties"
+.PP
+A list of vendor\-specific properties can be found on the pages for each vendor format, linked from
+\m[blue]\fBSupported Virtual Slide Formats\fR\m[]\&\s-2\u[1]\d\s+2\&.
+.SH "TRESTLE FORMAT"
+.PP
+Format
+.RS 4
+single\-file pyramidal tiled TIFF, with non\-standard metadata and overlaps; additional files can contain more metadata and detailed overlap info
+.RE
+.PP
+File extensions
+.RS 4
+
+\&.tif
+.RE
+.PP
+OpenSlide vendor backend
+.RS 4
+
+trestle
+.RE
+.PP
+OpenSlide ops backend
+.RS 4
+
+tiff
+.RE
+.SS "Detection"
+.PP
+Trestle slides are stored in single\-file TIFF format\&. OpenSlide will detect a file as Trestle if:
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 1.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 1." 4.2
+.\}
+The file is TIFF\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 2.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 2." 4.2
+.\}
+The TIFF
+Software
+tag starts with \(rqMedScan\(rq\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 3.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 3." 4.2
+.\}
+The
+ImageDescription
+tag is present\&.
+.RE
+.SS "Relevant TIFF tags"
+.TS
+allbox tab(:);
+lB lB.
+T{
+Tag
+T}:T{
+Description
+T}
+.T&
+l l
+l l
+l l.
+T{
+ImageDescription
+T}:T{
+Stores some important key\-value pairs, see below
+T}
+T{
+Software
+T}:T{
+Starts with \(rqMedScan\(rq
+T}
+T{
+XResolution, YResolution
+T}:T{
+Seems to store microns\-per\-pixel (MPP), which may or may not take into account the correct objective power\&. Note that this is inverted from standard TIFF, which stores pixels\-per\-unit, not units\-per\-pixel\&.
+T}
+.TE
+.sp 1
+.SS "Extra data stored in ImageDescription"
+.PP
+The
+ImageDescription
+tag contains semicolon\-delimited key\-value pairs\&. A key\-value pair is equals\-delimited\&. We use the
+OverlapsXY
+and
+Background Color
+keys from the
+ImageDescription, and ignore the rest\&. All of these values are stored as properties starting with \(rqtrestle\&.\(rq\&.
+.TS
+allbox tab(:);
+lB lB.
+T{
+Key
+T}:T{
+Description
+T}
+.T&
+l l
+l l
+l l
+l l
+l l.
+T{
+Background Color
+T}:T{
+Hex\-encoded background color info, assumed to be in the format RRGGBB\&.
+T}
+T{
+White Balance
+T}:T{
+Hex\-encoded white balance
+T}
+T{
+Objective Power
+T}:T{
+Reported objective power, often incorrect\&.
+T}
+T{
+JPEG Quality
+T}:T{
+The JPEG quality value\&.
+T}
+T{
+OverlapsXY
+T}:T{
+Overlaps, see below\&.
+T}
+.TE
+.sp 1
+.SS "TIFF Image Directory Organization"
+.PP
+The first image in the TIFF file is the full\-resolution image\&. The subsequent images are assumed to be decreasingly sized reduced\-resolution images\&.
+.SS "Overlaps"
+.PP
+The
+OverlapsXY
+pseudo\-field encodes a list of tile overlap values as ASCII\&.
+.PP
+Example: \(rq64 64 32 32 16 16\(rq (note the initial space)\&.
+.PP
+These values are assumed to represent the amount of overlap between adjacent tiles in pixels, in both X and Y\&. This example encodes 3 levels worth of overlaps\&. Further overlaps are assumed to have the value 0\&.
+.SS "Associated Images"
+.PP
+None\&.
+.SS "Known Properties"
+.PP
+All data encoded in the
+ImageDescription
+TIFF field is represented as properties prefixed with \(rqtrestle\&.\(rq\&.
+.SS "Test Data"
+.PP
+
+\m[blue]\fBhttp://openslide\&.cs\&.cmu\&.edu/download/openslide\-testdata/Trestle/\fR\m[]
+.SH "HAMAMATSU FORMAT"
+.PP
+Format
+.RS 4
+multi\-file JPEG/NGR with proprietary metadata and index file formats
+.RE
+.PP
+File extensions
+.RS 4
+\&.vms,
+\&.vmu
+.RE
+.PP
+OpenSlide vendor backend
+.RS 4
+
+hamamatsu
+.RE
+.PP
+OpenSlide ops backend
+.RS 4
+jpeg
+for
+\&.vms,
+ngr
+for
+\&.vmu
+.RE
+.SS "Detection"
+.PP
+OpenSlide will detect a file as Hamamatsu if:
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 1.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 1." 4.2
+.\}
+The file given is a INI\-style text file\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 2.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 2." 4.2
+.\}
+It has a
+[Virtual Microscope Specimen]
+(VMS) or
+[Uncompressed Virtual Microscope Specimen]
+(VMU) group\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 3.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 3." 4.2
+.\}
+The file specifies a positive number of layer (NoLayers>=1)\&. Currently, only one of these focal plane layers is read\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 4.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 4." 4.2
+.\}
+If VMS, there are at least 1 row and 1 column of JPEG images (NoJpegColumns
+and
+NoJpegRows)\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 5.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 5." 4.2
+.\}
+The mapfile given by
+MapFile
+is a valid readable file in the same directory as the VMS file\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 6.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 6." 4.2
+.\}
+The files given by the various
+ImageFile
+lines do not exceed the number of rows and columns as specified above\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 7.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 7." 4.2
+.\}
+The mapfile and image files are all valid JPEG files or all valid NGR files\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 8.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 8." 4.2
+.\}
+The restart interval in each JPEG file is zero, or evenly divides into the number of MCUs per row\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 9.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 9." 4.2
+.\}
+The image files (except the map file) all have the same \(lqtile\(rq sizes (see below)\&.
+.RE
+.SS "Overview"
+.PP
+The Hamamatsu format consists of an index file (VMS or VMU), 2 or more image files, and (in the case of VMS) an \(lqoptimisation\(rq file\&.
+.PP
+Multiple focal planes are ignored, only focal plane 0 is read\&.
+.PP
+Because JPEG does not allow for large files, multiple JPEG files are needed to encode large images\&. To avoid having many files, the Hamamatsu format uses close to maximum size (65K by 65K) JPEG files\&.
+.PP
+Unfortunately, (unlike TIFF) JPEG provides very poor support for random\-access decoding of parts of a file\&. To get around this, JPEG restart markers are placed at regular intervals, and these offsets are specified in the optimisation file\&. With restart markers identified, OpenSlide can treat JPEG as a tiled format, where the height is the height of an MCU row, and the width is the number of MCUs per row divided by the restart marker interval times the width of an MCU\&. (This often leads to oddly\-shaped and inefficient tiles of 8x2048, for example\&.)
+.PP
+Unfortunately, the optimisation file does not give the location of every restart marker, only the ones found at the beginning of an MCU row\&. It also seems that the file ends early, and does not give the location of the restart marker at the last MCU row of the last image file\&.
+.PP
+Thus, the optimisation file can only be taken as a hint, and cannot be trusted\&. The entire set of JPEG files must be scanned for restart markers in order to facilitate random access\&. OpenSlide does this lazily as needed, and also in a background thread that runs only when OpenSlide is otherwise idle\&.
+.PP
+The map file is a lower\-resolution version of the other images, and can be used to make a 2\-level JPEG pyramid\&. JPEG also allows for lower\-resolution decoding, so further pyramid levels are synthesized from each JPEG file\&.
+.SS "VMS File"
+.PP
+The
+\&.vms
+file is the main index file for the VMS format\&. It is a Windows INI\-style key\-value pair file, with sections\&. Only keys in the
+Virtual Microscope Specimen
+group are read by OpenSlide\&.
+.PP
+Here are known keys from the file:
+.TS
+allbox tab(:);
+lB lB.
+T{
+Key
+T}:T{
+Description
+T}
+.T&
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l.
+T{
+NoLayers
+T}:T{
+Number of layers, currently must be 1 to be accepted
+T}
+T{
+NoJpegColumns
+T}:T{
+Number of JPEG files across, given in ImageFile attributes
+T}
+T{
+NoJpegRows
+T}:T{
+Number of JPEG files down, given in ImageFile attributes
+T}
+T{
+ImageFile
+T}:T{
+Semantically equivalent to ImageFile(0,0,0), though not specified that way\&. The image in position (0,0,0) of the set of images
+T}
+T{
+ImageFile(x,y)
+T}:T{
+Semantically equivalent to ImageFile(0,x,y), though not specified that way\&. The image in position (0,x,y) of the set of images
+T}
+T{
+ImageFile(z,x,y)
+T}:T{
+Where x and y are non\-negative integers\&. Both x and y cannot be 0\&. z is a positive integer\&. These are the images that make up the virtual slide, as a concatenation of JPEG images\&. x and y specify the location of each JPEG, z specifies the focal plane
+T}
+T{
+MapFile
+T}:T{
+A lower\-resolution version of all the ImageFiles
+T}
+T{
+OptimisationFile
+T}:T{
+File specifying some of the restart marker offsets in each ImageFile
+T}
+T{
+AuthCode
+T}:T{
+Unknown
+T}
+T{
+SourceLens
+T}:T{
+Possibly the magnification
+T}
+T{
+PhysicalWidth
+T}:T{
+Width of the slide in some unit?
+T}
+T{
+PhysicalHeight
+T}:T{
+Height of the slide in some unit?
+T}
+T{
+LayerSpacing
+T}:T{
+Unknown
+T}
+T{
+MacroImage
+T}:T{
+Image file for the \(lqmacro\(rq associated image
+T}
+T{
+PhysicalMacroWidth
+T}:T{
+Unknown
+T}
+T{
+PhysicalMacroHeight
+T}:T{
+Unknown
+T}
+T{
+XOffsetFromSlideCentre
+T}:T{
+Unknown
+T}
+T{
+YOffsetFromSlideCentre
+T}:T{
+Unknown
+T}
+.TE
+.sp 1
+.SS "VMU File"
+.PP
+The
+\&.vmu
+file is the main index file for the VMU format\&. Only keys in the
+Uncompressed Virtual Microscope Specimen
+group are read by OpenSlide\&.
+.PP
+Here are known keys from the file:
+.TS
+allbox tab(:);
+lB lB.
+T{
+Key
+T}:T{
+Description
+T}
+.T&
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l.
+T{
+NoLayers
+T}:T{
+(see VMS above)
+T}
+T{
+ImageFile
+T}:T{
+(see VMS above)
+T}
+T{
+ImageFile(x,y)
+T}:T{
+(see VMS above)
+T}
+T{
+ImageFile(z,x,y)
+T}:T{
+(see VMS above)
+T}
+T{
+MapFile
+T}:T{
+(see VMS above)
+T}
+T{
+MapScale
+T}:T{
+Seems to be the downsample factor of the map
+T}
+T{
+AuthCode
+T}:T{
+(see VMS above)
+T}
+T{
+SourceLens
+T}:T{
+(see VMS above)
+T}
+T{
+PixelWidth
+T}:T{
+Width of the image in pixels
+T}
+T{
+PixelHeight
+T}:T{
+Height of the image in pixels
+T}
+T{
+PhysicalWidth
+T}:T{
+(see VMS above)
+T}
+T{
+PhysicalHeight
+T}:T{
+(see VMS above)
+T}
+T{
+LayerSpacing
+T}:T{
+(see VMS above)
+T}
+T{
+LayerOffset
+T}:T{
+Unknown
+T}
+T{
+MacroImage
+T}:T{
+(see VMS above)
+T}
+T{
+PhysicalMacroWidth
+T}:T{
+(see VMS above)
+T}
+T{
+PhysicalMacroHeight
+T}:T{
+(see VMS above)
+T}
+T{
+XOffsetFromSlideCentre
+T}:T{
+(see VMS above)
+T}
+T{
+YOffsetFromSlideCentre
+T}:T{
+(see VMS above)
+T}
+T{
+Reference
+T}:T{
+Unknown
+T}
+T{
+BitsPerPixel
+T}:T{
+Bits per pixel, currently expected to be 36
+T}
+T{
+PixelOrder
+T}:T{
+Currently expected to be RGB
+T}
+T{
+Creator
+T}:T{
+String describing the software creating this image
+T}
+T{
+IlluminationMode
+T}:T{
+Unknown
+T}
+T{
+ExposureMultiplier
+T}:T{
+Unknown, possibly the multiplier used to scale to 15 bits?
+T}
+T{
+GainRed
+T}:T{
+Unknown
+T}
+T{
+GainGreen
+T}:T{
+Unknown
+T}
+T{
+GainBlue
+T}:T{
+Unknown
+T}
+T{
+FocalPlaneTolerance
+T}:T{
+Unknown
+T}
+T{
+NMP
+T}:T{
+Unknown
+T}
+T{
+MacroIllumination
+T}:T{
+Unknown
+T}
+T{
+FocusOffset
+T}:T{
+Unknown
+T}
+T{
+RefocusInterval
+T}:T{
+Unknown
+T}
+T{
+CubeName
+T}:T{
+Unknown
+T}
+T{
+HardwareModel
+T}:T{
+Name of the hardware
+T}
+T{
+HardwareSerial
+T}:T{
+Serial number of the hardware
+T}
+T{
+NoFocusPoints
+T}:T{
+Unknown
+T}
+T{
+FocusPoint0X
+T}:T{
+Unknown
+T}
+T{
+FocusPoint0Y
+T}:T{
+Unknown
+T}
+T{
+FocusPoint0Z
+T}:T{
+Unknown
+T}
+T{
+FocusPoint1X
+T}:T{
+Unknown
+T}
+T{
+FocusPoint1Y
+T}:T{
+Unknown
+T}
+T{
+FocusPoint1Z
+T}:T{
+Unknown
+T}
+T{
+FocusPoint2X
+T}:T{
+Unknown
+T}
+T{
+FocusPoint2Y
+T}:T{
+Unknown
+T}
+T{
+FocusPoint2Z
+T}:T{
+Unknown
+T}
+T{
+FocusPoint3X
+T}:T{
+Unknown
+T}
+T{
+FocusPoint3Y
+T}:T{
+Unknown
+T}
+T{
+FocusPoint3Z
+T}:T{
+Unknown
+T}
+T{
+NoBlobPoints
+T}:T{
+Unknown
+T}
+T{
+BlobPoint0Blob
+T}:T{
+Unknown
+T}
+T{
+BlobPoint0FocusPoint
+T}:T{
+Unknown
+T}
+T{
+BlobPoint1Blob
+T}:T{
+Unknown
+T}
+T{
+BlobPoint1FocusPoint
+T}:T{
+Unknown
+T}
+T{
+BlobPoint2Blob
+T}:T{
+Unknown
+T}
+T{
+BlobPoint2FocusPoint
+T}:T{
+Unknown
+T}
+T{
+BlobPoint3Blob
+T}:T{
+Unknown
+T}
+T{
+BlobPoint3FocusPoint
+T}:T{
+Unknown
+T}
+T{
+BlobMapWidth
+T}:T{
+Unknown
+T}
+T{
+BlobMapHeight
+T}:T{
+Unknown
+T}
+.TE
+.sp 1
+.SS "Optimisation File (only for VMS)"
+.PP
+The optimisation file contains a list of 32\- (or 64\- or 320\- ?) bit little endian values, giving the file offset into an MCU row, each offset starts at a 40\-byte alignment, and the last row (of the entire file, not each image) seems to be missing\&. The offsets are all packed into 1 file, even with multiple images\&. The order of images is left\-to\-right, top\-to\-bottom\&.
+.SS "Map File"
+.PP
+The VMS map file is a standard JPEG file\&. Its restart markers (if any) are not included in the optimisation file\&. The VMU map file is in NGR format\&. This file can be used to provide a lower\-resolution view of the slide\&.
+.SS "Image Files"
+.PP
+These files are given by the various
+ImageFile
+keys\&. They are assumed to have a height which is a multiple of the MCU height\&. They are assumed to have a width which is a multiple of MCUs per row divided by the restart interval\&.
+.PP
+For VMS, these files are in JPEG, for VMU they are in NGR format\&.
+.SS "NGR Format"
+.PP
+The NGR file contains uncompressed 16\-bit RGB data, with a small header\&. The files we have encountered start with
+GN, two more bytes, and then width, height, and column width in little endian 32\-bit format\&. The column width must divide evenly into the width\&. Column width is important, since NGR files are generated in columns, where the first column comes first in the file, followed by subsequent files\&. Columns are painted left\-to\-right\&.
+.PP
+At offset 24 is another 32\-bit integer which gives the offset in the file to the start of the image data\&. The image data we have encountered is in 16\-bit little endian format\&.
+.SS "Associated Images"
+.PP
+macro
+.RS 4
+the image file given by the
+MacroImage
+value in the VMS/VMU file
+.RE
+.SS "Known Properties"
+.PP
+All key\-value data stored in the VMS/VMU file are encoded as properties prefixed with \(rqhamamatsu\&.\(rq\&.
+.SS "Test Data"
+.PP
+\m[blue]\fBhttp://openslide\&.cs\&.cmu\&.edu/download/openslide\-testdata/Hamamatsu/\fR\m[]
+(ndpi format, wrapped vms format, currently not readable by OpenSlide)
+.PP
+\m[blue]\fBhttp://openslide\&.cs\&.cmu\&.edu/download/openslide\-testdata/Hamamatsu\-vms/\fR\m[]
+(vms format)
+.SS "Preliminary NDPI Notes"
+.PP
+NDPI is basically VMS stuffed into a broken TIFF file\&. libtiff cannot read the headers of a TIFF file, because NDPI specifies the
+RowsPerStrip
+as the height of the file, and after doing out the multiplication, this typically overflows libtiff and it refuses to open the file\&. Also, the TIFF tags are not stored in sorted order (sometimes, they may have fixed this in later versions)\&.
+.PP
+Unlike the VMS format, the NDPI is stored in a pyramid format as TIFF directory entries\&. The macro image seems to come last\&.
+.PP
+If one just reads the TIFF tags directly, perhaps using
+tiffdump, one will find:
+.TS
+allbox tab(:);
+lB lB.
+T{
+Tag
+T}:T{
+Description
+T}
+.T&
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l
+l l.
+T{
+ImageWidth
+T}:T{
+Width of the image
+T}
+T{
+ImageHeight
+T}:T{
+Height of the image
+T}
+T{
+Make
+T}:T{
+\(lqHamamatsu\(rq
+T}
+T{
+Model
+T}:T{
+\(lqNanoZoomer\(rq or \(lqC9600\-12\(rq, etc
+T}
+T{
+XResolution
+T}:T{
+Seemingly correct X resolution, when interpreted with ResolutionUnit
+T}
+T{
+YResolution
+T}:T{
+Seemingly correct Y resolution, when interpreted with ResolutionUnit
+T}
+T{
+ResolutionUnit
+T}:T{
+Seemingly correct resolution unit
+T}
+T{
+Software
+T}:T{
+\(lqNDP\&.scan\(rq, sometimes with a version number
+T}
+T{
+StripOffsets
+T}:T{
+The offset of the JPEG file for this layer
+T}
+T{
+StripByteCounts
+T}:T{
+The length of the JPEG file for this layer
+T}
+T{
+65420
+T}:T{
+Unknown, always 1?
+T}
+T{
+65421
+T}:T{
+Magnification? SourceLens from VMS? Seems correctly downsampled for each entry\&. (\-1 for macro image, \-2 for some sort of mask?)
+T}
+T{
+65422
+T}:T{
+XOffsetFromSlideCentre
+T}
+T{
+65423
+T}:T{
+YOffsetFromSlideCentre
+T}
+T{
+65424
+T}:T{
+Unknown, always 0?
+T}
+T{
+65425
+T}:T{
+Unknown, always 0?
+T}
+T{
+65426
+T}:T{
+Optimisation entries, as above
+T}
+T{
+65428
+T}:T{
+Unknown, AuthCode?
+T}
+T{
+65433
+T}:T{
+Unknown, I have seen 1500 in this tag
+T}
+T{
+65439
+T}:T{
+Unknown, perhaps some polygon ROI?
+T}
+T{
+65440
+T}:T{
+Unknown, I have seen this: <0 0 0 1 0 2 0 3 0 4 0 5 0 6 0 7 0 8 1 9 1 10 1 11 1 12 1 13 1 14 1 15 1 16 1 17>
+T}
+T{
+65441
+T}:T{
+Unknown, always 0?
+T}
+T{
+65442
+T}:T{
+Seems to be Model
+T}
+T{
+65443
+T}:T{
+Unknown, always 0?
+T}
+T{
+65444
+T}:T{
+Unknown, always 80?
+T}
+T{
+65445
+T}:T{
+Unknown, always 2?
+T}
+T{
+65446
+T}:T{
+Unknown, always 0?
+T}
+.TE
+.sp 1
+.PP
+Unlike in VMS, JPEG files in NDPI are not necessarily valid\&. If
+ImageWidth
+or
+ImageHeight
+exceeds the JPEG limit of 65535, then the width or height as stored in the JPEG file is 0\&. JPEG files are not split into validly\-sized files like in VMS\&. libjpeg will refuse to read the header of such a file, so the JPEG data stream must be altered when fed into libjpeg\&. Since a random access source manager is already required to read VMS JPEG files, this change is not too bad\&.
+.SH "APERIO FORMAT"
+.PP
+Format
+.RS 4
+single\-file pyramidal tiled TIFF, with non\-standard metadata and compression
+.RE
+.PP
+File extensions
+.RS 4
+\&.svs,
+\&.tif
+.RE
+.PP
+OpenSlide vendor backend
+.RS 4
+
+aperio
+.RE
+.PP
+OpenSlide ops backend
+.RS 4
+
+tiff
+.RE
+.SS "Vendor Documentation"
+.PP
+
+\m[blue]\fBhttp://www\&.aperio\&.com/documents/api/Aperio_Digital_Slides_and_Third\-party_data_interchange\&.pdf\fR\m[]
+.SS "Detection"
+.PP
+Aperio slides are stored in single\-file TIFF format\&. OpenSlide will detect a file as Aperio if:
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 1.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 1." 4.2
+.\}
+The file is TIFF\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 2.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 2." 4.2
+.\}
+The
+ImageDescription
+tag starts with
+Aperio\&.
+.RE
+.SS "Relevant TIFF tags"
+.TS
+allbox tab(:);
+lB lB.
+T{
+Tag
+T}:T{
+Description
+T}
+.T&
+l l
+l l.
+T{
+ImageDescription
+T}:T{
+Stores some important key\-value pairs and other information, see below
+T}
+T{
+Compression
+T}:T{
+May be 33003 or 33005, which represent specific kinds of JPEG 2000 compression, see below
+T}
+.TE
+.sp 1
+.SS "Extra data stored in ImageDescription"
+.PP
+For tiled images, the
+ImageDescription
+tag contains some dimensional downsample information as well as what look like offsets\&. Additionally, vertical line\-delimited key\-value pairs are stored, in at least the full\-resolution image\&. A key\-value pair is equals\-delimited\&. These key\-values are stored as properties starting with \(rqaperio\&.\(rq\&. Currently, OpenSlide does not use any of the information present in these key\-value fields\&.
+.PP
+For stripped images, the
+ImageDescription
+tag may contain a name, followed by a carriage return\&. This is used for naming the associated images\&. The second image in the file does not have a name, though it is an associated image\&.
+.SS "TIFF Image Directory Organization"
+.PP
+\m[blue]\fBhttp://www\&.aperio\&.com/documents/api/Aperio_Digital_Slides_and_Third\-party_data_interchange\&.pdf\fR\m[]
+page 14:
+.PP
+The first image in an SVS file is always the baseline image (full resolution)\&. This image is always tiled, usually with a tile size of 240x240 pixels\&. The second image is always a thumbnail, typically with dimensions of about 1024x768 pixels\&. Unlike the other slide images, the thumbnail image is always stripped\&. Following the thumbnail there may be one or more intermediate \(lqpyramid\(rq images\&. These are always compressed with the same type of compression as the baseline image, and have a tiled organization with the same tile size\&.
+.PP
+Optionally at the end of an SVS file there may be a slide label image, which is a low resolution picture taken of the slide\(cqs label, and/or a macro camera image, which is a low resolution picture taken of the entire slide\&. The label and macro images are always stripped\&.
+.SS "JPEG 2000 (compression types 33003 or 33005)"
+.PP
+Some Aperio files use compression type 33003 or 33005\&. Images using this compression need to be decoded as a JPEG 2000 codestream\&. For 33003: YCbCr format, possibly with a chroma subsampling of 4:2:2\&. For 33005: RGB format\&. Note that the TIFF file may not encode the colorspace or subsampling parameters in the
+PhotometricInterpretation
+field, nor the
+YCbCrSubsampling
+field, even though the TIFF standard seems to require this\&. The correct subsampling can be found in the JPEG 2000 codestream\&.
+.SS "Associated Images"
+.PP
+thumbnail
+.RS 4
+the second image in the file
+.RE
+.PP
+label
+.RS 4
+optional, the name \(lqlabel\(rq is given in
+ImageDescription
+.RE
+.PP
+macro
+.RS 4
+optional, the name \(lqmacro\(rq is given in
+ImageDescription
+.RE
+.SS "Known Properties"
+.PP
+All key\-value data encoded in the
+ImageDescription
+TIFF field is represented as properties prefixed with \(rqaperio\&.\(rq\&.
+.SS "Test Data"
+.PP
+
+\m[blue]\fBhttp://openslide\&.cs\&.cmu\&.edu/download/openslide\-testdata/Aperio/\fR\m[]
+.SH "MIRAX FORMAT"
+.PP
+Format
+.RS 4
+multi\-file JPEG with very complicated proprietary metadata and indexes
+.RE
+.PP
+File extensions
+.RS 4
+
+\&.mrxs
+.RE
+.PP
+OpenSlide vendor backend
+.RS 4
+
+mirax
+.RE
+.PP
+OpenSlide ops backend
+.RS 4
+
+jpeg
+.RE
+.SS "Detection"
+.PP
+
+\fBNote: MIRAX is incredibly complicated\&. These detection steps are probably not complete\&.\fR
+.PP
+OpenSlide will detect a file as MIRAX if:
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 1.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 1." 4.2
+.\}
+The file ends with
+\&.mrxs\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 2.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 2." 4.2
+.\}
+A directory exists in the same location as the file, with the same name as the file minus the extension\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 3.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 3." 4.2
+.\}
+A file named
+Slidedat\&.ini
+exists in the directory\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 4.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 4." 4.2
+.\}
+The slidedat file is readable as a Windows INI\-style file\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 5.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 5." 4.2
+.\}
+The slidedat file has a
+[GENERAL]
+section with the following keys:
+SLIDE_VERSION,
+SLIDE_ID,
+IMAGENUMBER_X,
+IMAGENUMBER_Y,
+CameraImageDivisionsPerSide\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 6.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 6." 4.2
+.\}
+The slidedat file has a
+[HIERARCHICAL]
+section with the following keys:
+HIER_COUNT,
+NONHIER_COUNT,
+INDEXFILE\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 7.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 7." 4.2
+.\}
+A key exists in the
+[HIERARCHICAL]
+section with the value of
+Slide zoom level\&. The key matches this printf\-style template:
+HIER_%d_NAME\&. The
+%d
+is bound to the variable
+zoom_level\&. Currently,
+zoom_level
+must be 0\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 8.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 8." 4.2
+.\}
+The
+[HIERARCHICAL]
+section has a key with the name
+HIER_%d_COUNT
+where
+%d
+is the value of
+zoom_level
+in the previous step\&. The value must be an integer, interpreted as
+zoom_count\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 9.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 9." 4.2
+.\}
+Setting
+x
+to
+zoom_level
+and
+y
+from 0 to
+zoom_count, the
+[HIERARCHICAL]
+section has a key with the name
+HIER_x_VAL_y_SECTION\&. Let
+section_names[]
+be an array of length zoom_count, holding the values for each key\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'10.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP "10." 4.2
+.\}
+The
+[DATAFILE]
+section must exist, with the following keys:
+FILE_COUNT\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'11.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP "11." 4.2
+.\}
+There are
+FILE_COUNT
+keys in the
+[DATAFILE]
+section with the following names:
+FILE_%d, where
+%d
+goes from 0 to
+FILE_COUNT\-1\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'12.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP "12." 4.2
+.\}
+For each value in
+section_names, a group must exist with that name\&. Each group must contain the keys:
+OVERLAP_X,
+OVERLAP_Y,
+IMAGE_FILL_COLOR_BGR,
+DIGITIZER_WIDTH,
+DIGITIZER_HEIGHT\&. The overlap values must be parseable as doubles, the rest as integers\&. The key
+IMAGE_FORMAT
+must exist, with the value
+JPEG\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'13.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP "13." 4.2
+.\}
+Each
+section_names
+section must have the key
+IMAGE_CONCAT_FACTOR\&. The value of the first section\(cqs
+IMAGE_CONCAT_FACTOR
+must be 0, the rest 1\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'14.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP "14." 4.2
+.\}
+The
+[HIERARCHICAL]
+section has a key with the name
+NONHIER_%d_NAME
+(%d
+is an integer) and with the value
+VIMSLIDE_POSITION_BUFFER\&. Bind
+%d
+to the variable
+position_nonhier_offset\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'15.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP "15." 4.2
+.\}
+The
+[HIERARCHICAL]
+section has a key with the name
+NONHIER_%d_NAME
+(%d
+is an integer) and with the value
+Scan data layer\&. Bind
+%d
+to the variable
+scan_nonhier_offset\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'16.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP "16." 4.2
+.\}
+The
+[HIERARCHICAL]
+section has a key with the name
+NONHIER_%d_VAL_%d
+where the first
+%d
+is the value of
+scan_nonhier_offset\&. The key has a value of
+ScanDataLayer_SlideThumbnail\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'17.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP "17." 4.2
+.\}
+The
+[HIERARCHICAL]
+section has a key with the name
+NONHIER_%d_VAL_%d
+where the first
+%d
+is the value of
+scan_nonhier_offset\&. The key has a value of
+ScanDataLayer_SlideBarcode\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'18.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP "18." 4.2
+.\}
+The
+[HIERARCHICAL]
+section has a key with the name
+NONHIER_%d_VAL_%d
+where the first
+%d
+is the value of
+scan_nonhier_offset\&. The key has a value of
+ScanDataLayer_SlidePreview\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'19.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP "19." 4.2
+.\}
+The value of the
+INDEXFILE
+key above is the name of a readable file\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'20.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP "20." 4.2
+.\}
+The index file is of a valid format, and all data referred to by it is valid (see below)\&.
+.RE
+.SS "Overview"
+.PP
+Because JPEG does not allow for large files, multiple JPEG files are needed to encode large images\&.
+.PP
+Unfortunately, (unlike TIFF) JPEG provides very poor support for random\-access decoding of parts of a file\&. To avoid having many individual files, MIRAX packs JPEG files into a small number of data files\&. The index file provides offsets into the data files for each required piece of data\&.
+.SS "Index File"
+.PP
+The index file is a crazy beast\&.
+.PP
+It starts with ASCII strings matching the
+SLIDE_VERSION
+and
+SLIDE_ID
+values from the slidedat file\&. Then, all hell breaks loose\&. The rest of the file consists of 32\-bit little\-endian integers (unaligned) with seemingly no structure\&.
+.PP
+More info coming, for now see
+\m[blue]\fBmisc/print\-mirax\&.py\fR\m[]\&\s-2\u[2]\d\s+2\&.
+.SS "Data Files"
+.SS "Slide Position File"
+.SS "Associated Images"
+.SS "Known Properties"
+.SS "Test Data"
+.PP
+
+\m[blue]\fBhttp://openslide\&.cs\&.cmu\&.edu/download/openslide\-testdata/Mirax/\fR\m[]
+.SH "GENERIC TILED TIFF FORMAT"
+.PP
+Format
+.RS 4
+single\-file pyramidal tiled TIFF
+.RE
+.PP
+File extensions
+.RS 4
+
+\&.tif
+.RE
+.PP
+OpenSlide vendor backend
+.RS 4
+
+generic\-tiff
+.RE
+.PP
+OpenSlide ops backend
+.RS 4
+
+tiff
+.RE
+.SS "Detection"
+.PP
+OpenSlide will detect a file as generic TIFF if:
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 1.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 1." 4.2
+.\}
+No other detections succeed\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 2.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 2." 4.2
+.\}
+The file is TIFF\&.
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04' 3.\h'+01'\c
+.\}
+.el \{\
+.sp -1
+.IP " 3." 4.2
+.\}
+The initial image is tiled\&.
+.RE
+.SS "TIFF Image Directory Organization"
+.PP
+The first image in the TIFF file is the full\-resolution image\&. Any other tiled images in the file with the \(lqreduced resolution\(rq bit set are assumed to be reduced\-resolution versions of the original\&.
+.SS "Associated Images"
+.PP
+None\&.
+.SS "Known Properties"
+.PP
+Many TIFF tags are encoded as properties starting with \(rqtiff\&.\(rq\&.
+.SH "AUTHORS"
+.PP
+The Carnegie Mellon School of Computer Science\&.
+.PP
+This manual page was written by Mathieu Malaterre <mathieu\&.malaterre at gmail\&.com> for the Debian GNU/Linux system (but may be used by others)\&.
+.SH "NOTES"
+.IP " 1." 4
+Supported Virtual Slide Formats
+.RS 4
+\%http://openslide.org/Supported%20Virtual%20Slide%20Formats
+.RE
+.IP " 2." 4
+misc/print-mirax.py
+.RS 4
+\%http://github.com/openslide/openslide/blob/master/misc/print-mirax.py
+.RE
Copied: trunk/packages/openslide/tags/3.2.5-1/debian/openslide-show-properties.1.xml (from rev 9050, trunk/packages/openslide/trunk/debian/openslide-show-properties.1.xml)
===================================================================
--- trunk/packages/openslide/tags/3.2.5-1/debian/openslide-show-properties.1.xml (rev 0)
+++ trunk/packages/openslide/tags/3.2.5-1/debian/openslide-show-properties.1.xml 2011-12-19 17:09:14 UTC (rev 9051)
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<refentry id="openslideshowproperties1">
+ <refmeta>
+ <refentrytitle>OPENSLIDE-SHOW-PROPERTIES</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="source">OpenSlide</refmiscinfo>
+ <refmiscinfo class="version">3.2.5</refmiscinfo>
+ <refmiscinfo class="manual">Users Commands</refmiscinfo>
+ </refmeta>
+ <refnamediv>
+ <refname>openslide-show-properties</refname>
+ <refpurpose>Print OpenSlide properties</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv id="synopsis">
+ <cmdsynopsis>
+ <command>openslide-show-properties</command>
+ <arg choice="plain">
+ <replaceable>infile</replaceable>
+ </arg>
+ <sbr/>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsection id="description">
+ <title>DESCRIPTION</title>
+ <para>Print OpenSlide properties.</para>
+ </refsection>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../ListofKnownProperties.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../Trestleformat.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../Hamamatsuformat.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../Aperioformat.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../MIRAXformat.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../GenerictiledTIFFformat.xml"/>
+ <refsect1 id="authors">
+ <title>AUTHORS</title>
+ <para>The Carnegie Mellon School of Computer Science.</para>
+ <para>This manual page was written by Mathieu Malaterre
+<mathieu.malaterre at gmail.com> for the Debian GNU/Linux system (but may be used by others).</para>
+ </refsect1>
+</refentry>
Deleted: trunk/packages/openslide/tags/3.2.5-1/debian/openslide-write-png.1
===================================================================
--- trunk/packages/openslide/trunk/debian/openslide-write-png.1 2011-12-19 15:19:23 UTC (rev 9045)
+++ trunk/packages/openslide/tags/3.2.5-1/debian/openslide-write-png.1 2011-12-19 17:09:14 UTC (rev 9051)
@@ -1,21 +0,0 @@
-.\" Originally generated by help2man 1.38.2.
-.TH OPENSLIDE-WRITE-PNG "1" "September 2011" "3.2.4" "OpenSlide"
-.SH NAME
-openslide-write-png \- Write a fragment of a virtual slide to a PNG
-.SH SYNOPSIS
-.B openslide-write-png
-\fIvirtual-slide x y layer width height output.png\fR
-.SH DESCRIPTION
-Write a fragment of a virtual slide to a PNG.
-.PP
-.SH "SEE ALSO"
-
-.IR openslide-quickhash1sum(1),
-.IR openslide-show-properties(1)
-.PP
-
-.SH AUTHORS
-The Carnegie Mellon School of Computer Science.
-
-This manual page was written by Mathieu Malaterre
-<mathieu.malaterre at gmail.com> for the Debian GNU/Linux system (but may be used by others).
Copied: trunk/packages/openslide/tags/3.2.5-1/debian/openslide-write-png.1 (from rev 9050, trunk/packages/openslide/trunk/debian/openslide-write-png.1)
===================================================================
--- trunk/packages/openslide/tags/3.2.5-1/debian/openslide-write-png.1 (rev 0)
+++ trunk/packages/openslide/tags/3.2.5-1/debian/openslide-write-png.1 2011-12-19 17:09:14 UTC (rev 9051)
@@ -0,0 +1,21 @@
+.\" Originally generated by help2man 1.38.2.
+.TH OPENSLIDE-WRITE-PNG "1" "September 2011" "3.2.5" "OpenSlide"
+.SH NAME
+openslide-write-png \- Write a fragment of a virtual slide to a PNG
+.SH SYNOPSIS
+.B openslide-write-png
+\fIvirtual-slide x y layer width height output.png\fR
+.SH DESCRIPTION
+Write a fragment of a virtual slide to a PNG.
+.PP
+.SH "SEE ALSO"
+
+.IR openslide-quickhash1sum(1),
+.IR openslide-show-properties(1)
+.PP
+
+.SH AUTHORS
+The Carnegie Mellon School of Computer Science.
+
+This manual page was written by Mathieu Malaterre
+<mathieu.malaterre at gmail.com> for the Debian GNU/Linux system (but may be used by others).
Copied: trunk/packages/openslide/tags/3.2.5-1/debian/openslide-write-png.1.in (from rev 9050, trunk/packages/openslide/trunk/debian/openslide-write-png.1.in)
===================================================================
--- trunk/packages/openslide/tags/3.2.5-1/debian/openslide-write-png.1.in (rev 0)
+++ trunk/packages/openslide/tags/3.2.5-1/debian/openslide-write-png.1.in 2011-12-19 17:09:14 UTC (rev 9051)
@@ -0,0 +1,12 @@
+[NAME]
+Write a fragment of a virtual slide to a PNG
+
+[SEE ALSO]
+.IR openslide-quickhash1sum(1),
+.IR openslide-show-properties(1)
+
+[AUTHOR]
+The Carnegie Mellon School of Computer Science.
+
+This manual page was written by Mathieu Malaterre <mathieu.malaterre at gmail.com> for
+the Debian GNU/Linux system, but may be used by others.
Copied: trunk/packages/openslide/tags/3.2.5-1/debian/process.xsl (from rev 9050, trunk/packages/openslide/trunk/debian/process.xsl)
===================================================================
--- trunk/packages/openslide/tags/3.2.5-1/debian/process.xsl (rev 0)
+++ trunk/packages/openslide/tags/3.2.5-1/debian/process.xsl 2011-12-19 17:09:14 UTC (rev 9051)
@@ -0,0 +1,148 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
+ <xsl:output method="xml" indent="yes" encoding="utf-8"/>
+ <xsl:template match="h1">
+ <title>
+ <xsl:apply-templates/>
+ </title>
+ </xsl:template>
+ <xsl:template match="h2">
+ <xsl:choose>
+ <xsl:when test="preceding-sibling::h2">
+END SECTION
+BEGIN SECTION
+ </xsl:when>
+ <xsl:when test="preceding-sibling::h1">
+BEGIN SECTION
+ </xsl:when>
+ </xsl:choose>
+ <title>
+ <xsl:apply-templates/>
+ </title>
+ </xsl:template>
+ <xsl:template match="table">
+ <informaltable>
+ <tgroup cols="2">
+ <xsl:apply-templates/>
+ </tgroup>
+ </informaltable>
+ </xsl:template>
+ <xsl:template match="tr">
+ <row>
+ <xsl:apply-templates/>
+ </row>
+ </xsl:template>
+ <xsl:template match="tbody">
+ <tbody>
+ <xsl:apply-templates/>
+ </tbody>
+ </xsl:template>
+ <xsl:template match="thead">
+ <thead>
+ <xsl:apply-templates/>
+ </thead>
+ </xsl:template>
+ <xsl:template match="th|td">
+ <entry>
+ <xsl:apply-templates/>
+ </entry>
+ </xsl:template>
+ <xsl:template match="code">
+ <!-- cant use programlisting -->
+ <literal>
+ <xsl:apply-templates/>
+ </literal>
+ </xsl:template>
+ <xsl:template match="p">
+ <xsl:choose>
+ <xsl:when test="normalize-space(.) = ''">
+ <xsl:apply-templates/>
+ </xsl:when>
+ <xsl:otherwise>
+ <para>
+ <xsl:apply-templates/>
+ </para>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:template>
+ <xsl:template match="dl">
+ <variablelist>
+ <xsl:for-each select="dt">
+ <varlistentry>
+ <term>
+ <xsl:apply-templates/>
+ </term>
+ <listitem>
+ <xsl:apply-templates select="following-sibling::dd[1]"/>
+ </listitem>
+ </varlistentry>
+ </xsl:for-each>
+ </variablelist>
+ </xsl:template>
+ <xsl:template match="ol">
+ <orderedlist>
+ <xsl:apply-templates/>
+ </orderedlist>
+ </xsl:template>
+ <xsl:template match="li">
+ <listitem>
+ <xsl:choose>
+ <xsl:when test="count(p) = 0">
+ <para>
+ <xsl:apply-templates/>
+ </para>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:apply-templates/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </listitem>
+ </xsl:template>
+ <xsl:template match="dd">
+ <xsl:choose>
+ <xsl:when test="boolean(p)">
+ <xsl:apply-templates/>
+ </xsl:when>
+ <xsl:otherwise>
+ <para>
+ <xsl:apply-templates/>
+ </para>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:template>
+ <xsl:template match="a">
+ <ulink>
+ <xsl:attribute name="url">
+ <xsl:if test="not(contains(@href,'http://'))">
+ <xsl:text>http://openslide.org</xsl:text>
+ </xsl:if>
+ <xsl:value-of select="normalize-space(@href)"/>
+ </xsl:attribute>
+ <xsl:apply-templates/>
+ </ulink>
+ </xsl:template>
+ <xsl:template match="/">
+ <xsl:for-each select="//div[@class = 'wikipage']">
+ <refsection><xsl:apply-templates/>
+END SECTION
+ </refsection>
+ </xsl:for-each>
+ </xsl:template>
+ <xsl:template match="*">
+ <xsl:message>No template for <xsl:value-of select="name()"/>
+ </xsl:message>
+ <xsl:apply-templates/>
+ </xsl:template>
+ <xsl:template match="@*">
+ <xsl:message>Still No template for <xsl:value-of select="name()"/>
+ </xsl:message>
+ <xsl:apply-templates/>
+ </xsl:template>
+ <xsl:template match="b | strong">
+ <emphasis role="bold">
+ <xsl:apply-templates/>
+ </emphasis>
+ </xsl:template>
+ <!-- Ignored elements -->
+ <xsl:template match="hr"/>
+</xsl:stylesheet>
Deleted: trunk/packages/openslide/tags/3.2.5-1/debian/rules
===================================================================
--- trunk/packages/openslide/trunk/debian/rules 2011-12-19 15:19:23 UTC (rev 9045)
+++ trunk/packages/openslide/tags/3.2.5-1/debian/rules 2011-12-19 17:09:14 UTC (rev 9051)
@@ -1,13 +0,0 @@
-#!/usr/bin/make -f
-#export DH_VERBOSE=1
-
-%:
- dh $@ --parallel
-
-override_dh_clean:
- rm -f src/callgrind.h
- rm -f src/valgrind.h
- dh_clean
-
-get-orig-source:
- ./debian/get-orig-source
Copied: trunk/packages/openslide/tags/3.2.5-1/debian/rules (from rev 9050, trunk/packages/openslide/trunk/debian/rules)
===================================================================
--- trunk/packages/openslide/tags/3.2.5-1/debian/rules (rev 0)
+++ trunk/packages/openslide/tags/3.2.5-1/debian/rules 2011-12-19 17:09:14 UTC (rev 9051)
@@ -0,0 +1,48 @@
+#!/usr/bin/make -f
+#export DH_VERBOSE=1
+
+%:
+ dh $@ --parallel
+
+override_dh_clean:
+ rm -f src/callgrind.h
+ rm -f src/valgrind.h
+ dh_clean
+
+get-orig-source:
+ ./debian/get-orig-source
+
+VER_FULL = $(shell dpkg-parsechangelog | grep '^Version' | cut -d' ' -f2 | cut -f1 -d-)
+
+# I could not get spaces working, instead duplicate boilerplate code:
+ListofKnownProperties.html:
+ wget -O $@ http://openslide.org/List%20of%20Known%20Properties/
+Trestleformat.html:
+ wget -O $@ http://openslide.org/Trestle%20format/
+Hamamatsuformat.html:
+ wget -O $@ http://openslide.org/Hamamatsu%20format/
+Aperioformat.html:
+ wget -O $@ http://openslide.org/Aperio%20format/
+MIRAXformat.html:
+ wget -O $@ http://openslide.org/MIRAX%20format/
+GenerictiledTIFFformat.html:
+ wget -O $@ http://openslide.org/Generic%20tiled%20TIFF%20format/
+
+%.xml: %.html
+ xsltproc --output $<.dummy.xml --html debian/process.xsl $<
+ sed -i -e 's/BEGIN SECTION/<refsection>/g' -e 's at END SECTION@</refsection>@g' $<.dummy.xml
+ xmllint --output $@ --format $<.dummy.xml
+ rm $<.dummy.xml
+
+debian/openslide-show-properties.1 : ListofKnownProperties.xml Trestleformat.xml Hamamatsuformat.xml Aperioformat.xml MIRAXformat.xml GenerictiledTIFFformat.xml debian/openslide-show-properties.1.xml
+ (cd debian && xsltproc --xinclude /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl openslide-show-properties.1.xml)
+
+# DO NOT USE for now
+#debian/openslide-quickhash1sum.1: debian/openslide-quickhash1sum.1.in
+# help2man --include=$< --output=$@ \
+# --no-info `basename $@ .1` --version-string=$(VER_FULL) --no-discard-stderr
+#
+#debian/openslide-write-png.1: debian/openslide-write-png.1.in
+# help2man --include=$< --output=$@ \
+# --name="Write a fragment of a virtual slide to a PNG" \
+# --no-info `basename $@ .1` --help-option=-usage --version-string=$(VER_FULL)
More information about the debian-med-commit
mailing list