GSTools Logo
stable

Documentation

  • GSTools Quickstart
    • Purpose
    • Installation
      • conda
      • pip
    • Citation
    • Tutorials and Examples
    • Spatial Random Field Generation
      • Examples
        • Gaussian Covariance Model
    • Estimating and fitting variograms
      • Examples
    • Kriging and Conditioned Random Fields
      • Example
    • User defined covariance models
      • Example
    • Incompressible Vector Field Generation
      • Example
    • VTK/PyVista Export
    • Requirements
      • Optional
      • Contact
    • License
  • GSTools Tutorials
    • Random Field Generation
      • Examples
        • A Very Simple Example
        • Creating an Ensemble of Fields
          • Using better Seeds
        • Creating Fancier Fields
        • Using an Unstructured Grid
        • Merging two Fields
        • Generating Fields on Meshes
        • Using PyVista meshes
        • Higher Dimensions
    • The Covariance Model
      • Provided Covariance Models
      • Examples
        • Introductory example
          • Parameters
        • Basic Methods
        • Anisotropy and Rotation
          • Rotation Angles
        • Spectral methods
        • Different scales
          • Integral scale
          • Percentile scale
          • Comparison
        • Additional Parameters
        • Fitting variogram data
    • Variogram Estimation
      • Examples
        • Fit Variogram
        • Finding the best fitting variogram model
        • Multi-field variogram estimation
        • Directional variogram estimation and fitting in 2D
        • Directional variogram estimation and fitting in 3D
        • Fit Variogram with automatic binning
        • Automatic binning with lat-lon data
    • Random Vector Field Generation
      • Examples
        • Generating a Random 2D Vector Field
          • Applications
        • Generating a Random 3D Vector Field
    • Kriging
      • Provided Kriging Methods
      • Examples
        • Simple Kriging
          • Example
        • Ordinary Kriging
          • Example
        • Interface to PyKrige
          • Ordinary Kriging with PyKrige
          • Ordinary Kriging with GSTools
        • Compare Kriging
        • External Drift Kriging
        • Universal Kriging
        • Detrended Kriging
        • Detrended Ordinary Kriging
        • Incorporating measurement errors
        • Redundant data and pseudo-inverse
          • Example
    • Conditioned Fields
      • Examples
        • Conditioning with Ordinary Kriging
        • Creating an Ensemble of conditioned 2D Fields
    • Field transformations
      • Examples
        • log-normal fields
        • binary fields
        • Discrete fields
        • Zinn & Harvey transformation
        • Bimodal fields
        • Combinations
    • Geographic Coordinates
      • Examples
        • Working with lat-lon random fields
        • Kriging geographical data
    • Spatio-Temporal Modeling
      • Examples
        • Creating a 1D Synthetic Precipitation Field
        • Creating a 2D Synthetic Precipitation Field
    • Normalizing Data
      • Mean, Trend and Normalizers
      • Provided Normalizers
      • Examples
        • Log-Normal Kriging
        • Automatic fitting
          • Artificial data
          • Fitting and Interpolation
          • Plotting
        • Normalizer Comparison
    • Miscellaneous Tutorials
      • Examples
        • Truncated Power Law Variograms
        • Exporting Fields
        • Check Random Sampling
        • Analyzing the Herten Aquifer with GSTools
          • The Data
          • Retrieving the Data
          • Downloading and Preprocessing
          • Analyzing the data
          • Estimating the Variogram
          • Fitting the Variogram
          • Estimating the Variogram in Specific Directions
          • Creating a Spatial Random Field from the Herten Parameters
        • Standalone Field class
  • GSTools API
    • Purpose
    • Subpackages
      • gstools.covmodel
        • Subpackages
          • gstools.covmodel.plot
            • gstools.covmodel.plot.plot_variogram
            • gstools.covmodel.plot.plot_covariance
            • gstools.covmodel.plot.plot_correlation
            • gstools.covmodel.plot.plot_vario_yadrenko
            • gstools.covmodel.plot.plot_cov_yadrenko
            • gstools.covmodel.plot.plot_cor_yadrenko
            • gstools.covmodel.plot.plot_vario_axis
            • gstools.covmodel.plot.plot_cov_axis
            • gstools.covmodel.plot.plot_cor_axis
            • gstools.covmodel.plot.plot_vario_spatial
            • gstools.covmodel.plot.plot_cov_spatial
            • gstools.covmodel.plot.plot_cor_spatial
            • gstools.covmodel.plot.plot_spectrum
            • gstools.covmodel.plot.plot_spectral_density
            • gstools.covmodel.plot.plot_spectral_rad_pdf
        • Covariance Base-Class
          • gstools.covmodel.CovModel
            • CovModel
        • Covariance Models
          • gstools.covmodel.Gaussian
            • Gaussian
          • gstools.covmodel.Exponential
            • Exponential
          • gstools.covmodel.Matern
            • Matern
          • gstools.covmodel.Integral
            • Integral
          • gstools.covmodel.Stable
            • Stable
          • gstools.covmodel.Rational
            • Rational
          • gstools.covmodel.Cubic
            • Cubic
          • gstools.covmodel.Linear
            • Linear
          • gstools.covmodel.Circular
            • Circular
          • gstools.covmodel.Spherical
            • Spherical
          • gstools.covmodel.HyperSpherical
            • HyperSpherical
          • gstools.covmodel.SuperSpherical
            • SuperSpherical
          • gstools.covmodel.JBessel
            • JBessel
          • gstools.covmodel.TPLGaussian
            • TPLGaussian
          • gstools.covmodel.TPLExponential
            • TPLExponential
          • gstools.covmodel.TPLStable
            • TPLStable
          • gstools.covmodel.TPLSimple
            • TPLSimple
      • gstools.field
        • Subpackages
          • gstools.field.generator
            • gstools.field.generator.Generator
            • gstools.field.generator.RandMeth
            • gstools.field.generator.IncomprRandMeth
          • gstools.field.upscaling
            • gstools.field.upscaling.var_coarse_graining
            • gstools.field.upscaling.var_no_scaling
        • Spatial Random Field
          • gstools.field.SRF
            • SRF
          • gstools.field.CondSRF
            • CondSRF
        • Field Base Class
          • gstools.field.Field
            • Field
      • gstools.variogram
        • Variogram estimation
          • gstools.variogram.vario_estimate
            • vario_estimate()
          • gstools.variogram.vario_estimate_axis
            • vario_estimate_axis()
        • Binning
          • gstools.variogram.standard_bins
            • standard_bins()
      • gstools.krige
        • Kriging Classes
          • gstools.krige.Krige
            • Krige
          • gstools.krige.Simple
            • Simple
          • gstools.krige.Ordinary
            • Ordinary
          • gstools.krige.Universal
            • Universal
          • gstools.krige.ExtDrift
            • ExtDrift
          • gstools.krige.Detrended
            • Detrended
      • gstools.random
        • Random Number Generator
          • gstools.random.RNG
            • RNG
        • Seed Generator
          • gstools.random.MasterRNG
            • MasterRNG
        • Distribution factory
          • gstools.random.dist_gen
            • dist_gen()
      • gstools.tools
        • Export
          • gstools.tools.vtk_export
            • vtk_export()
          • gstools.tools.vtk_export_structured
            • vtk_export_structured()
          • gstools.tools.vtk_export_unstructured
            • vtk_export_unstructured()
          • gstools.tools.to_vtk
            • to_vtk()
          • gstools.tools.to_vtk_structured
            • to_vtk_structured()
          • gstools.tools.to_vtk_unstructured
            • to_vtk_unstructured()
        • Special functions
          • gstools.tools.confidence_scaling
            • confidence_scaling()
          • gstools.tools.inc_gamma
            • inc_gamma()
          • gstools.tools.inc_gamma_low
            • inc_gamma_low()
          • gstools.tools.exp_int
            • exp_int()
          • gstools.tools.inc_beta
            • inc_beta()
          • gstools.tools.tplstable_cor
            • tplstable_cor()
          • gstools.tools.tpl_exp_spec_dens
            • tpl_exp_spec_dens()
          • gstools.tools.tpl_gau_spec_dens
            • tpl_gau_spec_dens()
        • Geometric
          • gstools.tools.rotated_main_axes
            • rotated_main_axes()
          • gstools.tools.set_angles
            • set_angles()
          • gstools.tools.set_anis
            • set_anis()
          • gstools.tools.no_of_angles
            • no_of_angles()
          • gstools.tools.rotation_planes
            • rotation_planes()
          • gstools.tools.givens_rotation
            • givens_rotation()
          • gstools.tools.matrix_rotate
            • matrix_rotate()
          • gstools.tools.matrix_derotate
            • matrix_derotate()
          • gstools.tools.matrix_isotropify
            • matrix_isotropify()
          • gstools.tools.matrix_anisotropify
            • matrix_anisotropify()
          • gstools.tools.matrix_isometrize
            • matrix_isometrize()
          • gstools.tools.matrix_anisometrize
            • matrix_anisometrize()
          • gstools.tools.ang2dir
            • ang2dir()
          • gstools.tools.generate_grid
            • generate_grid()
          • gstools.tools.generate_st_grid
            • generate_st_grid()
        • Misc
          • EARTH_RADIUS
      • gstools.transform
        • Wrapper
          • gstools.transform.apply
            • apply()
        • Field Transformations
          • gstools.transform.binary
            • binary()
          • gstools.transform.discrete
            • discrete()
          • gstools.transform.boxcox
            • boxcox()
          • gstools.transform.zinnharvey
            • zinnharvey()
          • gstools.transform.normal_force_moments
            • normal_force_moments()
          • gstools.transform.normal_to_lognormal
            • normal_to_lognormal()
          • gstools.transform.normal_to_uniform
            • normal_to_uniform()
          • gstools.transform.normal_to_arcsin
            • normal_to_arcsin()
          • gstools.transform.normal_to_uquad
            • normal_to_uquad()
          • gstools.transform.apply_function
            • apply_function()
        • Array Transformations
          • gstools.transform.array_discrete
            • array_discrete()
          • gstools.transform.array_boxcox
            • array_boxcox()
          • gstools.transform.array_zinnharvey
            • array_zinnharvey()
          • gstools.transform.array_force_moments
            • array_force_moments()
          • gstools.transform.array_to_lognormal
            • array_to_lognormal()
          • gstools.transform.array_to_uniform
            • array_to_uniform()
          • gstools.transform.array_to_arcsin
            • array_to_arcsin()
          • gstools.transform.array_to_uquad
            • array_to_uquad()
      • gstools.normalizer
        • Base-Normalizer
          • gstools.normalizer.Normalizer
            • Normalizer
        • Field-Normalizer
          • gstools.normalizer.LogNormal
            • LogNormal
          • gstools.normalizer.BoxCox
            • BoxCox
          • gstools.normalizer.BoxCoxShift
            • BoxCoxShift
          • gstools.normalizer.YeoJohnson
            • YeoJohnson
          • gstools.normalizer.Modulus
            • Modulus
          • gstools.normalizer.Manly
            • Manly
        • Convenience Routines
          • gstools.normalizer.apply_mean_norm_trend
            • apply_mean_norm_trend()
          • gstools.normalizer.remove_trend_norm_mean
            • remove_trend_norm_mean()
    • Classes
      • Kriging
      • Spatial Random Field
      • Covariance Base-Class
      • Covariance Models
        • Standard Covariance Models
        • Truncated Power Law Covariance Models
    • Functions
      • VTK-Export
      • Geometric
      • Variogram Estimation
    • Misc
  • Changelog
    • 1.4.1 - Sassy Sapphire - 2022-11
      • Enhancements
      • Changes
      • Bugfixes
    • 1.4.0 - Sassy Sapphire - 2022-08
      • Enhancements
      • Changes
      • Bugfixes
    • 1.3.5 - Pure Pink - 2022-01
      • Changes
      • Bugfixes
    • 1.3.4 - Pure Pink - 2021-11
      • Enhancements
      • Changes
    • 1.3.3 - Pure Pink - 2021-08
      • Enhancements
      • Bugfixes
    • 1.3.2 - Pure Pink - 2021-07
      • Bugfixes
    • 1.3.1 - Pure Pink - 2021-06
      • Enhancements
      • Bugfixes
    • 1.3.0 - Pure Pink - 2021-04
      • Topics
        • Geographical Coordinates Support (#113)
        • Krige Unification (#97)
        • Directional Variograms and Auto-binning (#87, #106, #131)
        • Better Variogram fitting (#78, #145)
        • CovModel update (#109, #122, #157)
        • Normalizer, Trend and Mean (#124)
        • Arbitrary dimensions (#112)
        • New Class for Conditioned Random Fields (#130)
      • Enhancements
      • Changes
      • Bugfixes
    • 1.2.1 - Volatile Violet - 2020-04-14
      • Bugfixes
    • 1.2.0 - Volatile Violet - 2020-03-20
      • Enhancements
      • Changes
      • Bugfixes
    • 1.1.1 - Reverberating Red - 2019-11-08
      • Enhancements
      • Changes
      • Bugfixes
    • 1.1.0 - Reverberating Red - 2019-10-01
      • Enhancements
      • Changes
      • Bugfixes
    • 1.0.1 - Bouncy Blue - 2019-01-18
      • Bugfixes
    • 1.0.0 - Bouncy Blue - 2019-01-16
      • Enhancements
      • Changes
      • Bugfixes
    • 0.4.0 - Glorious Green - 2018-07-17
      • Bugfixes
    • 0.3.6 - Original Orange - 2018-07-17

GSTools Links

  • GSTools GitHub
  • GSTools Zenodo DOI
  • GSTools PyPI

GeoStat Framework

  • GeoStat Website
  • GeoStat Github
  • GeoStat Examples
  • GeoStat ReadTheDocs
  • GeoStat PyPI


  • Index
  • Sitemap
GSTools
  • »
  • Overview: module code

All modules for which code is available

  • gstools.covmodel.base
  • gstools.covmodel.models
  • gstools.covmodel.plot
  • gstools.covmodel.tpl_models
  • gstools.field.base
  • gstools.field.cond_srf
  • gstools.field.generator
  • gstools.field.srf
  • gstools.field.upscaling
  • gstools.krige.base
  • gstools.krige.methods
  • gstools.normalizer.base
  • gstools.normalizer.methods
  • gstools.normalizer.tools
  • gstools.random.rng
  • gstools.random.tools
  • gstools.tools.export
  • gstools.tools.geometric
  • gstools.tools.special
  • gstools.transform.array
  • gstools.transform.field
  • gstools.variogram.binning
  • gstools.variogram.variogram

© Copyright 2018 - 2022, Sebastian Müller, Lennart Schüler. Revision 510df78d.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: stable
Versions
latest
stable
v1.4.1
v1.4.0
v1.3.5
v1.3.4
v1.3.3
v1.3.2
v1.3.1
v1.3.0
v1.2.1
v1.2.0
v1.1.1
v1.0.1
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds