Skip to contents

Parameters for the Clustered Pattern

Source: R/pattern_params.R
pattern_clustered.Rd

Vegetation clusters scattered into the bare zone.

Usage

pattern_clustered(
  boundary_position = 0.5,
  n_clusters = 10,
  cluster_radius = 5,
  cluster_zone = 0.3,
  elongation_x = 1,
  elongation_y = 1
)

Arguments

boundary_position

Numeric. Relative position of the horizontal vegetation boundary (if not rotated) from the top (0-1, default: 0.5).

n_clusters

Integer. Number of cluster centers (default: 10).

cluster_radius

Numeric. Radius of clusters in pixels (default: 5).

cluster_zone

Numeric. Proportion of height for the cluster zone, measured downward from the vegetation boundary (0-1, default: 0.3).

elongation_x

Numeric. Horizontal elongation factor for clusters. Values above 1 stretch clusters horizontally; values below 1 compress them (default: 1).

elongation_y

Numeric. Vertical elongation factor for clusters. Values above 1 stretch clusters vertically; values below 1 compress them (default: 1).

Value

A named "landscape_params" list containing the supplied parameters.

See also

Other landscape creation: create_landscape(), create_landscapes(), pattern_bands(), pattern_bare(), pattern_dense(), pattern_diffuse(), pattern_fingers(), pattern_gaps(), pattern_labyrinth(), pattern_random(), pattern_sharp(), pattern_spots()

Valid values and batch sampling

A single value fixes a parameter. A length-2 vector is a range, sampled once per landscape by create_landscapes and rejected by create_landscape. The table below shows for each parameter:

valid values that create_landscape accepts, and sampled ranges that create_landscapes draws from once per landscape for any parameter left unset. The defaults shown in Usage therefore apply to create_landscape only. Ranges that scale with landscape size are shown for the default 100 by 100.

ParameterValidSampled
boundary_position0 to 10.4 to 0.6
n_clusters1 or more5 to 12
cluster_radius1 or more5 to 10
cluster_zonegreater than 0, up to 10.2 to 1
elongation_xgreater than 00.5 to 1.5
elongation_ygreater than 00.5 to 1.5

Examples

# A single landscape, with fixed values
create_landscape(
  "clustered",
  params = pattern_clustered(n_clusters = 8, cluster_radius = 7)
)
#> Landscape: <unnamed> [pattern: clustered]
#> -----------------------------------------
#> Dimensions: 100x100 (10000 cells)
#> Resolution: 1.0x1.0
#> Extent    : xmin=0.0, xmax=100.0, ymin=0.0, ymax=100.0
#> Values    : min=0.0, max=1.0
#> Parameters: width = 100, height = 100, boundary_position = 0.5, n_clusters = 8, cluster_radius = 7, cluster_zone = 0.3, elongation_x = 1, elongation_y = 1, rotation = 0 

# A batch, with parameters drawn from ranges once per landscape.
# Parameters left unset vary too, over their default ranges
create_landscapes(
  n = 4,
  patterns = "clustered",
  params_list = list(
    clustered = pattern_clustered(
      n_clusters = c(5, 12),
      cluster_radius = c(4, 8)
    )
  )
)
#> ✔ Successfully generated all 4 training landscapes
#> $clustered_1_rot177
#> Landscape: "clustered_1_rot177" [pattern: clustered]
#> -----------------------------------------
#> Dimensions: 100x100 (10000 cells)
#> Resolution: 1.0x1.0
#> Extent    : xmin=0.0, xmax=100.0, ymin=0.0, ymax=100.0
#> Values    : min=0.0, max=1.0
#> Parameters: width = 100, height = 100, boundary_position = 0.591689004190266, n_clusters = 8, cluster_radius = 4, cluster_zone = 0.607681477069855, elongation_x = 0.902967239031568, elongation_y = 0.731844176771119, rotation = 177 
#> 
#> $clustered_2_rot356
#> Landscape: "clustered_2_rot356" [pattern: clustered]
#> -----------------------------------------
#> Dimensions: 100x100 (10000 cells)
#> Resolution: 1.0x1.0
#> Extent    : xmin=0.0, xmax=100.0, ymin=0.0, ymax=100.0
#> Values    : min=0.0, max=1.0
#> Parameters: width = 100, height = 100, boundary_position = 0.479156721988693, n_clusters = 8, cluster_radius = 5, cluster_zone = 0.890481751598418, elongation_x = 1.02773407287896, elongation_y = 1.23859300184995, rotation = 356 
#> 
#> $clustered_3_rot92
#> Landscape: "clustered_3_rot92" [pattern: clustered]
#> -----------------------------------------
#> Dimensions: 100x100 (10000 cells)
#> Resolution: 1.0x1.0
#> Extent    : xmin=0.0, xmax=100.0, ymin=0.0, ymax=100.0
#> Values    : min=0.0, max=1.0
#> Parameters: width = 100, height = 100, boundary_position = 0.444279740937054, n_clusters = 12, cluster_radius = 4, cluster_zone = 0.635638977959752, elongation_x = 0.938324093353003, elongation_y = 0.584773896960542, rotation = 92 
#> 
#> $clustered_4_rot49
#> Landscape: "clustered_4_rot49" [pattern: clustered]
#> -----------------------------------------
#> Dimensions: 100x100 (10000 cells)
#> Resolution: 1.0x1.0
#> Extent    : xmin=0.0, xmax=100.0, ymin=0.0, ymax=100.0
#> Values    : min=0.0, max=1.0
#> Parameters: width = 100, height = 100, boundary_position = 0.419753044517711, n_clusters = 8, cluster_radius = 8, cluster_zone = 0.580911484360695, elongation_x = 0.557363673113286, elongation_y = 1.47497145133093, rotation = 49 
#> 

# A batch, mixing a fixed value with a range
create_landscapes(
  n = 4,
  patterns = "clustered",
  params_list = list(
    clustered = pattern_clustered(
      n_clusters = 8,
      cluster_radius = c(4, 8)
    )
  )
)
#> ✔ Successfully generated all 4 training landscapes
#> $clustered_1_rot89
#> Landscape: "clustered_1_rot89" [pattern: clustered]
#> -----------------------------------------
#> Dimensions: 100x100 (10000 cells)
#> Resolution: 1.0x1.0
#> Extent    : xmin=0.0, xmax=100.0, ymin=0.0, ymax=100.0
#> Values    : min=0.0, max=1.0
#> Parameters: width = 100, height = 100, boundary_position = 0.594288135552779, n_clusters = 8, cluster_radius = 4, cluster_zone = 0.59355426300317, elongation_x = 1.20305816852488, elongation_y = 1.20890617207624, rotation = 89 
#> 
#> $clustered_2_rot321
#> Landscape: "clustered_2_rot321" [pattern: clustered]
#> -----------------------------------------
#> Dimensions: 100x100 (10000 cells)
#> Resolution: 1.0x1.0
#> Extent    : xmin=0.0, xmax=100.0, ymin=0.0, ymax=100.0
#> Values    : min=0.0, max=1.0
#> Parameters: width = 100, height = 100, boundary_position = 0.472178921988234, n_clusters = 8, cluster_radius = 8, cluster_zone = 0.449984030239284, elongation_x = 0.885540628340095, elongation_y = 1.48698451998644, rotation = 321 
#> 
#> $clustered_3_rot336
#> Landscape: "clustered_3_rot336" [pattern: clustered]
#> -----------------------------------------
#> Dimensions: 100x100 (10000 cells)
#> Resolution: 1.0x1.0
#> Extent    : xmin=0.0, xmax=100.0, ymin=0.0, ymax=100.0
#> Values    : min=0.0, max=1.0
#> Parameters: width = 100, height = 100, boundary_position = 0.406134204566479, n_clusters = 8, cluster_radius = 6, cluster_zone = 0.942507328093052, elongation_x = 0.5998674496077, elongation_y = 1.17017687787302, rotation = 336 
#> 
#> $clustered_4_rot231
#> Landscape: "clustered_4_rot231" [pattern: clustered]
#> -----------------------------------------
#> Dimensions: 100x100 (10000 cells)
#> Resolution: 1.0x1.0
#> Extent    : xmin=0.0, xmax=100.0, ymin=0.0, ymax=100.0
#> Values    : min=0.0, max=1.0
#> Parameters: width = 100, height = 100, boundary_position = 0.441980333859101, n_clusters = 8, cluster_radius = 7, cluster_zone = 0.299922896921635, elongation_x = 0.669052553595975, elongation_y = 0.65326046012342, rotation = 231 
#>