forked from Esri/OptimizeRasters
-
Notifications
You must be signed in to change notification settings - Fork 0
/
OptimizeRasters.OptimizeRasters.pyt.xml
1 lines (1 loc) · 19 KB
/
OptimizeRasters.OptimizeRasters.pyt.xml
1
<metadata xml:lang="en"><Esri><CreaDate>20160120</CreaDate><CreaTime>14175700</CreaTime><ArcGISFormat>1.0</ArcGISFormat><ArcGISstyle>ISO 19139 Metadata Implementation Specification</ArcGISstyle><SyncOnce>TRUE</SyncOnce><ModDate>20170925</ModDate><ModTime>16204100</ModTime><scaleRange><minScale>150000000</minScale><maxScale>5000</maxScale></scaleRange><ArcGISProfile>ItemDescription</ArcGISProfile></Esri><tool name="OptimizeRasters" displayname="OptimizeRasters" toolboxalias="" xmlns=""><arcToolboxHelpPath>c:\program files (x86)\arcgis\desktop10.6\Help\gp</arcToolboxHelpPath><parameters><param name="optTemplates" displayname="Configuration Files" type="Required" direction="Input" datatype="String" expression="Airbus_SatelliteProduct_to_MRF_LERC | CopyFilesOnly | CreateRasterProxy | DG_SatelliteProduct_to_MRF_LERC | Imagery_to_MRF_JPEG | Imagery_to_MRF_LERC | Imagery_to_TIF_JPEG | Imagery_to_TIF_LZW | Landsat8_RasterProxy | Landsat_to_MRF_LERC | Overviews_to_MRF_JPEG | Overviews_to_MRF_LERC | Sentinel2_to_MRF"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN><SPAN>Select an appropriate template file. </SPAN></SPAN></P><P><SPAN><SPAN>The template files houses the parameters used for optimizing rasters. The template names provide a basic understanding of the type of optimization that will take place. </SPAN></SPAN></P><P><SPAN><SPAN>Advanced users can view the template files from Templates folder in a simple text/xml editor. </SPAN></SPAN></P><P /><P><SPAN STYLE="font-weight:bold;"><SPAN>Airbus_SatelliteProduct_to_MRF_LERC</SPAN></SPAN><SPAN><SPAN>: This Template should be used to optimize and convert the Products from AirBus to MRF format. It uses LERC compression to compress the data. The output MRf files will be built with 2 levels of pyramids. The output file extensions are preserved so that they work with the ArcGIS Raster Type. The folder structure and required metadata files are also copied.</SPAN></SPAN></P><P><SPAN><SPAN /></SPAN></P><P><SPAN STYLE="font-weight:bold;"><SPAN>RasterProxy</SPAN></SPAN><SPAN>: This template encompasses two now depricated modes (CachingMRF &amp; CloneMRF). This template should be used when you want to reference any source imagery (MRF or Non MRF format) stored in cloud or tiered file storage. The output directory will contain all the same raster’s as the source, but the size will be considerably smaller as the original raster files will be replaced by small raster proxy metadata files. The local raster proxy files will then be used to cache the remote raster data as it is being accessed. The cache is typically stored in the LERC compressed format, which has faster access speed to size ratio. </SPAN></P><P><SPAN /></P><P><SPAN STYLE="font-weight:bold;"><SPAN>DG_SatelliteProduct_to_MRF_LERC</SPAN></SPAN><SPAN><SPAN>: This Template should be used to optimize and convert the products from Digital Globe delivered in GeoTiff to MRF format. To optimize the access speed pyramids are built on the TIL file if it references more than one GeoTiff file. The output Data uses LERC Compression. The output file extensions are preserved so that they work with the ArcGIS Raster Type. The folder structure and required metadata files are only copied.</SPAN></SPAN></P><P /><P><SPAN STYLE="font-weight:bold;"><SPAN>Imagery_to_MRF_JPEG</SPAN></SPAN><SPAN><SPAN>: This template has to be used when you want to optimize and convert your imagery ( TIF) to MRF format with JPEG compression, its recommended to use when input data is 3 band 8 bit unsigned data. JPEG quality for this is set as 95. </SPAN></SPAN></P><P /><P><SPAN STYLE="font-weight:bold;"><SPAN>Imagery_to_MRF_LERC</SPAN></SPAN><SPAN><SPAN>: This template has to be used when you want to optimize and convert your imagery ( TIF) to MRF format with LERC compression. LERC is especially valuable for higher bit depth data such as newer satellite imagery and elevation models ( 12 bit, 16 bit etc). </SPAN></SPAN></P><P /><P><SPAN STYLE="font-weight:bold;"><SPAN>Imagery_to_TIF_JPEG</SPAN></SPAN><SPAN><SPAN>: This template has to be used when you want to optimize your imagery ( TIF) to TIF format with JPEG compression, The template sets appropriate pyramid level and block size which will make the reading of the tif files faster.</SPAN></SPAN></P><P /><P><SPAN STYLE="font-weight:bold;"><SPAN>Imagery_to_TIF_LZW</SPAN></SPAN><SPAN><SPAN>: This template has to be used when you want to optimize your imagery ( TIF) to TIF format with LZW compression ( Lossless), The template sets appropriate pyramid level and block size which will make the reading of the tif files faster.</SPAN></SPAN></P><P /><P><SPAN STYLE="font-weight:bold;"><SPAN>Landsat_to_MRF_LERC</SPAN></SPAN><SPAN><SPAN>: This Template has be used to optimize and convert the Landsat data delivered in GeoTiff to MRF format with LERC Compression The output file extensions are preserved so that they work with the ArcGIS Raster Type. The folder structure and required metadata files are only copied.</SPAN></SPAN></P><P /><P><SPAN STYLE="font-weight:bold;"><SPAN>Overviews_to_MRF_LERC</SPAN></SPAN><SPAN><SPAN>: Use This template to convert the Overview Generated of Mosaic dataset into MRF format with Lerc compression. Pyramids are not built in this. As the Overviews don’t need it. </SPAN></SPAN></P><P /><P><SPAN STYLE="font-weight:bold;"><SPAN>Sentinel2_to_MRF</SPAN></SPAN><SPAN><SPAN>: This template has to be used to optimize and convert the Landsat data delivered in JP2000 to MRF format with LERC Compression The output file extensions are preserved so that they work with the ArcGIS Raster Type. The folder structure and required metadata files are only copied.</SPAN></SPAN></P><P STYLE="margin:0 0 0 0;"><SPAN /></P></DIV></DIV></DIV></dialogReference></param><param name="inType" displayname="Input Source" type="Required" direction="Input" datatype="String" expression="Local | Amazon S3 | Microsoft Azure | Google Cloud"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>The input data source type defines where the data is coming from. It could be either a local hard disk or a cloud based storage solution. </SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="inprofiles" displayname="Input Profile" type="Required" direction="Input" datatype="String" expression="inprofiles"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Select a profile to use as credentials for the selected cloud storage type. </SPAN></P><P><SPAN>This list is empty if no profiles are pre-defined using the Profile Editor. Use Profile Editor to define a profile beore continuing. Refer to help within Profile Editor for more info. </SPAN></P><P><SPAN>This item is disabled if Input type is Local. </SPAN></P><P><SPAN /></P></DIV></DIV></DIV></dialogReference></param><param name="inBucket" displayname="Input Bucket/Container" type="Required" direction="Input" datatype="String" expression="inBucket"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>A bucket or container is the unique storage location for your files. Enter the Bucket/Container name here,</SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="inPath" displayname="Input Path" type="Required" direction="Input" datatype="Folder or String" expression="inPath"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>The Input path can either be a local folder or a cloud storage folder name. </SPAN></P><P><SPAN>For local storage you can use the folder browse button to pick a location. </SPAN></P><P><SPAN>For Cloud storage solutions Type the location here. </SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="intempFolder" displayname="Input Temporary Folder" type="Optional" direction="Input" datatype="Folder" expression="{intempFolder}"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>The temporary input location is used to process files while downloading from cloud storage before it is written to the output location.</SPAN></P><P><SPAN>The temporary location while optional, can be useful if the space is restricted in the output location. </SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="outType" displayname=" Output Destination" type="Required" direction="Input" datatype="String" expression="Local | Amazon S3 | Microsoft Azure | Google Cloud"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>The output data source type defines where the data is written to . It could be either a local hard disk or a cloud based storage solution. For the moment Amzon S3 storage is supported. </SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="outprofiles" displayname="Output Profile to Use" type="Required" direction="Input" datatype="String" expression="outprofiles"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Select a profile to use as credentials for the selected cloud storage type. </SPAN></P><P><SPAN>This list is empty if no profiles are pre-defined using the Profile Editor. Use Profile Editor to define a profile beore continuing. Refer to help within Profile Editor for more info. </SPAN></P><P><SPAN>This item is disabled if Input type is Local. </SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="outBucket" displayname="Output Bucket/Container" type="Required" direction="Input" datatype="String" expression="outBucket"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>A bucket or container is the unique storage location for your files. Enter the Bucket/Container name here,</SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="outPath" displayname="Output Path" type="Required" direction="Input" datatype="Folder or String" expression="outPath"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>The output path can either be a local folder or a cloud storage folder name. </SPAN></P><P><SPAN>For local storage you can use the folder browse button to pick a location. </SPAN></P><P><SPAN>For Cloud storage solutions Type the location here. </SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="outtempFolder" displayname="Output Temporary Folder" type="Optional" direction="Input" datatype="Folder" expression="{outtempFolder}"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>The temporary output location is used to process files before uploading the final output to the specified cloud storage location. </SPAN></P><P><SPAN>If a cloud storage is slected as an output type, this item must be specified. A warning is displayed if left blank. </SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="rasterProxyFolder" displayname="Raster Proxy Output Folder" type="Optional" direction="Input" datatype="Folder" expression="{rasterProxyFolder}"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P STYLE="margin:0 0 0 0;"><SPAN>Specify a location to create the Raster Proxy files. Raster Proxy files are local file pointers to the converted file or the original source file that is stored either on the cloud or a local network. This option is disabled when the mode selected is RasterProxy. </SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="cacheMRFFolder" displayname="Cache Folder" type="Optional" direction="Input" datatype="Folder" expression="{cacheMRFFolder}"><dialogReference><DIV STYLE="text-align:Left;"><DIV><P><SPAN>The location where the cache files should be created.If left blank the default location is used. If there are any space constraints at the default location change this path to a different location where there is sufficient space to create cache. </SPAN></P></DIV></DIV></dialogReference></param><param name="editValue" displayname="Edit Configuration Values" type="Optional" direction="Input" datatype="Boolean" expression="{editValue}"><dialogReference><DIV STYLE="text-align:Left;"><DIV><P><SPAN>Enable editing of default values. The edited values are stored in a seperate file for later use. The stored file will show up in the confiuration files list, and can be used for future processes. </SPAN></P></DIV></DIV></dialogReference></param><param name="configVals" displayname="Configuration Values:" type="Optional" direction="Input" datatype="Value Table" expression="{Parameter {Value};Parameter {Value}...}"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-weight:bold;">For Advanced users only. </SPAN><SPAN /></P><P><SPAN>Edit the configuration values. Select a value in the values column to edit. Description and acceptable values for each parameter is given below. </SPAN></P><P><SPAN STYLE="font-weight:bold;">Mode </SPAN><SPAN>: Acceptable modes are mrf, mrf_jpeg, tif, tif_lzw, tif_jpeg, cachingmrf, clonemrf, splitmrf.</SPAN></P><P><SPAN STYLE="font-weight:bold;">RasterFormatFilter </SPAN><SPAN>: File extensions considered as (Rasters). These files will not be copied from the input path</SPAN></P><P><SPAN STYLE="font-weight:bold;">ExcludeFilter</SPAN><SPAN>: File extensions to ignore complety while copying files/data from the input path</SPAN></P><P><SPAN STYLE="font-weight:bold;">Compression </SPAN><SPAN>: Compression to use on output (Rasters). , Acceptable values are LERC, JPG, LZW</SPAN></P><P><SPAN STYLE="font-weight:bold;">Quality </SPAN><SPAN>: Compression quality to apply for JPEG compression. (Def: 85)</SPAN></P><P><SPAN STYLE="font-weight:bold;">LERCPrecision </SPAN><SPAN>: LERC precision to apply for LERC compression</SPAN></P><P><SPAN STYLE="font-weight:bold;">BuildPyramids </SPAN><SPAN>: Build pyramids Acceptable values are true, false. </SPAN></P><P><SPAN STYLE="font-weight:bold;">PyramidFactor </SPAN><SPAN>: Pyramid levels to create (Def: 2)</SPAN></P><P><SPAN STYLE="font-weight:bold;">PyramidSampling </SPAN><SPAN>: Pyramid sampling Acceptable values nearest, average, gauss, cubic, cubicspline, lanczos, average_mp, average_magphase, mode (Def: average)</SPAN></P><P><SPAN STYLE="font-weight:bold;">PyramidCompression </SPAN><SPAN>: Pyramid compression [jpeg, lzw, deflate] (Def: jpeg)</SPAN></P><P><SPAN STYLE="font-weight:bold;">NoDataValue </SPAN><SPAN>: No data value. If undefined/empy value -a_nodata will not be applied. (Def: undefined)</SPAN></P><P><SPAN STYLE="font-weight:bold;">BlockSize </SPAN><SPAN>: Output title size</SPAN></P><P><SPAN STYLE="font-weight:bold;">Scale </SPAN><SPAN>: This needs to specified when generating caching or clone MRF, the value should be based on the input raster pyramid factor default is 2</SPAN></P><P><SPAN STYLE="font-weight:bold;">KeepExtension </SPAN><SPAN>: ‘True’ to keep input raster extensions else outputs will be renamed to ‘mrf’. Acceptable values are true, false.</SPAN></P><P><SPAN STYLE="font-weight:bold;">Threads</SPAN><SPAN>: Simultaneous threads to use for parallel processing/instances of gdal translate / gdal addo etc. </SPAN></P><P><SPAN STYLE="font-weight:bold;">GDAL_Translate_UserParameters</SPAN><SPAN>: User GDAL_Translate values. These values will be passed on without any modification. Refer to </SPAN><A href="http://www.gdal.org/gdal_translate.html"><SPAN>http://www.gdal.org/gdal_translate.html </SPAN></A><SPAN>for more options. </SPAN></P><P><SPAN>Examples: (Refer to the link above for full explainations.) </SPAN></P><UL><LI><P><SPAN>-scale 200 255 0 255 (Rescale the input pixels values)</SPAN></P></LI><LI><P><SPAN>-outsize 10% 10% (Set the size of the output file)</SPAN></P></LI><LI><P><SPAN>-Scale 0 65536 1 25 (scale from 16 to 8bit and leave 0)</SPAN></P></LI><LI><P><SPAN>-b 1 -b 2 -b 3 (Extract 3 bands)</SPAN></P></LI><LI><P><SPAN>-co NBITS=8 (Output should be 8bits)</SPAN></P></LI><LI><P><SPAN>-ot Byte (Set output to byte) </SPAN></P></LI></UL></DIV></DIV></DIV></dialogReference></param></parameters><summary><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Optimizes the rasters using preset templates with optimal parametrers &amp; transfers rasters to and from cloud storage devices. </SPAN></P></DIV></DIV></DIV></summary></tool><dataIdInfo><idCitation><resTitle>OptimizeRasters</resTitle></idCitation><idAbs><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Optimizes the rasters using preset templates with optimal parametrers &amp; transfers rasters to and from cloud storage devices. </SPAN></P></DIV></DIV></DIV></idAbs></dataIdInfo><distInfo><distributor><distorFormat><formatName>ArcToolbox Tool</formatName></distorFormat></distributor></distInfo><mdHrLv><ScopeCd value="005"/></mdHrLv></metadata>