|
Scripting / Command Line / DOS Prompt Reference for Image Converter .EXE 3 - Scripting Edition
by: unknown - (Submit your own tutorials to tutorials@stintercorp.com)
Image Converter .EXE 3 - Scripting Edition supports full command line implementation of all supported
formats and conversion effects. These can be used from the DOS Prompt command line, or from Batch Files (*.bat). They can also be used via ShellEx API in any additional applications, such as databases and windows based programs.
Image Converter 3 - Command Line Scripting
(For Version 3.0.36)
Command Line Methods
File Array
/files:{file1};{file2};{file3};{fileX}
(File1): The Full Path to the image to be converted
(file2): The full path, or the filename in the directory of File1)
Example(s):
/files:c:\my documents\my photos\img1.jpg;c:\my documents\my photos\img2.jpg;c:\my documents\my photos\img3.jpg
/files:c:\my documents\my photos\img1.jpg;img2.jpg;img3.jpg
/files:c:\my documents\my photos\img1.jpg;img2.jpg;c:\my documents\my photos\new\img3.jpg
Description:
Tells the application which files should be edited/converted.
Folder All Array
/folderall:{folder1};{folder2};{folder3};{folderX}
(folder): The Full Path of the folder which you wish to have all the containing images (and sub-folder images) processed.
Example(s):
/folderall:c:\my documents\my photos
/folderall:c:\my documents\my photos;c:\my documents\my photos 2
Description:
This will add all the images in the specified folder(s) to be edited/converted. Note: This will include sub-folders, all files from the 'folder' root and above will be processed. You can use /folder if you do not want to include sub-folders.
Folder Array
/folder:{folder1};{folder2};{folder3};{folderX}
(folder): The Full Path of the folder which you wish to have all the containing images processed.
Example(s):
/folder:c:\my documents\my photos
/folder:c:\my documents\my photos;c:\my documents\my photos 2
Description:
This will add all the images in the specified folder(s) to be edited/converted. Note: This will not include sub-folders, if you wish to include sub folders please use /folderall:.
Load External Command Line Script (Command Line Code Stored in a txt file.)
/loadcmdscript:{filepath}
(filepath): The Full Path to the command line script to be imported.
Example(s):
/loadcmdscript:c:\file1.txt
/loadcmdscript:c:\file1.txt /loadic3script:c:\file2.txt
Description:
This function is useful when needing to import 'large' command lines from a text file. The contents of commandline script file is automatically imported in to the function. Note: Multiple load statments can be used. e.g. /loadcmdscript:c:\file1.txt /loadcmdscript:c:\file2.txt will merge the contents of both file1.txt and file2.txt into the command line.
Load IC3 Effects Script
/loadic3script:{filepath}
(filepath): The Full Path to the IC3 effect script to be imported.
Example(s):
/loadic3script:c:\file1.txt
/loadic3script:c:\file1.txt /loadcmdscript:c:\file2.txt
Description:
This function is useful when wanting to import Ic3 scripts for conversion with out having to write out fx. in the command line. (Note: You can use the script editor to create a script, then save the script and run its functionality using this command.) The contents of script file are automatically imported in to the function. Note: Multiple load statements can be used. e.g. /loadcmdscript:c:\file1.txt /loadcmdscript:c:\file2.txt will merge the contents of both file1.txt and file2.txt into the command line.
Show Script Window
/showscriptwindow
Example(s):
/showscriptwindow
Description:
This will load the script window and not run anything automatically.
Template ScriptFile (Advanced)
/scriptfile:{filepath}
(filepath): The Full Path to the script file to be loaded.
Example(s):
/scriptfile:c:\myscript.vb
Description:
Tells the application where to find a vb script file that can overwrite the 'default' template.txt script. (template.txt can be found and copied from the Program's data directory).
Basic FX Effects
Auto Contrast
fx.autocontrast
Description:
Uniformly adjusts the contrast in the photo.
Blur
fx.blur
Description:
Blurs the photo by averaging each pixel with each of its neighboring pixels.
Diffuse
fx.Diffuse
Description:
Diffuses the photo by replacing each pixel with a randomly selected neighboring pixel.
Dilate
fx.Dilate
Description:
Dilates the photo
Emboss
fx.emboss
Description:
Embosses the photo. Embossing gives the photo a raised metallic-like look.
Equalize
fx.equalize
Description:
Performs contrast equalization on the photo.
Erode
fx.erode
Description:
Erodes the photo using a 3x3 minimum filter.
Flip
fx.flip
Description:
Flips the photo.
Median
fx.median
Description:
Filters the photo using a 3x3 median filter. Median filtering attempts to eliminate noise in an photo.
Mirror
fx.mirror
Description:
Creates a mirror image of the photo.
Negate
fx.negate
Description:
Creates a color negative of the photo.
Outline
fx.outline
Example(s):
/fx.outline
Description:
Performs an outline effect on the current photo. Outlining has the effect of creating enhanced edges.
Advanced FX Effects
Adjust HSL
fx.adjusthsl {hue}, {saturation}, {luminance}
(Hue): -100 to 100
(Saturation): -100 to 100
(Luminance): -100 to 100
Example(s):
/fx.adjusthsl 10, 0, 100
Description:
Adjusts the hue, saturation, and luminance components of the photo.
Adjust RGB
fx.adjustrgb (type}, {red}, {green}, {blue}
(type): 0 = As Percent, 1 = as Units
Type = 1 (Red): 0 to 255, Type = 0 (Red): -100 to 100
Type = 1 (Green): 0 to 255, Type = 0 (Green): -100 to 100
Type = 1 (Blue): 0 to 255, Type = 0 (Blue): -100 to 100
Example(s):
/fx.adjustrgb 1, 155, 155, 20 'Colors as RGB Units
/fx.adjustrgb 0, 50, 50, 0 'Colors as RGB Percentage
Description:
Adjusts the red, green, and blue components of the photo.
Auto Crop
fx.autocrop {percent}
(percent): 0 to 100
Example(s):
/fx.autocrop 80
Description:
Automatically crops the white space from a document image.
Blend
fx.blend {blendpercent}
(BlendPercent) 0 to 100
Example(s):
/fx.blend 50
Description:
Blends each pixel in the photo with its neighboring pixels.
Brightness
fx.brightness {bright}
(bright) -100 to 100
Example(s):
/fx.bright 50
Description:
Brightens the photo. Higher intensities result in brighter photos. Negative intensities darken photos.
Buttonize
fx.buttonize {style}, {width}, {intensity}
(style):
0 Inset
1 Raised
(width): 0 to 32768
(intensity): 0 to 100
Example(s):
/fx.buttonize 0, 20, 50
Description:
Transforms the current DIB to make it look like a 3D button by adding translucent bevels to the edges of the image.
Color-depth
fx.ColorDepth {BitsPixel}, {Palette}, {Dither}
(BitsPixel): 1, 4, 8, 24 (Bits per Pixel)
(Palette):
0 Optimized
1 Fixed
2 Gray Scale
3 Palette File
4 User Defined
5 Optimized with Dither
6 Gray Scale with Dither
7 Palette File with Dither
(Dither):
0 None
1 Floyd-Steinberg
2 Ordered
3 Pegasus
Example(s):
/fx.ColorDepth 8, 5, 0
Description:
Changes the color depth of the photo.
Contrast
fx.contrast {contrast}
(Contrast): -100 to 100
Example(s):
/fx.contrast 50
Description:
Adjusts the contrast of the photo. Higher intensities result in images with higher contrast.
Crop
fx.crop {x}, {y}, {width}, {height}
(x): Starting 'x' point (must be less then image width)
(y): Starting 'y' point (must be less then image height)
(width): the with of the crop image. (must be less then the image width - x)
(height): The height of the crop image. (Must be less then the image height - y)
Example(s):
/fx.crop 10, 10, 780, 580
Description:
Crops the photo to the specified size. If the area defined by the crop parameters does not fall within the boundaries of the image, the image is not cropped.
Draw Text
fx.drawtext {x}, {y}, {text}, {color}
(x): Starting 'x' point (must be less then image width)
(y): Starting 'y' point (must be less then image height)
(text): "The text you want to show."
(color): The color of the text. RGB(r,g,b)
Example(s):
/fx.font.name = "Verdana" /fx.font.size = 14 /fx.drawtext 40, 50, "hello world", RGB(0,0,0)
Description:
Draws text on a photo. The font and size of the text depends on the settings of the Font property.
Gamma
fx.Gamma {gamma}
(gamma): 0.01 to 10.0
Example(s):
/fx.gamma 1.15
Description:
Increases or decreases the intensity of the image using the gamma function by raising or lowering the brightness midpoint. Gamma values greater than 1.0 produce a brighter image. Gamma values less than 1.0 produce a darker image.
Matrix
fx.Matrix {intensity}, {divisor}, {m1},{m2},{m3},{m4},{m5},{m6},{m7},{m8},{m9}
(intensity): 0 to 255
(divisor): -999 to 999
(mX): -32767 to 32767
Example(s):
/fx.matrix 2, 1, -1, -1, -1, -1, 9, -1, -1, -1, -1
Description:
Applies a 3x3 convolution matrix filter to the photo.
Mosaic
fx.mosaic {blocksize}
(blocksize): 1 to 63
Example(s):
/fx.mosaic 20
Description:
Creates a mosaic of the photo. Mosaic gives the image a pixelated look. Larger block sizes result in more pixelated images.
Motion Blur
fx.MBlur {intensity}, {x}, {y}
(intensity): 1 to 25
(x): The horizontal direction. -10 to 10
(y): The vertical direction. -10 to 10
Example(s):
/fx.mblur 10, 3, 5
Description:
Creates a motion blur of the photo.
Perspective
fx.perspective {type}, {percent}
(type):
0 Top to Bottom
1 Bottom to Top
2 Left to Right
3 Right to Left
(percent): 0 to 100
Example(s):
/fx.perspective 0, 50
Description:
Performs a perspective effect on the photo by vertically or horizontally changing the aspect for each row or column of pixels from the percent specified to 100%.
PICResize
fx.picresize {width}, {height}
(Width): Number of Pixels Wide
(height): Number of Pixels Tall
Example(s):
/fx.picresize 800, 600
Description:
Resizes the photo using an algorithm which produces an extremely high quality image. PICResize produces a higher quality image than the Resample and Resize.
Pinch
fx.pinch {intensity}
(intensity): -100 to 100
Example(s):
/fx.pinch 50
Description:
Transforms the photo by making it look as if it were pinched in the center. Positive values make it look as if it were pinched in the center. Negative values make it look as if it were stretched from the center.
Posterize
fx.posterize {numcolors}
(NumColors): 2 to 8
Example(s):
/fx.posterize 3
Description:
Reduces the number of colors in the photo. This has the effect of creating posterization contours in the image. {NumColors) = Number of colors for each color channel. For example, a value of 3 indicates 3 levels of red, 3 levels of green, 3 levels of blue.
Replace Colors
fx.replacecolors {colorfrom}, {colorto}, {colorreplace}
(colorfrom): RGB(i,i,i)
(colorto): RGB(i,i,i)
(colorreplace): RGB(i,i,i)
Example(s):
/fx.replacecolors rgb(0,0,0), rgb(50, 30, 20), rgb(0,0,255)
Description:
Replaces a range of colors in the photo.
Resample
fx.resample {width}, {height}
(Width): Number of Pixels Wide
(height): Number of Pixels Tall
Example(s):
/fx.resample 800, 600
Description:
Resizes the photo. The pixels in the image are resampled using a bilinear interpolation algorithm which produces a better quality image than the Resize method, however, the Resample method is slower. PICResize is recommended for still higher-quality images.
Resize
fx.resize {width}, {Height}
(Width): Number of Pixels Wide
(height): Number of Pixels Tall
Example(s):
/fx.resize 800, 600
Description:
Resizes the photo. The pixels in the image are resampled using a nearest neighbor interpolation algorithm which produces a lower quality image than the Resample (better) and PICResize (best), however, Resize is faster.
Ripple
fx.ripple {frequency}, {intensity}, {direction}
{frequency}: 1 to 100
{intensity}: 1 to 100
{direction}:
0 Horizontal
1 Vertical
Example(s):
/fx.ripple 10, 50, 1
Description:
Produces a wave-like ripple effect on the photo.
Rotate
fx.rotate {angle}
(angle): -360 to 360
Example(s):
/fx.rotate 45
/fx.backcolor = vbblack /fx.rotate 20
Description:
Rotates the photo.
Sharpen
fx.sharpen {intensity}
(intensity): 1 to 10
Example(s):
/fx.sharpen 5
Description:
Sharpens the photo by applying a high pass convolution filter.
Soften
fx.soften {intensity}
(intensity): 1 to 10
Example(s):
/fx.soften 5
Description:
Softens the photo by applying a low pass convolution filter.
Solarize
fx.solarize {threshold}
(Threshold): 0 to 255
Example(s):
/fx.solarize 20
Description:
Solarizes the colors in the photo by negating the colors beyond the threshold value.
Swirl
fx.swirl {degree}
(degree): -360 to 360
Example(s):
/fx.swirl -30
Description:
Transforms the photo by making it look as if it were swirled from the center. Positive values transform the photo by making it look as if it were swirled clockwise. Negative values transform the photo by making it look as if it were swirled counterclockwise.
Progress Functions
Hide Progress Window
progress.hide
Example(s):
/progress.hide
Show Progress Window
progress.show
Example(s):
/progress.show
General FX Properties
Filename
fx.filename {filepath}
(filepath): The full path to the file in quotes.
Example(s):
/fx.filename = "c:\my images\dog photo.jpg"
/fx.savefilename = fx.filename 'sets the save file to the same filename
/fx.msgdisplay GetFileName(fx.filename) 'popup message with just the file name.
Description:
Gets or Sets the current file that you are working with. This is automaically when using the command line /files:array or when using the script GUI 'select files'.
SaveFileType
fx.SavefileType = {type}
(type):
0 (Default) Use the 3 character file extension in the SaveFileName property to specify the file type.
1 TGA
2 PCX
3 GIF
4 TIF
5 BMP
6 WPG
8 JPG
10 PNG
21 PPM
22 PGM
23 PBM
24 DCX
25 ePIC
29 LJP
Example(s):
/fx.savefiletype = 5 'BMP
/fx.savefiletype = 25 'ePIC 'Set the type /fx.savefilename = NoExtension(fx.filename) & ".pic" 'Set the file to reflect the .pic extension /fx.savefile 'Save the file to disk.
Description:
Specifies the type of file to save when running the fx.SaveFile command. Note: make sure fx.savefilename is set to the correct extension if type is set to anything but default.
Undocumented FX Functions
Area
fx.Area
Description:
Undocumented...
BackColor
fx.BackColor = {color}
Description:
Undocumented...
CaptureWindow
fx.CaptureWindow {hWnd}
Description:
Undocumented...
Colorize {color}
fx.Colorize
Description:
Undocumented... e.g. fx.colorize RGB(FF,00,00)
ColorSeparation {type}
fx.ColorSeparation
Description:
Undocumented...
Copy
fx.Copy
Description:
Undocumented...
CropBorder
fx.CropBorder
Description:
Undocumented...
DrawArc
fx.DrawArc
Description:
Undocumented...
DrawCircle
fx.DrawCircle
Description:
Undocumented...
DrawCurve
fx.DrawCurve
Description:
Undocumented...
DrawFillColor
fx.DrawFillColor
Description:
Undocumented...
DrawFillStyle
fx.DrawFillStyle
Description:
Undocumented...
DrawLine
fx.DrawLine
Description:
Undocumented...
DrawMode
fx.DrawMode
Description:
Undocumented...
DrawPie
fx.DrawPie
Description:
Undocumented...
DrawPolygon
fx.DrawPolygon
Description:
Undocumented...
DrawRoundRect
fx.DrawRoundRect
Description:
Undocumented...
DrawStyle
fx.DrawStyle
Description:
Undocumented...
DrawWidth
fx.DrawWidth
Description:
Undocumented...
Font
fx.Font
Description:
Undocumented...
hWnd
fx.hWnd
Description:
Undocumented...
IBPP
fx.IBPP
Description:
Undocumented...
IFileSize
fx.IFileSize
Description:
Undocumented...
IFormat
fx.IFormat
Description:
Undocumented...
IHeight
fx.IHeight
Description:
Undocumented...
ImagError
fx.ImagError
Description:
Undocumented...
ImagHeight
fx.ImagHeight
Description:
Undocumented...
ImagWidth
fx.ImagWidth
Description:
Undocumented...
IPAdjustBlue
fx.IPAdjustBlue
Description:
Undocumented...
IPAdjustGreen
fx.IPAdjustGreen
Description:
Undocumented...
IPAdjustHue
fx.IPAdjustHue
Description:
Undocumented...
IPAdjustLum
fx.IPAdjustLum
Description:
Undocumented...
IPAdjustRed
fx.IPAdjustRed
Description:
Undocumented...
IPAdjustRed
fx.IPAdjustRed
Description:
Undocumented...
IPAdjustType
fx.IPAdjustType
Description:
Undocumented...
IPArea
fx.IPArea
Description:
Undocumented...
IPAreaHeight
fx.IPAreaHeight
Description:
Undocumented...
IPAreaWidth
fx.IPAreaWidth
Description:
Undocumented...
IPAreaX
fx.IPAreaX
Description:
Undocumented...
IPAreaY
fx.IPAreaY
Description:
Undocumented...
IPColorPlane
fx.IPColorPlane
Description:
Undocumented...
MsgDisplay
fx.MsgDisplay {text}
Description:
Undocumented...
NumPages
fx.NumPages
Description:
Undocumented...
PageNbr
fx.PageNbr
Description:
Undocumented...
Paste
fx.Paste
Description:
Undocumented...
PICPassword
fx.PICPassword
Description:
Undocumented...
Picture
fx.Picture
Description:
Undocumented...
PrinterhDC
fx.PrinterhDC
Description:
Undocumented...
PrinterHeight
fx.PrinterHeight
Description:
Undocumented...
PrinterLeft
fx.PrinterLeft
Description:
Undocumented...
PrinterTop
fx.PrinterTop
Description:
Undocumented...
PrinterWidth
fx.PrinterWidth
Description:
Undocumented...
ResizeAspect
fx.ResizeAspect {maxWidth}, {maxHeight}, {Strech}
Description:
Undocumented...
ResizePercent
fx.ResizePercent {percent}
Description:
Undocumented...
RGBColorCount
fx.RGBColorCount
Description:
Undocumented...
SaveFile
fx.SaveFile
Description:
Saves the modified File.
SaveFileName
fx.SaveFileName = {text}
Description:
The name to save the file as.
SaveFileNameAddPrefix
fx.savefilenameaddprefix {text}
Description:
Undocumented...
SaveFileNameExtension
fx.SaveFileNameExtension {extension_text}
Description:
Undocumented...
SaveGIFInterlaced
fx.SaveGIFInterlaced
Description:
Undocumented...
SaveGIFTColor
fx.SaveGIFTColor
Description:
Undocumented...
SaveGIFTransparent
fx.SaveGIFTransparent
Description:
Undocumented...
SaveGIFType
fx.SaveGIFType
Description:
Undocumented...
SaveJPGChromFactor
fx.SaveJPGChromFactor = {value}
Description:
Set the JPEG Compressin Quality.
SaveJPGGrayscale
fx.SaveJPGGrayscale
Description:
Undocumented...
SaveJPGLumFactor
fx.SaveJPGLumFactor = {value}
Description:
Set the JPEG Compressin Quality.
SaveJPGProgressive
fx.SaveJPGProgressive
Description:
Undocumented...
SaveJPGSubSampling
fx.SaveJPGSubSampling
Description:
Undocumented...
SaveLJPCompMethod
fx.SaveLJPCompMethod
Description:
Undocumented...
SaveLJPCompType
fx.SaveLJPCompType
Description:
Undocumented...
SaveLJPPrediction
fx.SaveLJPPrediction
Description:
Undocumented...
SaveMultiPage
fx.SaveMultiPage
Description:
Undocumented...
SavePBMType
fx.SavePBMType
Description:
Undocumented...
SavePGMType
fx.SavePGMType
Description:
Undocumented...
SavePNGInterlaced
fx.SavePNGInterlaced
Description:
Undocumented...
SavePPMType
fx.SavePPMType
Description:
Undocumented...
SaveTIFCompression
fx.SaveTIFCompression
Description:
Undocumented...
Tile
fx.Tile
Description:
Undocumented...
Undo
fx.Undo
Description:
Undocumented...
UniqueColors
fx.UniqueColors
Description:
(Undocumented...) Returns the number of Unique Colors in the Image.
<< You have reached the end of this tutorial >>
|
