.TH QCCHYPRAW 3 "QCCPACK" "".SH NAMEQccHYPRaw \- routines for reading and writing raw binary filestypical of hyperspectral applications.SH SYNOPSIS.B #include "libQccPack.h".sp.BI "int QccHYPRawRead2D(QccString " filename ", QccIMGImageComponent *" image_component ", int " bpp ", int " signed_data ", int " endian );.br.BI "int QccHYPRawWrite2D(QccString " filename ", const QccIMGImageComponent *" image_component ", int " bpp ", int " endian );.br.BI "int QccHYPRawRead3D(QccString " filename ", QccIMGImageCube *" image_cube ", int " bpv ", int " signed_data ", int " format ", int " endian );.br.BI "int QccHYPRawWrite3D(QccString " filename ", const QccIMGImageCube *" image_cube ", int " bpv ", int " format ", int " endian );.SH DESCRIPTIONQccPack provides data structureroutines for reading and writing raw binary files thatare typically used and produced by hyperspectral applications.Both 2D and 3D data files with arbitrary byte order are supported.For 3D datasets, the three popular scan orders (BSQ, BIL, BIP) aresupported..SH "FILE FORMAT"Hyperspectral applications typically use files that are storedin raw binary format without any headers. Each sample valueis a binary number which is stored in the raw-format filein either 1, 2, or 4 consecutive bytesin either big-endian (most-significant byte first) or little-endian(least-significant byte first) order..LPFor 2D files, it is assumed that the pixels are stored inrow-major order; i.e., pixels are orderedsuch that rows are stored one after the other.The loop order for outer to inner is: row, column..LPFor 3D files, samples (voxels) are stored in one of the following orders:.TP.BR "Band Sequential (BSQ)" " - "entire spectral bands are stored one after another.The loop order (outer to inner) is: band, row, col..TP.BR "Band Interleaved by Line (BIL)" " - "entire lines from each band are stored one after another.The loop order is: row, band, col..TP.BR "Band Interleaved by Pixel (BIP)" " - "entire pixels are stored one after another.The loop order is: row, col, band..LPNote that AVIRIS data is typically BIP, while TRWIS uses BIL.QccPack's.BR ICBformat for the.BR QccIMGImageCube (3)structure uses BSQ..LPNote that, internally, QccPack refers to spectral bands as "frames"as the.BR QccIMGImageCube (3)structure originally was deployed for video data in which the thirddimension represents temporal frames. Thus, routines often refer to.IR num_framesas the size in the third dimension..SH "ROUTINES".B QccHYPRawRead2D()reads the 2D raw file with the indicated.IR filename ,returning it in.IR image_component ,which must be allocated beforehand.The size of.IR image_componentindicates how many values to read from the file..B QccHYPRawRead3D()operates similarly, reading into the 3D.IR image_cube ..LP.B QccHYPWrite2D()writes values from.IR image_componentto the 2D raw file given by.IR filename ..B QccHYPWrite3D()operates similarly, writing from the 3D.IR image_cube..LPIn all of these routines,the parameters.IR bpp(2D files) or.IR bpv(3D files)specify the number of bits that each pixel or voxel value contains,respectively; these values must be between 1 and 32. If.IR bpp " or " bpvis <= 8, then each sample is stored as the least significantbits in a single byte; otherwise, if.IR bpp " or " bpvis <= 16, then each sample is storedas the least significant bits of two consecutive bytes;otherwise, if.IR bpp " or " bpvis <= 32, then each sample is storedas the least significant bits of four consecutive bytes..IR signed_dataindicates whether the sample values are signed or not;likewise,.IR endian ,which is one of.BR QCCHYP_RAWENDIAN_BIGor.BR QCCHYP_RAWENDIAN_LITTLE ,indicates the endianness of the binary values.For 3D reading and writing,.IR formatmust be one of.BR QCCHYP_RAWFORMAT_BSQ ,.BR QCCHYP_RAWFORMAT_BIL ,or.BR QCCHYP_RAWFORMAT_BIPto indicate the scan order of the 3D file..SH "RETURN VALUE"These routines return 0 on success, and 1 on failure..SH "SEE ALSO".BR QccHYPRawDist2D (3),.BR QccHYPRawDist3D (3),.BR QccPackHYP (3),.BR QccPack (3).SH AUTHORCopyright (C) 1997-2009  James E. Fowler.\"  The programs herein are free software; you can redistribute them an.or.\"  modify them under the terms of the GNU General Public License.\"  as published by the Free Software Foundation; either version 2.\"  of the License, or (at your option) any later version..\"  .\"  These programs are distributed in the hope that they will be useful,.\"  but WITHOUT ANY WARRANTY; without even the implied warranty of.\"  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the.\"  GNU General Public License for more details..\"  .\"  You should have received a copy of the GNU General Public License.\"  along with these programs; if not, write to the Free Software.\"  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.