[med-svn] r7690 - trunk/packages/openslide/trunk/debian

Tue Sep 6 15:32:22 UTC 2011

Author: malat-guest
Date: 2011-09-06 15:32:22 +0000 (Tue, 06 Sep 2011)
New Revision: 7690

Modified:
   trunk/packages/openslide/trunk/debian/openslide-quickhash1sum.1
   trunk/packages/openslide/trunk/debian/openslide-show-properties.1
   trunk/packages/openslide/trunk/debian/openslide-write-png.1
Log:
Improve documentation

Modified: trunk/packages/openslide/trunk/debian/openslide-quickhash1sum.1
===================================================================

--- trunk/packages/openslide/trunk/debian/openslide-quickhash1sum.1	2011-09-06 15:12:01 UTC (rev 7689)
+++ trunk/packages/openslide/trunk/debian/openslide-quickhash1sum.1	2011-09-06 15:32:22 UTC (rev 7690)
@@ -1,9 +1,10 @@
 .\" Originally generated by help2man 1.38.2.
-.TH OPENSLIDE-QUICKHASH1SUM: "1" "September 2011" "openslide-quickhash1sum: --version: Not a file that OpenSlide can recognize" "User Commands"
+.TH OPENSLIDE-QUICKHASH1SUM: "1" "September 2011" "3.2.4" "OpenSlide"
 .SH NAME
-openslide-quickhash1sum: \- Print OpenSlide quickhash-1 (256-bit) checksums 3.2.4 
+openslide-quickhash1sum: \- Print OpenSlide quickhash-1 (256-bit) checksums
 .SH DESCRIPTION
 openslide\-quickhash1sum Print OpenSlide quickhash-1 (256-bit) checksums.
+
 .SH "SEE ALSO"
 openslide-write-png(1), openslide-show-properties(1)
 

Modified: trunk/packages/openslide/trunk/debian/openslide-show-properties.1
===================================================================
--- trunk/packages/openslide/trunk/debian/openslide-show-properties.1	2011-09-06 15:12:01 UTC (rev 7689)
+++ trunk/packages/openslide/trunk/debian/openslide-show-properties.1	2011-09-06 15:32:22 UTC (rev 7690)
@@ -1,9 +1,134 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.38.2.
-.TH OPENSLIDE-SHOW-PROPERTIES: "1" "September 2011" "openslide-show-properties: --version: Not a file that OpenSlide can recognize" "User Commands"
+.\" 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 3.2.4
+openslide-show-properties: \- Print OpenSlide properties
 .SH DESCRIPTION
 openslide\-show\-properties: Print OpenSlide properties.
+
+.SH "List of Known Properties"
+.PP
+.SS "Properties generated by OpenSlide"
+.PP
+.nf
+openslide.vendor
+  The name of the vendor backend.
+openslide.comment
+  A free-form text comment, the same as returned from openslide_get_comment.
+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.
+openslide.background-color
+  The background color of the slide, given as an RGB hex triplet. This property is not always present.
+.fi
+.PP
+.SS "Properties from the JPEG backend"
+
+No properties defined.
+
+.SS "Properties from the TIFF backend"
+.PP
+.nf
+tiff.ImageDescription
+  The contents of the TIFF ImageDescripton tag.
+tiff.Make
+  The contents of the TIFF Make tag.
+tiff.Model
+  The contents of the TIFF Model tag.
+tiff.Software
+  The contents of the TIFF Software tag.
+tiff.DateTime
+  The contents of the TIFF DateTime tag.
+tiff.Artist
+  The contents of the TIFF Artist tag.
+tiff.HostComputer
+  The contents of the TIFF HostComputer tag.
+tiff.Copyright
+  The contents of the TIFF Copyright tag.
+tiff.DocumentName
+  The contents of the TIFF DocumentName tag.
+tiff.XResolution
+  The contents of the TIFF XResolution tag.
+tiff.YResolution
+  The contents of the TIFF yResolution tag.
+tiff.XPosition
+  The contents of the TIFF XPosition tag.
+tiff.YPosition
+  The contents of the TIFF YPosition tag.
+tiff.ResolutionUnit
+  The contents of the TIFF ResolutionUnit tag.
+.fi
+.PP
+.SH Vendor-specific properties
+.SS Aperio format
+.nf
+Format
+  single-file pyramidal tiled TIFF, with non-standard metadata and compression
+File extensions
+  .svs, .tif
+OpenSlide vendor backend
+  aperio
+OpenSlide ops backend
+  tiff
+.fi
+.SS Relevant TIFF tags
+.nf
+Tag	Description
+ImageDescription	Stores some important key-value pairs and other information, see below
+Compression	May be 33003 or 33005, which represent specific kinds of JPEG 2000 compression, see below
+.fi
+.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 ”aperio.”. 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
+
+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 “pyramid” 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
+
+.nf
+thumbnail
+  the second image in the file
+label
+  optional, the name “label” is given in ImageDescription
+macro
+  optional, the name “macro” is given in ImageDescription
+.fi
+.SS Known Properties
+
+All key-value data encoded in the ImageDescription TIFF field is represented as properties prefixed with ”aperio.”.
+
 .SH "SEE ALSO"
 openslide-write-png(1), openslide-quickhash1sum(1)
 

Modified: trunk/packages/openslide/trunk/debian/openslide-write-png.1
===================================================================
--- trunk/packages/openslide/trunk/debian/openslide-write-png.1	2011-09-06 15:12:01 UTC (rev 7689)
+++ trunk/packages/openslide/trunk/debian/openslide-write-png.1	2011-09-06 15:32:22 UTC (rev 7690)
@@ -1,5 +1,5 @@
 .\" Originally generated by help2man 1.38.2.
-.TH USAGE: "1" "September 2011" "Usage: openslide-write-png virtual-slide x y layer width height output.png" "User Commands"
+.TH USAGE: "1" "September 2011" "3.2.4" "OpenSlide"
 .SH NAME
 openslide-write-png: \- Write a fragment of a virtual slide to a PNG
 .SH SYNOPSIS


