Vector of available class targets

Description

Vector of available class targets

Usage

CLASS_LEVEL_TARGETS

Format

An object of class character of length 16.

Creates a predefined landscape class structure that can be converted as JSON input for flsgen generate.

Description

Creates a predefined landscape class structure that can be converted as JSON input for flsgen generate.

Usage

flsgen_create_class_structure(class_name, patch_areas, is_square = FALSE)

Arguments

Value

A landscape class structure

Examples

  ## Not run: 
    cls_1 <- flsgen_class_structure("class 1", c(10, 100, 1000))
  
## End(Not run)

Creates a set of targets for a landscape class

Description

Creates a set of targets for a landscape class, which can be converted into JSON for flsgen.

Usage

flsgen_create_class_targets(
  class_name,
  NP = NULL,
  AREA = NULL,
  AREA_MN = NULL,
  CA = NULL,
  PLAND = NULL,
  PD = NULL,
  SPI = NULL,
  LPI = NULL,
  MESH = NULL,
  SPLI = NULL,
  NPRO = NULL,
  SDEN = NULL,
  COHE = NULL,
  DIVI = NULL,
  IS_SQUARE = FALSE,
  ALL_DIFFERENT = FALSE
)

Arguments

Details

Note that NP and AREA targets can be set as NULL, if the class targets is used within the 'generate_series' function to generate landscape series with varying NP and/or AREA. However, flsgen won't run is NP and AREA are not set elsewhere.

Value

A class targets object which can be converted to JSON for flsgen

Examples

  ## Not run: 
    cls_1 <- flsgen_create_class_targets("class 1", NP=c(1, 10), AREA=c(0, 1000))
  
## End(Not run)

Creates a predefined landscape structure that can be converted as JSON Input for flsgen generate

Description

Creates a predefined landscape structure that can be converted as JSON converted as JSON Input for flsgen generate.

Usage

flsgen_create_landscape_structure(
  nb_rows,
  nb_cols,
  classes,
  mask_raster = NULL
)

Arguments

Details

The class structures must be created prior to the call to this function

Either nb_rows and nb_cols, or mask_raster must be specified. The dimensions of the landscape are deduced from the mask raster if it is used.

Value

A landscape structure object which can be converted to JSON for flsgen generate

Examples

  ## Not run: 
    cls_1 <- flsgen_class_structure("class 1", c(10, 100, 1000))
    cls_2 <- flsgen_class_structure("class 2", c(20, 200, 2000))
    ls_struct <- flsgen_landscape_structure(200, 200, list(cls_1, cls_2))
  
## End(Not run)

Creates a set of targets for a landscape

Description

Creates a set of targets for a landscape, which can be converted into JSON for flsgen.

Usage

flsgen_create_landscape_targets(
  nb_rows,
  nb_cols,
  classes,
  mask_raster = NULL,
  NON_FOCAL_PLAND = NULL
)

Arguments

Details

The class targets must be created prior to the call to this function

Either nb_rows and nb_cols, or mask_raster must be specified. The dimensions of the landscape are deduced from the mask raster if it is used.

Value

A landscape targets object which can be converted to JSON for flsgen

Examples

  ## Not run: 
    cls_1 <- flsgen_create_class_targets("class 1", NP=c(1, 10), AREA=c(0, 1000))
    cls_2 <- flsgen_create_class_targets("class 2", NP=c(1, 10), AREA=c(0, 1000))
    ls_targets <- flsgen_create_landscape_targets(200, 200, list(cls_1, cls_2))
  
## End(Not run)

From a base landscape target object, create a series of landscape targets, with one target for one class varying according to a specified sequence.

Description

Create a series of landscape targets, with one target for one class varying according to a specified sequence.

Usage

flsgen_create_target_series(
  landscape_targets,
  class_name = NULL,
  class_id = NULL,
  target_key,
  sequence
)

Arguments

Details

Either the class name of id must be given to identify the class to use for generating the series.

Value

A list of landscape targets

Examples

  ## Not run: 
    cls_1 <- flsgen_create_class_targets("class 1", NP=c(1, 10), AREA=c(0, 1000))
    cls_2 <- flsgen_create_class_targets("class 2", AREA=c(0, 1000))
    ls_targets <- flsgen_create_landscape_targets(200, 200, list(cls_1, cls_2))
    target_series <- flsgen_create_target_series(ls_targets, class_name="class 2",
                                                 target_key="NP", sequence=seq(1, 10, by=1))
  
## End(Not run)

Extracts a landscape structure from an existing raster

Description

Extracts a landscape structure from an existing raster

Usage

flsgen_extract_structure_from_raster(
  raster_file,
  focal_classes,
  connectivity = 4
)

Arguments

Value

A JSON landscape structure that can be used with flsgen generate

Examples

  ## Not run: 
    ls_struct <- flsgen_extract_structure_from_raster(raster_path, c(0, 1, 2))
  
## End(Not run)

Landscape raster generator

Description

Generate landscape raster from landscape structure

Usage

flsgen_generate(
  structure_str,
  structure_file,
  terrain_file = NULL,
  roughness = 0.5,
  terrain_dependency = 0.5,
  min_distance = 2,
  min_max_distance = NULL,
  connectivity = 4,
  x = 0,
  y = 0,
  resolution_x = 1e-04,
  resolution_y = NULL,
  epsg = "EPSG:4326",
  max_try = 2,
  max_try_patch = 10,
  verbose = TRUE
)

Arguments

Details

The input landscape structure must be either specified as a JSON-formatted string (structure_str parameter) or as a JSON file (structure_file parameter)

Value

A terra::rast object

Examples

  ## Not run: 
    json <- "{
      \"nbRows\" : 200,
      \"nbCols\" : 200,
      \"classes\" : [
        {
          \"name\" : \"Class A\",
          \"NP\" : [1, 10],
          \"AREA\" : [300, 4000],
          \"CA\" : [1000, 5000],
          \"MESH\" : [225, 225]
        },
        {
          \"name\" : \"Class B\",
          \"NP\" : [2, 8],
          \"AREA\" : [200, 4000],
          \"PLAND\" : [40, 40]
        },
        {
          \"name\" : \"Class C\",
           \"NP\" : [5, 7],
           \"AREA\" : [800, 1200]
        }
      ]
    }"
    structure <- flsgen_structure(targets_str = json)
    landscape <- flsgen_generate(structure_str = structure)
  
## End(Not run)

Landscape structure solver

Description

Find landscape structures satisfying user targets

Usage

flsgen_structure(
  targets_str,
  targets_file,
  nb_solutions = 1,
  time_limit = 60,
  search_strategy = "DEFAULT"
)

Arguments

Details

The input user targets must be either specified as a JSON-formatted string (targets_str parameter) or as a JSON file (target_file parameter).

Value

A vector of JSON-formatted landscape structures satisfying user targets.

Examples

  ## Not run: 
    json <- "{
      \"nbRows\" : 200,
      \"nbCols\" : 200,
        {
          \"name\" : \"Class A\",
          \"NP\" : [1, 10],
          \"AREA\" : [300, 4000],
          \"CA\" : [1000, 5000],
          \"MESH\" : [225, 225]
        },
        {
          \"name\" : \"Class B\",
          \"NP\" : [2, 8],
          \"AREA\" : [200, 4000],
          \"PLAND\" : [40, 40]
        },
        {
          \"name\" : \"Class C\",
           \"NP\" : [5, 7],
           \"AREA\" : [800, 1200]
        }
      ]
    }"
    structure <- flsgen_structure(targets_str = json)
  
## End(Not run)

Fractal terrain generator

Description

Fractal terrain generation with the diamond-square algorithm

Usage

flsgen_terrain(
  width,
  height,
  roughness = 0.5,
  x = 0,
  y = 0,
  resolution = 1e-04,
  epsg = "EPSG:4326"
)

Arguments

Value

A terra::rast object

Examples

  ## Not run: 
    terrain <- flsgen_terrain(200, 200)
  
## End(Not run)