SNAP Configuration

Owned by Former user (Deleted)
Last updated: 2024-03-27 by Tom Block
4 min read

SNAP Desktop configuration

The way SNAP Desktop is configured is mainly driven by the NetBeans platform.

On Windows, the SNAP Desktop configuration is stored in the %HOMEPATH%/AppData/Roaming/SNAP directory. On other platform (Unixes), it is $HOME/.snap/system.

This directory may contain the following sub-directories:

  • etc - NetBeans Platform application configuration

  • config - SNAP Desktop user preferences and UI configurations

  • var/log - SNAP Desktop log files

  • var/cache - NetBeans Platform cache files

  • modules - SNAP extension module installations and updates (JARs)

SNAP Engine configuration

SNAP configuration is stored in Java properties files with the ending .properties. SNAP configuration parameter names usually start with snap. and can be set via Java system properties, the ${snap.home}/etc/snap.properties file, or the .snap/etc/snap.properties file in %HOMEPATH%/ (Windows) or $HOME/ (Unixes). The SNAP configuration is programmatically accessed using the org.esa.snap.runtime.Config class. 



Key

Value

Format

Default

Description

Perf

Scope

 

Key

Value

Format

Default

Description

Perf

Scope

 

snap.home

String

path

.

SNAP installation directory.

API: Config.instance().installDir(), SystemUtils.getApplicationHomeDir()



All modules

 

snap.userdir

String

path

${user.dir}/.snap

SNAP user directory which contains per-user application data (configuration, preferences, cache, GUI state, etc). See also How to move .snap directory to a different location.

API: Config.instance().userDir(), SystemUtils.getApplicationDataDir()



All modules

 

snap.log.name

String

any

org.esa.snap

API: Config.instance().logger(), SystemUtils.LOG



All modules

 

snap.log.level

String

OFF | ERROR | WARNING | INFO | DEBUG | ALL

INFO

API: Config.instance().logger(), SystemUtils.LOG



All modules

 

snap.pythonExecutable

String

path

python

Points to the CPython interpreter executable to be used with SNAP. Used from Java (by the org.esa.snap.python.PyBridge class) in order to configure the Python VM which will be used to execute SNAP Python extensions.



snap-python

 

snap.pythonModuleDir

String

path

${snap.userdir}/snap-python

Directory where the CPython VM (see snap.pythonExecutable key) finds the Python module snappy. Used to execute SNAP Python extensions that require to call back into the SNAP Java API.



snap-python

 

snap.forcePythonConfig

Boolean

true | false

false

If set to true, SNAP will always reconfigure the CPython (org.esa.snap.python.PyBridge class) before it is used.



snap-python

 

snap.pythonExtraPaths

String

path {: path} (Unixes)

path {; path} (Windows)



Extra directories to scan for CPython extensions. Currently only Operator plugins are possible, therefore sub-directories must contain a file META-INF/services/org.esa.snap.python.gpf.PyOperator to be recognised as plugins.



snap-python

 

snap.jai.defaultTileSize

Integer

size in pixel

512

The default size in width and hight direction of a JAI tile.

 

 

 

snap.jai.tileCacheSize

Integer

Size in Megabytes

1024

The amount of memory JAi can use for caching tiles

yes

All

 

snap.jai.prefetchTiles

Boolean

true | false

false

If it is known that tiles are soon needed they can be prefetched before actually acquired.

yes

All

 

snap.jythonExtraPaths

String

path {: path} (Unixes)

path {; path} (Windows)



Extra directories to scan for Python extensions. Sub-directories must contain a file META-INF/services/org.esa.snap.jython.PluginActivator to be recognised as plugins.



snap-jython

 

snap.gpf.executionOrder

String

SCHEDULE_ROW_COLUMN_BAND | SCHEDULE_ROW_BAND_COLUMN | SCHEDULE_BAND_ROW_COLUMN | PULL_ROW_BAND_COLUMN

 



yes 

 snap-gpf

 

snap.gpf.useFileTileCache

Boolean

true | false

false



yes

snap-gpf

 

snap.gpf.disableTileCache

Boolean

true | false

false



yes

snap-gpf

 

snap.gpf.tileComputationObserver

String

class name

 

Implementation of a org.esa.snap.framework.gpf.monitor.TileComputationObserver

For example: org.esa.snap.core.gpf.monitor.TileComputationEventLogger



snap-gpf

 

snap.gpf.beepAfterProcessing

Boolean

true | false

false

If enabled GPF will make a beep when processing is finished.



snap-gpf

 

snap.gpf.allowAuxdataDownload

Boolean

true | false

true

Disables the access of external auxiliary data over the internet.



snap-gpf

 

snap.parallelism

Integer

1...n

number of CPU cores



yes

snap-core

 

snap.extraClusters

String

path {: path} (Unixes)

path {; path} (Windows)



Used for SNAP Engine stand-alone (command-line) tools, such as GPT. It's value is a list of extra NetBeans clusters whose JAR modules are added to the application's classpath.



snap-runtime

 

snap.application.name

String

any

SNAP





snap-core

 

snap.homepage.url

String

URL

http://sentinel.esa.int





snap-core

 

snap.pixelGeoCoding.fractionAccuracy

 

true | false

true | false

false



yes (Dev)

snap-core

snap.pixelGeoCoding.useTiling

Boolean

true | false

true



yes (Dev)

snap-core

 

snap.tiePointGeoCoding.maxPrecision

Boolean

true | false

false

If set to true, the inverse TiePointGeocoding uses polynomial approximates of higher order to achieve minimal interpolation errors, if set to false, approximations with an RMSE of a quarter pixel are assumed to be sufficiently precise

yes

snap-core

 

snap.useDEMGravitationalModel

Boolean

true | false

false





snap-core

 

snap.dataio.reader.tileWidth

Integer

1...n



Default tile width

yes (Dev)

snap-core

 

snap.dataio.reader.tileHeight

Integer

1...n



Default tile height

yes (Dev)

snap-core

 

snap.dataio.netcdf.metadataElementLimit

Integer

1...n

100







 

snap.binning.sliceHeight

Integer

1...n

Prefererred tile size

Height of a source slice to be processed in pixels

yes

snap-binning

 

snap.binning.traceLatLon

String

lat,lon



Bin tracing



snap-binning

 

snap.worldImageDir

String

path



World image directory



blue-marble-worldmap,
globcover-worldmap,
snap-worldwind? 

 

snap.worldwind.useFlatEarth

Boolean

true | false

false

Use a flat earth image instead of 3D globe





 

snap.worldwind.logLevel

String

OFF | SEVERE | WARNING | INFO | CONFIG | FINE | ALL

OFF







 

snap.dataio.bigtiff.compression.type

String

LZW





snap-bigtiff

 

snap.dataio.bigtiff.compression.quality

Float

0...1





snap-bigtiff

 

snap.dataio.bigtiff.tiling.width

Integer

1...n







snap-bigtiff

 

snap.dataio.bigtiff.tiling.heigh

Integer

1...n







snap-bigtiff

 

snap.dataio.bigtiff.force.bigtif

Boolean

true | false

false





snap-bigtiff

 

snap.dataio.writer.dimap.useCache

Boolean

true | false

true

Selects whether the DIMAPproduct writer uses write caching or not.



snap-core

 

snap.dataio.writer.envi.useCache

Boolean

true | false

true

Selects whether the ENVI product writer uses write caching or not.



snap-envi-reader

 

snap.random.seed

Integer

seed value



If a value is specified all random instances are initialized with the given seed, otherwise the current time is used as seed.



All modules

 

snap.envisat.usePixelGeoCoding

Boolean

true | false

false

Only applicable to orthorectified MERIS full resolution data (MER_FSG_1P, MER_FRG_1P). If set to true, PixelGeoCoding will be used on the terrain corrected geolocation data, if set to false a TiePointGeoCoding will be used.



snap-envisat-reader

 

snap.envisat.pixelGeoCoding.inverse

String

INV_PIXEL_QUAD_TREE |

INV_PIXEL_GEO_INDEX

INV_PIXEL_QUAD_TREE

Only applicable to orthorectified MERIS full resolution data (MER_FSG_1P, MER_FRG_1P). Defines which inverse coding class to use in pixel GeoCoding.



snap-envisat-reader

 

snap.envisat.tiePointGeoCoding.forward

String

FWD_TIE_POINT_BILINEAR |

FWD_TIE_POINT_SPLINE

FWD_TIE_POINT_BILINEAR

Applicable to all ENVISAT products with a tie-point based GeoCoding. Defines which forward coding to use in GeoCoding.



snap-envisat-reader

 

s3tbx.reader.olci.pixelGeoCoding

Boolean

true | false

false

Only applicable to orthorectified OLCI data. If set to true, PixelGeoCoding will be used on the terrain corrected geolocation data, if set to false a TiePointGeoCoding will be used.



s3tbx-sentinel3-reader

 

s3tbx.reader.olci.pixelGeoCoding.inverse

String

INV_PIXEL_QUAD_TREE | INV_PIXEL_GEO_INDEX

INV_PIXEL_QUAD_TREE

Only applicable to orthorectified OLCI data. Defines the inverse GeoCoding to use.



s3tbx-sentinel3-reader

 

s3tbx.reader.olci.tiePointGeoCoding.forward

String

FWD_TIE_POINT_BILINEAR | FWD_TIE_POINT_SPLINE

FWD_TIE_POINT_BILINEAR

Defines the forward GeoCoding for OLCI products when using the tie-point data



s3tbx-sentinel3-reader

 

s3tbx.reader.slstrl1b.pixelGeoCodings

Boolean

true | false

false

Ifs set to true, each band in the product will be associated with a pixel geocoding. If set to false, tie-point geocodings are used.



s3tbx-sentinel3-reader

 

s3tbx.reader.slstrl1b.pixelGeoCodings.inverse

String

INV_PIXEL_QUAD_TREE | INV_PIXEL_GEO_INDEX

INV_PIXEL_QUAD_TREE

Defines the inverse pixel GeoCoding for SLSTR L1B products. Only applicable if reader is switched to PixelGeoCoding mode (see above).



s3tbx-sentinel3-reader

 

s3tbx.reader.slstr.tiePointGeoCoding.forward

String

FWD_TIE_POINT_BILINEAR | FWD_TIE_POINT_SPLINE

FWD_TIE_POINT_BILINEAR

Defines the forward GeoCoding for SLSTR products.



s3tbx-sentinel3-reader

 

s3tbx.reader.slstr.lst.tiePointGeoCoding.forward

String

FWD_TIE_POINT_BILINEAR | FWD_TIE_POINT_SPLINE

FWD_TIE_POINT_BILINEAR

Defines the forward tie-point GeoCoding for SLSTR L2 LST products.



s3tbx-sentinel3-reader

 

s3tbx.reader.slstr.lst.pixelGeoCoding.inverse

String

INV_PIXEL_QUAD_TREE | INV_PIXEL_GEO_INDEX

INV_PIXEL_QUAD_TREE

Defines the inverse pixel GeoCoding for SLSTR L2 LST products.



s3tbx-sentinel3-reader

 

s3tbx.reader.slstr.wst.pixelGeoCoding.inverse

String

INV_PIXEL_QUAD_TREE | INV_PIXEL_GEO_INDEX

INV_PIXEL_QUAD_TREE

Defines the inverse pixel GeoCoding for SLSTR L2 WST products.



s3tbx-sentinel3-reader

 

s3tbx.reader.slstr.frp.pixelGeoCoding.inverse

String

INV_PIXEL_QUAD_TREE | INV_PIXEL_GEO_INDEX

INV_PIXEL_QUAD_TREE

Defines the inverse pixel GeoCoding for SLSTR L2 FRP products.



s3tbx-sentinel3-reader

 

s3tbx.reader.slstr.frp.tiePointGeoCoding.forward

String

FWD_TIE_POINT_BILINEAR | FWD_TIE_POINT_SPLINE

FWD_TIE_POINT_BILINEAR

Defines the forward tie-point GeoCoding for SLSTR L2 FRP products.



s3tbx-sentinel3-reader

 

s3tbx.reader.slstrl2sst.pixelGeoCodings

Boolean

true | false

false

Ifs set to true, each band in the product will be associated with a pixel geocoding. If set to false, tie-point geocodings are used.



s3tbx-sentinel3-reader

 

s3tbx.reader.slstrl2sst.pixelGeoCodings.inverse

String

INV_PIXEL_QUAD_TREE | INV_PIXEL_GEO_INDEX

INV_PIXEL_QUAD_TREE

Defines the inverse Pixel GeoCoding for SLSTR L2 SST products. Only applicable if band geo-codings are set to pixel GeoCoding.



s3tbx-sentinel3-reader

 

s3tbx.reader.syn.l2.pixelGeoCoding.inverse

String

INV_PIXEL_QUAD_TREE | INV_PIXEL_GEO_INDEX

INV_PIXEL_QUAD_TREE

Defines the inverse pixel GeoCoding for SYN L2 products.



s3tbx-sentinel3-reader

 

s3tbx.reader.syn.aod.pixelGeoCoding.inverse

String

INV_PIXEL_QUAD_TREE | INV_PIXEL_GEO_INDEX

INV_PIXEL_QUAD_TREE

Defines the inverse pixel GeoCoding for SYN AOD products.



s3tbx-sentinel3-reader