animate_raster animates raster data provided as list of raster class objects. The function creates an animated GIF or video file and saves it into the output directory.
animate_raster(layer, out_dir, conv_dir = "convert", layer_dt = 0,
layer_type = "gradient", layer_stretch = "none",
layer_col = c("sandybrown", "white", "darkgreen"), layer_nacol = "white",
static_data = NA, static_gg = NA, img_title = "title",
img_sub = "subtitle", img_caption = "caption", img_labs = "labs",
legend_title = "", legend_limits = NA, legend_labels = "auto",
map_elements = TRUE, time_bar_col = "grey", scalebar_col = "white",
north_col = "white", frames_nmax = 0, frames_fps = 25,
frames_nres = 1, frames_width = NA, frames_height = NA,
frames_pixres = 80, out_name = "moveVis_ani", out_format = "gif",
overwrite = FALSE, log_level = 1, log_logical = FALSE, conv_cmd = "",
conv_frames = 100)list. List of raster objects.
character. Output directory of the output file.
character. Command of or directory to required image/video converter library. Depends on, what is specified for out_format. If out_format = "gif", animate_move() works with the ImageMagick convert tool. In this case, specify command of or path to the convert tool. You can use get_libraries to find or download/install convert. If out_format is a video format (e.g. "mp4", "mov" ...), animate_move() works with either the FFmpeg ffmepg tool or the libav avconv tool. In this case, specify command of or path to the ffmpeg or avconv tool. See also get_libraries. If not specified, animate_move() trys to find libraries automatically.
POSIXct or vector. Optional vector of POSIXct date/time stamps corresponding to the acquisition dates of the layer raster objects to display a time scale.
charachter. Layer type. Either "RGB" (if layer is a rasterBrick class onejct), "gradient" or "discrete". Default is "RGB". Ignored, if layer = "basemap".
character. Ignored, if layer_type is not "RGB". Either "none", "lin", "hist", "sqrt" or "log" for no stretch, linear, histogram, square-root or logarithmic stretch. Default is "none".
character vector. Two or more colours to be used for displaying the background layer. If layer_type = "gradient", a colour ramp between the colous is calcualted. If layer_type = "discrete", the colours will be used per value range. Ignored, if layer_type = "RGB".
character. Colour to be displayed for NA values. Default is "white".
data.frame. Data (e.g. static points) to be displayed within the spatial plot of the output animation. At least, "x", "y" columns for the coordinates and "names" for the naming of the point have to be included. If "static_gg" remains unspecified, "static_data" is plottet as points to the output map, annotated with their namings. Points outside the frame extent are not displayed. See "static_gg" for further options.
character. One or several ggplot2 functions, concatenated by "+" specifying how "static_data" should be displayed, e.g. using geom_point and geom_text for displaying points annotated with text. ggplot2 data and aes, aes_ arguments etc. need to referr to the columns specified in "static_data". As default, "static_data" is plotted as geom_point and geom_label.
character. Titel to be displayed above the animated plot. If not specified, no title will be displayed.
character. Subtitel to be displayed underneath the title. If not specified, no subtitle will be displayed.
character. Caption to be displayed underneath the plot. If not specified, no caption will be displayed.
character. Axis titles to be displayed at the x and y axis of the plot. If not specified, labs will be computed depending on the projection or will be "x" and "y".
character. Title to be displayed above the basemap layer legend (if layer_type is not "RGB"). Ignored, if layer = "basemap".
numeric vector. Fixed minimum and maximum limit values of the legend (gradient layer type). Default is NA for data-depending minimum and maximum values. Ignored, if layer_type is "discrete" or "RGB".
character vectors. Label for each legend break class. If set to "auto", values are displayed. Default is "auto".
logical. If FALSE, map elements (north arrow and scale bar) are hidden. Default is TRUE.
character. Colour of the time progress bar on the top edge of the map. Default is "grey".
character. Colour of the scalebar text. Default is "white".
character. Colour of the north arrow. Default is "white".
numeric. Number of maximum frames. If set, the animation will be stopped, after the specified number of frames is reached. Default is 0 (displaying all frames).
numeric. Frames to display per second (FPS). Note that the gif format only can handle FPS out of 100, e.g. 25. In that case, frames_fps input is rounded. Default is 25.
numeric. Interval of which frames of all frames should be used (nth elements). Default is 1 (every frame is used). If set to 2, only every second frame is used.
numeric. Number of pixels of frame width. Default is 600 (with stats plots 1000).
numeric. Number of pixels of frame height. Defualt is 600.
numeric. Resolution of output file in pixel in ppi. The higher the ppi, the higher frames_height and frames_width should be to avoid large fonts and overlaps. Default is 80.
character. Name of the output file. Default is "moveVis_ani".
character. Output format, e.g. "gif", "avi", "3gp", "mov", "mpeg", "mp4". Use get_formats to get all supported file formats on your system. "gif" is recommended for short animations only (recommended max. frame number around 200 frames; GIF frames are unlimited, but compution time will be very long). Use a video format for long animations. Format "gif" requires ImageMagick, all other video formats require FFmpeg ('ffmpeg') or libav ('avconv') to be installed. For that, also see get_libraries.
logical. If TRUE, files with equal file names to out_name will be overwritten. Default is FALSE.
numeric. Level of console output given by the function. There are three log levels. If set to 3, no messages will be displayed except erros that caused an abortion of the process. If set to 2, warnings and errors will be displayed. If set to 1, a log showing the process activity, wanrnings ans errors will be displayed.
logical. For large processing schemes. If TRUE, the function returns TRUE when finished processing succesfully.
character. Recommended for expert use only. Passes additional command line options to the conversion command, e.g. with a convert call adding '-limit' for memory ressource handling. For details, see check the documentations of ImageMagick convert, FFmpeg ffmpeg and libav avconv.
numeric. Recommended for expert use only. Only used, if out_format = "gif". Number of frames to be used for creating GIF segments that will be assembled to a final GIF file. Correct number depends on system performance and total frames number. Default is 100. Ignored, if out_format is not "gif".
None or logical (see log_logical). The output GIF or video file is written to the ouput directory.
animate_raster is based on ggplot2. Depending on the selected output format (out_format, it either needs the convert tool of the ImageMagick software package (.gif format) or either ffmpeg from FFmpeg or avconv from libav (video formats). The command or directory to the convert tool needs to be provided with conv_dir. Please use get_libraries to search for the needed libraries and command/tool directories on your system or to automatically download and install the required software. See get_libraries and out_format and conv_dir for details.
# NOT RUN {
#Create a list of several raster objects to be displayed one after another
#If layer_type = RGB, use a brick class obejct with RGB bands!
layer <- list(raster1, raster2, raster2)
#Get your convert directory/command
conv_dir <- get_libraries()
#Specify the output directory, e.g.
out_dir <- "/out/test"
#or to a temporary directory:
out_dir <- paste0(tempdir(),"/test")
dir.create(out_dir)
#Call animate_raster
animate_raster(layer,out_dir = our_dir, conv_dir = conv_dir, layer_type = "RGB",
out_format = "gif")
#use another file format for longer videos
animate_raster(layer,out_dir = our_dir, conv_dir = conv_dir, layer_type = "RGB",
out_format = "mov")
# }
# NOT RUN {
# }
Run the code above in your browser using DataLab