geodalib / core/src / GeoDaInterface
Interface: GeoDaInterface
Defined in: common/dist/wasm/index.d.ts:667
Properties
DiagnosticReport
DiagnosticReport: typeof
DiagnosticReport
Defined in: common/dist/wasm/index.d.ts:992
GeometryCollection
GeometryCollection: typeof
GeometryCollection
Defined in: common/dist/wasm/index.d.ts:978
LineCollection
LineCollection: typeof
LineCollection
Defined in: common/dist/wasm/index.d.ts:980
LisaResult
LisaResult: typeof
LisaResult
Defined in: common/dist/wasm/index.d.ts:991
PointCollection
PointCollection: typeof
PointCollection
Defined in: common/dist/wasm/index.d.ts:981
Polygon
Polygon: typeof
Polygon
Defined in: common/dist/wasm/index.d.ts:982
PolygonCollection
PolygonCollection: typeof
PolygonCollection
Defined in: common/dist/wasm/index.d.ts:979
VectorDouble
VectorDouble: typeof
VectorDouble
Defined in: common/dist/wasm/index.d.ts:987
VectorInt
VectorInt: typeof
VectorInt
Defined in: common/dist/wasm/index.d.ts:985
VectorPolygon
VectorPolygon: typeof
VectorPolygon
Defined in: common/dist/wasm/index.d.ts:989
VectorString
VectorString: typeof
VectorString
Defined in: common/dist/wasm/index.d.ts:990
VectorUInt
VectorUInt: typeof
VectorUInt
Defined in: common/dist/wasm/index.d.ts:983
VecVecDouble
VecVecDouble: typeof
VecVecDouble
Defined in: common/dist/wasm/index.d.ts:988
VecVecInt
VecVecInt: typeof
VecVecInt
Defined in: common/dist/wasm/index.d.ts:986
VecVecUInt
VecVecUInt: typeof
VecVecUInt
Defined in: common/dist/wasm/index.d.ts:984
Methods
bivariateLocalMoran()
bivariateLocalMoran(
data1,data2,neighbors,undefs,significanceCutoff,permuations,lastSeed):LisaResult
Defined in: common/dist/wasm/index.d.ts:800
Bivariate Local Moran statistics
Parameters
data1
VectorDouble
the first data values
data2
VectorDouble
the second data values
neighbors
VecVecUInt
the spatial weights matrix that represents neighbor indices: [[1, 2], [0, 2], [0, 1],...]
undefs
VectorUInt
the undefined values
significanceCutoff
number
the significance cutoff
permuations
number
the number of permutations
lastSeed
number
the last seed
Returns
LisaResult
boxBreaks()
boxBreaks(
data,undefs,hinge):VectorDouble
Defined in: common/dist/wasm/index.d.ts:763
Box breaks classification: Lower outlier, < 25%, [25-50)%, [50-75)%, >= 75%, Upper outlier
Parameters
data
VectorDouble
the values to be classified
undefs
VectorInt
the flags of undefined values
hinge
number
the hinge value, default is 1.5 and could be 3.0
Returns
VectorDouble
dotProduct()
dotProduct(
x,y):number
Defined in: common/dist/wasm/index.d.ts:889
Parameters
x
VectorDouble
y
VectorDouble
Returns
number
equalIntervalBreaks()
equalIntervalBreaks(
k,data,undefs?):VectorDouble
Defined in: common/dist/wasm/index.d.ts:748
Equal interval breaks classification
Parameters
k
number
number of breaks
data
VectorDouble
the values to be classified into k classes
undefs?
VectorInt
the flags of undefined values
Returns
VectorDouble
getDistanceThresholds()
getDistanceThresholds(
geometries,isMile):VectorDouble
Defined in: common/dist/wasm/index.d.ts:724
get the distance thresholds of a collection of geometries that guarantee 1 nearest neighbors
Parameters
geometries
the collection of geometries
isMile
boolean
the unit of distance
Returns
VectorDouble
getDistanceWeights()
getDistanceWeights(
geometries,threshold,isMile):VecVecUInt
Defined in: common/dist/wasm/index.d.ts:713
get the nearest neighbors of a collection of geometries
Parameters
geometries
the collection of geometries
threshold
number
the distance threshold
isMile
boolean
the unit of distance
Returns
VecVecUInt
getNearestNeighbors()
getNearestNeighbors(
geometries,k):VecVecUInt
Defined in: common/dist/wasm/index.d.ts:705
get the nearest neighbors of a collection of geometries
Parameters
geometries
the collection of geometries
k
number
the number of nearest neighbors
Returns
VecVecUInt
getPointContiguityWeights()
getPointContiguityWeights(
geometries,isQueen,precisionThreshold,orderOfContiguity,includeLowerOrder):VecVecUInt
Defined in: common/dist/wasm/index.d.ts:676
get the contiguity neighbors using the centroids of a collection of geometries
Parameters
geometries
isQueen
boolean
precisionThreshold
number
orderOfContiguity
number
includeLowerOrder
boolean
Returns
VecVecUInt
getPolygonContiguityWeights()
getPolygonContiguityWeights(
geometries,isQueen,precisionThreshold,orderOfContiguity,includeLowerOrder):VecVecUInt
Defined in: common/dist/wasm/index.d.ts:692
get the contiguity neighbors of a collection of polygons
Parameters
geometries
isQueen
boolean
precisionThreshold
number
orderOfContiguity
number
includeLowerOrder
boolean
Returns
VecVecUInt
linearRegression()
linearRegression(
dep,indeps,weights,weightsValues,depName,indepNames,datasetName,depUndefs,indepUndefs):DiagnosticReport
Defined in: common/dist/wasm/index.d.ts:903
Parameters
dep
VectorDouble
The values of the dependent variable
indeps
VecVecDouble
The values of the independent variables, it's a 2D array
weights
VecVecUInt
The spatial weights represented as a 2D array and each row shows the neighbors of the corresponding observation
weightsValues
VecVecDouble
The spatial weights values represented as a 2D array and each row shows the neighbors of the corresponding observation
depName
string
The name of the dependent variable
indepNames
VectorString
The names of the independent variables
datasetName
string
The name of the dataset
depUndefs
VectorUInt
The 0/1 array indicating the undefined values of the dependent variable
indepUndefs
VecVecUInt
The 2D array of 0/1 indicating the undefined values of the independent variables
Returns
DiagnosticReport
localG()
localG(
data,neighbors,undefs,significanceCutoff,permuations,lastSeed,isGStar):LisaResult
Defined in: common/dist/wasm/index.d.ts:820
Local Getis-Ord statistics
Parameters
data
VectorDouble
the data values
neighbors
VecVecUInt
the spatial weights matrix that represents neighbor indices: [[1, 2], [0, 2], [0, 1],...]
undefs
VectorUInt
the undefined values
significanceCutoff
number
the significance cutoff
permuations
number
the number of permutations
lastSeed
number
the last seed
isGStar
number
whether to use G* or G
Returns
LisaResult
localGeary()
localGeary(
data,neighbors,undefs,significanceCutoff,permuations,lastSeed):LisaResult
Defined in: common/dist/wasm/index.d.ts:839
Local Geary statistics
Parameters
data
VectorDouble
the data values
neighbors
VecVecUInt
the spatial weights matrix that represents neighbor indices: [[1, 2], [0, 2], [0, 1],...]
undefs
VectorUInt
the undefined values
significanceCutoff
number
the significance cutoff
permuations
number
the number of permutations
lastSeed
number
the last seed
Returns
LisaResult
localMoran()
localMoran(
data,neighbors,undefs,significanceCutoff,permuations,lastSeed):LisaResult
Defined in: common/dist/wasm/index.d.ts:781
Local Moran statistics
Parameters
data
VectorDouble
the data values
neighbors
VecVecUInt
the spatial weights matrix that represents neighbor indices: [[1, 2], [0, 2], [0, 1],...]
undefs
VectorUInt
the undefined values
significanceCutoff
number
the significance cutoff
permuations
number
the number of permutations
lastSeed
number
the last seed
Returns
LisaResult
multivariateLocalGeary()
multivariateLocalGeary(
data,neighbors,undefs,significanceCutoff,permuations,lastSeed):LisaResult
Defined in: common/dist/wasm/index.d.ts:857
Multivariate Local Geary statistics
Parameters
data
VecVecDouble
the array of data values
neighbors
VecVecUInt
the spatial weights matrix that represents neighbor indices: [[1, 2], [0, 2], [0, 1],...]
undefs
VecVecUInt
the array of undefined values
significanceCutoff
number
the significance cutoff
permuations
number
the number of permutations
lastSeed
number
the last seed
Returns
LisaResult
naturalBreaks()
naturalBreaks(
k,data,undefs?):VectorDouble
Defined in: common/dist/wasm/index.d.ts:740
Natural Jenks breaks classification
Parameters
k
number
number of breaks
data
VectorDouble
the values to be classified into k classes
undefs?
VectorInt
the indices of data that are undefined
Returns
VectorDouble
percentileBreaks()
percentileBreaks(
data,undefs?):VectorDouble
Defined in: common/dist/wasm/index.d.ts:755
Percentile breaks classification: <1%, 1-10%, 10-50%, 50-90%, 90-99%, >99%
Parameters
data
VectorDouble
the values to be classified
undefs?
VectorInt
the flags of undefined values
Returns
VectorDouble
quantileBreaks()
quantileBreaks(
k,data,undefs?):VectorDouble
Defined in: common/dist/wasm/index.d.ts:732
Parameters
k
number
the number of breaks
data
VectorDouble
the values to be classified into k classes
undefs?
VectorUInt
the indices of data that are undefined
Returns
VectorDouble
quantileLisa()
quantileLisa(
k,quantile,data,neighbors,undefs,significanceCutoff,permuations,lastSeed):LisaResult
Defined in: common/dist/wasm/index.d.ts:877
Local Quantile LISA statistics
Parameters
k
number
the number of breaks
quantile
number
which quantile to use
data
VectorDouble
the data values
neighbors
VecVecUInt
the spatial weights matrix that represents neighbor indices: [[1, 2], [0, 2], [0, 1],...]
undefs
VectorUInt
the undefined values
significanceCutoff
number
the significance cutoff
permuations
number
the number of permutations
lastSeed
number
the last seed
Returns
LisaResult
spatialDissolve()
spatialDissolve(
polys):Polygon
Defined in: common/dist/wasm/index.d.ts:976
Spatial Dissolve of a collection of polygons
Parameters
polys
The collection of polygons
Returns
Polygon
The dissolved polygon
spatialError()
spatialError(
dep,indeps,weights,weightsValues,depName,indepNames,datasetName,depUndefs,indepUndefs):DiagnosticReport
Defined in: common/dist/wasm/index.d.ts:951
Spatial Error regression
Parameters
dep
VectorDouble
The values of the dependent variable
indeps
VecVecDouble
The values of the independent variables, it's a 2D array
weights
VecVecUInt
The spatial weights represented as a 2D array and each row shows the neighbors of the corresponding observation
weightsValues
VecVecDouble
The spatial weights values represented as a 2D array and each row shows the neighbors of the corresponding observation
depName
string
The name of the dependent variable
indepNames
VectorString
The names of the independent variables
datasetName
string
The name of the dataset
depUndefs
VectorUInt
The 0/1 array indicating the undefined values of the dependent variable
indepUndefs
VecVecUInt
The 2D array of 0/1 indicating the undefined values of the independent variables
Returns
DiagnosticReport
spatialJoin()
spatialJoin(
left,right):VecVecUInt
Defined in: common/dist/wasm/index.d.ts:969
Spatial Join of two collections of geometries
Parameters
left
The left collection of geometries
right
The right collection of geometries
Returns
VecVecUInt
The indices of the right geometries that are spatially joined to the left geometries
spatialLag()
spatialLag(
dep,indeps,weights,weightsValues,depName,indepNames,datasetName,depUndefs,indepUndefs):DiagnosticReport
Defined in: common/dist/wasm/index.d.ts:927
Spatial Lag regression
Parameters
dep
VectorDouble
The values of the dependent variable
indeps
VecVecDouble
The values of the independent variables, it's a 2D array
weights
VecVecUInt
The spatial weights represented as a 2D array and each row shows the neighbors of the corresponding observation
weightsValues
VecVecDouble
The spatial weights values represented as a 2D array and each row shows the neighbors of the corresponding observation
depName
string
The name of the dependent variable
indepNames
VectorString
The names of the independent variables
datasetName
string
The name of the dataset
depUndefs
VectorUInt
The 0/1 array indicating the undefined values of the dependent variable
indepUndefs
VecVecUInt
The 2D array of 0/1 indicating the undefined values of the independent variables
Returns
DiagnosticReport
standardDeviationBreaks()
standardDeviationBreaks(
data,undefs):VectorDouble
Defined in: common/dist/wasm/index.d.ts:770
Standard deviation breaks classification
Parameters
data
VectorDouble
the values to be classified
undefs
VectorInt
the flags of undefined values
Returns
VectorDouble