RequestImageAsBuffer
The RequestImageAsBuffer ISCommand is used to create raster datasets from an image service definition or published image service, with different compression methods, for a particular area of interest. This ISCommand also allows you to view the image buffer sent by the server with different compression methods. Currently, the client does not support decompression. You can override various parameters, such as the area of interest, compressed transmission method, and compression quality. You can specify the location to save the generated image as a .buffer file.
The default command line is:
ISCommand RequestImageAsBuffer --ImageService=<Fully qualified image service name> --FileName=<OutputFileName> --XMin=<XMin> --YMin=<YMin> --XMax=<XMax> --YMax=<YMax> --NCols=<number of columns> --NRows=<number of rows> --CompressedTransmission=[None|JPEG|LZ77] --CompressionQuality=<percentage>
The table below defines the variables that are required to use this script. Most variables are defined within the script. You can either make an edit to the script or enter the variable at the command line as shown below.
Variable |
Description/Options |
Default |
Required |
||||||||
ImageService |
Path and name of the fully qualified image service. Examples include:
|
User specified |
Yes |
||||||||
FileName |
The output file name and path. |
Default |
Yes |
||||||||
XMin |
Leftmost X coordinate of the set extent. |
User specified |
Yes |
||||||||
YMin |
Bottommost Y coordinate of the set extent. |
User specified |
Yes |
||||||||
XMax |
Rightmost X coordinate of the set extent. |
User specified |
Yes |
||||||||
YMax |
Topmost Y coordinate of the set extent. |
User specified |
Yes |
||||||||
NCols |
Number of columns of pixels in the image. |
1000 |
Yes |
||||||||
NRows |
Number of rows of pixels in the image. |
1000 |
Yes |
||||||||
CompressedTransmission |
Method of compressed Transmission to be used to create external overviews.
|
None |
No |
||||||||
CompressionQuality |
Quality of the compression.
|
100 |
No |
Example:
ISCommand RequestImageAsBuffer --ImageService=ImageService://ServerHost:3982/LandsatWorld --FileName=DefaultImage.Buffer --XMin=0 --YMin=-7500 --XMax=11500 --YMax=0 --NCols=1000 --NRows=1000 --CompressedTransmission=None --CompressionQuality=<100>