Victor Image Processing Library -- Function List

Function List

File Operations

loadbif: load 8-bit binary image data file
loadbmp: load 1-, 4-, 8-, or 24-bit BMP or DIB file
loadbmpfrombuffer: load BMP or DIB file from memory
loadbmppalette: load BMP palette
loadbmppalettefrombuffer: load BMP palette from memory
loadgif: load GIF image
loadgifframe: load GIF image from multiframe file
loadgifframefrombuffer: load GIF image from multiframe file in memory
loadgiffrombuffer: load GIF file from memory
loadgifpalette: load GIF palette
loadgifpalettefrombuffer: load GIF palette from memory
loadgifglobalpalette: load GIF global palette
loadgifglobalpalettefrombuffer: load GIF global palette from memory
loadgifframepalette: load GIF frame palette
loadgifframepalettefrombuffer: load GIF frame palette from memory
loadjpg: load JPEG file
loadjpgex: load JPEG file without converting from ycc to rgb
loadjpgfrombuffer: load 8- or 24-bit JPEG file from memory
loadjpgfrombufferex: load JPEG file without converting from ycc to rgb
loadjpgthumbnail: load a thumbnail image from a JPEG file
loadjpgthumbnailfrombuffer: load a thumbnail image from a JPEG file in memory
loadpcx: load 1-, 4-, 8-, or 24-bit PCX file
loadpcxpalette: load PCX color palette
loadpng: load 1- through 24-bit PNG file
loadpngfrombuffer: load PNG file from memory
loadpngpalette: load PNG palette
loadpngpalettefrombuffer: load PNG palette from memory
loadpngwithalpha: load image and alpha channel data from PNG file
loadpngfrombufferwithalpha: load image and alpha channel data from PNG file in memory
loadtga: load Targa 8-, 16-, 24-, 32-bit file
loadtgapalette: load TGA color palette
loadtgawithalpha: load image and alpha channel data from TGA file
loadtif: load 1-, 4-, 6-, 8-, 16-, or 24-bit TIFF
loadtiffrombuffer: load image from TIFF file in memory
loadtifpage: load an image from a multipage TIFF file
loadtifpagebyindex: load image from TIFF multipage file
loadtifpagebyindexfrombuffer: load image from TIFF multipage file in memory
loadtifpagebyindexfrombufferwithalpha: load image and alpha channel image from file in memory
loadtifpalette: load TIFF color palette
loadtifpalettefrombuffer: load palette from TIFF file from memory
loadtifpalettepage: load palette from TIFF multipage file
loadtifpalettepagebyindex: load palette from TIFF multipage file
loadtifwithalpha: load image and alpha channel data from TIFF file
savebif: save 8-bit binary image data file
savebmp: save image as 1-, 8-, or 24-bit BMP or DIB
savebmptobuffer: save image as BMP file in memory
saveeps: save image as EPS file (grayscale or color)
savegif: save image as GIF file
savegifex: save image as GIF file, interlace and transparent color options
savegiftobufferex: save image as GIF in memory, interlace and transparent color options
savegifframe: save image as a frame in a multiframe GIF file
savegifframetobuffer: save image as a frame in a multiframe GIF file in memory
savejpg: save image as 8-bit grayscale or 24-bit color JPEG compressed file
savejpgex: save image as JPEG file with mode option
savejpgtobuffer: save image as JPEG file in memory
savejpgtobufferex: save image as JPEG file with mode option in memory
savepcx: save image as 1- or 8-bit PCX
savepng: save image as 1- through 24-bit PNG
savepngex: save image as 1- through 24-bit PNG with transparent color
savepngtobuffer: save image as PNG file to memory
savepngtobufferex: save image as PNG with transparent color to memory
savetga: save image as 24-bit RGB Targa
savetif: save image as 1-, 8-, 16-, or 24-bit TIFF
savetifpage: save image in a multipage TIFF file
savetiftobuffer: save image as TIFF file to memory
getgifcomment: read comment from a GIF file
getpngcomment: read comment from a PNG file
setgifcomment: set comment and version for saving a GIF file
bmpinfo: obtain information about BMP or DIB file
bmpinfofrombuffer: BMP file information from memory
gifframecount: get number of frames in GIF file
gifframecountfrombuffer: get number of frames in GIF file in memory
gifinfo: GIF file information
gifinfoallframes: get image info about all frames in GIF file
gifinfoallframesfrombuffer: get image info about all frames in GIF file in memory
gifinfoframe: get image info about one frame in GIF file
gifinfoframefrombuffer: get image info about one frame in GIF file in memory
gifinfofrombuffer: GIF file information from memory
jpeginfo: obtain information about JPEG file
jpeginfoex: JPEG file information
jpeginfofrombuff: obtain information about JPEG file from memory
jpeginfofrombufferex: JPEG file information from memory buffer
jpegsetthumbnailsize: set JPEG thumbnail size
jpegsetxyresolution: set resolution dta for saving JPEG files
pcxinfo: obtain information about PCX file
pnginfo: obtain information about PNG file
pnginfofrombuffer: PNG file information from memory
pnggetxyresolution: get resolution data from a PNG file
pngsetxyresolution: set resolution data for saving PNG files
tgainfo: obtain information about TGA file
tiffinfo: TIFF file information
tiffinfofrombuffer: TIFF file information from memory
tiffinfopage: TIFF information about a single page in a multipage TIFF file
tiffinfopagebyindex: TIFF information about a single page in a multipage TIFF file
tiffinfopagebyindexfrombuffer: TIFF info about a single page from memory
tiffinfopagebyindexex: expanded TIFF info about a single page
tiffinfopagebyindexfrombufferex: expanded TIFF info about a single page from memory
tiffgetpageinfo: TIFF file information about all pages
tiffgetpageinfofrombuffer: TIFF file info about all pages in memory
tiffgetSOIofspagebyindex: get offset of JPEG-compressed data
tiffgetSOIofspagebyindexfrombuffer: get offset of JPEG-compressed data
tiffgetxyresolution: get resolution data from a TIFF file
tiffgetxyresolutionpagebyindex: get resolution data about a single page from a TIFF file
tiffsetxyresolution: set resolution data for saving an image in a TIFF file
jpeggeterror: report last JPEG error
pnggeterror: report last PNG error
tiffgeterror: report last TIFF error
unlockLZW: unlock LZW (unnecessary since July 2004)

Image Processing Functions

addnoise: add random noise
addtext: add text
addtextex: add text
blur: smoothing filter
blurthresh: smoothing filter with threshold
brightenmidrange: raise brightness of mid levels
changebright: increase or decrease brightness
divide: divide by factor
dilate: darken by enlarging dark areas
dropbits: reduce noise by dropping bits
emboss: emboss filter
embossongray: emboss filter
erode: brighten by enlarging bright areas
exchangelevel: change range to new value
expandcontrast: increase contrast
gammabrighten: adjust gamma brightness
gaussianblur: blur filter
histobrighten: histogram brightening
histoequalize: histogram equalization
kodalith: create high contrast image
limitlevel: set maximum brightness level
matrixconv: matrix convolution, 3 x 3 kernel
matrixconvex: matrix convolution, 63 x 63 kernel
medianfilter: median filter, to despeckle an image
multiply: multiply by factor
multiplyex: multiply by a floating point factor
negative: negative image
outline: edge detection filter
outlineongray: outline filter
pixellize: pixellation, to create mosaic effect
removenoise: median filter, to despeckle an image
sharpen: sharpening filter
sharpengentle: gently sharpen
threshold: set minimum brightness level
tile: fill with multiple copies of an image
usetable: assign brightness based on table
zeroimage: set all pixel values to a value

Combine and Compare Images

addimage: add two images
addtexture: add a texture
andimage: AND two images
bleachimage: special effect
correlateimages: correlates two images for pattern recognition
cover: overlay two images, transparent range of colors
coverclear: overlay two images, transparent color
darker: take the darker pixels of two images
difference: subtract two images
differenceabs: subtract two images, absolute value
displace: alter pixel positions
divideimage: divide one image by another image
isolate: isolate portions of an image by masking
lighter: take the lighter pixels of two images
multnegimage: special effect
multiplyimage: multiply two images
orimage: OR two images
screen: apply user-defined dither screen
subimage: subtract two images
wtaverage: weighted average of two images
wtaveragemask: apply user-defined weight mask
xorimage: XOR two images

Image Manipulation, Geometry, and Orientation

copyimage: copy or crop image
displace: alter pixel positions
extractcolorrange: create an 8-bit mask based on color
extractplane: copy a plane into an 8-bit image
flipimage: flip image top to bottom
insertplane: paste an 8-bit plane into a 24-bit image
mirrorimage: reverse image left to right
resize: resize image
resizeex: resize image with pixel interpolation
rotate: rotate image any angle
rotateex: rotate image any angle with pixel replication
rotate90: rotate image 90 degrees
setimagearea: set region of interest in image, all subsequent operations affect only the region of interest
tile: fill with multiple copies of an image

Image Analysis

calcavglevel: calculate average brightness
calcavglevelfloat: calculate average brightness as a floating pt number
calchisto: calculate histogram
calchistorgb: calculate histogram treating palette color image as an RGB image
calcminmax: calculate minimum and maximum pixel values
correlationcoef: calculate correlation coefficient between two imager
correlationcoefRGB: calculate correlation coefficients by plane between two images
getpixelcolor: read a pixel value
isgrayscaleimage: determine if image is grayscale
pixelcount: count pixels in brightness range
setpixelcolor: set pixel value
sortpixelsbyval: sort pixels by brightness into an array

Color Reduction and Image Conversion

clienttoimage: capture window client area to image
cmykimagetorgbimage: convert 32-bit CMYK image to 24-bit RGB
colordither: create dithered color image, 16- or 256-color palette
colorscatter: create scatter color image, 16- or 256-color palette
colortogray: color image to grayscale
convert1bitto8bit: 1-bit image to 8-bit image
convert1bitto8bitsmooth: 1-bit image to 8-bit image with smoothing
convert8bitto1bit: 8-bit image to 1-bit image with dither, scatter, or threshold options
convert8bitto1bitex: convert 8- to 1-bit with dither matrix
convertgray8to16: 8-bitgrayscale to 16-bit grayscale image
convertgray16to8: 16-bitgrayscale to 8-bit grayscale image
convertgray16to8ex: convert 16- to 8-bit with contrast expansion
convertgray32to8: convert 32- to 8-bit grayscale
convertgray32to16: convert 32- to 16-bit grayscale
convertrgbpal: 24-bit RGB image to 8-bit with optimum palette
convertrgbpalex: 24-bit RGB image to 8-bit with optimum palette with diffusion scatter and color matching options
convertpalrgb: 8-bit image to 24-bit RGB
ddbtoimage: device dependent bitmap to image
dibtobitmap: DIB to a device specific bitmap
dibtoimage: DIB to a Victor-compatible image
dibsecttoimage: DIB section to a Victor-compatible image
hsvimagetorgbimage: convert 24-bit HSV image to 24-bit RGB image
imagetodib: extract an image area and create a new DIB
matchcolorimage: match image to a specified palette
matchcolorimageex: match image to a specified palette with diffusion scatter and color matching options
reduceimagecolors: decrease the number of colors used in an image
rgbimagetocmykimage: onvert 24-bit RGB image to 32-bit CMYK image
rgbimagetohsvimage: convert 24-bit RGB image to 24-bit HSV image
windowtoimage: capture window to image

Color Palette Functions

copyimagepal: copy image palette data
defaultpalette: assign Windows 16-color palette to image
makepalette: create a palette
rainbowpalette: assign rainbow 256-color palette to image
standardpalette: assign Windows palette to image
hsv2rgb: convert hue, saturation, value table to red, green, blue palette
rgb2hsv: convert red, green, blue palette to hue, saturation, value table
updatebitmapcolortable: update internal color info
victowinpal: convert image palette to Windows logical palette
wintovicpal: convert Windows logical palette to image palette

Memory Management

allocDIB: allocate space for a clipboard-compatible packed DIB
allocimage: allocate space for an image stored as a DIB section
freebuffer: release memory from a savefiletobuffer function
freeimage: free an allocated image
getbuffersize: determine size of a buffer from a savefiletobuffer function

Printer Functions

printimage: print image
printimagenoeject: print image without ejecting page, allowing multiple images and text to be printed
printimagestartdoc: begin print document
printimageenddoc: end print document and eject page

TWAIN Device Control

TWopen: open TWAIN data source and data source manager
TWclose: close TWAIN data source and data source manager
TWdetecttwain: detect TWAIN source manager
TWgetbrightness: set scanner brightness
Twgetcontrast: set scanner contrast
TWgeterror: get extended error information
TWgetfeeder: get document feeder status
TWgetmeasureunit: get valid measurement units
TWgetphysicalsize: get scan bed size
TWgetpixeltype: restrict pixel type
TWgetsourcenames: get names of available data sources
TWgetxresolution: set scanner horizontal resolution
TWgetyresolution: set scanner vertical resolution
TWscancountimages: acquire specific number of images from TWAIN device
TWscanimage: acquire image from TWAIN device
TWscanimageex: acquire image from TWAIN device without displaying Acquire dialog box
TWscanmultipleimages: acquire multiple images
TWscanmultipleimagesex: acquire multiple images without displaying Acquire dialog box
TWselectsource: select a new data source
TWselectsourcebyname: select a data source by name
TWsetbrightness: set scanner brightness
TWsetcontrast: set scanner contrast
TWsetduplex: enable/disable duplex scanning
TWsetfeeder: enable/disable automatic document feeder
TWsetmeasureunit: set measurement unit type
TWsetpagesize: set the default page size for the device
TWsetpixeltype: restrict pixel type
TWsetproductname: inform data source of application name
TWsetxresolution: set scanner horizontal resolution
TWsetyresolution: set scanner vertical resolution
TWvicversion: return Victor Library TWAIN support module version number

Video Digitizer Support

Optional support is available for PixelSmart grayscale and color framegrabbers.
These modules have the functionality to give you complete control over the video framegrabbers.

capture an image area
display continuous video in a window
capture and average multiple frames
adjust brightness, contrast, hue, saturation (depends on framegrabber capabilities)
transfer image from computer memory to framegrabber video memory for display on an external monitor (if framegrabber supports video output)

Display Functions

drawhisto: display histogram
viewimage: display image
viewimageex: display image with automatic color reduction at a specific location in a window