Operator reference
The 436 operators of Terraflux, grouped as in the application's library. Each node of a model runs one operator: this reference lists what it reads (inputs), what it gives (outputs) and how it is set (settings). It is generated from Terraflux 1.41.0 itself.
Data preparation 53
data.downloadData downloaded on demand and warped onto a grid (gdalwarp straight from the servers: only the part the...data.environment90mThe environment of every sub-catchment of a map of Hydrography90m's sub-catchments (data.download's...raster.calcMaps, stacks and numbers computed cell by cell from a script over the node's inputs (any names: maps,...raster.cell_areaThe true area of every cell of a map's grid, as terra's cellSize: on a grid of longitudes and latitudes...raster.classifyA map's values in classes 1.. by breaks, as a GIS's graduated symbology or classInt: quantiles (each class...raster.clipRasters cut to an extent in their own coordinates (GDAL's gdal_translate), their cells as they are.raster.contourThe contour lines of a map, as gdal_contour: lines through the places of equal value, at every multiple of...raster.convertRasters copied into another format or cell type (gdal_translate): GTiff, COG (cloud-optimised, with...raster.correlationThe correlation and covariance between maps over their cells, as terra's layerCor or R's cor: between...raster.expandClasses of a map grown a number of cells into the others, as ArcGIS's Expand: a cell a step, every cell...raster.fillThe cells without a value filled from the cells around them (gdal_fillnodata: inverse distance weighting,...raster.focalA statistic of the cells in a moving window around every cell, as terra's focal or GRASS's r.neighbors:...raster.labelThe patches of a map numbered, as GRASS's r.clump or scipy's label: every group of connected cells of one...raster.legendThe names and colours of a map's classes: the map shown with them, and carried with it (the maps made from...raster.local_correlationThe correlation and the least squares line between two maps in a moving window around every cell...raster.majorityA map of classes cleaned by the majority filter, as ArcGIS's Majority Filter: a cell takes the most common...raster.matchRasters on the grid of another (its CRS, extent and cells: landschaft's match_grid, by gdalwarp), so that...raster.mosaicThe files of a series (a folder, a pattern: tiles of a region) joined into one raster (gdalwarp), in the...raster.readA raster: a file, or a folder or a pattern (forest/*.tif) for every raster in it as one stack (a layer per...raster.reclassifyA map's values changed by rules, one per line: `1 2 3 -> 1` (values), `0..10 -> 2` (a range, both ends in;...raster.reprojectRasters in another coordinate reference system and/or resolution (GDAL's gdalwarp): the method by the data...raster.resampleRasters at another resolution in their own CRS (gdalwarp): the method by the data unless one is given...raster.shrinkClasses of a map shrunk a number of cells, as ArcGIS's Shrink: a cell a step, every cell of the classes...raster.sieveThe patches smaller than a size merged into their largest neighbour, as gdal_sieve (GDALSieveFilter): a...raster.standardizeA map (or every layer of a stack, or every map of a series) put on a common scale, for drivers and...raster.statsA summary of a map, or of every layer of a stack or of a series of maps, as tables: the cells with a value...raster.tabulateThe area of every class of a map in every zone of another, as ArcGIS's Tabulate Area or a cross...raster.terrainA measure of a surface such as an elevation model (gdaldem): slope (degrees, or percent with the option...raster.viewshedWhat can be seen from observers over an elevation map, as gdal_viewshed or GRASS's r.viewshed: a cell is...raster.writeWrite a map, a stack (a band per map), the series of maps of a loop (a band per step) or rasters on disk...raster.zonalStatistics of a map (or of every layer of a stack) in the zones of a map of zone ids (municipalities,...vector.bufferThe area within a distance of every feature (GEOS through GDAL, as shapely's buffer): circles around...vector.calcAttributes computed for every feature from a script over the others, as QGIS's field calculator, in map...vector.clipFeatures cut to the area of a mask (the union of its polygons; GEOS through GDAL, as geopandas' clip):...vector.densityThe density of points on a map's grid, as ArcGIS's Kernel Density or QGIS's Heatmap: each point (its...vector.dissolveFeatures merged (GEOS's union through GDAL, as geopandas' dissolve): all into one, or one per value of an...vector.distanceThe distance (in the map's units) from every cell's centre to the nearest cell of the features (as...vector.exact_sumThe coverage-weighted sum of a map (or of every layer of a stack) over every polygon, exactextractr's...vector.extractThe values of a map (or of every layer of a stack) at points, landschaft's extract: the cell holding each...vector.filterThe features where an expression over their attributes is true, as QGIS's Select by Expression or...vector.from_tablePoints from a table's columns of coordinates, as QGIS's Create Points Layer from Table or geopandas'...vector.geometryThe measures of every feature's geometry as attributes, as QGIS's Add Geometry Attributes: the area and...vector.grid_zonesSquare zones tiling a map, as landschaft's grid_zones: squares of a side (map units) from the map's...vector.joinA table's columns as attributes of features: every feature takes the row whose key column equals its...vector.overlayTwo layers of polygons overlaid, as geopandas' overlay or QGIS's Intersection, Union and Difference (GEOS...vector.pointsPoints inside polygons, as QGIS's Random Points Inside Polygons and Regular Points: `random`, n points in...vector.polygonizeA map of classes as polygons, as gdal_polygonize (GDALPolygonize): a polygon (with its holes) per patch,...vector.rasterizeBurn vector features into the grid of a map, as GDAL's rasterizer (landschaft's rasterize): the cells...vector.readVector features from a file GDAL reads (GeoPackage, Shapefile, GeoJSON, FlatGeobuf, KML...): their...vector.reprojectFeatures in another coordinate system, their coordinates transformed by PROJ through GDAL (as geopandas'...vector.spatial_joinThe features of a layer joined to those of another where they meet, as geopandas' sjoin or QGIS's Join...vector.writeWrite vector features to a file by GDAL, its format by the extension (gpkg by default; shp, geojson, fgb,...vector.zonalStatistics of a map (or of every layer of a stack) in every polygon, landschaft's zonal_stats: each...
Habitat patterns 6
landscape.accountingThe foreground's objects in size classes, as GuidosToolbox's Accounting: every object labelled, measured...landscape.contortionContortion, as GuidosToolbox: how contorted the boundary of each patch of foreground is (the turns of its...landscape.mspaMorphological Spatial Pattern Analysis (Soille & Vogt 2009), as GuidosToolbox computes it: the foreground...landscape.mspa_tiledMSPA of a map larger than memory by overlapping tiles, GuidosToolbox's MSPA Tiling as landschaft's...landscape.parcellationParcellation, as GuidosToolbox: the patches (parcels) of every class of a map, and per class and for the...landscape.spaSimplified Pattern Analysis, as GuidosToolbox computes it: a coarser, faster MSPA of the 8-connected...
Fragmentation 9
fragmentation.clusteringForeground area clustering (FAC) in a moving window, as GuidosToolbox (SpatCon's rule 76): the share (%)...fragmentation.contagionContagion (Pff) in a moving window, as GuidosToolbox (SpatCon's rule 77): the share (%) of the...fragmentation.entropySpatial joint entropy of the whole map, as GuidosToolbox: how mixed the pairs of neighbouring cells are,...fragmentation.entropy_mapSpatial joint entropy in a moving window, as GuidosToolbox's batch: for each cell the entropy (%) of the...fragmentation.fadForest Area Density, as GuidosToolbox computes it: the share (%) of foreground in a square window around...fragmentation.fad_multiscaleForest Area Density at several observation scales, as GuidosToolbox's FAD-MS: the density (%) in windows...fragmentation.fosFragmentation at a Fixed Observation Scale, as GuidosToolbox's FOS: for each foreground cell the...fragmentation.gray_convolutionA moving window over a % cover (0-100; above 100 or without a value missing), as GuidosToolbox's...fragmentation.landscape_mosaicThe landscape mosaic, as GuidosToolbox (SpatCon's rule 7): for each cell the mix of agriculture, natural...
Landscape metrics 12
metrics.classLandscape metrics of every class, as landscapemetrics and FRAGSTATS: area, share (pland), patches, edge...metrics.clusterGroups of landscapes or zones with similar metrics (landschaft's SpatialSignatureAnalysis.cluster):...metrics.clustergramClusters for a range of k (Schonlau's clustergram, landschaft's SpatialSignatureAnalysis.clustergram): for...metrics.correlationThe correlation between the metrics of a table (its columns, over its rows), as landscapemetrics'...metrics.landscapeLandscape metrics of the whole map, as landscapemetrics and FRAGSTATS: diversity (shdi, sidi...),...metrics.nmfNon-negative factors of spatial signatures (landschaft's SpatialSignatureAnalysis.nmf): each metric scaled...metrics.patchLandscape metrics of every patch (the cells of a class connected to one another), as landscapemetrics and...metrics.pcaThe principal components of spatial signatures (landschaft's SpatialSignatureAnalysis.pca): the metrics as...metrics.sampleLandscape metrics of sample plots, as landscapemetrics' sample_lsm and scale_sample: squares or circles...metrics.seriesLandscape metrics along a series of maps (a layer per date), as pylandstats' SpatioTemporalAnalysis in...metrics.signaturesSpatial signatures, as pylandstats' SpatialSignatureAnalysis in landschaft: landscapes described by their...metrics.windowLandscape-level metrics in a moving window, as landscapemetrics' window_lsm: for every cell, the metrics...
Habitat networks 29
conn.centralityThe centralities of every node (Makurhini's MK_RMCentrality): degree (or strength), eigenvector,...conn.componentsThe component (1, 2...) of every node: the groups of nodes joined by links at the distance.conn.connectivity_gridConnectivity per cell of a grid over a region (Makurhini's MK_Connect_grid, landschaft's...conn.distancesThe distances between the patches of a raster or between features (landschaft's distance_table,...conn.eca_changeThe change of the equivalent connected area (ECA) from graph to graph, e.g. the habitat of several ...conn.eca_change_gridThe change of ECA per cell of a grid between consecutive times (Makurhini's MK_dECA_grid, landschaft's...conn.focal_nodesThe importance of every node in its neighbourhood (Makurhini's MK_Focal_nodes, landschaft's focal_nodes):...conn.graphA habitat graph (landschaft's HabitatGraph): nodes with an attribute (an area, a quality) and the...conn.graph_from_rasterA habitat graph of the patches of a raster (landschaft's HabitatGraph.from_raster): the nodes' attributes...conn.graph_from_samcA habitat graph of settlement probabilities (landschaft's HabitatGraph.from_samc, Makurhini's MK_dPCIIC...conn.graph_from_vectorA habitat graph of vector features (landschaft's HabitatGraph.from_vector): the nodes' attributes and the...conn.link_changeThe change of IIC or PC when pairs change (Conefor's link change): new links or lost ones, distances or...conn.link_importanceEvery link's importance (Conefor's link removal): the share of IIC or PC lost without it.conn.make_gridA grid of hexagons (sf's st_make_grid) or squares of a given area over a region (Makurhini's make_grid):...conn.metapopulationA metapopulation in a network of habitat patches over time, Hanski's incidence function model as R's...conn.node_importanceEvery node's importance (Conefor's dI, Makurhini's MK_dPCIIC): the share of each index lost without it and...conn.nodesThe nodes of a habitat graph from a raster of patches or from features (landschaft's node_table,...conn.overallA habitat graph's connectivity (Conefor's indices, Makurhini's MK_dPCIIC overall): A, NC (components), NL...conn.protconnSaura's ProtConn (Makurhini's MK_ProtConn, landschaft's protconn): the share of a region protected and...conn.protconn_rasterProtConn of a raster of protected areas (landschaft's protconn_raster): its patches inside the region (the...conn.protconn_regionsProtConn for every region of several (landschaft's protconn_regions): conn.protconn's indicators with a...conn.read_coneforA habitat graph from Conefor Sensinode's files: the node file (an id and an attribute per line) and the...conn.settlement_probabilitiesThe probabilities of settling between habitat nodes (landschaft's settlement_probabilities, the samc...conn.to_mapPer-node values on the patches of a graph made from a raster (landschaft's HabitatGraph.to_raster): every...conn.to_vectorA table of nodes joined onto the features of a graph made from them (landschaft's...conn.write_coneforA habitat graph written as Conefor Sensinode's node and connection files (the pairs with a value).networks.coneforThe habitat network of an MSPA map as Conefor Sensinode's inputs, as GuidosToolbox's nw_cs22 (landschaft's...networks.gtn_componentsThe components of the habitat network of an MSPA map, as GuidosToolbox's nw_components (landschaft's...networks.gtn_importanceThe importance of every link (bridge) and stepping-stone node (core with two links or more) of the habitat...
Circuit connectivity 8
circuit.advancedCurrents and voltages of a raster circuit with sources and grounds, Circuitscape 6.1's advanced mode...circuit.circuitscape_iniRun a Circuitscape INI file on rasters, as Circuitscape.compute(path) does (landschaft's...circuit.network_advancedCircuitscape's advanced mode on a network (data_type = network; landschaft's...circuit.network_pairwiseCircuitscape's pairwise mode on a network (landschaft's circuitscape_network_pairwise): the effective...circuit.omniscapeOmnidirectional connectivity with Omniscape's moving-window circuits (Omniscape 0.7 through landschaft's...circuit.omniscape_iniRun an Omniscape INI file, as run_omniscape(path) does (landschaft's omniscape_ini): every option of...circuit.one_to_allCircuitscape's one-to-all (or all-to-one) mode on rasters (landschaft's circuitscape_one_to_all): for...circuit.pairwiseCircuitscape's pairwise mode on rasters (landschaft's circuitscape_pairwise): the effective resistance...
Surface metrics 20
surface.aacfThe areal autocorrelation function of a surface, geodiv's aacf: 1 at zero lag in the centre; on the...surface.bearingThe bearing area (Abbott-Firestone) curve of a surface, geodiv's bearing_area: the share of the surface at...surface.curvatureA curvature of a surface (spatialEco's curvature): planform, profile, total, McNab's or Bolstad's.surface.dissectionMartonne's dissection (spatialEco's dissection): (z - min) / (max - min) in a window.surface.fit_planeThe trend of a surface: geodiv's least-squares polynomial of an order (0-6), or the best of order 0-3 (the...surface.geomorphonsLandforms of a DEM by geomorphons (Jasiewicz & Stepinski 2013), GRASS's r.geomorphon (8.4) bit for bit...surface.gravityGravitational interaction potential of source cells, Dinamica EGO's CalcInteractionPotentialMap...surface.hilltopHilltops as permanent protection areas (APP de topo de morro, Lei 12.651/2012, art. 4, IX), landschaft's...surface.hliThe heat load index (McCune & Keon's equations, spatialEco's hli) from the aspect and the slope; the...surface.hspThe hierarchical slope position (spatialEco's hsp): the TPI summed over windows of growing scale.surface.metricsSurface metrics of a continuous raster (an elevation, a canopy height, an NDVI...), ISO 25178 as the R...surface.peaksThe peaks (or valleys) of a surface, geodiv's findpeaks: the cells higher (lower) than their 8 neighbours;...surface.spherical_sdThe spherical standard deviation of the surface's normals in a window (spatialEco's spherical.sd), or...surface.srrThe surface relief ratio (spatialEco's srr): (mean - min) / (max - min) in a window.surface.terrainSlope or aspect of a surface as terra::terrain (Horn's 8 or 4 neighbours), through landschaft's C++; no...surface.tpiThe topographic position index (spatialEco's tpi): each cell's value less the mean of a window around it...surface.traspThe transformed aspect (spatialEco's trasp): (1 - cos(aspect - 30°)) / 2, from 0 (north-northeast) to 1.surface.triThe terrain ruggedness index (spatialEco's tri) in an odd window of cells.surface.vrmThe vector ruggedness measure (spatialEco's vrm): 1 less the length of the summed unit normals of a window...surface.windowSurface metrics in a moving window around every cell (landschaft's surface.window_metrics through its...
Terrain hydrology 21
hydro.along_networkThe stretches of river up and down from every point within a distance along the network, as hydrographr's...hydro.breachRemove the depressions of a DEM by cutting channels through their rims (least-cost breaching,...hydro.centralityThe place of every link in its river network, as hydrographr's get_centrality on the graph of the links:...hydro.connectivity_indexThe index of connectivity (Borselli et al. 2008) as InVEST's sediment delivery ratio model computes it:...hydro.dciThe dendritic connectivity index of a river network cut by barriers (Cote et al. 2009), as R's riverconn:...hydro.distance_to_channelThe mean distance water travels from each cell to a stream along pygeoprocessing's multiple flow...hydro.fillFill the depressions of a DEM so that water flows from every cell to the edge: each depression raised to...hydro.flow_accumulationThe area that drains through each cell (itself included): all to the steepest neighbour (d8), split...hydro.flow_directionThe direction each cell drains to: D8 (O'Callaghan & Mark 1984) as ESRI's codes (1 E, 2 SE, 4 S, 8 SW, 16...hydro.handHeight Above the Nearest Drainage (HAND; Rennó et al. 2008, Nobre et al. 2011): the height of each cell...hydro.network_distanceThe distance along the river network between every two points, as hydrographr's get_distance: down the D8...hydro.snapPoints moved onto the stream network, as hydrographr's snap_to_network: gauges, dams, records of fish each...hydro.spiStream power index a x tan(slope) (Moore, Grayson & Ladson 1991), WhiteboxTools' StreamPowerIndex: the...hydro.stiSediment transport index (m + 1) (a / 22.13)^m (sin(slope) / 0.0896)^n (Moore & Burch 1986),...hydro.stream_linksThe links of a stream network: the stretches between sources, junctions and outlets along the D8...hydro.streamsThe stream cells: those whose flow accumulation is at least a threshold; or, with the DEM and trace,...hydro.twiTopographic wetness index ln(a / tan(slope)) (Beven & Kirkby 1979), WhiteboxTools' WetnessIndex: high...hydro.upstreamThe land upstream of every link of a stream network, or of every point on it, summarised, as hydrographr's...hydro.upstream_catchmentThe catchment of every point (a gauge, a dam, a site), as hydrographr's get_upstream_catchment: all the...hydro.watershedsThe area draining to each seed: every cell labelled with the first seed below it along the D8 directions...swat.runSimulate a SWAT+ project (a TxtInOut folder or a zip of one) as SWAT+ 62.0.1 does, through landschaft's...
Grid distances 17
cost.acc_costThe accumulated cost from the nearest origin over a transition of conductances (gdistance's accCost...cost.areasArea transitions of a map of categories (gdistance's transition(x, "areas")): one per category k (1, 2,...cost.barriersBarrier transitions of a map (gdistance's transition(x, "barriers")): each marks with 1 (as resistances)...cost.combineTwo transitions on the same grid added, subtracted or multiplied connection by connection (gdistance's...cost.commute_distanceThe expected commute distances of a random walk between points (gdistance's commuteDistance through...cost.distanceThe least costs between points over a transition of conductances (gdistance's costDistance through...cost.geo_correctionA transition corrected for the distances between cells' centres (gdistance's geoCorrection through...cost.mahalThe Mahalanobis transition of a stack of maps (gdistance's transition(brick, "mahal")): for every pair of...cost.mathA function of a transition's values on its connections (landschaft's Transition.map, R's maths to the...cost.normalizeA transition normalised (gdistance's normalize): each row divided by its sum (the probabilities of a...cost.passageThe passages of a random walk from origins to goals through every cell (gdistance's passage through...cost.path_incThe overlap and non-overlap of the routes from a common origin to each location (gdistance's pathInc...cost.rsp_distanceRandomised-shortest-path distances between points (gdistance's rSPDistance through landschaft's C++): the...cost.shortest_pathThe least-cost paths from an origin to goals over a transition of conductances (gdistance's shortestPath...cost.sum_reciprocalTwo transitions of conductances as resistances in series (gdistance's sumReciprocal): 1 / (1/a + 1/b) on...cost.to_mapA map of each cell's connections (gdistance's raster() of a TransitionLayer): sums or means of the...cost.transitionA transition between neighbouring cells (gdistance's transition through landschaft's C++): the connection...
Distance & restoration 16
distance.euclideanThe Euclidean distance to the foreground's edge, as GuidosToolbox: in cells, positive inside the...distance.influence_zonesThe zones of influence of the foreground objects, as GuidosToolbox's Distance -> Influence Zones...distance.objects_proximityThe proximity between neighbouring foreground objects, as GuidosToolbox's Distance -> Proximity...distance.proximityThe distance from every cell to the nearest cell of some values (gdal_proximity), in the units of the...restoration.corridorThe gain of restoring the least-cost corridor between two areas, as GuidosToolbox's Restoration Planner...restoration.cost_distanceThe accumulated cost of travelling from the sources across a resistance, as GuidosToolbox (landschaft's...restoration.ecosystem_areasThe ecosystems' (ecoregions') natural area now and before conversion and what restoring a cell gives them:...restoration.ecosystem_targetsShare a restoration target among ecosystems for the least risk of collapse (the targets per ecosystem of...restoration.intactnessEcological intactness (Beyer et al. 2020), as Strassburg et al. (2020) compute it: the habitat's quality q...restoration.intactness_gradientHow much the total ecological intactness grows per unit of each cell restored (its derivative): restoring...restoration.isochroneThe isochrone map of GuidosToolbox's Restoration Planner (landschaft's isochrone_map and isochrone_map_ab,...restoration.least_cost_pathThe least-cost path between two areas across a resistance, as GuidosToolbox (landschaft's...restoration.original_vegetationThe original vegetation of converted land (Strassburg et al. 2020): for every cell with anthropic land,...restoration.planRestoration planning (Strassburg et al. 2020): how much of every converted cell to restore for the most...restoration.resistanceA resistance growing with the distance to the habitat, as GuidosToolbox's Setup Tools -> Distance ->...restoration.statusHow connected the habitat is and how much reconnecting it could add, as GuidosToolbox's Restoration Status...
Change detection 16
change.componentsThe components of the difference between two maps of classes (Pontius & Santacruz 2014, diffeR's...change.compositeThe cross-tabulation of two maps at a coarser resolution by the composite method (diffeR's composite...change.countHow many times each cell changed along a series of maps of classes (OpenLand's acc_changes through...change.crosstabThe transition matrix between two maps of classes (landschaft's crosstab, diffeR's crosstabm): the cells...change.fadThe change of fragmentation between two dates measured by FAD at several scales, as GuidosToolbox's Change...change.fosThe change of fragmentation between two FOS maps (fragmentation.fos, or FAD) of the same windows, as...change.intensityThe intensity analysis of land change (Aldwaik & Pontius 2012) as OpenLand's intensityAnalysis through...change.madThe mean absolute deviation between two continuous maps and its components (diffeR's MAD through...change.membershipsThe share of each class in each block of factor x factor cells (diffeR's memberships through landschaft:...change.morphologicalMorphological change detection, as GuidosToolbox: the change of the foreground between two dates told...change.mosaicThe change of the landscape mosaic's heatmap between two dates, as GuidosToolbox's Change -> Landscape...change.resolutionsThe quantity, exchange and shift differences between two maps at coarser and coarser resolutions (diffeR's...change.sample_to_populationA sample's cross-tabulation scaled to the population of each row's class (diffeR's sample2pop through...change.simpleThe change of the foreground between two dates, as GuidosToolbox: 11 stable background, 12 gain, 21 loss,...change.suggestThe transitions worth modelling, from the first map of a series to the last: every change of a class to...change.transitionsThe transitions of a series of maps of classes, as landschaft's changes (OpenLand's contingencyTable):...
Map accuracy and area 3
accuracy.assessThe accuracy and the area of a map's classes from a stratified random sample labelled with the reference...accuracy.sampleA stratified random sample of a map's cells for its accuracy and area (Olofsson et al. 2014): in every...accuracy.sample_sizeThe size of a stratified random sample for the accuracy and the area of a map, and its share of each...
Spatial statistics 7
stats.getis_ordGetis and Ord's Gi* of every cell (PySAL's esda.G_Local with star and row-standardised weights, to...stats.idwInverse distance weighting of points onto a map, as R's gstat (idw, to rounding): every cell the mean of...stats.krigingOrdinary kriging of points onto a map, as R's gstat (krige, to rounding): every cell the best linear...stats.lisaThe local Moran's I of every cell (Anselin's LISA; PySAL's esda.Moran_Local, to rounding): how much it and...stats.moranThe global Moran's I of a map (PySAL's esda.Moran, to rounding): how much neighbouring cells are alike,...stats.trendThe monotonic trend of every cell along a series of maps (pymannkendall's original_test, the same...stats.variogramThe sample variogram of points and a model fitted to it, as R's gstat (variogram and fit.variogram, to...
Large data & batch 1
batch.runAn operator run on many rasters in parallel (landschaft's batch, GuidosToolbox's Batch Process): each...
Neutral landscape models 19
nlm.binarizeHabitat (2) and matrix (1) of a map (NLMR's util_binarize): the share of habitat given, the cells with the...nlm.classifyClasses 1, 2... of a map (NLMR's util_classify): by the weights, each class's share of the cells (the...nlm.curdsA hierarchical binary map (NLMR's nlm_curds, curdling): at each level every cell splits into steps x steps...nlm.distance_gradientThe distance of every cell to a rectangle of cells (NLMR's nlm_distancegradient). As NLMR's (the default):...nlm.edge_gradientA gradient that peaks in the middle of the map and falls to its edges along a direction (NLMR's...nlm.fbmA fractal surface from 0 to 1 (NLMR's nlm_fbm, fractional Brownian motion): rough for a small fractal...nlm.gaussian_fieldA smooth random surface from 0 to 1 (NLMR's nlm_gaussianfield): a Gaussian field whose autocorrelation...nlm.mergeLandscapes merged (NLMR's util_merge): the primary plus the sum of the secondary ones times the scaling,...nlm.mosaic_fieldA mosaic random field (NLMR's nlm_mosaicfield, spatstat's rMosaicField): the sum of n mosaics, each a...nlm.mosaic_gibbsA Voronoi mosaic of classes from germs kept apart (NLMR's nlm_mosaicgibbs): spatstat's rSSI germs at least...nlm.mosaic_tessA Voronoi mosaic of random values (NLMR's nlm_mosaictess): random germs (sf's st_sample), a uniform value...nlm.mpdA fractal surface by midpoint displacement (NLMR's nlm_mpd, the diamond-square algorithm): each step...nlm.neighA map of categories grown by neighbourhood (NLMR's nlm_neigh): cells are filled one at a time, with the...nlm.percolationA random binary map (NLMR's nlm_percolation): each cell is 1 with the probability given (a uniform draw...nlm.planar_gradientA linear gradient across the map along a direction (NLMR's nlm_planargradient): eastness times the column...nlm.randomSpatially random values (NLMR's nlm_random): a uniform draw for every cell, by column as R fills a matrix....nlm.random_clusterA map of patches of classes 1, 2... (NLMR's nlm_randomcluster, Saura & Martínez-Millán 2000): a share p of...nlm.random_rectangular_clusterOverlapping rectangles of random values (NLMR's nlm_randomrectangularcluster): rectangles with sides from...nlm.rescaleA map rescaled to 0-1 (NLMR's util_rescale): (x - min) / (max - min), all 0 when the minimum and maximum...
Biodiversity analysis 14
bio.clusterBiodiverse's cluster analysis (landschaft's cluster): groups joined pair by pair by the dissimilarity of...bio.h3A basedata of lon/lat records in H3 cells (landschaft's BaseData.from_h3): the groups the centres of the...bio.hexA basedata of records in a grid of hexagons (landschaft's BaseData.from_hex): the groups the centres of...bio.matrixA label matrix from a Biodiverse matrix file (landschaft's read_matrix): full or a triangle (the element...bio.occurrencesA basedata of occurrence records (landschaft's BaseData.from_occurrences and read_occurrences): a GBIF...bio.pointsA basedata of point records read like Biodiverse's feature import (landschaft's BaseData.from_points):...bio.propertiesLabel or group properties of a basedata from a Biodiverse properties file (landschaft's read_properties...bio.randomiseRandomisations of a spatial analysis (landschaft's randomise, Biodiverse's): each iteration randomises the...bio.rasterA basedata of rasters read like Biodiverse's raster import (landschaft's BaseData.from_raster): each layer...bio.region_growerBiodiverse's region grower (landschaft's region_grower): pairs of groups joined in decreasing order of an...bio.spatialBiodiverse's spatial analysis (landschaft's spatial_analysis): its indices over the neighbourhood of every...bio.tableA basedata of a delimited text file read like Biodiverse's import (landschaft's BaseData.from_table):...bio.treeA phylogenetic tree of a Newick or Nexus file read as Biodiverse reads it (landschaft's read_tree):...bio.vectorA basedata of vector features read like Biodiverse's feature import (landschaft's BaseData.from_vector):...
Spatial prioritization 20
prioritize.actionsMulti-action planning as a mixed integer program (Salgado-Rojas et al. 2020): which planning units to...prioritize.actions_rasterMulti-action planning on rasters (landschaft's actions_raster_data): the planning units are the cells with...prioritize.adjacency_matrix1 for every two adjacent planning units (landschaft's adjacency_matrix): cells with data sharing an edge...prioritize.binary_stackA 0/1 layer per zone from a map of zone numbers (landschaft's binary_stack), for the locked-in constraints...prioritize.boundary_matrixThe length of the boundary every two planning units share, and every unit's perimeter on the diagonal...prioritize.calibrateThe calibration of trade-offs (Hanson et al. 2025): candidate solutions of a problem (given as to...prioritize.coarsenA problem's rasters on blocks of factor x factor cells (landschaft's coarsen, for continental problems:...prioritize.connectivity_matrixThe connectivity of adjacent planning units (landschaft's connectivity_matrix): the length of their shared...prioritize.decay_connectivityConnectivity from the distances between planning units as a dispersal probability (landschaft's...prioritize.evaluateThe evaluation of a solution (Hanson et al. 2025): the units selected, their cost and boundary; how much...prioritize.h3_unitsH3 hexagons as planning units, as landschaft's h3_units: the hexagons of an H3 resolution that cover a...prioritize.marxanMarxan 4: reserves that meet the features' targets at the least cost and boundary, by simulated annealing...prioritize.optimizeSystematic conservation planning as an integer linear program (Beyer et al. 2016; Hanson et al. 2025): a...prioritize.protected_cellsThe selected cells of a solution on raster planning units (landschaft's protected_cells): 1 where more...prioritize.proximity_matrix1 for every two planning units within a distance of each other (landschaft's proximity_matrix): cell...prioritize.proxirrProxIRR irreplaceability (Baisero et al. 2022), the bits of R's proxirr: for every feature in a unit alpha...prioritize.refineA selection on coarse blocks (of a prioritize.coarsen-ed problem) back on the fine grid (landschaft's...prioritize.unit_pointsA point per planning unit (landschaft's unit_points): the centre of every cell of a map, or a point inside...prioritize.zonationZonation 5's priority ranking (Moilanen et al.), the same rank map as the z5 binary: cells removed one...prioritize.zonation_projectA Zonation 5 project run as the z5 binary runs it (landschaft's run_project): the settings file (.z5), its...
Species distributions 34
sdm.accessible_areaThe area the species could have reached, where its background is drawn (landschaft's accessible_area, the...sdm.area_of_habitatThe area of habitat of species (Brooks et al. 2019; Strassburg et al. 2020): over the cells of each...sdm.autocorrelation_rangeThe range of spatial autocorrelation of the predictors (landschaft's autocorrelation_range, blockCV's...sdm.backgroundBackground points for a species distribution model (landschaft's background, dismo's randomPoints): cells...sdm.bias_surfaceThe sampling effort as a surface (landschaft's bias_surface): a Gaussian kernel density of the records of...sdm.boyceThe continuous Boyce index (landschaft's boyce, ecospat's ecospat.boyce): the correlation between the...sdm.buffer_foldsBuffered leave-one-out folds (blockCV's cv_buffer): for every presence (or record) the records farther...sdm.checkerboard_foldsA checkerboard of the predictors' cells aggregated by a factor (ENMeval's checkerboard1) or two...sdm.clean_occurrencesOccurrence records with suspicious coordinates flagged or dropped (landschaft's clean_occurrences,...sdm.datasetThe records of a species distribution model (landschaft's dataset): presences (or a table with a y,...sdm.download_gbifOccurrence records of a species from GBIF (landschaft's download_gbif, the occurrence search API, no...sdm.evaluateHow well predictions separate presences from the background (landschaft's evaluate, dismo's): AUC, the...sdm.exdetMesgaran's extrapolation detection (landschaft's exdet): NT1, below 0 where a predictor falls outside the...sdm.fitA species distribution model with cross-validation (landschaft's fit): MaxNet (the default), a GLM...sdm.importanceThe permutation importance of a model's predictors (landschaft's importance): the mean drop of AUC over...sdm.jackknife_foldsJackknife folds (ENMeval's): every presence its own fold; background 0.sdm.maxnetA MaxNet species distribution model (landschaft's MaxNet, the maxnet package): Maxent as a lasso logistic...sdm.maxnet_predictA model's predictions (maxnet's predict, the others' predict_proba): the suitability of every cell of a...sdm.messElith's multivariate environmental similarity surface (landschaft's mess, dismo's): per predictor the...sdm.migrateA species' dispersal through the habitat suitability of successive periods (MigClim 1.6's cellular...sdm.mopThe mobility-oriented parity of new conditions (landschaft's mop, the mop package): the mean distance of...sdm.omission_rateThe share of test presences predicted below the training presences' minimum (mtp) or 10th percentile (p10,...sdm.one_per_cellA record per cell of a raster (landschaft's one_per_cell): the first in each cell, those outside the...sdm.prepareThe preparation of a species distribution model in one node (landschaft's prepare): the records cleaned...sdm.quadrant_foldsThe four quadrants of the presences (ENMeval's block partition): near-equal counts split along the...sdm.random_foldsRandom folds of the presences (landschaft's random_folds, ENMeval's randomkfold): k groups of near-equal...sdm.reference_dataThe geographic reference data of the cleaning of records (landschaft's reference_data):...sdm.response_curvesA model's response curves (landschaft's response_curves): each predictor over its range in the records,...sdm.select_predictorsPredictors without collinearity (landschaft's select_predictors, usdm's vifcor and vifstep): the most...sdm.spatial_blocksSpatial blocks (blockCV's cv_spatial): the records in hexagons or squares of a size (or rows and columns),...sdm.spatial_clustersSpatial or environmental clusters (blockCV's cv_cluster): R's kmeans of the records' coordinates, or of...sdm.thinOccurrence records thinned (landschaft's thin, spThin's thin.algorithm): records dropped at random until...sdm.thresholdA threshold of suitability from presences and background (landschaft's threshold, dismo's): max_spec_sens...sdm.vifThe variance inflation factor of every predictor (landschaft's vif, usdm's vif): 1 / (1 - R^2) of its...
Animal movement 27
move.aeqd_crsAn azimuthal equidistant projection centred on the tracks (move2's mt_aeqd_crs): distances and directions...move.as_tracksTracks from points or a table of locations (move2's mt_as_move2, landschaft's as_tracks): ordered by track...move.azimuthThe direction of each step, clockwise from north (move2's mt_azimuth): the geodesic azimuth on the...move.distanceThe distance from each location to the next of its track (move2's mt_distance, the same numbers): on the...move.distributionA distribution of step lengths or turn angles (amt's make_distribution): gamma (shape, and scale or rate),...move.extract_covariatesThe values of rasters at locations, or at the ends or starts of steps (amt's extract_covariates): the...move.filter_min_n_burstThe bursts (move.resample) of at least min_n locations (amt's filter_min_n_burst).move.filter_movebank_visibleThe tracks without the locations Movebank hides (move2's mt_filter_movebank_visible): those of the column...move.filter_per_intervalOne location per time interval of each track (move2's mt_filter_per_interval): the intervals of...move.filter_uniqueThe tracks without duplicated times within a track (move2's mt_filter_unique and mt_unique). criterion...move.fit_distributionA distribution fitted to step lengths or turn angles (amt's fit_distr, the same numbers): gamma by maximum...move.interpolateLocations at given times between the recorded ones (move2's mt_interpolate). Without times, the records...move.nsdThe net squared displacement: the squared distance of each location from the first of its track (amt's...move.random_numbersDraws of a distribution of steps (amt's random_numbers), from R's generator after set.seed(seed): amt's...move.random_stepsEach observed step with n_control random steps from its start (amt's random_steps, the same steps): the...move.read_tracksAnimal tracks from a Movebank file (move2's mt_read, landschaft's load_tracks): the CSV files Movebank...move.resampleLocations at a regular rate, in bursts (amt's track_resample, the same locations and bursts): from the...move.segmentsThe step from each location to the next of its track as a line (move2's mt_segments): one feature per...move.simulate_brownianTracks of Brownian motion (move2's mt_sim_brownian_motion): each step moves by normal draws of standard...move.speedThe speed of each step: the distance over the time lag (move2's mt_speed). Locations of a track must not...move.stepsThe steps between consecutive locations of each track (amt's steps and steps_by_burst, the same numbers),...move.time_lagsThe time from each location to the next of its track (move2's mt_time_lags), exact between datetimes...move.time_of_dayDay or night at each location, or at the end or start of each step (amt's time_of_day): sunrise and sunset...move.track_dataOne row per track (in the order they appear) with the columns whose value does not change within a track...move.track_linesEach track as a line through its locations in time order (move2's mt_track_lines): one feature per track,...move.track_summaryamt's summaries of each track, a line per track (move.track_lines's, with n_locations and the track's...move.turn_angleThe change of direction at each location, in [-pi, pi) (move2's mt_turnangle): the azimuth of the step...
Ecosystem services 7
services.carbonCarbon storage of a landscape and its change between two land use maps: InVEST's carbon model...services.habitat_qualityHabitat degradation, quality and rarity: InVEST's habitat quality model (natcap.invest 3.20) bit for bit,...services.ndrNutrient export and retention: InVEST's nutrient delivery ratio model (natcap.invest 3.20) bit for bit,...services.pollinationCrop pollination by wild bees: InVEST's pollination model (natcap.invest 3.20) bit for bit, through...services.sdrSediment export, deposition and retention: InVEST's sediment delivery ratio model (natcap.invest 3.20),...services.seasonal_water_yieldQuickflow, local recharge and baseflow: InVEST's seasonal water yield model (natcap.invest 3.20) bit for...services.water_yieldAnnual water yield, consumption and hydropower: InVEST's annual water yield model (natcap.invest 3.20) bit...
Carbon and REDD+ 6
carbon.emissionsThe carbon emitted and removed by land change over a series of maps (the IPCC's stock-difference method):...redd.allocateVT0007's allocation (UDef-ARP's prediction): the fitted relative frequency of every modelling region (a...redd.assessVT0007's assessment of an allocation (UDef-ARP's model evaluation): the predicted and the actual...redd.fitVT0007's fit of a vulnerability map to a period's deforestation (UDef-ARP's fitting): the relative...redd.nrtVT0007's negligible risk threshold (UDef-ARP's nrt_calculation): the distance to the forest's edge below...redd.vulnerabilityVT0007's vulnerability map in classes of geometric widths (UDef-ARP's geometric classification): the...
Forest Code (Brazil) 2
forest_code.appThe Áreas de Preservação Permanente of Brazil's Forest Code (Lei 12.651/2012, art. 4): the margins of...forest_code.reserveThe balance of every rural property's Reserva Legal (Lei 12.651/2012): the share of its area it must keep...
Machine learning 5
ml.fitA random forest or a histogram gradient boosting fitted to records (scikit-learn's RandomForestClassifier...ml.importanceThe permutation importance of each predictor of a fitted model (scikit-learn's permutation_importance, the...ml.partial_dependenceHow a fitted model's prediction follows a predictor (scikit-learn's partial_dependence, its brute method):...ml.potentialThe potential of each class from a model per class (landschaft's Estimator with scikit-learn's...ml.predictA fitted model (ml.fit, ml.potential) on maps or on the rows of a table: the value, or the class of the...
Land change simulation 46
agents.mapAn attribute of the agents painted on their parcels: each cell takes the value of the agent whose `id` is...agents.parcelsAn agent per parcel of a map of parcel ids (its cells sharing an id): the columns `id` and `cells` (its...agents.summaryThe number of agents and the sum and mean of each attribute (a row), to collect along a loop.agents.tableAgents from a table written in the model (macro agents: countries, markets): `agents` is a list of objects...agents.updateThe agents' behaviour at a step: `rules`, lines `attribute = expression` applied in order (each line sees...cars.stepOne step of PLUS's CARS: iterations from the current map until every class has the cells of the step's...clumondo.agesThe years each cell has had its land system at the start: the given map (missing cells counted 1), or...clumondo.stepOne year of CLUMondo: the suitability of each land system (logistic regressions in floats, or given maps)...crafty.allocateOne step of CRAFTY's competition for land between agent functional types (AFTs): production of services...demand.from_mapsThe cells of each class at each step, interpolated and extrapolated linearly from observed maps (lulcc's...demand.regionalA demand per region (municipalities, biomes, basins...): each region's cells meet its own demand, cells of...demand.tableA demand given as a table: `classes` and one row of cells per step (the first the start).dinamica.continuous_patcherDinamica EGO's Patcher of a continuous state (PatcherContinuousState), landschaft's ContinuousPatcher: new...dinamica.cost_mapThe cost of reaching every cell from the nearest source over a friction surface, Dinamica EGO's...dinamica.destinationsCells drawn by attraction in quadrants of a map, Dinamica EGO's CalcDestinationMap (landschaft's...dinamica.pathwaysPaths from source cells to a network, Dinamica EGO's CalcPathwayMap (landschaft's pathways): from each...dinamica.roadsA step of endogenous road building, Dinamica EGO's road constructor (landschaft's RoadBuilder.step): the...dinamica.stepOne step of Dinamica's Expander and Patcher: the changes of each transition (its rate per step times the...dynamic.distance_toThe distance from each cell to the nearest cell of some classes (exact Euclidean distance between cell...dynamic.share_ofThe share of the cells around each cell that hold some classes (the mean of the window's weights x...futures.calibrateThe calibration of FUTURES' patches (r.futures.calib through landschaft's calibrate_patches): the patches...futures.devpressureThe development pressure of each cell (r.futures.devpressure through landschaft): the sum over the...futures.patch_libraryThe sizes of the patches developed between two maps (r.futures.calib's patch library through landschaft):...futures.simulationFUTURES' patch growing (r.futures.simulation): at every step each subregion develops its demand in patches...glm.coefficientsLogistic regressions given in the model: per class, its drivers and coefficients (the intercept first), as...glm.fitLogistic regression of the presence of each class on the drivers (lulcc's glmModels, R's glm.fit operation...glm.predictThe probability of each class in every cell from fitted logistic regressions (NaN where a driver, or the...lulcc.historyThe steps each cell has had its class at the start (lulcc's hist): the given map, missing cells counted 1,...lulcc.stepOne step of a CLUE-S or ordered allocation (lulcc's allocate): the elasticity of each cell's class (CLUE),...markov.fitA Markov chain of land change from two maps: the transition probabilities of the period (cells of each...markov.matrixA Markov chain given in the model: the transition probabilities of a period over `steps` steps (rows the...molusce.stepOne iteration of MOLUSCE's Simulator: every cell is predicted the transition of largest total weight (or...molusce.totalMOLUSCE's total weight of each transition: per transition, the sum over the drivers of the weight of each...patches.observeThe Expander and Patcher settings of each transition with a rate, measured on the observed change: the...patches.settingsThe Expander and Patcher settings given in the model: per transition the Expander's share and the mean,...plus.demandThe cells of each class at each step for CARS: a Markov chain projected from the starting map (PLUS's...validate.agreementHow a simulated map matches the observed one, both from the same start: the share of cells of the same...validate.error_budgetMOLUSCE's error budget (Pontius 2002, through landschaft): the agreement of the maps when the simulation...validate.futuresFUTURES' validation (r.futures.validation through landschaft): the quantity and allocation disagreement...validate.futures_gridFUTURES' validation per tile or per region (r.futures.gridvalidation through landschaft): a row per tile...validate.kappaMOLUSCE's comparison of two maps of classes (DependenceCoef through landschaft): kappa, kappa location and...validate.similarityDinamica EGO's validation: the fuzzy similarity of the simulated and the observed change (the cells that...validate.three_mapThe three-map comparison of a simulation (Pontius, Peethambaram & Castella 2011; lulcc's...woe.fitWeights of evidence of each transition, calibrated on two maps as Dinamica EGO does: the ranges of a...woe.probabilityThe probability of each calibrated transition at every cell of its initial class, from the weights of...woe.weightsWeights of evidence given in the model (as woe.fit gives them): transitions, ranges and weights.
Uncertainty 7
sensitivity.analyzeThe indices of a global sensitivity analysis from its runs and their outputs (SALib's analyses, the same...sensitivity.designThe runs of a global sensitivity analysis (SALib's samplers, the same values): Morris's trajectories (a...uncertainty.deltaThe uncertainty of an expression of the node's maps and numbers (raster.calc's) from the uncertainty of...uncertainty.intervalThe normal confidence interval of a value: value -/+ z sd, z the normal quantile of the level...uncertainty.monte_carloThe uncertainty of an expression of the node's maps and numbers by drawing its parameters (landschaft's...uncertainty.product_sdThe standard deviation of the product of two independent uncertain values x v (landschaft's product_sd):...uncertainty.sum_sdThe standard deviation of a total of uncertain values, the sum of w v (landschaft's sum_sd): independent...
Map algebra 5
stack.classesA stack whose layers are named by class ("1", "2"...) or transition ("1_to_3") as the suitability of each...stack.extract_layerTake one layer out of a stack as a map, by its name or its 0-based number: a band of rasters (the bands of...stack.ofMaps of one grid as a stack, a layer each named as its input (any names: the features of a prioritization,...stack.reduceA statistic of a stack's layers (or of a series of maps) at every cell, as terra's app or a cell...stack.setA stack with a map in the layer of a name (replacing the layer of that name, else added at the end): a...
Tables 10
table.aggregateRows grouped by the values of some columns and summarised, as dplyr's group_by and summarise: a row per...table.calcA column computed row by row from an expression over the others, as a spreadsheet's field calculator or...table.filterThe rows of a table where an expression is true, as dplyr's filter: the columns by their names, the...table.joinTwo tables joined by key columns, as dplyr's joins: every row of the left with each row of the right of...table.ofA table written in the settings: its columns' names and its rows of numbers (null: no value), such as the...table.pivotA table from long to wide or back, as tidyr's pivot_wider and pivot_longer. Wider: a row per value of the...table.readA table from a file: comma-separated values (.csv), tab-separated (.tsv, .txt), with ; as Excel writes...table.selectColumns of a table chosen (in the order given), left out, or renamed, as dplyr's select and rename.table.sortThe rows of a table sorted by some columns (the first, then the next where it ties; missing values last),...table.writeWrite a table to a file, its format by the extension: comma-separated values (.csv, the default),...
Plot 1
view.plotRetired: a figure is a Plot now, kept with the model outside the graph (the Viewer's Plots; set_plot for...
Model flow 8
control.eachRun the body once for each element of a collection: the layers of a stack (a folder of rasters, the bands...control.groupRun the body once: its inputs (any names) are @name inside, its outputs the references of body.outputs....control.repeatRun the body once per step (1..times): `@step` is the step, each carried value starts as the input of its...control.submodelAnother model used as one node: its inputs are the node's inputs of the same names (its value inputs keep...control.switchRun one branch, chosen by the value of `case`: its body holds a group per branch, the one whose id is the...plugin.wasmA map computed cell by cell by a WebAssembly function (a plugin written in any language), in a sandbox:...rng.numpynumpy's legacy random number generator after numpy.random.seed(seed) (Mersenne-Twister), as MOLUSCE draws:...rng.rR's random number generator after set.seed(seed) (Mersenne-Twister), as lulcc and landschaft use it: carry...
Other 7
check.accuracyA check that a map of classes agrees enough with a reference: the overall agreement (the share of the...check.area_keptA check that an area is kept from a map to another (a step to the next, the start to the end): the cells...check.assertA check that stops the run when it fails, as a test does: `expression` over the node's inputs in map...check.demandA check that an allocation met its demand: the cells of each class of the demand in the map of the step...check.no_nodataA check that a map has a value where it should: no cell without a value (NaN) in the map (every layer of a...check.rangeA check that every value is within a range: each cell with a value of a map (every layer of a stack), or a...value.calcA number or a text from the node's inputs, not a map: `expression` in map algebra's syntax and functions...