[wxWidgets.git] / src / tiff / man / TIFFstrip.3tiff

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