Movie

makeMovie(simulation_id::Integer; magick_path::Union{Missing,String}=simulator().path_to_magick, ffmpeg_path::Union{Missing,String}=simulator().path_to_ffmpeg)
makeMovie(T::AbstractTrial; kwargs...)
makeMovie(out::PCMMOutput; kwargs...)
makeMovie(simulation_ids::AbstractVector{<:Integer}; kwargs...)
makeMovie(Ts::AbstractVector{<:AbstractTrial}; kwargs...)

Batch make movies for each simulation identified by the input.

Use the PhysiCell Makefile to generate the movie. This process requires first generating JPEG files, which are then used to create the movie. Deletes the JPEG files after the movie is generated.

This relies on ImageMagick and FFmpeg being installed on the system. There are three ways to allow this function to find these dependencies:

1. Pass the path to the dependencies using the magick_path and ffmpeg_path keyword arguments.
2. Set the PATH environment variable to include the directories containing the dependencies.
3. Set environment variables PCMM_IMAGEMAGICK_PATH and PCMM_FFMPEG_PATH before using PhysiCellModelManager.

Arguments

• simulation_id::Integer: The ID of the simulation for which to make the movie.
• T::AbstractTrial: Make movies for all simulations in the AbstractTrial.
• out::PCMMOutput: Make movies for all simulations in the output, i.e., all simulations in the completed trial.
• simulation_ids::AbstractVector{<:Integer}: Make movies for each simulation ID in the collection (e.g. a range such as 4:7).
• Ts::AbstractVector{<:AbstractTrial}: Make movies for every simulation across the collection of trials (e.g. Simulation.(4:7)).

Keyword Arguments

• magick_path::Union{Missing,String}: The path to the ImageMagick executable. If not provided, uses simulator().path_to_magick.
• ffmpeg_path::Union{Missing,String}: The path to the FFmpeg executable. If not provided, uses simulator().path_to_ffmpeg.
• verbose::Bool: If true, prints the output of the commands used to generate the movie. Default is false.
• framerate::Union{Missing,Int}: Frames per second, forwarded to the Makefile's FRAMERATE variable. If not provided, uses the Makefile's own default.
• magick_density::Union{Missing,Int}: JPEG rendering density (dpi), forwarded to the Makefile's MAGICK_DENSITY variable. If not provided, uses the Makefile's own default.
• magick_resize_x::Union{Missing,Int}: JPEG resize width, forwarded to the Makefile's MAGICK_RESIZE_X variable. If not provided, uses the Makefile's own default.
• magick_resize_y::Union{Missing,Int}: JPEG resize height, forwarded to the Makefile's MAGICK_RESIZE_Y variable. If not provided, uses the Makefile's own default.

Example

makeMovie(123) # make a movie for simulation 123

makeMovie(sampling) # make movies for all simulations in the sampling

out = run(sampling) # run the sampling
makeMovie(out) # make movies for all simulations in the output

makeMovie(123; framerate=10, magick_density=48, magick_resize_x=512, magick_resize_y=512)

makeMovie(4:7) # make movies for simulations 4, 5, 6, and 7
makeMovie(Simulation.(4:7)) # equivalent, passing Simulation objects