fastoad.gui.analysis_and_plots module

Defines the analysis and plotting functions for postprocessing

fastoad.gui.analysis_and_plots.wing_geometry_plot(aircraft_file_path: str | PathLike, name=None, fig=None, *, file_formatter=None) → FigureWidget

Returns a figure plot of the top view of the wing. Different designs can be superposed by providing an existing fig. Each design can be provided a name.

Parameters:

• aircraft_file_path – path of data file

• name – name to give to the trace added to the figure

• fig – existing figure to which add the plot

• file_formatter – the formatter that defines the format of data file. If not provided, default format will be assumed.

Returns:

wing plot figure

fastoad.gui.analysis_and_plots.aircraft_geometry_plot(aircraft_file_path: str | PathLike, name=None, fig=None, *, file_formatter=None) → FigureWidget

Returns a figure plot of the top view of the wing. Different designs can be superposed by providing an existing fig. Each design can be provided a name.

Parameters:

• aircraft_file_path – path of data file

• name – name to give to the trace added to the figure

• fig – existing figure to which add the plot

• file_formatter – the formatter that defines the format of data file. If not provided, default format will be assumed.

Returns:

wing plot figure

fastoad.gui.analysis_and_plots.drag_polar_plot(aircraft_file_path: str | PathLike, name=None, fig=None, *, file_formatter=None) → FigureWidget

Returns a figure plot of the aircraft drag polar. Different designs can be superposed by providing an existing fig. Each design can be provided a name.

Parameters:

• aircraft_file_path – path of data file

• name – name to give to the trace added to the figure

• fig – existing figure to which add the plot

• file_formatter – the formatter that defines the format of data file. If not provided, default format will be assumed.

Returns:

wing plot figure

fastoad.gui.analysis_and_plots.mass_breakdown_bar_plot(aircraft_file_path: str | PathLike, name=None, fig=None, *, file_formatter=None, input_mass_name='data:weight:aircraft:MTOW') → FigureWidget

Returns a figure plot of the aircraft mass breakdown using bar plots. Different designs can be superposed by providing an existing fig. Each design can be provided a name.

Parameters:

• aircraft_file_path – path of data file

• name – name to give to the trace added to the figure

• fig – existing figure to which add the plot

• file_formatter – the formatter that defines the format of data file. If not provided, default format will be assumed.

• input_mass_name – the variable name for the mass input as defined in the mission definition file.

Returns:

bar plot figure

fastoad.gui.analysis_and_plots.mass_breakdown_sun_plot(aircraft_file_path: str | PathLike, *, file_formatter=None, input_mass_name='data:weight:aircraft:MTOW', mission_name=None)

Returns a figure sunburst plot of the mass breakdown of the aircraft of the sizing mission. On the left a MTOW sunburst and on the right a OWE sunburst. Different designs can be superposed by providing an existing fig. Each design can be provided a name.

Parameters:

• aircraft_file_path – path of data file

• file_formatter – the formatter that defines the format of data file. If not provided, default format will be assumed.

• input_mass_name – the variable name for the mass input as defined in the mission definition file.

• mission_name – the name of the specific mission for which the mass breakdown is plotted. If not provided, the sizing mission configuration is plotted.

Returns:

sunburst plot figure

fastoad.gui.analysis_and_plots.payload_range_plot(aircraft_file_path: str | PathLike, name='Payload-Range', mission_name='operational', variable_of_interest: str | None = None, variable_of_interest_legend: str | None = None)

Returns a figure of the payload-range diagram. The diagram contains by default only the contour but can also provide a heatmap of the grid points, if variable_of_interest is not None. Please note that the data for the contour are expected in the variables data:payload_range:{mission_name}:range and data:payload_range:{mission_name}:payload. Similarly, the data for the heatmap are expected in the variables data:payload_range:{mission_name}:grid:range, data:payload_range:{mission_name}:grid:payload and data:payload_range:{mission_name}:grid:{variable_of_interest}.

Parameters:

• aircraft_file_path – path of data file

• name – name to give to the trace added to the figure

• mission_name – name of the mission present in the data file to be plotted.

• variable_of_interest – variable of interest for the heatmap.

• variable_of_interest_legend – name to give to variable of interest in plot legend.

Returns:

payload-range plot figure