inst/extdata/detect_change/sits_detect_change_method.R

In sits: Satellite Image Time Series Analysis for Earth Observation Data Cubes

#' @title Create detect change method.
#' @name sits_detect_change_method
#'
#' @author Gilberto Camara, \email{gilberto.camara@@inpe.br}
#' @author Felipe Carlos, \email{efelipecarlos@@gmail.com}
#'
#' @description Prepare detection change method. Currently, sits supports the
#' following methods: 'dtw' (see \code{\link[sits]{sits_dtw}})
#'
#' @param  samples          Time series with the training samples.
#' @param  cd_method        Change detection method.
#' @return                  Change detection method prepared
#'                          to be passed to
#'                          \code{\link[sits]{sits_detect_change}}
sits_detect_change_method <- function(samples, cd_method = sits_dtw()) {
    # set caller to show in errors
    .check_set_caller("sits_detect_change_method")
    # check if samples are valid
    .check_samples_train(samples)
    # is the train method a function?
    .check_that(inherits(cd_method, "function"),
                msg = .conf("messages", "sits_detect_change_method_model")
    )
    # are the timelines OK?
    timeline_ok <- .timeline_check(samples)
    .check_that(timeline_ok,
                msg = .conf("messages", "sits_detect_change_method_timeline")
    )
    # compute the training method by the given data
    result <- cd_method(samples)
    # return a valid detect change method
    return(result)
}