#' @title Build a labelled image from a probability cube
#'
#' @name sits_label_classification
#' @author Rolf Simoes, \email{rolf.simoes@@inpe.br}
#' @author Felipe Souza, \email{felipe.souza@@inpe.br}
#'
#' @description Takes a set of classified raster layers with probabilities,
#' and label them based on the maximum probability for each pixel.
#'
#' @param cube Classified image data cube.
#' @param ... Other parameters for specific functions.
#' @param multicores Number of workers to label the classification in
#' parallel.
#' @param memsize maximum overall memory (in GB) to label the
#' classification.
#' @param output_dir Output directory for classified files.
#' @param version Version of resulting image
#' (in the case of multiple runs).
#' @param progress Show progress bar?
#' @return A data cube with an image with the classified map.
#' @note
#' Please refer to the sits documentation available in
#' <https://e-sensing.github.io/sitsbook/> for detailed examples.
#'
#' @examples
#' if (sits_run_examples()) {
#' # create a random forest model
#' rfor_model <- sits_train(samples_modis_ndvi, sits_rfor())
#' # create a data cube from local files
#' data_dir <- system.file("extdata/raster/mod13q1", package = "sits")
#' cube <- sits_cube(
#' source = "BDC",
#' collection = "MOD13Q1-6.1",
#' data_dir = data_dir
#' )
#' # classify a data cube
#' probs_cube <- sits_classify(
#' data = cube, ml_model = rfor_model, output_dir = tempdir()
#' )
#' # plot the probability cube
#' plot(probs_cube)
#' # smooth the probability cube using Bayesian statistics
#' bayes_cube <- sits_smooth(probs_cube, output_dir = tempdir())
#' # plot the smoothed cube
#' plot(bayes_cube)
#' # label the probability cube
#' label_cube <- sits_label_classification(
#' bayes_cube,
#' output_dir = tempdir()
#' )
#' # plot the labelled cube
#' plot(label_cube)
#' }
#' @export
sits_label_classification <- function(cube,
memsize = 4L,
multicores = 2L,
output_dir,
version = "v1",
progress = TRUE) {
.check_set_caller("sits_label_classification")
# Dispatch
UseMethod("sits_label_classification", cube)
}
#' @rdname sits_label_classification
#' @export
sits_label_classification.probs_cube <- function(cube, ...,
memsize = 4L,
multicores = 2L,
output_dir,
version = "v1",
progress = TRUE) {
# Pre-conditions - Check parameters
.check_raster_cube_files(cube)
.check_num_parameter(memsize, min = 1, max = 16384)
.check_num_parameter(multicores, min = 1, max = 2048)
.check_output_dir(output_dir)
version <- .check_version(version)
# version is case-insensitive in sits
version <- tolower(version)
# Get block size
block <- .raster_file_blocksize(.raster_open_rast(.tile_path(cube)))
# Check minimum memory needed to process one block
job_memsize <- .jobs_memsize(
job_size = .block_size(block = block, overlap = 0),
npaths = length(.cube_labels(cube)) + 1,
nbytes = 8, proc_bloat = .conf("processing_bloat_cpu")
)
# Update multicores parameter
multicores <- .jobs_max_multicores(
job_memsize = job_memsize, memsize = memsize, multicores = multicores
)
# Update block parameter
block <- .jobs_optimal_block(
job_memsize = job_memsize,
block = block,
image_size = .tile_size(.tile(cube)), memsize = memsize,
multicores = multicores
)
# Prepare parallel processing
.parallel_start(workers = multicores)
on.exit(.parallel_stop(), add = TRUE)
# Create label classification function
label_fn <- .label_fn_majority()
# Process each tile sequentially
class_cube <- .cube_foreach_tile(cube, function(tile) {
# Label the data
class_tile <- .label_tile(
tile = tile,
band = "class",
label_fn = label_fn,
output_dir = output_dir,
version = version,
progress = progress
)
return(class_tile)
})
return(class_cube)
}
#' @rdname sits_label_classification
#' @export
sits_label_classification.probs_vector_cube <- function(cube, ...,
output_dir,
version = "v1",
progress = TRUE) {
# Pre-conditions - Check parameters
.check_raster_cube_files(cube)
.check_output_dir(output_dir)
version <- .check_version(version)
# version is case-insensitive in sits
version <- tolower(version)
# Process each tile sequentially
class_cube <- .cube_foreach_tile(cube, function(tile) {
# Label the segments
class_tile <- .label_vector_tile(
tile = tile,
band = "class",
version = version,
output_dir = output_dir
)
# Return classified tile segments
return(class_tile)
})
return(class_cube)
}
#' @rdname sits_label_classification
#' @export
sits_label_classification.raster_cube <- function(cube, ...) {
stop(.conf("messages", "sits_label_classification"))
}
#' @rdname sits_label_classification
#' @export
sits_label_classification.derived_cube <- function(cube, ...) {
stop(.conf("messages", "sits_label_classification"))
}
#' @rdname sits_label_classification
#' @export
sits_label_classification.default <- function(cube, ...) {
cube <- tibble::as_tibble(cube)
if (all(.conf("sits_cube_cols") %in% colnames(cube)))
cube <- .cube_find_class(cube)
else
stop(.conf("messages", "sits_label_classification"))
class_cube <- sits_label_classification(cube, ...)
return(class_cube)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.