vis_nc_film: Visualize NETCDF file

In brry/mhmVis: Visualisation of 'mHM' Input and Output Files, Including 'netcdf' Files

Description

Visualize several (or even all) time slices of a NETCDF object into an mp4 animation

Usage

vis_nc_film(nc, index = seq_along(nc$time), Range = range(nc$var, na.rm =
  TRUE), vlcnote = TRUE, test = TRUE, outfile = paste0(nc$file, ".mp4"),
  width = 7 * 200, height = 5 * 200, interval = 0.1,
  ffmpeg = ani.options("ffmpeg"), vidargs = NULL, mar = c(4, 7, 10, 1),
  mgp = c(3, 1.2, 0), xpd = TRUE, parargs = NULL, cex = 1,
  cex.axis = 3, cex.leg = cex.axis, bg.leg = NA, ...)

Arguments

nc	nc object from read_nc
index	Integer: time slice numbers to be plotted. See vis_nc_all. DEFAULT: seq_along(nc$time)
Range	Range of values, see vis_nc_all. DEFAULT: range(nc$var, na.rm=TRUE)
vlcnote	Add VLC instruction note in each frame? TO include other information in each frame, use expr, see vis_nc_all. DEFAULT: TRUE
test	Logical: test the resolution parameters etc by creating a single png file of the first value in index. This is useful to select useful settings before creating an entire movie. DEFAULT: TRUE
outfile	Output video filename. = video.name in animation::saveVideo. DEFAULT: paste0(nc$file,".mp4")
width, height	Size of image frames in pixels. DEFAULT: 7*200, 5*200
interval	Time interval of animation in seconds. DEFAULT: 0.1
ffmpeg	Path to the progam ffmpeg. DEFAULT: ani.options("ffmpeg")
vidargs	Further arguments passed to animation::saveVideo.
mar, mgp, xpd	Graphical parameters passed to par. DEFAULT: c(4,7,10,1), c(3,1.2,0), TRUE
parargs	List of further parameters to par. DEFAULT: NULL
cex	Symbol size passed to vis_nc. DEFAULT: 1
cex.axis, cex.leg	Label size passed to vis_nc. DEFAULT: 3
bg.leg	colPointsLegend Background. DEFAULT: NA
...	Further arguments passed to vis_nc. You likely do not want to mess with z!

Value

list of colPoints list outputs

Author(s)

Berry Boessenkool, [e-mail], Feb 2017

References

http://ffmpeg.org/documentation.html

See Also

vis_nc, vis_nc_all

Examples

# to be added

brry/mhmVis documentation built on May 13, 2019, 7:53 a.m.