matlantis_features.features.phonon.band.plot_band_dos(band_results: PostPhononBandFeatureResult, dos_results: PostPhononDOSFeatureResult, plt_name: Optional[str] = None) → Figure#

Plot the phonon band structure and phonon density of states in one figure.

Parameters

  • band_results (PostPhononBandFeatureResult) – The result of PostPhononBandFeature.

  • dos_results (PostPhononDOSFeatureResult) – The result of PostPhononDOSFeature.

  • plt_name (str or None, optional) – The file name to which the figure will be saved.
    Supported formats include ‘png’ ‘jpg’ ‘jpeg’ ‘webp’ ‘svg’ and ‘pdf’. If
    ‘None’ is provided, the figure will not be saved. Defaults to None.

Returns

The plot of the phonon band structure and phonon density of states as a
plotly.graph_objects.Figure instance.

Return type

go.Figure