TUFLOW Viewer - Summary Of Options - Revision history

Melissa.Moghanloo: /* Tool Description */

2025-06-24T01:44:39Z

Tool Description

← Older revision		Revision as of 11:44, 24 June 2025
Line 1:		Line 1:
	===Tool Description===		===Tool Description===
	[[File: ~~Options_Mesh_Dialog~~.~~PNG~~]]<br>		[[File: TUFLOW Viewer_Summary of Options_1a.png]]<br>
	<ol>		<ol>
	<li> '''Show Grid''' - Toggles mesh rendering.		<li> '''Show Grid''' - Toggles mesh rendering.
Line 9:		Line 9:
	<br>		<br>

	[[File: ~~Options_Plotting_Dialog~~.~~PNG~~]]<br>		[[File: TUFLOW Viewer_Summary of Options_2a.png]]<br>
	<ol>		<ol>
	<li> '''Live Map Tracking''' - Toggles live cursor tracking - see <u>[[TUFLOW_Viewer_-_Auto_Update_Plot_From_Cursor_Location \| Auto Update Plot From Cursor Location]]</u>		<li> '''Live Map Tracking''' - Toggles live cursor tracking - see <u>[[TUFLOW_Viewer_-_Auto_Update_Plot_From_Cursor_Location \| Auto Update Plot From Cursor Location]]</u>
Line 27:		Line 27:
	Options are taken directly from the Matplotlib 'Quiver' options, and values input here will be passed directly to the library.<br>		Options are taken directly from the Matplotlib 'Quiver' options, and values input here will be passed directly to the library.<br>
	[https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html]<Br>		[https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html]<Br>
	[[File: ~~Options_Curtain_Vectors.PNG~~ \| ~~350px~~]]<br><br>		[[File: TUFLOW Viewer_Summary of Options_3a.png]]<br><br>

	[[File: ~~Options_Defaults_Dialog~~.~~PNG~~]]<br>		[[File: TUFLOW Viewer_Summary of Options_4a.png]]<br>
	<ol>		<ol>
	<li> '''Default Layout''' - Sets the default layout that TUFLOW Viewer will use when it is first opened.		<li> '''Default Layout''' - Sets the default layout that TUFLOW Viewer will use when it is first opened.
Line 43:		Line 43:
	<br><br>		<br><br>

	[[File: ~~Options_Check_Dialog~~.~~PNG~~]]<br>		[[File: TUFLOW Viewer_Summary of Options_5a.png]]<br>
	<ol>		<ol>
	<li> '''Mesh Intercept Locations''' - Outputs mesh intercept points with a plotting line (from any of the plotting types e.g. From Map, From Layer etc). If the mesh layer stores results on the mesh face, the mesh faces are also output (mesh face in this context refers to the cell area as opposed to the mesh sides).		<li> '''Mesh Intercept Locations''' - Outputs mesh intercept points with a plotting line (from any of the plotting types e.g. From Map, From Layer etc). If the mesh layer stores results on the mesh face, the mesh faces are also output (mesh face in this context refers to the cell area as opposed to the mesh sides).

Ellis Symons at 13:12, 21 September 2022

2022-09-21T13:12:31Z

← Older revision		Revision as of 23:12, 21 September 2022
Line 24:		Line 24:
	<br><br>		<br><br>

			<b>Curtain Vectors</b>
	Options are taken directly from the Matplotlib 'Quiver' options, and values input here will be passed directly to the library.<br>		Options are taken directly from the Matplotlib 'Quiver' options, and values input here will be passed directly to the library.<br>
	[https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html]<Br>		[https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html]<Br>

Ellis Symons at 13:11, 21 September 2022

2022-09-21T13:11:52Z

← Older revision		Revision as of 23:11, 21 September 2022
Line 24:		Line 24:
	<br><br>		<br><br>

⚫	[[File: Options_Curtain_Vectors.PNG]]<br>
	Options are taken directly from the Matplotlib 'Quiver' options, and values input here will be passed directly to the library.<br>		Options are taken directly from the Matplotlib 'Quiver' options, and values input here will be passed directly to the library.<br>
	[https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html]<Br>~~<br>~~		[https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html]<Br>
		⚫	[[File: Options_Curtain_Vectors.PNG \| 350px]]<br><br>

	[[File: Options_Defaults_Dialog.PNG]]<br>		[[File: Options_Defaults_Dialog.PNG]]<br>

Ellis Symons at 13:11, 21 September 2022

2022-09-21T13:11:02Z

← Older revision		Revision as of 23:11, 21 September 2022
Line 23:		Line 23:
	</ol>		</ol>
	<br><br>		<br><br>

			[[File: Options_Curtain_Vectors.PNG]]<br>
			Options are taken directly from the Matplotlib 'Quiver' options, and values input here will be passed directly to the library.<br>
			[https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.quiver.html]<Br><br>

	[[File: Options_Defaults_Dialog.PNG]]<br>		[[File: Options_Defaults_Dialog.PNG]]<br>

Ellis Symons at 13:21, 30 May 2022

2022-05-30T13:21:18Z

← Older revision		Revision as of 23:21, 30 May 2022
Line 16:		Line 16:
	<li> '''Zero Date''' - Changes the zero date-time - see <u>[[TUFLOW_Viewer_-_Isodate_(Date-Time)_Format \| Working With Isodate (Date-Time) format]]</u>		<li> '''Zero Date''' - Changes the zero date-time - see <u>[[TUFLOW_Viewer_-_Isodate_(Date-Time)_Format \| Working With Isodate (Date-Time) format]]</u>
	<li> '''X-Axis Label Rotation''' - changes the rotation of the x-axis tick labels when displaying as dates.		<li> '''X-Axis Label Rotation''' - changes the rotation of the x-axis tick labels when displaying as dates.
	<li> '''Plot Inactive Areas in 1D Cross-Section''' - ''Introduced in v3.4'' if checked, inactive areas on ESTRY cross-section will be shown. Prior to v3.4 inactive areas were always shown.		<li> '''Plot Inactive Areas in 1D Cross-Section''' - ''Introduced in v3.4'' - if checked, inactive areas on ESTRY cross-section will be shown. Prior to v3.4 inactive areas were always shown.
	<li> '''Resolution''' - Deprecated setting since TUFLOW Viewer 3.1.0. Previously this would control the mesh sampling interval along plotting lines (e.g. along a cross-section line). Since 3.1.0 TUFLOW Viewer will calculate mesh intersections with the plotting line and use mid-way points to extract mesh information. This was done to improve extraction from flexible mesh results (e.g. Quadtree and FV). ''Note: some mesh results store information on the mesh face as opposed to the mesh vertices (mesh face in this context refers to the cell area as opposed to the mesh sides) and TUFLOW Viewer will use the raw mesh face results and not the resampled vertex information. An example of a result dataset that stores results on the mesh face is TUFLOW FV NetCDF map outputs.''		<li> '''Resolution''' - Deprecated setting since TUFLOW Viewer 3.1.0. Previously this would control the mesh sampling interval along plotting lines (e.g. along a cross-section line). Since 3.1.0 TUFLOW Viewer will calculate mesh intersections with the plotting line and use mid-way points to extract mesh information. This was done to improve extraction from flexible mesh results (e.g. Quadtree and FV). ''Note: some mesh results store information on the mesh face as opposed to the mesh vertices (mesh face in this context refers to the cell area as opposed to the mesh sides) and TUFLOW Viewer will use the raw mesh face results and not the resampled vertex information. An example of a result dataset that stores results on the mesh face is TUFLOW FV NetCDF map outputs.''
	<li> '''Label Field Index''' - sets the index (starting at index 1) of the attribute field used for the plot legend when plotting from an existing vector layer.		<li> '''Label Field Index''' - sets the index (starting at index 1) of the attribute field used for the plot legend when plotting from an existing vector layer.

Ellis Symons at 13:19, 30 May 2022

2022-05-30T13:19:44Z

← Older revision		Revision as of 23:19, 30 May 2022
Line 16:		Line 16:
	<li> '''Zero Date''' - Changes the zero date-time - see <u>[[TUFLOW_Viewer_-_Isodate_(Date-Time)_Format \| Working With Isodate (Date-Time) format]]</u>		<li> '''Zero Date''' - Changes the zero date-time - see <u>[[TUFLOW_Viewer_-_Isodate_(Date-Time)_Format \| Working With Isodate (Date-Time) format]]</u>
	<li> '''X-Axis Label Rotation''' - changes the rotation of the x-axis tick labels when displaying as dates.		<li> '''X-Axis Label Rotation''' - changes the rotation of the x-axis tick labels when displaying as dates.
			<li> '''Plot Inactive Areas in 1D Cross-Section''' - ''Introduced in v3.4'' if checked, inactive areas on ESTRY cross-section will be shown. Prior to v3.4 inactive areas were always shown.
	<li> '''Resolution''' - Deprecated setting since TUFLOW Viewer 3.1.0. Previously this would control the mesh sampling interval along plotting lines (e.g. along a cross-section line). Since 3.1.0 TUFLOW Viewer will calculate mesh intersections with the plotting line and use mid-way points to extract mesh information. This was done to improve extraction from flexible mesh results (e.g. Quadtree and FV). ''Note: some mesh results store information on the mesh face as opposed to the mesh vertices (mesh face in this context refers to the cell area as opposed to the mesh sides) and TUFLOW Viewer will use the raw mesh face results and not the resampled vertex information. An example of a result dataset that stores results on the mesh face is TUFLOW FV NetCDF map outputs.''		<li> '''Resolution''' - Deprecated setting since TUFLOW Viewer 3.1.0. Previously this would control the mesh sampling interval along plotting lines (e.g. along a cross-section line). Since 3.1.0 TUFLOW Viewer will calculate mesh intersections with the plotting line and use mid-way points to extract mesh information. This was done to improve extraction from flexible mesh results (e.g. Quadtree and FV). ''Note: some mesh results store information on the mesh face as opposed to the mesh vertices (mesh face in this context refers to the cell area as opposed to the mesh sides) and TUFLOW Viewer will use the raw mesh face results and not the resampled vertex information. An example of a result dataset that stores results on the mesh face is TUFLOW FV NetCDF map outputs.''
	<li> '''Label Field Index''' - sets the index (starting at index 1) of the attribute field used for the plot legend when plotting from an existing vector layer.		<li> '''Label Field Index''' - sets the index (starting at index 1) of the attribute field used for the plot legend when plotting from an existing vector layer.

Ellis Symons at 16:00, 1 April 2022

2022-04-01T16:00:05Z

← Older revision		Revision as of 02:00, 2 April 2022
Line 32:		Line 32:
	<ol>		<ol>
	<li> '''By Scenario Selection''' - Only method available prior to v3.3. Gives the user the option to select the desired scenario, event, and output zone (if any of them are present) and TUFLOW Viewer will then try and figure out which results to load based on the selected criteria.		<li> '''By Scenario Selection''' - Only method available prior to v3.3. Gives the user the option to select the desired scenario, event, and output zone (if any of them are present) and TUFLOW Viewer will then try and figure out which results to load based on the selected criteria.
	<li> '''By Result Selection''' - Default since v3.3. TUFLOW Viewer will find all results based on the TCF. If there are multiple options, the user will be given the chance to choose the ~~results~~ to load. This method is generally preferred as the original method was a little ambiguous as to which results would actually be loaded. It would also miss scenario names if they were never invoked within an "IF Scenario" block anywhere in the control files.		<li> '''By Result Selection''' - Default since v3.3. TUFLOW Viewer will find all results based on the TCF. If there are multiple options, the user will be given the chance to choose the result(s) to load. This method is generally preferred as the original method was a little ambiguous as to which results would actually be loaded. It would also miss scenario names if they were never invoked within an "IF Scenario" block anywhere in the control files.
	</ol>		</ol>
	</ol>		</ol>

Ellis Symons at 15:59, 1 April 2022

2022-04-01T15:59:23Z

← Older revision		Revision as of 01:59, 2 April 2022
Line 32:		Line 32:
	<ol>		<ol>
	<li> '''By Scenario Selection''' - Only method available prior to v3.3. Gives the user the option to select the desired scenario, event, and output zone (if any of them are present) and TUFLOW Viewer will then try and figure out which results to load based on the selected criteria.		<li> '''By Scenario Selection''' - Only method available prior to v3.3. Gives the user the option to select the desired scenario, event, and output zone (if any of them are present) and TUFLOW Viewer will then try and figure out which results to load based on the selected criteria.
	<li> '''By Result Selection''' - Default since v3.3. TUFLOW Viewer will find all results based on the TCF. If there are multiple options, the user will be given the chance to choose the results to load. This method is generally preferred as the original method was a little ambiguous as to which results would actually loaded. It would also miss scenario names if they were never invoked within an "IF Scenario" block.		<li> '''By Result Selection''' - Default since v3.3. TUFLOW Viewer will find all results based on the TCF. If there are multiple options, the user will be given the chance to choose the results to load. This method is generally preferred as the original method was a little ambiguous as to which results would actually be loaded. It would also miss scenario names if they were never invoked within an "IF Scenario" block anywhere in the control files.
	</ol>		</ol>
	</ol>		</ol>

Ellis Symons at 15:58, 1 April 2022

2022-04-01T15:58:43Z

← Older revision		Revision as of 01:58, 2 April 2022
Line 32:		Line 32:
	<ol>		<ol>
	<li> '''By Scenario Selection''' - Only method available prior to v3.3. Gives the user the option to select the desired scenario, event, and output zone (if any of them are present) and TUFLOW Viewer will then try and figure out which results to load based on the selected criteria.		<li> '''By Scenario Selection''' - Only method available prior to v3.3. Gives the user the option to select the desired scenario, event, and output zone (if any of them are present) and TUFLOW Viewer will then try and figure out which results to load based on the selected criteria.
	<li> '''By Result Selection''' - Default since v3.3. TUFLOW Viewer will find all results based on the TCF. If there are multiple options, the ~~possible results~~ will be ~~presented to~~ the ~~user~~ to choose ~~from)~~. This method is generally preferred as the original method was a little ambiguous as to which results would actually loaded. It would also miss scenario names if they were never invoked within an "IF Scenario" block.		<li> '''By Result Selection''' - Default since v3.3. TUFLOW Viewer will find all results based on the TCF. If there are multiple options, the user will be given the chance to choose the results to load. This method is generally preferred as the original method was a little ambiguous as to which results would actually loaded. It would also miss scenario names if they were never invoked within an "IF Scenario" block.
	</ol>		</ol>
	</ol>		</ol>

Ellis Symons at 15:57, 1 April 2022

2022-04-01T15:57:16Z

← Older revision		Revision as of 01:57, 2 April 2022
Line 32:		Line 32:
	<ol>		<ol>
	<li> '''By Scenario Selection''' - Only method available prior to v3.3. Gives the user the option to select the desired scenario, event, and output zone (if any of them are present) and TUFLOW Viewer will then try and figure out which results to load based on the selected criteria.		<li> '''By Scenario Selection''' - Only method available prior to v3.3. Gives the user the option to select the desired scenario, event, and output zone (if any of them are present) and TUFLOW Viewer will then try and figure out which results to load based on the selected criteria.
	<li> '''By Result Selection''' - Default since v3.3. TUFLOW Viewer will find all results based on the TCF. If there are multiple options, the possible results will be presented to the user to choose from). This method is generally preferred as the original method was a little ambiguous as to which results would actually loaded.		<li> '''By Result Selection''' - Default since v3.3. TUFLOW Viewer will find all results based on the TCF. If there are multiple options, the possible results will be presented to the user to choose from). This method is generally preferred as the original method was a little ambiguous as to which results would actually loaded. It would also miss scenario names if they were never invoked within an "IF Scenario" block.
	</ol>		</ol>
	</ol>		</ol>