Functions (sorted by name)
Top  Previous  Next


abs
Returns the absolute value of a number
aCos
Returns the arccosine of a number
addIm
Adds two images on a pixel-by-pixel basis
adjColors
Adjusts the color balance of an image
adjContrast
Adjusts the contrast, brightness and gamma of an image
adjHueSat
Adjusts the hue and/or saturation values of an image
adjLevels
Performs the linear scaling of an image
affine
Applies an arbitrary affine transformation to an image
align
Aligns one image with another by defining a set of fiducial points
andIm
Performs a bitwise logical "AND" between pixels in two images
applyMap
Applies a display map to an image by changing its pixels
asc
Returns the ASCII character code corresponding to the first letter in a string
asFloating
Converts argument to floating
aSin
Returns the arcsine of a number
asInteger
Converts argument to integer
asString
Converts argument to string
aTan
Returns the arctangent of a number
aTan2
Returns the arctangent of x/y
avrgIm
Finds an average value of two images on a pixel-by-pixel basis

bayer
Converts an 8-bit color filter array image into a 24-bit RGB image
bkAssign
Assigns background for optical density measurements
bkBlow
Removes or extracts background by dilating it inside objects of interests
bkCorrect
Corrects an image background using images of dark and white field
bkTrack
Removes or extracts background from an image by erasing objects of interest
border
Removes objects that touch the borders of a multiphase image or selection
bottomHat
Detects small dark regions
bottomHatKernel
Applies the bottomhat operator with a user-defined kernel

call
Executes a specified series of statements
chr
Converts integers to corresponding ASCII characters
clarify
Enhances an image by applying the nonlinear lowpass filter
classify
Classifies objects based on a selected geometrical parameter
close
Fills gaps in bright objects and connects objects that are close together
closeAll
Closes all open documents
closeAllCharts
Closes all open charts
closeChart
Closes an existing chart
closeIm
Closes an existing image
closeKernel
Performs closing with a user-defined kernel
clSerialClose
Closes a camera-link serial device
clSerialConnect
Changes the connection of camera-link serial ports
clSerialOpen
Opens a camera-link serial device
clSerialRead
Reads a string from a camera-link serial device
clSerialWrite
Writes a string to a camera-link serial device
convolve
Applies a linear convolution to an image
convolveFFT
Applies an FFT-based linear convolution to an image
copyIm
Copies an image to the Clipboard
copyPal
Copies the palette from a palettized or grayscale image to another one
copySelect
Copies a selection from one image to another
cos
Returns the cosine of an angle
createChart
Opens a new chart linked to a specified data table
createIm
Creates a new image

defIntCal
Assigns a default intensity calibration scale
defSpaceCal
Assigns a default spatial calibration scale
degToRad
Converts degrees to radians
deinterlace
Removes motion artifacts from an interlaced image
delFile
Deletes an existing file
diffIm
Finds absolute differences of two images on a pixel-by-pixel basis
dilate
Dilates bright objects on the image and erodes dark ones
dilateKernel
Performs dilation with a user-defined kernel
direction
Performs the direction transform of an image
distance
Performs the distance transform of a binary image
divIm
Divides one image by another on a pixel-by-pixel basis
drawArrow
Draws a straight-line segment with an arrow at the end
drawBrush
Draws on an image using the Brush tool
drawEllipse
Draws an ellipse on an image
drawFlood
Fills an area in an image using the Flood tool
drawLine
Draws a straight-line segment on an image
drawPencil
Draws on an image using the Pencil tool
drawRect
Draws a rectangle on an image
drawText
Draws a string of text on an image
duplicate
Copies an image or selection to another image

endThread
Terminates one or several processing threads
embed
Inserts an image into another image
emboss
Creates a 3D-effect appearance of an image
emphasize
Emphasizes fine detail in an image by applying the unsharp mask
ends
Finds end points of skeletons or ridges of intensity
equalize
Enhances the contrast of an image by equalizing its histogram
erode
Erodes bright objects on an image and dilates dark ones
erodeKernel
Performs erosion with a user-defined kernel
exp
Returns e (the base of natural logarithms) raised to a power
extract
Extracts a rectangular part from an image

factorIm
Multiplies each pixel in an image to a constant value
featureAnd
Extracts the features (blobs) that match foreground pixels in another image
fill
Fills holes in objects in a multiphase image
flip
Reverses an image horizontally or vertically
floyd
Applies the Floyd-Steinberg dithering to an image
fourier
Applies the direct or inverse Fourier transform to an image
   
gauss
Applies the discrete Gaussian filter to an image
genGrid
Superimposes a rectangular grid on an image
genImpulse
Generates an impulse noise with a user-defined amplitude and density
genNoise
Generates a random noise with a user-defined distribution
genShading
Applies non-uniform light distribution to an image
genSine
Generates a flat sine wave
genWedge
Generates a gray or color wedge
getComplexMode
Retrieves the mode of the active component of a complex image
getCurDir
Returns the current directory
getDisplayRange
Retrieves the minimum and maximum value of the display range of an image
getError
Returns the last error code
getErrorText
Returns the description of an error
getFileCount
Returns the number of files matching specified conditions
getFileName
Returns the name of a file matching specified conditions
getFrameCount
Returns the number of frames in a sequence
getFrameDelay
Retrieves the interval between frames in a sequence
getInputBit
Reads the state of a general purpose input bit of the framegrabber
getImHeight
Retrieves the vertical size of an image in pixels
getImScroll
Retrieves the position of the viewable area in an image frame
getImPos
Retrieves the position and size of an image frame in the workspace
getImType
Retrieves the type of an image
getImWidth
Retrieves the horizontal size of an image in pixels
getImZoom
Retrieves the zoom factor of an image
getMaxPixel
Retrieves the maximum permitted pixel value for an image
getParamSize
Retrieves the size of a specified measurement parameter of the vector type
getParamValue
Retrieves the value of a specified measurement parameter
getPixel
Retrieves a pixel's value
getSelect
Retrieves the coordinates of the bounding rectangle of the selection
getSpaceCal
Retrieves parameters of a current spatial calibration scale of an image
getTicks
Retrieves the number of milliseconds elapsed since the system was started
getVideoHeight
Retrieves the vertical size of the video in pixels
getVideoScroll
Retrieves the position of the viewable area in the Video window
getVideoPos
Retrieves the position and size of the Video window
getVideoType
Returns the type of the incoming video
getVideoWidth
Retrieves the horizontal size of the video in pixels
getVideoZoom
Retrieves the zoom factor of the Video window
getWorkHeight
Retrieves the height of ImageWarp's workspace
getWorkWidth
Retrieves the width of ImageWarp's workspace
grabAbort
Aborts acquisition of the current frame
grabAvrg
Captures a single image by averaging several video frames
grabAVI
Captures an AVI file from the video device
grabFile
Captures images from the video device and stores them in files
grabIm
Captures a single image from the video device
grabInt
Captures a single image by integrating several video frames
grabSeq
Captures several video frames as an image sequence
grabSeqAvrg
Captures a sequence by continuously averaging most recent frames
grabTrig
Issues the software trigger signal
gradient
Extracts gradient information from an image

highpass
Extracts high frequency components from an image
hitOrMiss
Applies "hit-or-miss" operator with two user-defined kernels
hypot
Calculates the hypotenuse

identify
Identifies connected components in a binary image
inStr
Returns the position of the first occurrence of one string within another
intCal
Opens the Intensity Calibration dialog box
invertIm
Inverts pixel values in an image
isFloating
Returns a TRUE if argument is floating or FALSE if it is not.
isImage
Determines the existence of an image frame
isInteger
Returns a TRUE if argument is integer or FALSE if it is not
isString
Returns TRUE if argument is string or FALSE if it is not

label
Labels or erases an object in a multiphase image
laplace
Detects points, lines and edges by applying the Laplacian operator
lCase
Returns a string that has been converted to lowercase.
left
Returns a specified number of characters from the left side of a string
len
Returns the number of characters in a string
link
Connects the ends of linear structures in a binary image
loadAVI
Loads a sequence from an existing AVI file
loadData
Opens an existing data file in a table
loadData
Loads data from an existing data file to a table
loadIm
Loads an existing image from a file
loadIntCal
Applies an existing intensity calibration scale to an image
loadMap
Loads a display map to a grayscale image
loadPal
Loads an existing palette from a palette file to an image
loadRaw
Imports the image from a non-standard image file
loadSpaceCal
Applies an existing spatial calibration scale to an image
localMax
Finds local maxima of intensity in an image
localMin
Finds local minima of intensity in an image
log
Returns the natural logarithm of a number
log10
Returns the logarithm to the base 10
lowpass
Applies the lowpass filter to an image
lshiftIm
Performs a bitwise left shift on all pixels of an image
lTrim
Returns a copy of a string without leading spaces

maskIm
Masks a source image with an image of the multiphase type
maskSelect
Converts a selection into a binary mask
maxIm
Finds the maximum of two images on a pixel-by-pixel basis
maxmin
Emphasizes edges of objects while suppressing the noise
measAngles
Activates interactive angle measurements
measBlobs
Activates interactive blob measurements
measContours
Activates interactive contour measurements
measCount
Activates interactive count of objects
measCurves
Activates interactive curve measurements
measFields
Performs automatic field measurements
measHistogram
Measures the histogram of a current image or selection
measLines
Activates interactive line measurements
measObjects
Performs automatic blob measurements
measPoints
Activates interactive point measurements
measProfile
Measure the line profile
medialAxis
Performs the medial axis transform of a binary image
median
Applies the median filter to an image
mergeComplex
Merges two floating point component images into a complex image
mergeHLS
Merges the H, L, S components of a color image into an RGB image
mergeIHS
Merges the I, H, S components of a color image into an RGB image
mergeLab
Merges the L, a*, b* components of a color image into an RGB image
mergeLCH
Merges the L, C, H components of a color image into an RGB image
mergeRGB
Merges the R, G, B components of a color image into an RGB image
mergeYIQ
Merges the Y, I, Q components of a color image into an RGB image
mid
Returns a specified number of characters from a string
minIm
Finds the minimum of two images on a pixel-by-pixel basis
msgBox
Displays a message box
mulIm
Multiplies two images on a pixel-by-pixel basis

nandIm
Performs a bitwise logical "NAND" between pixels in two images
nodes
Finds node points of skeletons or ridges of intensity
norIm
Performs a bitwise logical "NOR" between pixels in two images
normalize
Enhances the contrast of an image by normalizing its histogram
notIm
Performs a bitwise logical "NOT" on pixel values of an image

offsetIm
Adds a constant value to each pixel in an image
odRatio
Creates an optical density image
open
Separates narrowly connected bright objects and removes small ones
openKernel
Performs opening with a user-defined kernel
orIm
Performs a bitwise logical "OR" between pixels in two images

pasteIm
Pastes an image from the Clipboard
pause
Pauses the script execution
pixelate
Creates a mosaic effect on an image
prewitt
Detects edges on an image by applying the Prewitt operator
prune
Removes branches from skeletons

radToDeg
Converts radians to degrees
rand
Generates a pseudorandom integer
randomize
Initializes the random number generator
range
Detects textures in an image by applying the range operator
refreshData
Reloads data from a file into to an opened table
renFile
Renames a file or folder
renameParam
Renames a measurement parameter
resetPal
Loads a standard 256-level gray palette to a grayscale image
resetParam
Clears the list of measurement parameters previously selected
resetSelect
Removes a selection from an image
resize
Resizes an image
right
Returns a specified number of characters from the right side of a string
roberts
Detects fine edges on an image by applying the Roberts cross operator
rotate
Rotates an image at a desired angle
rotatePal
Modifies an image palette by shifting its entries
rshiftIm
Performs a bitwise right shift on all pixels of an image
rTrim
Returns a copy of a string without trailing spaces

saddles
Finds saddle points of ridges of intensity
SaltPepper
Removes the salt-and-pepper type of noise from an image
saveIm
Saves an image to a file
savePal
Saves the palette from a palettized or pseudo-colored image to a file
scrap
Removes small objects in a multiphase image
selectParam
Selects parameters for automatic measurements
Separate
Separates touching convex objects in a binary image
seqAdd
Adds a frame to the end of a sequence
seqAvrg
Averages frames in a sequence
seqDiff
Differentiates frames in a sequence
seqExtract
Extracts a frame from a sequence
seqInsert
Inserts a frame or sequence in a sequence
seqMerge
Merges two sequences into a new sequence
seqPlay
Controls playback of a sequence
seqSplit
Splits a sequence into a series of single images
serialClear
Clears the input and output buffers of the currently open serial port
serialClose
Closes the currently open serial port
serialCount
Waits for a communication event on the currently open serial port
serialOpen
Opens a serial port and set up its attributes
serialRead
Reads a string of characters from a serial port
serialWait
Waits for a communication event on a serial port
serialWrite
Writes a string of characters to a serial port

setBrush
Changes the settings for the Brush tool
setChart
Changes a chart's type and appearance
setChartAttr
Sets the default attributes for the charts
setChartPos
Changes the position and size of a chart
setColorSpace
Assigns a color space for image processing
setComplexMode
Changes the active component of a complex image
setCurDir
Changes the current directory
setDataPos
Changes the position and size of a data table
setDisplayRange
Sets the minimum and maximum value of the display range of an image
setDrawColor
Sets a current draw color for an image
setFillColor
Sets a current fill color for an image
setFlood
Sets the tolerance of the Flood tool
setFont
Sets the font for the text tool
setFrameDelay
Sets the interval between frames in a sequence
setFrameNumber
Sets the current frame in a sequence
setGridPos
Changes the position and size of the Global Grid
setHistAttr
Sets environmental parameters for the histogram
setHistPos
Sets the position and size of the Histogram window
setOuputBit
Sets the state of a general purpose output bit of the framegrabber
setImFocus
Sets the focus to an image
setImScroll
Sets the position of the viewable area in an image frame
setImZoom
Sets the zoom factor of an image
setImPos
Sets the position and size of an image frame in the workspace
setMeasAttr
Sets the attributes for blob measurement functions
setParamScope
Sets the scope of parameters for interactive measurements
setParamSize
Sets the size of a specified measurement parameter
setParamValue
Sets the value of a specified measurement
setPal
Applies one of the predefined palettes to an image
setPencil
Sets the width of the Pencil tool
setPixel
Sets the value of a pixel in an image
setProfile
Sets the shape and position of the profile line
setProfilePos
Sets the position and size of the Line profile tool
setSelect
Creates a selection (region of interest) on an image
setShowGrid
Enables or disables automatic display of the Global Grid
setSpaceCal
Defines a spatial calibration scale and applies it to an image
setTermPos
Changes the position and size of the Terminal window
setVideoDevice
Sets the current video device by index
setVideoCamera
Sets the current video device or camera by name
setVideoMode
Sets the current video format or mode by index
setVideoPal
Applies pseudo-coloring to the video window
setVideoScroll
Sets the position of the viewable area in the Video window
setVideoPos
Sets the video window's position and size
setVideoZoom
Sets the zoom factor of the Video window
sharpen
Sharpens an image by applying the sharpening filter
showGrid
Shows or hides the Global Grid
showHistogram
Shows or hides the Histogram window

showProfile
Shows or hides the Line profile tool
showTerm
Shows or hides the terminal window
showVideo
Show or hides the video window
sigma
Applies a non-linear smoothing to an image
sin
Returns the sine of an angle
skip
Removes or extract objects based on a selected parameter's range
sobel
Detects principal edges on an image by applying the Sobel operator
spaceCal
Opens the Spatial Calibration dialog box
split
Splits an image into several images.
splitComplex
Splits a complex image into two floating point component images
splitHLS
Split a color image into the H, L, S component images
splitIHS
Splits a color image into the I, H, S component images
splitLab
Splits a color image into the L, a*, b* component images
splitLCH
Splits a color image into the L, C, H component images
splitRGB
Split a color image into the Red, Green and Blue component images
splitYIQ
Splits a color image into the Y, I, Q component images
sqr
Returns the square root of a number
strFormat
Writes formatted data to a string
subIm
Subtracts one image from another on a pixel-by-pixel basis

tan
Returns the tangent of an angle
template
Performs a binary template matching on a multiphase image
terminate
Terminates the script and closes ImageWarp
thicken
Grows bright objects from their skeletons
thin
Reduces bright objects to their skeletons
thread
Creates a new processing thread in the script
threshDistr
Performs automatic thresholding by minimizing the distribution error
threshDistrLocal
Perform adaptive segmentation by minimizing the local distribution error
threshGauss
Performs automatic threshodling by fitting the Gaussian to the histogram
threshGaussLocal
Perform adaptive segmentation by fitting the Gaussian to the local histogram
threshHLS
Performs HLS thresholding on a color image
threshMin
Performs automatic thresholding based on the histogram minimum search
threshMulti
Performs multiphase thresholding of an image
threshold
Performs binary thresholding of an image
threshRGB
Performs RGB thresholding on a color image
threshTrim
Performs automatic thresholding by trimming the histogram of an image
threshUnimod
Performs automatic thresholding based on the unimodal distribution
threshVar
Performs automatic thresholding based on the minimum of variance
threshVarLocal
Perform adaptive segmentation based on the local minimum of variance
threshWater
Performs automatic thresholding by finding the valleys in the histogram
to16bit
Converts an image or selection into a high-color bitmap (5 bits per channel)
to1bit
Converts an image into a two color binary bitmap
to24bit
Converts an image or selection into a 24-bit true color bitmap
to32bit
Converts an image into an RGB 32-bit high-depth color image
to48bit
Converts an image into an RGB 48-bit high-depth color image
To4bit
Converts an image or selection into a 16-color bitmap
To8bit
Converts an image or selection into a 256-color bitmap
toComplex
Converts an image or selection into a 64-bit complex grayscale format
toFloat
Converts an image or selection into a floating point grayscale format
toGray
Converts an image or selection into an 8-bit standard grayscale format
toGray16
Converts an image or selection into a 16-bit high-depth grayscale format
toGray32
Converts an image or selection into a 32-bit high-depth grayscale format
toMulti
Converts an image or selection into a multiphase 256-band image
topHat
Detects small bright regions
topHatKernel
Applies the tophat operator with a user-defined kernel
toSequence
Converts an image into a one-frame sequence
translate
Translates an image horizontally or vertically
twainAcquire
Opens a manufacturer's user interface for TWAIN acquisition
twainGrab
Captures an image from the TWAIN device without displaying user interface
twainSelect
Opens Select Source dialog box for selecting a TWAIN device
twainSeq
Captures a sequence from the TWAIN device

uCase
Returns a string that has been converted to uppercase
ultErode
Reduces objects in a binary image to single pixels or small groups of pixels
updateIm
Turns the automatic update of an image on screen on and off

variance
Detects edges and textures in an image by applying the variance operator
   
wait
Delays execution of the script for the specified number of milliseconds
waitThread
Pauses execution of the script until one or several threads terminate
warp
Applies a linear warp to an image
waterfall
Creates basins of intensity in an image
watershed
Finds the ridges of intensity in an image

xnorIm
Performs a bitwise logical "XNOR" between pixels in two images
xorIm
Performs a bitwise logical "XOR" between pixels in two images