GA Layer To Points (Geostatistical Analyst)

Available with Geostatistical Analyst license.

Summary

Exports a geostatistical layer to points. The tool can also be used to predict values at unmeasured locations or to validate predictions made at measured locations.

Usage

  • For data formats that support Null values, such as file geodatabase feature classes, a Null value will be used to indicate that a prediction could not be made for that location or that the value should be ignored when used as input. For data formats that do not support Null values, such as shapefiles, the value of -1.7976931348623158e+308 is used (this is the negative of the C++ defined constant DBL_MAX) to indicate that a prediction could not be made for that location.

  • If a validation z-field is supplied, the predictions and standard errors are calculated differently than if a validation field is not supplied. For more information, see the following reference:

    • Krivoruchko, K., A. Gribov, and J. M. Ver Hoef, 2006, "A new method for handling the nugget effect in kriging," T. C. Coburn, J. M. Yarus, and R. L. Chambers, Eds., Stochastic modeling and geostatistics: Principles, methods, and case studies, volume II: AAPG Computer Applications and Geology 5, p. 81–89.

Parameters

LabelExplanationData Type
Input geostatistical layer

The geostatistical layer to be analyzed.

Geostatistical Layer
Input point observation locations

Point locations where predictions or validations will be performed.

Feature Layer
Field to validate on
(Optional)

If this field is left blank, predictions are made at the location points. If a field is selected, predictions are made at the location points, compared to their Z_value_field values, and a validation analysis is performed.

Field
Output statistics at point locations

The output feature class containing either the predictions or the predictions and the validation results.

The fields in this feature class can include the following fields (where applicable):

  • Source_ID (Source ID)—The object ID of the source feature in the Input point observation locations.
    • The feature or object identifier of the input dataset that was used.
  • Included (Included)—Indicates whether a prediction was calculated for this feature. The values in this field can be one of the following:
    • Yes—There are no problems making a prediction at this point.
    • Not enough neighbors—There are not enough neighbors to make a prediction.
    • Weight parameter is too small—The weight parameter is too small.
    • Overfilling—Overflow of floating-point calculations.
    • Problem with data transformation—The value to be transformed is outside of the supported range for the selected transformation (only in kriging).
    • No explanatory rasters—The value cannot be calculated because one of the explanatory variables is not defined. The point could be outside the extent of at least one explanatory variable raster, or the point could be on top of a NoData cell in at least one of the explanatory variable rasters. This only applies to EBK Regression Prediction models.
  • Predicted (Predicted)—The prediction value at this location.
  • Error (Error)—The predicted value minus the value in the validation field.
  • StdError (Standard Error)—The kriging standard error.
  • Stdd_Error (Standardized Error)—The standardized prediction errors. Ideally, the standardized prediction errors are distributed normally.
  • NormValue (Normal Value)—The normal distribution value (x-axis) that corresponds to the standardized prediction errors (y-axis) in the normal QQplot.
  • CRPS (Continuous Ranked Probability Score)—The continuous ranked probability score is a diagnostic that measures the deviation from the predictive cumulative distribution function to each observed data value. This value should be as small as possible. This diagnostic has advantages over cross-validation diagnostics because it compares the data to a full distribution rather than to single-point predictions. This field is only created for Empirical Bayesian Kriging and EBK Regression Prediction models.
  • Interval90 (Inside 90 Percent Interval)—Indicates whether or not the validation point is inside of a 90 percent confidence interval. This field is only created for Empirical Bayesian Kriging and EBK Regression Prediction models. If the model fits the data, approximately 90 percent of the features should be contained in a 90 percent confidence interval. This field can contain the following values:
    • Yes—The validation point is inside the 90 percent confidence interval.
    • No—The validation point is not inside the 90 percent confidence interval.
    • Excluded—A prediction cannot be made at this location.
  • Interval95 (Inside 95 Percent Interval)—Indicates whether or not the validation point is inside of a 95 percent confidence interval. This field is only created for Empirical Bayesian Kriging and EBK Regression Prediction models. If the model fits the data, approximately 95 percent of the features should be contained in a 95 percent confidence interval. This field can contain the following values:
    • Yes—The validation point is inside the 95 percent confidence interval.
    • No—The validation point is not inside the 95 percent confidence interval.
    • Excluded—A prediction cannot be made at this location.
  • QuanVal (Validation Quantile)—The quantile of the measured value at the feature with respect to the prediction distribution. This value can range from 0 to 1, and values close to 0 indicate that the measured value is on the far left tail of the distribution, and values close to 1 indicate that the measured value is on the right tail of the distribution. If many values are close to either extreme, this could indicate that the prediction distributions do not model the data well, and some of the interpolation parameters need to be altered. This field is only created for Empirical Bayesian Kriging and EBK Regression Prediction models.
Feature Class
Append all fields from input features
(Optional)

Determines whether all fields will be copied from the input features to the output feature class.

  • Checked—All fields from the input features will be copied to the output feature class. This is the default.
  • Unchecked—Only the feature ID value will be copied, and it will be named Source_ID on the output feature class.
Boolean
Elevation field
(Optional)

The field containing the elevation of each input point. The parameter only applies to 3D geostatistical models. If the elevation values are stored as geometry attributes in Shape.Z, it is recommended to use that field. If the elevations are stored in an attribute field, the elevations must indicate distance from sea level. Positive values indicate distance above sea level, and negative values indicate distance below sea level.

Field
Elevation field units
(Optional)

The units of the elevation field. This parameter only applies to 3D geostatistical models. If Shape.Z is provided as the elevation field, the units will automatically match the Z-units of the vertical coordinate system.

  • InchElevations are in inches.
  • FootElevations are in feet.
  • YardElevations are in yards.
  • US mileElevations are in U.S. miles.
  • Nautical mileElevations are in nautical miles.
  • MillimeterElevations are in millimeters.
  • CentimeterElevations are in centimeters.
  • DecimeterElevations are in decimeters.
  • MeterElevations are in meters.
  • KilometerElevations are in kilometers.
String

arcpy.ga.GALayerToPoints(in_geostat_layer, in_locations, {z_field}, out_feature_class, {append_all_fields}, {elevation_field}, {elevation_units})
NameExplanationData Type
in_geostat_layer

The geostatistical layer to be analyzed.

Geostatistical Layer
in_locations

Point locations where predictions or validations will be performed.

Feature Layer
z_field
(Optional)

If this field is left blank, predictions are made at the location points. If a field is selected, predictions are made at the location points, compared to their Z_value_field values, and a validation analysis is performed.

Field
out_feature_class

The output feature class containing either the predictions or the predictions and the validation results.

The fields in this feature class can include the following fields (where applicable):

  • Source_ID (Source ID)—The object ID of the source feature in the Input point observation locations.
    • The feature or object identifier of the input dataset that was used.
  • Included (Included)—Indicates whether a prediction was calculated for this feature. The values in this field can be one of the following:
    • Yes—There are no problems making a prediction at this point.
    • Not enough neighbors—There are not enough neighbors to make a prediction.
    • Weight parameter is too small—The weight parameter is too small.
    • Overfilling—Overflow of floating-point calculations.
    • Problem with data transformation—The value to be transformed is outside of the supported range for the selected transformation (only in kriging).
    • No explanatory rasters—The value cannot be calculated because one of the explanatory variables is not defined. The point could be outside the extent of at least one explanatory variable raster, or the point could be on top of a NoData cell in at least one of the explanatory variable rasters. This only applies to EBK Regression Prediction models.
  • Predicted (Predicted)—The prediction value at this location.
  • Error (Error)—The predicted value minus the value in the validation field.
  • StdError (Standard Error)—The kriging standard error.
  • Stdd_Error (Standardized Error)—The standardized prediction errors. Ideally, the standardized prediction errors are distributed normally.
  • NormValue (Normal Value)—The normal distribution value (x-axis) that corresponds to the standardized prediction errors (y-axis) in the normal QQplot.
  • CRPS (Continuous Ranked Probability Score)—The continuous ranked probability score is a diagnostic that measures the deviation from the predictive cumulative distribution function to each observed data value. This value should be as small as possible. This diagnostic has advantages over cross-validation diagnostics because it compares the data to a full distribution rather than to single-point predictions. This field is only created for Empirical Bayesian Kriging and EBK Regression Prediction models.
  • Interval90 (Inside 90 Percent Interval)—Indicates whether or not the validation point is inside of a 90 percent confidence interval. This field is only created for Empirical Bayesian Kriging and EBK Regression Prediction models. If the model fits the data, approximately 90 percent of the features should be contained in a 90 percent confidence interval. This field can contain the following values:
    • Yes—The validation point is inside the 90 percent confidence interval.
    • No—The validation point is not inside the 90 percent confidence interval.
    • Excluded—A prediction cannot be made at this location.
  • Interval95 (Inside 95 Percent Interval)—Indicates whether or not the validation point is inside of a 95 percent confidence interval. This field is only created for Empirical Bayesian Kriging and EBK Regression Prediction models. If the model fits the data, approximately 95 percent of the features should be contained in a 95 percent confidence interval. This field can contain the following values:
    • Yes—The validation point is inside the 95 percent confidence interval.
    • No—The validation point is not inside the 95 percent confidence interval.
    • Excluded—A prediction cannot be made at this location.
  • QuanVal (Validation Quantile)—The quantile of the measured value at the feature with respect to the prediction distribution. This value can range from 0 to 1, and values close to 0 indicate that the measured value is on the far left tail of the distribution, and values close to 1 indicate that the measured value is on the right tail of the distribution. If many values are close to either extreme, this could indicate that the prediction distributions do not model the data well, and some of the interpolation parameters need to be altered. This field is only created for Empirical Bayesian Kriging and EBK Regression Prediction models.
Feature Class
append_all_fields
(Optional)

Determines whether all fields will be copied from the input features to the output feature class.

  • ALL All fields from the input features will be copied to the output feature class. This is the default.
  • FID_ONLY Only the feature ID will be copied, and it will be named Source_ID on the output feature class.
Boolean
elevation_field
(Optional)

The field containing the elevation of each input point. The parameter only applies to 3D geostatistical models. If the elevation values are stored as geometry attributes in Shape.Z, it is recommended to use that field. If the elevations are stored in an attribute field, the elevations must indicate distance from sea level. Positive values indicate distance above sea level, and negative values indicate distance below sea level.

Field
elevation_units
(Optional)

The units of the elevation field. This parameter only applies to 3D geostatistical models. If Shape.Z is provided as the elevation field, the units will automatically match the Z-units of the vertical coordinate system.

  • INCHElevations are in inches.
  • FOOTElevations are in feet.
  • YARDElevations are in yards.
  • MILE_USElevations are in U.S. miles.
  • NAUTICAL_MILEElevations are in nautical miles.
  • MILLIMETERElevations are in millimeters.
  • CENTIMETERElevations are in centimeters.
  • DECIMETERElevations are in decimeters.
  • METERElevations are in meters.
  • KILOMETERElevations are in kilometers.
String

Code sample

GALayerToPoints example 1 (Python window)

Export a geostatistical layer to a point feature class.

import arcpy
arcpy.env.workspace = "C:/gapyexamples/data"
arcpy.GALayerToPoints_ga("C:/gapyexamples/data/kriging.lyr", 
                         "C:/gapyexamples/data/obs_pts.shp",                   
                         "", "C:/gapyexamples/output/krig_pts")
GALayerToPoints example 2 (stand-alone script)

Export a geostatistical layer to a point feature class.

# Name: GALayerToPoints_Example_02.py
# Description: Exports a geostatistical layer to points.
# Requirements: Geostatistical Analyst Extension

# Import system modules
import arcpy

# Set environment settings
arcpy.env.workspace = "C:/gapyexamples/data"

# Set local variables
inLayer = "C:/gapyexamples/data/kriging.lyr"
inPoints = "C:/gapyexamples/data/obs_pts.shp"
zField = ""
outPoints = "C:/gapyexamples/output/krig_pts"

# Execute GALayerToPoints
arcpy.GALayerToPoints_ga(inLayer, inPoints, zField, outPoints)

Licensing information

  • Basic: Requires Geostatistical Analyst
  • Standard: Requires Geostatistical Analyst
  • Advanced: Requires Geostatistical Analyst

Related topics