qccpackwav.3

QccPack implementation in C

.TH QCCPACKWAV 3 "QCCPACKWAV" ""
.SH NAME
QccPackWAV \- QccPack module for wavelets
.SH DESCRIPTION
.B QccPackWAV
provides a collection of library routines and utility programs for
wavelet-based analysis and synthesis of signals.
.SS "DATA TYPES AND FILE FORMATS"
.TP
.BR QccWAVFilterBank (3)
data structure 
.B QccWAVFilterBank
and corresponding
.B FBK
file format for wavelet-based analysis/synthesis using a
filter-bank implementation
.TP
.BR QccWAVLiftingScheme (3)
data structure 
.B QccWAVLiftingScheme
and corresponding
.B LFT
file format for wavelet-based analysis/synthesis using lifting
.TP
.BR QccWAVWavelet (3)
data structure
.B QccWAVWavelet
for storing a wavelet
.TP
.BR QccWAVSubbandPyramid (3)
data structure
.B QccWAVSubbandPyramid
and corresponding
.B SBP
file format for a two-dimensional dyadic subband decomposition of an image
.TP
.BR QccWAVPerceptualWeights (3)
data structure
.B QccWAVPerceptualWeights
and corresponding
.B PCP
file format for perceptual weighting of subbands
.TP
.BR QccWAVZerotree (3)
data structure
.B QccWAVZerotree
and corresponding
.B ZT
file format for zerotrees
.SS "PATH AND ENVIRONMENT VARIABLE"
The
.B QccPack
library routines dealing with wavelets searches a number of
directories for filter-bank,
lifting-scheme, and perceptual-weight files.
The order of the directories to be searched for these files is
given by the colon-separated list of directories in the
environment variable
.BR QCCPACK_WAVELET_PATH .
This environment variable is set to a default path by
.BR QccInit (3);
this default path is overridden if the user sets
.B QCCPACK_WAVELET_PATH
prior to invocation of any
.B QccPack
library routines or programs.
The default path is
.B .:$(QCCPACK_INSTALL_DATA_PATH)/Wavelets
where
.B $(QCCPACK_INSTALL_DATA_PATH)
is the installation location of the
.B QccPack
data files (usually /usr/local/share/QccPack).
Note that the current working directory is the first directory in the
default path.
.SS "LIBRARY ROUTINES"
.SS "Discrete Wavelet Transform (DWT)"
.TP
.BR QccWAVWaveletDWT1D (3)
discrete wavelet transform (DWT) of 1D signal
.TP
.BR QccWAVWaveletInverseDWT1D (3)
inverse discrete wavelet transform (DWT) of 1D signal
.TP
.BR QccWAVWaveletDWTSubbandLength (3)
length of a subband
inverse discrete wavelet transform (DWT) of 1D signal
.TP
.BR QccWAVWaveletDWT2D (3)
separable discrete wavelet transform (DWT) of 2D signal
.TP
.BR QccWAVWaveletInverseDWT2D (3)
separable inverse discrete wavelet transform (DWT) of 2D signal
.TP
.BR QccWAVWaveletDyadicDWT3D (3)
separable dyadic discrete wavelet transform (DWT) of 3D signal
.TP
.BR QccWAVWaveletInverseDyadicDWT3D (3)
separable dyadic inverse discrete wavelet transform (DWT) of 3D signal
.TP
.BR QccWAVWaveletPacketDWT3D (3)
separable wavelet-packet discrete wavelet transform (DWT) of 3D signal
.TP
.BR QccWAVWaveletInversePacketDWT3D (3)
separable wavelet-packet inverse discrete wavelet transform (DWT) of 3D signal
.SS "Redundant Discrete Wavelet Transform (RDWT)"
.TP
.BR QccWAVWaveletRedundantDWT1D (3)
redundant discrete wavelet transform (RDWT) of 1D signal
.TP
.BR QccWAVWaveletRedundantDWT1DSubsample (3)
subsample RDWT coefficients to produce DWT coefficients
.TP
.BR QccWAVWaveletInverseRedundantDWT1D (3)
inverse redundant discrete wavelet transform (RDWT) of 1D signal
.TP
.BR QccWAVWaveletRedundantDWT2DAlloc (3)
allocate subband matrices for 2D RDWT
.TP
.BR QccWAVWaveletRedundantDWT2DFree (3)
free subband matrices for 2D RDWT
.TP
.BR QccWAVWaveletRedundantDWT2D (3)
redundant discrete wavelet transform (RDWT) of 2D signal
.TP
.BR QccWAVWaveletRedundantDWT2DSubsample (3)
subsample RDWT coefficients to produce DWT coefficients
.TP
.BR QccWAVWaveletInverseRedundantDWT2D (3)
inverse redundant discrete wavelet transform (RDWT) of 2D signal
.SS "Wavelet"
.TP
.BR QccWAVWaveletInitialize (3)
initialize a wavelet
.TP
.BR QccWAVWaveletAlloc (3)
allocate a wavelet
.TP
.BR QccWAVWaveletFree (3)
free a wavelet
.TP
.BR QccWAVWaveletPrint (3)
print a wavelet
.TP
.BR QccWAVWaveletCreate (3)
create a wavelet
.TP
.BR QccWAVWaveletBiorthogonal (3)
check if wavelet is biorthogonal
.TP
.BR QccWAVWaveletAnalysis1D (3)
wavelet analysis of a 1D signal
.TP
.BR QccWAVWaveletSynthesis1D (3)
wavelet synthesis of a 1D signal
.TP
.BR QccWAVWaveletAnalysis2D (3)
separable wavelet analysis of a 2D signal
.TP
.BR QccWAVWaveletSynthesis2D (3)
separable wavelet synthesis of a 2D signal
.TP
.BR QccWAVWaveletAnalysis3D (3)
separable wavelet analysis of a 3D signal
.TP
.BR QccWAVWaveletSynthesis3D (3)
separable wavelet synthesis of a 3D signal
.SS "Filter Bank"
.TP
.BR QccWAVFilterBankInitialize (3)
initialize filter bank
.TP
.BR QccWAVFilterBankAlloc (3)
allocate filter bank
.TP
.BR QccWAVFilterBankFree (3)
free filter bank
.TP
.BR QccWAVFilterBankPrint (3)
print filter bank
.TP
.BR QccWAVFilterBankMakeOrthogonal (3)
create orthogonal filter bank
.TP
.BR QccWAVFilterBankMakeBiorthogonal (3)
create biorthogonal filter bank
.TP
.BR QccWAVFilterBankBiorthogonal (3)
check if filter bank is biorthogonal
.TP
.BR QccWAVFilterBankRead (3)
read filter bank from file
.TP
.BR QccWAVFilterBankWrite (3)
write filter bank to file
.TP
.BR QccWAVFilterBankAnalysis (3)
wavelet analysis using a filter bank
.TP
.BR QccWAVFilterBankSynthesis (3)
wavelet synthesis using a filter bank
.SS "Lazy Wavelet Transform (LWT)"
.TP
.BR QccWAVWaveletLWT (3)
forward lazy wavelet transform
.TP
.BR QccWAVWaveletInverseLWT (3)
inverse lazy wavelet transform
.TP
.BR QccWAVWaveletLWT2D (3)
forward separable 2D lazy wavelet transform
.TP
.BR QccWAVWaveletInverseLWT2D (3)
inverse separable 2D lazy wavelet transform
.TP
.BR QccWAVWaveletLWT3D (3)
forward separable 3D lazy wavelet transform
.TP
.BR QccWAVWaveletInverseLWT3D (3)
inverse separable 3D lazy wavelet transform
.SS "Lifting Scheme"
.TP
.BR QccWAVLiftingSchemeInitialize (3)
initialize lifting scheme
.TP
.BR QccWAVLiftingSchemePrint (3)
print lifting scheme
.TP
.BR QccWAVLiftingSchemeBiorthogonal (3)
check if lifting scheme is biorthogonal
.TP
.BR QccWAVLiftingAnalysis (3)
wavelet analysis using lifting
.TP
.BR QccWAVLiftingSynthesis (3)
wavelet synthesis using lifting
.SS "Shape-Adaptive Discrete Wavelet Transform (SA-DWT)"
.TP
.BR QccWAVWaveletShapeAdaptiveDWT1D (3)
shape-adaptive discrete wavelet transform (SA-DWT) for a 1D signal
.TP
.BR QccWAVWaveletInverseShapeAdaptiveDWT1D (3)
inverse shape-adaptive discrete wavelet transform (SA-DWT) for a 1D signal
.TP
.BR QccWAVWaveletShapeAdaptiveDWT2D (3)
separable shape-adaptive discrete wavelet transform (SA-DWT) for a 2D signal
.TP
.BR QccWAVWaveletInverseShapeAdaptiveDWT2D (3)
separable inverse shape-adaptive discrete wavelet transform (SA-DWT)
for a 2D signal
.TP
.BR QccWAVWaveletShapeAdaptiveDyadicDWT3D (3)
separable shape-adaptive dyadic 
discrete wavelet transform (SA-DWT) for a 3D signal
.TP
.BR QccWAVWaveletInverseShapeAdaptiveDyadicDWT3D (3)
separable inverse shape-adaptive dyadic discrete wavelet transform (SA-DWT)
for a 3D signal
.TP
.BR QccWAVWaveletShapeAdaptivePacketDWT3D (3)
separable shape-adaptive wavelet-packet
discrete wavelet transform (SA-DWT) for a 3D signal
.TP
.BR QccWAVWaveletInverseShapeAdaptivePacketDWT3D (3)
separable inverse shape-adaptive wavelet-packet
discrete wavelet transform (SA-DWT)
for a 3D signal
.SS "Shape-Adaptive Mask"
.TP
.BR QccWAVShapeAdaptiveMaskBAR (3)
calculate the boundary-to-area ratio (BAR) for a transparency mask
.SS "Subband Pyramid"
.TP
.BR QccWAVSubbandPyramidInitialize (3)
initialize subband pyramid
.TP
.BR QccWAVSubbandPyramidAlloc (3)
allocate subband pyramid
.TP
.BR QccWAVSubbandPyramidFree (3)
free subband pyramid
.TP
.BR QccWAVSubbandPyramidNumLevelsToNumSubbands (3)
calculate number of subbands from number of levels
.TP
.BR QccWAVSubbandPyramidNumSubbandsToNumLevels (3)
calculate number of levels from number of subbands
.TP
.BR QccWAVSubbandPyramidCalcLevelFromSubband (3)
calculate level of subband
.TP
.BR QccWAVSubbandPyramidSubbandSize (3)
calculate size of subband
.TP
.BR QccWAVSubbandPyramidSubbandOffsets (3)
calculate position of subband
.TP
.BR QccWAVSubbandPyramidSubbandToQccString (3)
create name of subband
.TP
.BR QccWAVSubbandPyramidPrint (3)
print subband pyramid
.TP
.BR QccWAVSubbandPyramidRead (3)
read a subband pyramid from file
.TP
.BR QccWAVSubbandPyramidWrite (3)
write a subband pyramid to file
.TP
.BR QccWAVSubbandPyramidCopy (3)
copy a subband pyramid
.TP
.BR QccWAVSubbandPyramidZeroSubband (3)
make subband zero in subband pyramid
.TP
.BR QccWAVSubbandPyramidSubtractMean (3)
subtract mean from subband-pyramid data
.TP
.BR QccWAVSubbandPyramidAddMean (3)
add mean to subband-pyramid data
.TP
.BR QccWAVSubbandPyramidCalcCoefficientRange (3)
calculate range of coefficients in subband pyramid
.TP
.BR QccWAVSubbandPyramidAddNoiseSquare (3)
add noise square to subband-pyramid data
.TP
.BR QccWAVSubbandPyramidRasterScan (3)
raster scan subband pyramid
.TP
.BR QccWAVSubbandPyramidInverseRasterScan (3)
inverse raster scan subband pyramid
.TP
.BR QccWAVSubbandPyramidDWT (3)
separable discrete wavelet transform (DWT) of subband-pyramid data
.TP
.BR QccWAVSubbandPyramidInverseDWT (3)
separable inverse discrete wavelet transform (DWT) of subband-pyramid data
.TP
.BR QccWAVSubbandPyramidShapeAdaptiveDWT (3)
separable shape-adaptive discrete wavelet transform (SA-DWT)
of subband-pyramid data
.TP
.BR QccWAVSubbandPyramidInverseShapeAdaptiveDWT (3)
separable inverse shape-adaptive discrete wavelet transform (SA-DWT)
of subband-pyramid data
.TP
.BR QccWAVSubbandPyramidRedundantDWTSubsample (3)