src/tiff/man/TIFFstrip.3tiff

   1 .\"
   2 .\" Copyright (c) 1992-1997 Sam Leffler
   3 .\" Copyright (c) 1992-1997 Silicon Graphics, Inc.
   4 .\"
   5 .\" Permission to use, copy, modify, distribute, and sell this software and
   6 .\" its documentation for any purpose is hereby granted without fee, provided
   7 .\" that (i) the above copyright notices and this permission notice appear in
   8 .\" all copies of the software and related documentation, and (ii) the names of
   9 .\" Sam Leffler and Silicon Graphics may not be used in any advertising or
  10 .\" publicity relating to the software without the specific, prior written
  11 .\" permission of Sam Leffler and Silicon Graphics.
  12 .\"
  13 .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
  14 .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  15 .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  16 .\"
  17 .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  18 .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  19 .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  20 .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  21 .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  22 .\" OF THIS SOFTWARE.
  23 .\"
  24 .if n .po 0
  25 .TH TIFFSTRIP 3TIFF "October 15, 1995" "libtiff"
  26 .SH NAME
  27 TIFFDefaultStripSize, TIFFStripSize, TIFFVStripSize, TIFFRawStripSize,
  28 TIFFComputeStrip, TIFFNumberOfStrips \- strip-related utility routines
  29 .SH SYNOPSIS
  30 .B "#include <tiffio.h>"
  31 .sp
  32 .BI "uint32 TIFFDefaultStripSize(TIFF *" tif ", uint32 " estimate ")"
  33 .br
  34 .BI "tsize_t TIFFStripSize(TIFF *" tif ")"
  35 .br
  36 .BI "tsize_t TIFFVStripSize(TIFF *" tif ", uint32 " nrows ")"
  37 .br
  38 .BI "tsize_t TIFFRawStripSize(TIFF *" tif ", tstrip_t " strip ")"
  39 .br
  40 .BI "tstrip_t TIFFComputeStrip(TIFF *" tif ", uint32 " row ", tsample_t " sample ")"
  41 .br
  42 .BI "tstrip_t TIFFNumberOfStrips(TIFF *" tif ")"
  43 .SH DESCRIPTION
  44 .I TIFFDefaultStripSize
  45 returns the number of rows for a reasonable-sized strip according to the
  46 current settings of the
  47 .IR ImageWidth ,
  48 .IR BitsPerSample ,
  49 .IR SamplesPerPixel ,
  50 tags and any compression-specific requirements. If the
  51 .I estimate
  52 parameter, if non-zero, then it is taken as an estimate of the desired strip
  53 size and adjusted according to any compression-specific requirements. The
  54 value returned by this function is typically used to define the
  55 .I RowsPerStrip
  56 tag. In lieu of any unusual requirements
  57 .I TIFFDefaultStripSize
  58 tries to create strips that have approximately
  59 8 kilobytes of uncompressed data.
  60 .PP
  61 .IR TIFFStripSize
  62 returns the equivalent size for a strip of data as it would be returned in a
  63 call to
  64 .IR TIFFReadEncodedStrip
  65 or as it would be expected in a call to
  66 .IR TIFFWriteEncodedStrip .
  67 .PP
  68 .I TIFFVStripSize
  69 returns the number of bytes in a strip with
  70 .I nrows
  71 rows of data.
  72 .PP
  73 .I TIFFRawStripSize
  74 returns the number of bytes in a raw strip (i.e. not decoded).
  75 .PP
  76 .IR TIFFComputeStrip
  77 returns the strip that contains the specified coordinates. A valid strip is
  78 always returned; out-of-range coordinate values are clamped to the bounds of
  79 the image. The
  80 .I row
  81 parameter is always used in calculating a strip. The
  82 .I sample
  83 parameter is used only if data are organized in separate planes (\c
  84 .IR PlanarConfiguration =2).
  85 .PP
  86 .IR TIFFNumberOfStrips
  87 returns the number of strips in the image.
  88 .SH DIAGNOSTICS
  89 None.
  90 .SH "SEE ALSO"
  91 .BR TIFFReadEncodedStrip (3TIFF),
  92 .BR TIFFReadRawStrip (3TIFF),
  93 .BR TIFFWriteEncodedStrip (3TIFF),
  94 .BR TIFFWriteRawStrip (3TIFF),
  95 .BR libtiff (3TIFF),
  96 .PP
  97 Libtiff library home page:
  98 .BR http://www.remotesensing.org/libtiff/