CommandService
The LEAD CommandService is a helper service used to generate LEAD image processing Command Datasets. The generated datasets are passed to the ProcessImage method of the LEADImage Service.
For a list of all members of this type, see CommandService Members below.
LEAD
WebServices
ImagingService
CommandService
Format of CommandService DataSet
The CommandService methods generate an XML dataset. Each command has a row in the CommandTable and zero or more rows in the ParametersTable for its parameters. The CommandService dataset defines a one-to-many relationship between the commands and their parameters.
DataSet Name
CommandsDataSet
Number of Tables
2
Table 0
Name: CommandTable
Fields:
Field Name
Type
Indexed
Description
CommandId
int
Yes (Primary key)
Primary key.
CommandName
string(50)
No
Command name.
CommandOrder
int
No
Order of command. Commands will be executed depending on order, from lowest to highest.
Table 1
Name: ParameterTable
Fields:
Field Name
Type
Indexed
Description
CommandId
int
No
Foreign key for CommandTable.CommandId
ParameterName
string(256)
No
Parameter name.
ParameterValue
string(256)
No
Parameter value.
Relationships
Name: CommandParameters
Fields:
Parent
Child
CommandTable.CommandId
ParameterTable.CommandId
Method Name Description AddColorHsvRangeRegion Generates a command dataset to add a region to the image by using the HSV color model to set a region based on a color range. AddColorRegion Generates a command dataset to add a region that consists of all pixels of a specified color. AddColorRGBRangeRegion Generates a command dataset to add a region to the image object using the RGB color model to set a region based on a color range. AddEllipseRegion Generates a command dataset to add an elliptical region to an image. AddMagicWandRegion Generates a command dataset to add a region to the Bitmap object based on the color found at point x, y. AddNoise Generates a command dataset to add random pixels to an image. AddRectangleRegion Generates a command dataset to add a rectangular region to the Bitmap object. AddRoundRectangleRegion Generates a command dataset to add a rounded rectangular region to the Bitmap object. AntiAlias Generates a command dataset to apply an Anti-Aliasing filter to the bitmap. AutoTrim Generates a command dataset to remove blank space around the edges of an image. Average Generates a command dataset to change the color of each pixel in an image to the Average color of pixels in its neighborhood. BorderRemove Generates a command dataset to remove borders from 1-bit images. ColorRes Generates a command dataset to converts the bitmap from any bits-per-pixel to any bits-per-pixel. Contour Generates a command dataset to perform a Contour segment filter on the bitmap. Contrast Generates a command dataset to increases or decreases the Contrast of the bitmap. CreateNew Generates an empty command dataset. Deskew Generates a command dataset to rotate the specified image to straighten it. Despeckle Generates a command dataset to remove speckles from the bitmap. Dilation Generates a command dataset to impose a Dilation filter on an image. DotRemove Generates a command dataset to find and removes dots, specks, and blobs of various sizes in 1-bit documents. EdgeDetector Generates a command dataset to apply the specified edge filter to the bitmap. Emboss Generates a command dataset to apply an Emboss effect to an image. Erosion Generates a command dataset to apply an Erosion filter to an image. Fill Generates a command dataset to Fill the image with the specified color. Flip Generates a command dataset to flip the image from top to bottom, or from right to left. GammaCorrect Generates a command dataset to adjust the intensity of colors in an image by changing the gamma constant that is used to map the intensity values. Gaussian Generates a command dataset to Smooth or blur images by applying a Gaussian filter to the image. Gradient Generates a command dataset to impose a Gradient filter on an image. GrayScale Generates a command dataset to convert a 1-, 4-, 8-, 16-, 24-, or 32-bit bitmap to an 8, 12, or 16-bit grayscale bitmap. GrayScaleFactor Generates a command dataset to convert a 1-, 4-, 8-, 16-, 24-, or 32-bit bitmap to an 8, 12, or 16-bit grayscale bitmap. HalfTone Generates a command dataset to convert a 1-, 4-, 8-, 16-, 24-, 32- or 64-bit bitmap to a halftoned bitmap, with a specified pattern rotation. HistoContrast Generates a command dataset to Increase or decrease the Contrast of an image, using a histogram to determine the median brightness. HistoEqualize Generates a command dataset to generate the number of pixels per gray level in an image. HolePunchRemove Generates a command dataset to detect and removes hole punches, common in scanned documents. Hue Generates a command dataset to change the hue of colors in the bitmap by rotating the color wheel. Intensity Generates a command dataset to change the intensity (brightness) of the bitmap. IntensityDetect Generates a command dataset to filter the specified image to detect colors in a specified intensity range. Invert Generates a command dataset to invert the colors in an image. InvertedText Generates a command dataset to find and inverts areas of inverted text in a 1-bit black and white image. Laplacian Generates a command dataset to impose a Laplacian filter on an image. LineRemove Generates a command dataset to remove horizontal and vertical lines in a 1-bit black and white image. LineSeg Generates a command dataset to impose a Line Segment filter on an image. Max Generates a command dataset to erode dark objects in an image. Median Generates a command dataset to change the color of each pixel in an image to the median color of pixels in its neighborhood. Min Generates a command dataset to dilate dark objects in an image. Mosaic Generates a command dataset to impose a mosaic effect on an image. MotionBlur Generates a command dataset to apply a filter, which creates the illusion of movement in an image. Oilify Generates a command dataset to apply an oil-painting effect to an image. Posterize Generates a command dataset to impose a poster effect on an image. Prewitt Generates a command dataset to impose a Prewitt filter on an image. Resize Generates a command dataset to resize an image. Rotate Generates a command dataset to rotate an image by the number of degrees specified. Saturation Generates a command dataset to increase or decrease the saturation of colors in the bitmap. Sharpen Generates a command dataset to increase or decrease the sharpness of an image. Shear Generates a command dataset to move the corner of an image in the fashion of a parallelogram. ShiftDiff Generates a command dataset to impose a Shift and Difference filter on an image. Smooth Generates a command dataset to smooth the bumps and Fills in the nicks of a 1-bit black and white image. Sobel Generates a command dataset to impose a Sobel filter on an image. Solarize Generates a command dataset to apply an effect that mimics the accidental exposure of photographic film to light. StretchIntensity Generates a command dataset to increase the Contrast in an image by centering, maximizing, and proportioning the range of intensity values. SwapColors Generates a command dataset to swap the specified color channels. Trim Generates a command dataset to trim the bitmap, resulting in a bitmap that is the size of the specified rectangle. UnsharpMask Generates a command dataset to create a blurred copy of the original image, where the amount of blurring depends on the specified radius.