TUFLOW Viewer - Exporting An Animation: Difference between revisions

Content deleted Content added
No edit summary
 
(5 intermediate revisions by 2 users not shown)
Line 1:
===Tool Description===
Animations can be exported from TUFLOW Viewer for all accepted result types (map outputs, time series, particles etc). The process for animation creation is the same regardless of the result type. The tool will export an image for each timestep in a given range and then use ffmpeg to convert the images into a video. TUFLOW Viewer offers the additional functionality of adding dynamic plots and dynamic time text. It also offers convenience functionality for adding items such as a legend, images etc, however these can also be added manually in the print layout.<br>
 
<b>Note:</b> Since v3.10, it is possible to select a netCDF grid result for animation or a GPKG time series result (in the active scalar result dropdown). The GPKG time series result will be temporally updated if present in the map window and not required to be selected for it to update (e.g. if a 2D result is selected instead), however selecting the GPKG time series simply allows users to animate the results if no 2D results are desired.
 
The following steps through the process of creating an animation with TUFLOW Viewer.<br>
Line 8 ⟶ 10:
* TUFLOW Viewer will take care of all the interaction with ffmpeg and the user is not required to learn how to use ffmpeg
<li> Open the export animation tool via '''Export >> Export Animation'''<br>
[[File: Animation_Export_Animation_MenuTUFLOW Viewer_Exporting an Animation_1a.PNGpng]]
<li> Set the '''General''' settings<br>
[[File: Animation_Export_Animation_General_SettingsTUFLOW Viewer_Exporting an Animation_2a.PNGpng]]<br>
<ol>
<li> '''Start Time''' - The output time to start on
Line 31 ⟶ 33:
<li> Use '''Custom Layout''' using the template file
</ol>
[[File: TUFLOW Viewer_Exporting an Animation_3a.png]]
[[File: Animation_Export_Animation_Layout_Settings.PNG]]
<li> Assuming the above workflow, the '''Default Layout''' lets the user specify some items to add to the layout. Starting with the first three, each of these has the ability to add an additional label to the item and set properties such as the font, background colour, background border, and position in the layout (all of these properties can be changed later in the print layout):
<ol>
Line 38 ⟶ 40:
<li> '''Legend''' - A legend item - can be added / modified later in the print layout<br>
</ol>
[[File: Animation_Layout_Item_SettingsTUFLOW Viewer_Exporting an Animation_4a.PNGpng | 450px]]
<li> The next layout item is '''Plots'''. These are dynamic plot objects that will be added to the animation. To add a plot, the plot must already be available in one of the TUFLOW Viewer plotting windows<br>
[[File: Animation_Layout_Plot_ItemTUFLOW Viewer_Exporting an Animation_5a.PNGpng | 450px]]
<ol>
<li> Use the add button [[File: Animation_add_button.PNG | 20px]] to add a plot
Line 48 ⟶ 50:
<li> Set the plot properties. When the user clicks this button, TUFLOW Viewer will calculate the min/max for the plot axes. For lines on the cross-section and vertical profile plots, this can take some time as TUFLOW Viewer will need to step through every timestep to find the min/max values.<br>
: ''<b>Note: since v3.3 cross-section plots will now longer trigger an automatic min/max calculation</b>''
[[File: Animation_Plot_Properties_DialogTUFLOW Viewer_Exporting an Animation_6a.PNGpng | 450px]]
<ol>
<li> '''Plot Title''' - can be useful to indicate where the plot was extracted from by aligning the title with labels in the print layout
Line 82 ⟶ 84:
<li> Once all layout items have been chosen and added, clicking '''Preview''' will allow the user to view how it's going to look<br>
[[File: Animation_Preview_Button.PNG | 450px]]
<li> Clicking the preview button will open up the layout in the QGIS print layout. InIf thisany layout,of the plot properties have not been manually set by the user canor modify,previously movecalculated, resize,they add,will andnow removebe itemsautomatically incalculated as the layout.first Thestage followingof itemsgenerating mustthe retainanimation theiror IDs:animation preview.<br>
: ''<b>Note: Since v3.3 if there are any cross-section plots that have not been set previously, the user will now be given the option to auto calculate the limits (which can be a slow process), use the limits in the cross-section/long profile plotting window in TUFLOW Viewer, or to cancel and go set the plot axis limits manually.</b>''<br>
In this layout, the user can modify, move, resize, add, and remove items in the layout. The following items must retain their IDs:
* The dynamic time text must have an ID 'time'
* Dynamic plots will have an ID 'plot_<n>' where <n> is the plot index (starting at index 0) based on the order they were added in the '''Default Layout'''