Module dcg_sci_tool.plot.plot_basic_graph

Functions

def plot_basic_graph(src_file: str = 'neb_mep.dat',
x_col: int = 0,
y_cols: int | List[int] = 3,
legend_loc='upper right',
mode: str = 'line',
x_label: str = 'Indexes',
y_label: str = 'Potential Energy (eV)',
output_file: str | None = None,
colors: List[str] | None = None,
labels: List[str] | None = None,
title: str | None = None,
config: Dict[str, Any] | None = None) ‑> matplotlib.figure.Figure

绘制基础折线图或散点图

注意： - 目前不支持图中的中文字符，请统一使用国际标准的英文 - 该函数只做前期基础配置，不输出图片，需要额外调用 plt.savefig() 输出图片 - 此设计方便在此基础上调用 plt 命令进行再加工

Parameters

src_file : str, optional

源数据文件路径，文件内容为多列数据，默认 'neb_mep.dat'

x_col : int, optional

X轴数据列索引，默认 0

y_cols : Union[int, List[int]], optional

Y轴数据列索引（单个整数或整数列表），默认 3

legend_loc : str, optional

图例的位置，'upper right' 右上角，'upper left' 左上角，

'lower right' 右下角，'lower left' 左下角。

默认 'upper right'，

mode : str, optional

绘图模式，'line' 为折线图，'scatter' 为散点图，默认 'line'

x_label : str, optional

X轴标签，默认 'Indexes'

y_label : str, optional

Y轴标签，默认 'Potential Energy (eV)'

output_file : Optional[str], optional

输出文件路径，如果为None则不自动保存

colors : Optional[List[str]], optional

颜色列表，如果为None则使用默认颜色

labels : Optional[List[str]], optional

图例标签列表，如果为None则自动生成

title : Optional[str], optional

图表标题

config : Optional[Dict[str, Any]], optional

自定义配置字典，覆盖默认配置

Returns

plt.Figure

创建的matplotlib图形对象

Raises

FileNotFoundError

当指定的源文件不存在时

ValueError

当参数值不合法时

IndexError

当指定的列索引超出数据范围时

Examples

>>> # 绘制单条折线
>>> fig = plot_basic_line_chart('data.dat', x_col=0, y_cols=1)
>>> plt.savefig('output.png', dpi=300, bbox_inches='tight')
>>> plt.show()

>>> # 绘制多条散点图
>>> fig = plot_basic_line_chart('data.dat', 
...                             x_col=0, 
...                             y_cols=[1, 2, 3],
...                             mode='scatter',
...                             labels=['Series A', 'Series B', 'Series C'])
>>> plt.savefig('scatter_plot.png', dpi=300)
>>> plt.close(fig)