.ds Vv 1.2.14
.TH VistaIOCreateImage 3 "24 April 1993" "VistaIO Version \*(Vv"
.SH NAME
VistaIOCreateImage, VistaIOCreateImageLike \- allocate memory for an image
.SH SYNOPSIS
.nf
.B #include <vistaio.h>
.PP
.ft B
VistaIOImage VistaIOCreateImage (\fInbands\fP, \fInrows\fP, \fIncolumns\fP, \
\fIpixel_repn\fP)
.RS
int \fInbands\fP, \fInrows\fP, \fIncolumns\fP;
VistaIORepnKind \fIpixel_repn\fP;
.RE
.fi
.PP
.B VistaIOImage VistaIOCreateImageLike (\fIsrc\fP)
.RS
.B VistaIOImage \fIsrc\fP;
.RE
.SH ARGUMENTS
.IP \fInbands\fP 10n
Specifies the number of bands in the new image.
.IP \fInrows\fP
Specifies the number of rows in the new image.
.IP \fIncolumns\fP
Specifies the number of columns in the new image.
.IP \fIpixel_repn\fP
Specifies the representation of pixels in the new image.
It must be one of \fBVistaIOBitRepn\fP, \fBVistaIOUByteRepn\fP, \fBVistaIOSByteRepn\fP,
\fBVistaIOShortRepn\fP, \fBVistaIOLongRepn\fP, \fBVistaIOFloatRepn\fP, or \fBVistaIODoubleRepn\fP.
.IP \fIsrc\fP
Specifies an image having the properties desired of the new image.
.SH DESCRIPTION
\fBVistaIOCreateImage\fP allocates memory for a new image with the specified
properties. Fields of the new image structure are initialized, as are the
image's row and band indices. Its pixel values, however, are not
initialized.  The new image is given an empty attribute list. The size of
its frame band interpretation dimension (\fBnframes\fP) is set to
\fInbands\fP; its other band interpretation dimensions (\fBnviewpoints\fP,
\fBncolors\fP, and \fBncomponents\fP) are set to 1.
.PP
\fBVistaIOCreateImageLike\fP allocates memory for a new image with the same
properties as \fIsrc\fP (same pixel representation, and same numbers of
bands, rows, and columns).  Fields of the new image structure are
initialized, as are the image's row and band indices. Its pixel values,
however, are not initialized.  The new image is given a copy of \fIsrc\fP's
attribute list, and the sizes of its band interpretation dimensions
(\fBnframes\fP, ..., \fBncomponents\fP) are set identical to those of
\fIsrc\fP.
.SH "RETURN VALUES"
If successful, these routines return a pointer to the newly-allocated image
structure. Otherwise, ther return
.SB \fBNULL\c
.
.SH "SEE ALSO"
.BR VistaIODestroyImage (3),
.BR VistaIOImage (3)
.SH DIAGNOSTICS
.IP "``Invalid number of \fIdimension\fP: \fIvalue\fP.''"
\fIDimension \fP is ``bands'', ``rows'', or ``columns''. 
An inappropriate value, \fIvalue\fP, was specified for that dimension.
.IP "``Invalid pixel representation: \fIrepn\fP.''"
The representation kind specified is not one of the valid pixel
representations.
.SH AUTHOR
Art Pope <pope@cs.ubc.ca>

Adaption to vistaio: Gert Wollny <gw.fossdev@gmail.com>