Getting the samples forest

This method returns the samples forest.

Value

The samples forest having as leaves the sampled cells

Examples

# set the seed of the random number generator
set.seed(0)

# create a simulation
sim <- SpatialSimulation()
sim$add_mutant(name = "A",
               growth_rate = 0.2,
               death_rate = 0.01)
sim$place_cell("A", 500, 500)

sim$death_activation_level <- 100
sim$run_up_to_size(species = "A", num_of_cells = 50000)
#> 
 [████████████████████████████████████████] 100% [00m:00s] Saving snapshot                                        


# sample the region [450,500]x[475,550]
sim$sample_cells("S1", lower_corner=c(450,475), upper_corner=c(500,550))

# build the samples forest
forest <- sim$get_samples_forest()

forest
#> SamplesForest
#>   # of trees: 1
#>   # of nodes: 12077
#>   # of leaves: 3863
#>   samples: {"S1"}
#>