Changes between Version 3 and Version 4 of ConfigOptions
- Timestamp:
- Feb 28, 2010, 10:20:30 AM (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
ConfigOptions
v3 v4 38 38 }}} 39 39 40 For boolean options, the values YES, TRUE or ON can be used to turn the option on; NO, FALSE or OFF to turn it off. 41 40 42 == What Configuration Options Exist? == 41 43 … … 64 66 === GDAL_DATA === 65 67 68 Path to directory containing various GDAL data files (EPSG CSV files, S-57 definition files, DXF header and footer files, ...). 69 70 This option is read by the GDAL and OGR driver registration functions. It is used to expand EPSG codes into their description in the OSR model (WKT based). 71 72 On some builds (Unix), the value can be hard-coded at compilation time to point to the path after installation (/usr/share/gdal/data for example). On Windows platform, this option must be generally declared. 73 66 74 === GEOTIFF_CSV === 67 75 … … 71 79 === GDAL_DISABLE_READDIR_ON_OPEN === 72 80 81 Defaults to FALSE. 82 83 By default (GDAL_DISABLE_READDIR_ON_OPEN=FALSE), GDAL establishes a list of all the files in the directory of the file passed to GDALOpen(). This can result in speed-ups in some use cases, but also to major slow downs when the directory contains thousands of other files. When set to TRUE, GDAL will not try to establish the list of files. 84 73 85 === GDAL_CACHEMAX === 74 86 … … 77 89 === GDAL_SKIP === 78 90 91 Used by GDALDriverManager::AutoSkipDrivers() 92 93 This option can be used to unregister one or several GDAL drivers. This can be useful when a driver tries to open a dataset that it should not recognize, or when several drivers are built-in that can open the same datasets (for example JP2MrSID, JP2ECW, JPEG2000 and JP2KAK for JPEG2000 datasets). The value of this option must be a space delimited list of the short name of the GDAL drivers to unregister. 94 95 This option must be set before calling GDALAllRegister(), or an explicit call to GDALDriverManager::AutoSkipDrivers() will be required. 96 79 97 === GDAL_DRIVER_PATH === 98 99 Used by GDALDriverManager::AutoLoadDrivers() 100 101 This function will automatically load drivers from shared libraries. It searches the "driver path" for .so (or .dll) files that start with the prefix "gdal_X.so". It then tries to load them and then tries to call a function within them called GDALRegister_X() where the 'X' is the same as the remainder of the shared library basename ('X' is case sensitive), or failing that to call GDALRegisterMe(). 102 103 There are a few rules for the driver path. If the GDAL_DRIVER_PATH environment variable it set, it is taken to be a list of directories to search separated by colons on UNIX, or semi-colons on Windows. Otherwise the /usr/local/lib/gdalplugins directory, and (if known) the lib/gdalplugins subdirectory of the gdal home directory are searched on UNIX and $(BINDIR)\gdalplugins on Windows. 104 105 This option must be set before calling GDALAllRegister(), or an explicit call to GDALDriverManager::AutoLoadDrivers() will be required. 80 106 81 107 === GDAL_FORCE_CACHING === 82 108 109 Defaults to NO. 110 111 When set to YES, the GDALDataset::RasterIO() and GDALRasterBand::RasterIO() will use cached IO (access block by block through GDALRasterBand::IReadBlock() API) instead of a potential driver specific implementation of IRasterIO(). This will only have an effect on drivers that specialize IRasterIO() at the dataset or raster band level, for example JP2KAK, NITF, HFA, WCS, ECW, MrSID, JPEG, ... 112 83 113 === GDAL_VALIDATE_CREATION_OPTIONS === 114 115 Defaults to YES. 116 117 When using GDALDriver::Create() or GDALDriver::CreateCopy() (for example when using the -co option of gdal_translate or gdalwarp utilies) , GDAL checks by default that the passed creation options match the syntax of the allowed options declared by the driver. If they don't match the syntax, a warning will be emitted. There should be hardly any reason to set this option to FALSE, as it's either a sign of a user typo, or an error in the declared options of the driver. The latter should be worth a bug report. 84 118 85 119 === GDAL_IGNORE_AXIS_ORIENTATION === … … 99 133 === PROJSO === 100 134 101 The name of the PROJ.4 DLL or shared library to try and load at runtime. 135 Used by ogr/ogrct.cpp 136 137 The name of the PROJ.4 DLL or shared library to try and load at runtime. For example "/home/bob/libproj.so". If not set, OGR will try to load : 138 * libproj.so on Linux/Unix platforms 139 * proj.dll on Windows platforms 140 * libproj.dylib on MacOSX platforms 141 * libproj-0.dll on MinGW32 builds 142 * cygproj-0.dll on Cygwin builds 102 143 103 144 === CENTER_LONG === … … 105 146 === CHECK_WITH_INVERT_PROJ === 106 147 148 Used by ogr/ogrct.cpp and apps/gdalwarp.cpp. Added in GDAL/OGR 1.7.0 149 150 This option can be used to control the behaviour of gdalwarp when warping global datasets or when transforming from/to polar projections, which causes coordinates discontinuities. See http://trac.osgeo.org/gdal/ticket/2305. 151 152 The background is that proj.4 does not guarantee that converting from src_srs to dst_srs and then from dst_srs to src_srs will yield to the initial coordinates. This can cause to errors in the computation of the target bounding box of gdalwarp, or to visual artifacts. 153 154 If CHECK_WITH_INVERT_PROJ option is not set, gdalwarp will check that the the computed coordinates of the edges of the target image are in the validity area of the target projection. If they are not, it will retry computing them by setting CHECK_WITH_INVERT_PROJ=TRUE that forces ogrct.cpp to check the consistency of each requested projection result with the invert projection. 155 156 If set to NO, gdalwarp will behave like GDAL/OGR < 1.7.0 157 107 158 === THRESHOLD === 108 159 160 Used by ogr/ogrct.cpp. Added in GDAL/OGR 1.7.0 161 162 Used in combination with CHECK_WITH_INVERT_PROJ=TRUE. Define the acceptable threshold used to check if the roundtrip from src_srs to dst_srs and from dst_srs to srs_srs yield to the initial coordinates. The value must be expressed in the units of the source SRS (typically degrees for a geographic SRS, meters for a projected SRS) 163 109 164 === OGR_DEBUG_ORGANIZE_POLYGONS === 165 166 Used by OGRGeometryFactory::organizePolygons(). Defaults to NO. 167 168 If set to YES, ogranizePolygons(), which is in particular used when reading Shapefiles with Polygon geometry, will use GEOS to check the topological relationship of the subparts of multipolygons. This will slow down processing. There should be no reason to set this option to YES, except for debugging purposes. 110 169 111 170 === OGR_ARC_STEPSIZE === … … 113 172 === OGR_FORCE_ASCII === 114 173 174 Used by OGRGetXML_UTF8_EscapedString() function and by GPX, KML, GeoRSS and GML drivers. Defaults to YES 115 175 176 Those XML based drivers should write UTF8 content. If they are provided with non UTF8 content, they will replace each non-ASCII character by '?' when OGR_FORCE_ASCII=YES. 177 178 Set to NO to preserve the content, but beware that the resulting XML file will not be valid and will require manual edition of the encoding in the XML header.
