附录 A：Tcl 命令参考（第 2 部分）

PDF 来源

Sentaurus Visual User Guide (W-2024.09) 附录 A：第 282–342 页 原文命令区间：get_grid_prop → remove_cutplanes

---

get_grid_prop

获取 plot 的网格属性。

TIP

此命令仅适用于 xy 图和 2D 图。

语法

get_grid_prop
(
-align | -line1_color | -line1_style | -line1_width | -line2_color |
-line2_style | -line2_width | -show | -show_minor_lines
)
[-plot <stringValue>]

返回值

所查询属性的值。

示例

get_grid_prop -line1_color
#-> #ff0000

参数说明

参数	说明
-align	显示 plot 对齐方式（仅适用于 xy 图）。
-line1_color	显示主网格线颜色。
-line1_style	显示主网格线样式（仅适用于 xy 图）。
-line1_width	显示主网格线宽度。
-line2_color	显示次网格线颜色。
-line2_style	显示次网格线样式（仅适用于 xy 图）。
-line2_width	显示次网格线宽度。
-show	显示主网格线。
-show_minor_lines	显示次网格线。
-plot <stringValue>	Plot 名称。如未指定，则使用当前选中的 plot。

---

get_input_data

弹出可自定义的对话框，要求用户输入。

TIP

此命令仅在交互模式下有效。否则会失败，除非提供了默认值。

语法

get_input_data [-default <stringValue>] [-desc <stringValue>]
[-double | -file | -int | -list | -string | -yesno]
[-elements <stringList>]

返回值

以字符串形式返回输入结果。 如果用户取消输入，则返回默认值；若未指定默认值，则生成错误信息。

示例

get_input_data -desc "Variable that defines the cut point." \
-default 0.0 -double
#-> 1.5

参数说明

参数	说明
-default <stringValue>	设置变量的默认值。
-desc <stringValue>	描述输入内容的说明文字。
-double | -file | -int | -list | -string | -yesno	设置期望的输入类型： • -double：期望输入双精度数。 • -file：从文件对话框中选择文件。 • -int：期望输入整数。 • -list：从列表中选择。 • -string：期望输入字符串（未指定类型时的默认选项）。 • -yesno：期望输入 Yes 或 No，返回 1 表示 Yes，0 表示 No。
-elements <stringList>	可能的元素列表。

---

get_interfaces

沿一条直线遍历，查找所有材料或区域与其他材料/区域存在界面的位置点。直线可通过一对坐标点指定，也可通过两个轴及其坐标值指定。

TIP

此命令仅适用于 2D 和 3D 图。

语法

get_interfaces
-points {<x1> <y1> [<z1>] <x2> <y2> [<z2>]} |
-x <doubleValue> -y <doubleValue> [-z <doubleValue>]
[-dataset <stringValue> | -plot <stringValue>]
[-materials <stringList> | -regions <stringList>]

返回值

所有材料或区域与其他材料/区域存在界面的位置点列表。

示例

get_interfaces -plot Plot_n1_mesh -material Silicon \
-points {-9 1 0 -9 1 2}
#-> {-9 1 0.600000023842} {-9 1 1.39999997616}

get_interfaces -plot Plot_n1_mesh -material Silicon -x -9 -y 1
#-> {-9 1 0.600000023842} {-9 1 1.39999997616}

参数说明

参数	说明
-points {<x1> <y1> [<z1>] <x2> <y2> [<z2>]}	指定一对坐标点，用于检查它们之间给定材料的所有界面。
-x <doubleValue> -y <doubleValue> [-z <doubleValue>]	指定两个轴及其坐标，沿垂直于这些轴的直线搜索界面。
-dataset <stringValue> | -plot <stringValue>	执行命令的数据集或 plot 名称。如均未指定，则使用当前选中的 2D 或 3D 图数据集。
-materials <stringList> | -regions <stringList>	指定要搜索界面的材料或区域。

---

get_legend_prop

返回图例属性。

TIP

此命令每次仅返回一个属性。

语法

get_legend_prop
(
-color_bg | -color_fg | -label_font_att | -label_font_color |
-label_font_factor | -label_font_family | -label_font_size |
-label_format | -location | -margins | -nof_labels | -orientation |
-position | -precision | -show_background | -size | -title_font_att |
-title_font_color | -title_font_factor | -title_font_family
)
[-plot <stringValue>]

返回值

所查询属性的值。

示例

get_legend_prop -orientation
#-> vertical

参数说明

参数	说明
-color_bg	图例背景色。
-color_fg	图例前景色。
-label_font_att	图例标签字体属性。
-label_font_color	图例标签字体颜色。
-label_font_factor	图例标签字体倍数。
-label_font_family	图例标签字体类型。
-label_font_size	图例标签字体大小。
-label_format	图例标签的数字格式。
-location	图例在 plot 区域中的显示位置（仅适用于 xy 图）。
-margins	图例框的边距。
-nof_labels	图例中使用的标签数量。
-orientation	图例方向。
-position	图例位置，归一化到窗口坐标（0 到 1 之间）。
-precision	图例标签精度。
-show_background	显示图例是否透明。
-size	图例大小，归一化到窗口坐标。
-title_font_att	图例标题字体属性。
-title_font_color	图例标题字体颜色。
-title_font_factor	图例标题字体倍数。
-title_font_family	图例标题字体类型。
-plot <stringValue>	Plot 名称。如未指定，则使用当前选中的 plot。

---

get_light_prop

返回光照配置属性。

TIP

此命令每次仅返回一个属性，且仅适用于 3D 图。

语法

get_light_prop
(
-back_azimuth | -back_elevation | -back_ratio | -back_warmth |
-fill_azimuth | -fill_elevation | -fill_ratio | -fill_warmth |
-head_ratio | -head_warmth |
-key_azimuth | -key_elevation | -key_intensity | -key_warmth
)
[-plot <stringValue>]

返回值

双精度数值。

示例

get_light_prop -key_warmth
#-> 0.75

参数说明

参数	说明
-back_azimuth	返回背光方位角。
-back_elevation	返回背光仰角。
-back_ratio	返回主光源与背光的比率。
-back_warmth	返回背光暖度。
-fill_azimuth	返回补光方位角。
-fill_elevation	返回补光仰角。
-fill_ratio	返回主光源与补光的比率。
-fill_warmth	返回补光暖度。
-head_ratio	返回主光源与头光的比率。
-head_warmth	返回头光暖度。
-key_azimuth	返回主光源方位角。
-key_elevation	返回主光源仰角。
-key_intensity	返回主光源强度。
-key_warmth	返回主光源暖度。
-plot <stringValue>	Plot 名称。如未指定，则使用当前选中的 plot。

---

get_line_prop

返回线条属性。

TIP

此命令每次仅返回一个属性，且仅适用于 xy 图和 2D 图。

语法

get_line_prop <stringValue>
( -line_color | -line_style | -line_width | -p1 | -p2 )
[-plot <stringValue>]

返回值

所查询属性的值。

示例

get_line_prop Line_1 -plot Plot_1 -line_width
#-> 4

参数说明

参数	说明
<stringValue>	要返回属性的线条对象名称。
-line_color	返回线条颜色。
-line_style	返回线条样式（仅适用于 xy 图）。
-line_width	返回线条宽度（像素）。
-p1	返回表示线条起点的双精度值列表。
-p2	返回表示线条终点的双精度值列表。
-plot <stringValue>	Plot 名称。如未指定，则使用当前选中的 plot。

---

get_material_prop

返回材料属性。

TIP

此命令每次仅返回一个属性，且仅适用于 2D 和 3D 图。

语法

get_material_prop <stringValue>
(
-border_color | -border_width | -color | -mesh_color | -mesh_width |
-on | -particles_size | -show_all | -show_border |
-show_bulk | -show_field | -show_mesh | -show_vector |
-translucency_level | -translucency_on
)
[-geom <stringValue>] [-plot <stringValue>]

返回值

所查询属性的值。

示例

get_material_prop Silicon -plot Plot_2D -show_mesh
#-> false

参数说明

参数	说明
<stringValue>	材料名称。
-border_color	材料边界颜色。
-border_width	材料边界宽度（像素）。
-color	材料体颜色。
-mesh_color	材料网格颜色。
-mesh_width	材料网格宽度（像素）。
-on	材料可见性状态。
-particles_size	粒子大小。
-show_all	显示材料可见性状态。
-show_border	显示材料边界可见性状态。
-show_bulk	显示材料体可见性状态。
-show_field	显示材料标量场可见性状态。
-show_mesh	显示材料网格可见性状态。
-show_vector	显示材料矢量场可见性状态。
-translucency_level	材料半透明度级别。
-translucency_on	显示半透明度是否已激活。
-geom <stringValue>	指定要请求材料属性的几何体。如未指定，则使用给定 -plot 的第一个几何体。
-plot <stringValue>	请求材料属性的 plot 名称。如未指定，则使用当前选中的 plot。

---

get_plot_prop

返回 plot 属性。

TIP

此命令每次仅返回一个属性。

语法

get_plot_prop
(
-axes_interchanged | -bg_gradient | -caption_font_size |
-caption_leader_on | -caption_material | -color_bg | -color_fg |
-color_map | -color_palette | -e_path_limit | -frame_width |
-gradient_colors | -keep_aspect_ratio | -material_colors |
-path_depth | -ratio_xtoy | -show | -show_axes |
-show_axes_label | -show_axes_title | -show_cube_axes |
-show_curve_lines | -show_curve_markers | -show_grid |
-show_legend | -show_major_ticks |
-show_max_marker | -show_min_marker | -show_minor_ticks |
-show_path | -show_regions_bg | -show_title |
-tdr_state | -tdr_state_index | -title |
-title_font_att | -title_font_color | -title_font_factor |
-title_font_family | -title_font_size | -transformation
)
[-plot <stringValue>]

返回值

所查询属性的值。

示例

get_plot_prop -title
#-> Test Plot

参数说明

参数	说明
-axes_interchanged	返回轴是否被交换的值（仅适用于 2D 图）。
-bg_gradient	返回背景是否显示渐变的值（仅适用于 2D 和 3D 图）。
-caption_font_size	返回标题字体大小（仅适用于 3D 图）。
-caption_leader_on	返回是否显示标题引导线（仅适用于 3D 图）。
-caption_material	返回在标题中显示材料名还是区域名。
-color_bg	显示实色背景激活时使用的背景色。
-color_fg	显示前景色。
-color_map	返回颜色映射是否为默认（完整调色板）、灰度或自定义（参见 -color_palette）。
-color_palette	返回自定义颜色调色板使用的颜色分量向量。
-e_path_limit	返回路径是否受限的值。
-frame_width	返回一个小于 8 的正整数，表示以像素为单位的边框宽度。
-gradient_colors	返回渐变背景激活时使用的颜色列表（仅适用于 2D 和 3D 图）。
-keep_aspect_ratio	返回是否保持纵横比的值（仅适用于 2D 图）。
-material_colors	返回颜色方案是"经典（Classic）"还是"生动（Vivid）"。
-path_depth	返回在 plot 标题中显示的路径目录名数量。
-ratio_xtoy	返回 x 轴和 y 轴之间的变换比率（仅适用于 2D 图）。
-show	返回 plot 是否显示的值。
-show_axes	返回是否显示轴的值。
-show_axes_label	返回是否显示轴标签的值（仅适用于 xy 图）。
-show_axes_title	返回是否显示轴标题的值（仅适用于 xy 图）。
-show_cube_axes	返回是否显示立方轴的值（仅适用于 3D 图）。
-show_curve_lines	返回是否显示曲线线的值（仅适用于 xy 图）。
-show_curve_markers	返回是否激活标记的值（仅适用于 xy 图）。
-show_grid	返回是否显示网格的值（仅适用于 xy 和 2D 图）。
-show_legend	返回是否显示图例的值。
-show_major_ticks	返回是否显示主刻度的值（仅适用于 3D 图）。
-show_max_marker	返回是否显示最大值标记的值（仅适用于 2D 和 3D 图）。
-show_min_marker	返回是否显示最小值标记的值（仅适用于 2D 和 3D 图）。
-show_minor_ticks	返回是否显示次刻度的值（仅适用于 3D 图）。
-show_path	返回是否显示路径的值。
-show_regions_bg	返回是否显示区域背景色的值。
-show_title	返回是否显示标题的值。
-tdr_state	返回当前在 plot 中显示的 TDR 状态名称。
-tdr_state_index	返回当前在 plot 中显示的 TDR 状态索引。
-title	显示 plot 标签。
-title_font_att	显示 plot 标签属性（normal、bold、italic、underline 或 strikeout）。
-title_font_color	显示使用的 plot 标签颜色。
-title_font_factor	返回字体大小因子的值（仅适用于 2D 和 3D 图）。
-title_font_family	显示使用的标签字体族（arial、courier 或 times）。
-title_font_size	返回标签字体大小的值（仅适用于 xy 图）。
-transformation	显示使用的变换（仅适用于 3D 图）。
-plot <stringValue>	Plot 名称。如未指定，则使用当前选中的 plot。

---

get_rectangle_prop

返回矩形属性。

TIP

此命令每次仅返回一个属性，且仅适用于 xy 图和 2D 图。

语法

get_rectangle_prop <stringValue>
(
-fill_color | -line_color | -line_style | -line_width | -p1 | -p2
)
[-plot <stringValue>]

返回值

所查询属性的值。

示例

get_rectangle_prop Rectangle_1 -plot Plot_1 -fill_color
#-> #00FF3B

参数说明

参数	说明
<stringValue>	要返回属性的矩形对象名称。
-fill_color	返回矩形内部的填充颜色。
-line_color	返回线条颜色。
-line_style	返回线条样式。
-line_width	返回线条宽度。
-p1	返回表示矩形起点的双精度值列表（2D 图中为左下角，xy 图中为左上角）。
-p2	返回表示矩形终点的双精度值列表（2D 图中为右上角，xy 图中为右下角）。
-plot <stringValue>	Plot 名称。如未指定，则使用当前选中的 plot。

---

get_region_prop

返回区域属性。

TIP

此命令每次仅返回一个属性，且仅适用于 2D 和 3D 图。

语法

get_region_prop <stringValue>
(
-border_color | -border_width | -color | -mesh_color | -mesh_width |
-on | -particles_size |
-show_all | -show_border | -show_bulk | -show_caption |
-show_field | -show_mesh | -show_vector |
-translucency_level | -translucency_on
)
[-geom <stringValue>] [-plot <stringValue>]

返回值

所查询属性的值。

示例

get_region_prop RGate -plot Plot_2D -border_color
#->#0000FF

参数说明

参数	说明
<stringValue>	区域名称。
-border_color	区域边界颜色。
-border_width	区域边界宽度（像素）。
-color	区域体颜色。
-mesh_color	区域网格颜色。
-mesh_width	区域网格宽度（像素）。
-on	材料可见性状态。
-particles_size	当前粒子大小。仅适用于粒子（kinetic Monte Carlo）区域。
-show_all	显示区域可见性状态。
-show_border	显示区域边界可见性状态。
-show_bulk	显示区域体可见性状态。
-show_caption	显示区域标题可见性状态。
-show_field	显示区域标量场可见性状态。
-show_mesh	显示区域网格可见性状态。
-show_vector	显示区域矢量场可见性状态。
-translucency_level	区域半透明度级别。
-translucency_on	显示半透明度是否已激活。
-geom <stringValue>	指定要请求区域属性的几何体。如未指定，则使用给定 -plot 的第一个几何体。
-plot <stringValue>	请求区域属性的 plot 名称。如未指定，则使用当前选中的 plot。

---

get_ruler_prop

返回标尺属性。

TIP

此命令每次仅返回一个属性。

语法

get_ruler_prop -color | -pos1 | -pos2 | -precision | -show_label |
-snap_on | -snap_type | -width
[-id <intValue>] [-plot <stringValue>]

返回值

所查询属性的值。

示例

get_ruler_prop -width
#-> 4

参数说明

参数	说明
-color	标尺颜色。
-pos1	标尺第一点。
-pos2	标尺第二点。
-precision	测量值的小数精度。
-show_label	标尺标签状态。
-snap_on	网格吸附功能状态。
-snap_type	Sentaurus Process Explorer 结构的吸附类型状态。值为 none、both、corner 和 edge。
-width	标尺宽度（像素）。
-id <intValue>	标尺 ID，命令将在该 ID 下搜索属性。如未指定，则使用最后选中的标尺。
-plot <stringValue>	Plot 名称，命令将在该 plot 中搜索属性。如未指定，则使用当前选中的 plot。

---

get_streamline_prop

返回流线的指定属性。

TIP

此命令仅适用于 2D 和 3D 图。

语法

get_streamline_prop <stringValue> -plot <stringValue>
(
-arrow_angle | -arrow_color | -arrow_size | -arrow_step |
-arrow_style | -arrow_width | -constant_arrow |
-line_color | -line_resolution | -line_style |
-line_width | -positive_direction | -show_arrows | -show_line
)

返回值

所查询属性的值。

示例

get_streamline_prop Streamline_1 -plot Plot_2D -arrow_angle
#-> 30

参数说明

参数	说明
<stringValue>	要返回属性的流线名称。
-plot <stringValue>	请求流线属性的 plot 名称。如未指定，则使用当前选中的 plot。
-arrow_angle	箭头角度。
-arrow_color	箭头颜色。
-arrow_size	箭头大小。
-arrow_step	箭头间距。
-arrow_style	返回流线箭头样式。
-arrow_width	箭头宽度。
-constant_arrow	返回流线箭头在 plot 区域中是否与向量幅度无关（恒定缩放）还是与向量幅度成比例（正常）。
-line_color	线条颜色。
-line_resolution	构成线条的点之间的距离。
-line_style	线条样式。
-line_width	线条宽度。
-positive_direction	显示箭头是在正常视图还是倒转视图中显示。
-show_arrows	显示箭头是否可见。
-show_line	显示线条是否可见。

---

get_textbox_prop

返回文本框的指定属性。

TIP

此命令仅适用于 xy 图和 2D 图。

语法

get_textbox_prop <stringValue>
(
-anchor_pos | -arrow_size | -font_att | -font_color | -font_factor |
-font_family | -font_size | -line_color | -line_style | -line_width |
-pos | -rotation | -show_anchor | -show_border | -text
)
[-plot <stringValue>]

返回值

所查询属性的值。

示例

get_textbox_prop Textbox_1 -text
#-> Hello World

参数说明

参数	说明
<stringValue>	文本框名称。
-anchor_pos	使用世界坐标系返回锚点位置（仅适用于 2D 图）。
-arrow_size	返回箭头大小（仅适用于 2D 图）。
-font_att	返回文本框字体属性。
-font_color	返回文本字体颜色。
-font_factor	返回文本字体倍数（仅适用于 2D 图）。
-font_family	返回文本字体族。
-font_size	返回字体大小（仅适用于 xy 图）。
-line_color	返回线条和箭头颜色（仅适用于 2D 图）。
-line_style	返回文本框线条的表示样式（仅适用于 2D 图）。
-line_width	返回文本框和锚点线的宽度（仅适用于 2D 图）。
-pos	返回文本框左下角位置。 对于 xy 图，返回世界坐标系中的一个点 {x, y}（关于世界坐标系的说明请参见第 60 页"在图上插入文本"）。 对于 2D 图，返回归一化的相对屏幕坐标对（0.0 到 1.0 之间）。
-rotation	返回文本框的旋转角度（仅适用于 xy 图）。
-show_anchor	如果显示了文本框锚点则返回 true（仅适用于 2D 图）。
-show_border	如果显示了文本框边框则返回 true（仅适用于 2D 图）。
-text	返回文本框中的文本。
-plot <stringValue>	命令搜索文本框的 plot 名称。如未指定，则使用当前选中的 plot。

---

get_variable_data

返回变量值列表。

TIP

此命令仅适用于 xy 图。

语法

get_variable_data <stringValue> -dataset <stringValue>

返回值

列表。

示例

get_variable_data X -dataset plotXY
#-> 1 2 3 4 5

参数说明

参数	说明
<stringValue>	变量名称。
-dataset <stringValue>	数据集名称。

---

get_vector_prop

返回矢量场的指定属性。

TIP

此命令仅适用于 2D 和 3D 图。

语法

get_vector_prop <stringValue>
(
-constant_heads | -fill_color | -head_angle | -head_shape |
-head_size | -line_color | -line_pattern | -line_width |
-scale | -scale_factor_grid | -scale_factor_uniform | -show
)
[-geom <stringValue>] [-plot <stringValue>]

返回值

所查询属性的值。

示例

get_vector_prop ElectricField-V -plot Plot_2D -geom 2D -scale
#-> uniform

参数说明

参数	说明
<stringValue>	矢量场名称。
-constant_heads	显示箭头是否相对于 plot 区域恒定（与矢量幅度无关）还是与矢量幅度成比例（正常）。
-fill_color	实心箭头颜色。
-head_angle	箭头角度。
-head_shape	箭头形状。
-head_size	箭头大小。
-line_color	箭头颜色。
-line_pattern	箭头线型。
-line_width	箭头宽度。
-scale	显示箭头的比例方式：uniform（统一大小）或 grid（网格显示）。
-scale_factor_grid	显示箭头的网格因子。
-scale_factor_uniform	显示箭头的统一因子。
-show	显示箭头是否可见。
-geom <stringValue>	指定命令搜索矢量的几何体。
-plot <stringValue>	命令搜索几何体的 plot 名称。如未指定，则使用当前选中的 plot。

---

get_vertical_lines_prop

返回垂直线属性。

TIP

此命令仅适用于 xy 图。

语法

get_vertical_lines_prop <stringValue>
( -line_color | -line_style | -line_width | -show | -values )
[-plot <stringValue>]

返回值

所查询属性的值。

示例

get_vertical_lines_prop VerticalLine_1 -values
#-> 0.001 0.0156

参数说明

参数	说明
<stringValue>	垂直线名称。
-line_color	返回垂直线颜色。
-line_style	返回垂直线样式。
-line_width	返回垂直线宽度（像素）。
-show	指示垂直线是否可见。
-values	返回表示垂直线 x 值的双精度值列表。
-plot <stringValue>	命令搜索垂直线的 plot 名称。如未指定，则使用当前选中的 plot。

---

help

显示 Sentaurus Visual Tcl 命令的相关信息。

不带任何参数时，返回所有可用 Tcl 命令的完整列表。

语法

help [<stringValue>]

返回值

字符串。

示例

help import_settings
#-> import_settings <stringValue>

参数说明

参数	说明
<stringValue>	Sentaurus Visual Tcl 命令名称。

---

import_settings

从先前保存的配置文件导入 Sentaurus Visual 设置。

语法

import_settings <stringValue>

返回值

整数。

示例

import_settings /path/to/settings.conf
#-> 0

参数说明

参数	说明
<stringValue>	配置文件名称。

---

integrate_field

对完整的 2D 或 3D plot，或在特定区域内对场进行积分。

TIP

此命令仅适用于 2D 和 3D 图。

语法

integrate_field
[-bottom <doubleValue>] [-top <doubleValue>]
[-dataset <stringValue> | -plot <stringValue>]
[-field <stringValue>]
[-geom <stringValue>]
[-materials <stringList> | -regions <stringList>]
[-points <pointList>] [-returndomain]
[-type x | y | z]
[-window {<xmin> <ymin> [<zmin>] <xmax> <ymax> [<zmax>]}]

返回值

双精度数值。

示例

integrate_field -field Abs(ElectricField) -regions {RGate}
# Dataset: 3D
# Field: Abs(ElectricField)
# ==================================
# Regions of Dimension 3
# ----------------------------------
# 1. RGate (PolySi)
#
# Integral: 3.697957e-04 [V*um^2]
#
# Domain: 9.211180e-04 [um^3]
# ----------------------------------
# Total Integral: 3.697957e-04 [V*um^2]
# Total Domain: 9.211180e-04 [um^3]
# ==================================
#-> 0.000369796

参数说明

参数	说明
-bottom <doubleValue>	设置挤出轴上多面体域的下界。
-top <doubleValue>	设置挤出轴上多面体域的上界。
-dataset <stringValue> | -plot <stringValue>	Plot 或数据集名称。如未指定，使用当前选中的 plot。
-field <stringValue>	指定要积分的场。如未指定，使用当前活动场。
-geom <stringValue>	指定数据集名称。
-materials <stringList> | -regions <stringList>	要积分的区域或材料列表。如未指定，积分所有区域。
-points <pointList>	设置用于沿选定轴挤出多段线创建多面体域的顶点。点必须定义为：{ {x0 y0 z0} {x1 y1 z1} ...}
-returndomain	设置函数返回积分域值（三维时为积分体积，二维时为积分表面积）。
-type x | y | z	选择由点定义的多段线的挤出轴。
-window {<xmin> <ymin> [<zmin>] <xmax> <ymax> [<zmax>]}	定义要积分的特定窗口。 注意：当要积分的 plot 是具有 x 轴和 z 轴的 2D 图时，参数变为 {<xmin> <zmin> <xmax> <zmax>}。同样，当 plot 具有 y 轴和 z 轴时，参数变为 {<ymin> <zmin> <ymax> <zmax>}。

---

link_plots

链接两个或多个 plot 的属性。

语法

link_plots <stringList>
[-id <intValue>]
[-special {axes_prop axis_x axis_y axis_y2 blanking curve_prop cuts
deformation field_prop field_sel grid_prop legend_prop matreg move
plot_mode plot_prop streamlines tags}]
[-unlink]

返回值

整数。

示例

link_plots {Plot_1 Plot_2} -id 10
#-> 10

参数说明

参数	说明
<stringList>	要链接的所有 plot 列表。
-id <intValue>	链接 plot 的整数标识符。
-special {<properties>}	仅链接指定的属性： • axes_prop：链接轴属性（仅适用于 2D 图）。 • axis_x、axis_y、axis_y2：分别链接 x-、y- 和 y2 轴的属性（仅适用于 xy 图）。 • blanking：链接消隐操作（仅适用于 2D 和 3D 图）。 • curve_prop：链接曲线属性（仅适用于 xy 图）。 • cuts：链接切割线和平面的切割（仅适用于 2D 和 3D 图）。 • deformation：链接变形操作（仅适用于 2D 和 3D 图）。 • field_prop：链接场的属性，如范围、比例和级别数（仅适用于 2D 和 3D 图）。 • field_sel：链接场的选择（等值带和线场的开关）（仅适用于 2D 和 3D 图）。 • grid_prop：链接网格属性（仅适用于 xy 图）。 • legend_prop：链接图例属性。 • matreg：链接材料和区域属性。 • move：链接移动操作，如缩放、平移和旋转（仅适用于 3D 图）。 • plot_mode：链接 plot 模式，如选择、缩放窗口和探测。 • plot_prop：链接 plot 属性（plot 标题文本除外）。 • streamlines：链接流线操作。默认关闭（仅适用于 2D 和 3D 图）。 • tags：链接 TDR 标签和自定义文本标签属性（仅适用于 2D 和 3D 图）。
-unlink	移除链接。

---

list_curves

返回曲线名称列表。

TIP

此命令仅适用于 xy 图。

语法

list_curves [<stringValue>] [-plot <stringValue>]
[-selected | -not_selected] [-show | -hide]

返回值

列表。

示例

list_curves _1
#-> Curve_1 Curve_12

参数说明

参数	说明
<stringValue>	指定搜索模式。
-plot <stringValue>	在特定 plot 上搜索。如未指定，在当前选中的 plot 上搜索。
-selected | -not_selected	返回已选中或未选中的曲线列表。
-show | -hide	显示或隐藏结果。

---

list_custom_buttons

返回自定义按钮列表。

语法

list_custom_buttons [<stringValue>]

返回值

与模式匹配的所有自定义按钮和分隔符列表

示例

list_custom_buttons Buttons
#-> Buttons1 Custom_Button2 MyButton

参数说明

参数	说明
<stringValue>	指定搜索模式。如未指定，命令返回所有自定义按钮。

---

list_cutlines

返回切割线列表。如未指定参数，返回所有切割线。

TIP

此命令仅适用于 2D 图。

语法

list_cutlines [<stringValue>] [-plot <stringValue>]
[-type x | y | z | free]

返回值

列表。

示例

list_cutlines -type y
#-> C1 C2

参数说明

参数	说明
<stringValue>	指定搜索模式。
-plot <stringValue>	在特定 plot 上搜索。如未指定，在当前选中的 plot 上搜索。
-type x | y | z | free	指定要搜索的切割线类型。

---

list_cutplanes

返回切割平面列表。如未指定参数，返回所有切割平面。

TIP

此命令仅适用于 3D 图。

语法

list_cutplanes [<stringValue>] [-plot <stringValue>]
[-type x | y | z | free]

返回值

列表。

示例

list_cutplanes -type y
#-> C3

参数说明

参数	说明
<stringValue>	指定搜索模式。
-plot <stringValue>	在特定 plot 上搜索。如未指定，在当前选中的 plot 上搜索。
-type x | y | z | free	指定要搜索的切割平面类型。

---

list_datasets

返回符合给定模式的数据集名称列表。如未指定模式，返回所有数据集。可以按维度、给定 plot 或选中的 plot 过滤返回的数据集。维度过滤器可与给定 plot 或选中的 plot 过滤器结合使用。

语法

list_datasets [<stringValue>] [-dim <intValue>]
[-plot <stringValue | -selected]

返回值

列表。

示例

list_datasets -dim 3
#-> 3D_3

参数说明

参数	说明
<stringValue>	指定搜索模式。
-dim <intValue>	数据集维度，可以是 1、2 或 3。
-plot <stringValue> | -selected	指定按 plot 名称过滤还是按选中的 plot 过滤。 如果指定了这些参数之一，则返回的数据集列表将限制为：对于 -plot 参数，为命名 plot 中包含的数据集；对于 -selected 参数，为选中的 plot 中包含的数据集。

---

list_ellipses

返回椭圆名称列表。

TIP

此命令仅适用于 xy 图。

语法

list_ellipses [<stringValue>] [-plot <stringValue>]

返回值

符合搜索模式的椭圆名称列表。

示例

list_ellipses -plot Plot_1
#-> Ellipse_1 Ellipse_2

参数说明

参数	说明
<stringValue>	指定搜索模式。如未指定搜索模式，返回所有椭圆名称。
-plot <stringValue>	搜索的 plot 名称。如未指定，命令使用当前选中的 plot。

---

list_fields

返回场名称列表。

TIP

此命令仅适用于 2D 和 3D 图。

语法

list_fields [<stringValue>]
[-dataset <stringValue> | -geom <stringValue> | -plot <stringValue>]
[-show | -hide] [-show_bands | -hide_bands]

返回值

列表。

示例

list_fields ElectricField -plot Plot_3D
#-> Abs(ElectricField) ElectricField-X ElectricField-Y ElectricField-Z

参数说明

参数	说明
<stringValue>	指定搜索模式。
-dataset <stringValue> | -geom <stringValue> | -plot <stringValue>	搜索特定的 plot、数据集或几何体。
-show | -hide	显示或隐藏等值带。
-show_bands | -hide_bands	搜索显示或隐藏等值带的场。

---

list_files

返回已打开文件的列表，按给定模式过滤。如未指定模式，返回所有文件。可以过滤为仅返回选中的 plot 中包含的文件。

语法

list_files [<stringValue>] [-fullpath] [-selected]

返回值

列表。

示例

list_files
#-> 2D_file.tdr 3D_file.tdr

参数说明

参数	说明
<stringValue>	指定搜索模式。
-fullpath	指定打开文件所在目录的完整路径。如未指定，使用当前工作目录。
-selected	指定仅获取选中的 plot 中包含的文件。

---

list_lines

返回线条名称列表。

TIP

此命令仅适用于 xy 图和 2D 图。

语法

list_lines [<stringValue>] [-plot <stringValue>]

返回值

符合搜索模式的线条名称列表。

示例

list_lines -plot Plot_1
#-> Line_1 Line_2

参数说明

参数	说明
<stringValue>	指定搜索模式。如未指定搜索模式，返回所有线条名称。
-plot <stringValue>	Plot 名称。如未指定，命令使用当前选中的 plot。

---

list_materials

返回材料名称列表。

TIP

此命令仅适用于 2D 和 3D 图。

语法

list_materials [<stringValue>]
[-dataset <stringValue> | -geom <stringValue> | -plot <stringValue>]
[-show_all | -hide_all] [-show_border | -hide_border]
[-show_bulk | -hide_bulk] [-show_field | -hide_field]
[-show_mesh | -hide_mesh]

返回值

列表。

示例

list_materials -plot Plot_3D
#-> Contact DepletionRegion JunctionLine nitride Oxide PolySi Silicon

参数说明

参数	说明
<stringValue>	指定搜索模式。
-dataset <stringValue> | -geom <stringValue> | -plot <stringValue>	搜索特定的 plot、数据集或几何体。
-show_all | -hide_all	完全显示或隐藏材料。
-show_border | -hide_border	显示或隐藏材料边界。
-show_bulk | -hide_bulk	显示或隐藏材料体。
-show_field | -hide_field	显示或隐藏材料场。
-show_mesh | -hide_mesh	显示或隐藏材料网格。

---

list_movie_frames

返回帧缓冲区中的帧列表。

语法

list_movie_frames

返回值

列表。

示例

list_movie_frames
# Frame0001 Frame0002 Frame0003 Frame0004

---

list_plots

返回符合给定模式的 plot 名称列表。如未指定模式，返回所有 plot。

语法

list_plots [<stringValue>] [-dim <intValue>] [-link <intValue>]
[-selected] [-show | -hide]

返回值

列表。

示例

list_plots -dim 3
#-> 3D

参数说明

参数	说明
<stringValue>	指定搜索模式。
-dim <intValue>	Plot 维度，可以是 1、2 或 3。
-link <intValue>	仅返回链接 ID 等于 <intValue> 的链接 plot。
-selected	返回选中的 plot。
-show | -hide	指定仅列出可见的 plot（-show）或仅列出隐藏的 plot（-hide）。

---

list_rectangles

返回矩形名称列表。

TIP

此命令仅适用于 xy 图和 2D 图。

语法

list_rectangles [<stringValue>] [-plot <stringValue>]

返回值

符合搜索模式的矩形名称列表。

示例

list_rectangles -plot Plot_1
#-> Rectangle_1 Rectangle_2 Rectangle_3

参数说明

参数	说明
<stringValue>	指定搜索模式。如未指定搜索模式，返回所有矩形名称。
-plot <stringValue>	Plot 名称。如未指定，命令使用当前选中的 plot。

---

list_regions

返回区域名称列表。

TIP

此命令仅适用于 2D 和 3D 图。

语法

list_regions [<stringValue>]
[-dataset <stringValue> | -geom <stringValue> | -plot <stringValue>]
[-material <stringValue>] [-parts]
[-show_all | -hide_all] [-show_border | -hide_border]
[-show_bulk | -hide_bulk] [-show_field | -hide_field]
[-show_mesh | -hide_mesh]

返回值

列表。

示例

list_regions -dataset 3D
#-> bulk gate drain DepletionRegion JunctionLine source

参数说明

参数	说明
<stringValue>	指定搜索模式。
-dataset <stringValue> | -geom <stringValue> | -plot <stringValue>	返回指定 plot、数据集或几何体的区域。如未指定，命令返回选中的 plot 的区域。
-material <stringValue>	返回指定材料中存在的区域。
-parts	返回具有部件（parts）的区域列表。
-show_all | -hide_all	按区域是否完全显示或隐藏进行过滤。
-show_border | -hide_border	按材料的边界是否显示或隐藏进行过滤。
-show_bulk | -hide_bulk	按材料的体是否显示或隐藏进行过滤。
-show_field | -hide_field	按材料的场是否显示或隐藏进行过滤。
-show_mesh | -hide_mesh	按材料的网格是否显示或隐藏进行过滤。

---

list_streamlines

返回在 plot 上创建的流线列表。

TIP

此命令仅适用于 2D 和 3D 图。

语法

list_streamlines [<stringValue>] [-plot <stringValue>]

返回值

列表。

示例

list_streamlines
#-> Streamline_1 Streamline_2 Streamline_3

参数说明

参数	说明
<stringValue>	指定搜索模式。
-plot <stringValue>	返回指定 plot 的流线。如未指定，命令返回选中的 plot 的流线。

---

list_tdr_states

返回 plot 中可视化的几何体的状态名称列表。

语法

list_tdr_states [<stringValue>] [-plot <stringValue>]

返回值

列表。

示例

list_tdr_states state_1* -plot Plot_2D
#-> state_1 state_10 state_100

参数说明

参数	说明
<stringValue>	指定状态名称必须匹配的搜索模式。如未指定，返回所有状态名称。
-plot <stringValue>	指定要可视化的几何体所在的 plot 名称。如未指定，命令使用当前选中的 plot。

---

list_textboxes

返回文本框名称列表。

TIP

此命令仅适用于 xy 图和 2D 图。

语法

list_textboxes [<stringValue>] [-plot <stringValue>]

返回值

符合搜索模式的文本框名称列表。

示例

list_textboxes -plot Plot_1
#-> TextBox_1 TextBox_2 TextBox_3

参数说明

参数	说明
<stringValue>	指定搜索模式。如未指定搜索模式，返回所有文本框名称。
-plot <stringValue>	Plot 名称。如未指定，命令使用当前选中的 plot。

---

list_variables

返回符合给定模式的变量名称列表。如未指定模式，返回所有变量。

TIP

此命令仅适用于 xy 图。

语法

list_variables -dataset <stringValue> [<stringValue>]

返回值

列表。

示例

list_variables -dataset testDataset
#-> drainCurrent gateToSourceVoltage time

参数说明

参数	说明
-dataset <stringValue>	指定要使用的数据集。
<stringValue>	指定搜索模式。

---

list_vertical_lines

返回垂直线名称列表。

TIP

此命令仅适用于 xy 图。

语法

list_vertical_lines [<stringValue>] [-plot <stringValue>]

返回值

符合搜索模式的垂直线名称列表。

示例

list_vertical_lines -plot Plot_1
#-> DE(C1(n_10)) DE(C2(n_10))

参数说明

参数	说明
<stringValue>	指定搜索模式。如未指定搜索模式，返回所有垂直线名称。
-plot <stringValue>	Plot 名称。如未指定，命令使用当前选中的 plot。

---

load_file

加载指定的文件，并返回与该文件关联的数据集名称字符串。

语法

load_file <stringValue>
[-alldata] [-fod] [-geoms <intList>] [-name <stringValue>] [-parts]

返回值

字符串。

示例

load_file /pathTo/Structure.tdr -geoms {0 2}
#-> Structure_geometry_0

参数说明

参数	说明
<stringValue>	要加载的文件名。
-alldata	无论用户偏好设置如何，加载文件中的所有数据。
-fod	按需加载场数据。
-geoms <intList>	指定要加载的几何体索引。
-name <stringValue>	指定自定义数据集名称。参见第 220 页"对象名称：-name 参数"。
-parts	此选项指定如果区域有部件（parts），则部件将独立显示和控制。

---

load_file_datasets

从指定文件加载数据集。

语法

load_file_datasets <stringValue> [-alldata] [-geoms <intList>] [-parts]

返回值

列表。

示例

load_file_datasets /pathTo/IdVg.tdr
#-> IdVg

参数说明

参数	说明
<stringValue>	文件名。
-alldata	无论用户偏好设置如何，加载文件中的所有数据。
-geoms <intList>	指定要加载的几何体索引。
-parts	此选项指定如果区域有部件（parts），则部件将独立显示和控制。

---

load_library

加载 Sentaurus Visual 库。可以加载默认路径处的所有库，或仅加载给定路径处的库，或仅加载指定路径和库名给出的库。

语法

load_library
-all |
-path <stringValue> [<stringValue>]

返回值

整数。

示例

load_library -path ~/mySVLibs myLibrary1
#-> 0

参数说明

参数	说明
-all	加载默认路径处的所有库。
-path <stringValue> [<stringValue>]	加载库所在路径。可选地，可以指定位于该路径下的特定库名称。

---

load_netlist

从 Raphael FX 加载网表文件。

语法

load_netlist <stringValue> [-plot <stringValue>]

返回值

整数。

示例

load_netlist_localData/capacitances/netlist.spf
#-> 0

参数说明

参数	说明
<stringValue>	要加载的网表文件路径。
-plot <stringValue>	创建场的 plot 或数据集名称。如未指定，命令使用当前活动 plot。

---

load_script_file

加载 Tcl 脚本或 Inspect 脚本。

语法

load_script_file <stringValue> [-inspect]

返回值

整数。

示例

load_script_file testScript.tcl
#-> 0

参数说明

参数	说明
<stringValue>	要加载的 Tcl 脚本名称。
-inspect	强制 Sentaurus Visual 将脚本作为 Inspect 脚本执行。

---

move_plot

移动选中的 plot。

语法

move_plot -position <doubleList>
[-absolute] [-plot <stringValue>]

返回值

整数。

示例

move_plot -position {1.5 0.5} -absolute
#-> 0

参数说明

参数	说明
-position <doubleList>	设置 plot 的新位置。期望双精度类型的参数。
-absolute	如果指定，则将 plot 移动到绝对位置。
-plot <stringValue>	要移动的 plot 名称。如未指定，使用当前活动 plot。

---

overlay_plots

叠加两个或多个 plot。使用指定名称创建一个新的 plot。

TIP

此命令仅适用于 2D 和 3D 图。

语法

overlay_plots <stringList>
[-datasets <stringList>] [-name <stringValue>]

返回值

字符串。

示例

overlay_plots {Plot_3D Plot_3D_2} –name Plot_Overlay
#-> Plot_Overlay

参数说明

参数	说明
<stringList>	要叠加到第一个 plot 上的 plot 列表。如果只给出一个 plot，命令将 plot 叠加到数据集列表。
-datasets <stringList>	将此数据集列表叠加到指定的 plot 列表。
-name <stringValue>	要创建的新 plot 名称。如未指定，创建一个具有通用名称的新 plot。参见第 220 页"对象名称：-name 参数"。

---

probe_curve

使用与轴匹配的内插来探测曲线（如果轴处于正常模式则为线性，如果轴处于对数模式则为对数）。

TIP

此命令仅适用于 xy 图。对于 2D 和 3D 图，请使用命令 probe_field（参见第 339 页 probe_field）。

语法

probe_curve <stringValue>
-valueX <doubleValue> | -valueY <doubleValue> | -valueY2 <doubleValue>
[-extrapolate | -snap] [-plot <stringValue>]

返回值

双精度数值。

示例

probe_curve idvg_1_des -valueX 0.85
#-> 0.5433e-6

参数说明

参数	说明
<stringValue>	要探测的曲线关联的标识符。
-valueX <doubleValue> | -valueY <doubleValue> | -valueY2 <doubleValue>	指定在曲线上要探测的点。
-extrapolate | -snap	指定探测可以外推值，或者探测返回曲线最近点。
-plot <stringValue>	包含要探测的曲线的 plot 名称。如未指定，命令使用当前选中的 plot。

---

probe_field

探测 plot 上的一个点，并返回该点上定义的场的值。

TIP

此命令仅适用于 2D 和 3D 图。对于 xy 图，请使用命令 probe_curve。

语法

probe_field
-coord {<x> <y> [<z>]} |
-point <intValue> -region <stringValue>
[-field <stringValue>] [-geom <stringValue> | -plot <stringValue>]
[-position] [-snap]

返回值

双精度数值。

示例

probe_field -field DopingConcentration -coord {0.2 0.3 -0.2}
#-> -2e18

参数说明

参数	说明
-coord {<x> <y> [<z>]}	指定要探测的点。在 2D 图中，z 值必须为 0 或必须留空。
-point <intValue>	指定要探测的相对于区域集的顶点 ID。与 -region 选项一起使用。
-region <stringValue>	指定要探测场的区域。与 -point 选项一起使用。
-field <stringValue>	要在 plot 中探测的场名称。如未指定，探测活动场。
-geom <stringValue> | -plot <stringValue>	要探测的 plot 或几何体名称。如未指定，命令探测选中的 plot。
-position	返回探测点的坐标向量。 如果指定了 -snap，返回最近节点的坐标。 如果未指定 -snap，返回 -coord。
-snap	如果指定，在最近节点上探测场。

---

reload_datasets

重新加载所有指定的数据集。

语法

reload_datasets <stringList> [-alldata]

返回值

整数。

示例

reload_datasets {3D 3D_2}
#-> 0

参数说明

参数	说明
<stringList>	要重新加载的数据集列表。
-alldata	无论用户偏好设置如何，从文件重新加载所有数据。

---

reload_files

重新加载指定的文件。

语法

reload_files <stringList> [-alldata]

返回值

整数。

示例

reload_files {2D.tdr 3D.tdr}
#-> 0

参数说明

参数	说明
<stringList>	要重新加载的文件列表。
-alldata	无论用户偏好设置如何，从文件重新加载所有数据。

---

remove_curves

从 xy 图中移除曲线。

语法

remove_curves <stringList> [-plot <stringValue>]

返回值

整数。

示例

remove_curves {IdVg_1 IdVg_2}
#-> 0

参数说明

参数	说明
<stringList>	曲线名称列表。
-plot <stringValue>	要从中移除曲线的 plot 名称。如未指定，命令使用当前活动 plot。

---

remove_custom_buttons

移除自定义按钮。

语法

remove_custom_buttons <stringList>

返回值

被移除的所有自定义按钮和分隔符列表。

示例

remove_custom_buttons {Buttons1 MyButton}
#-> Buttons1 MyButton

参数说明

参数	说明
<stringList>	自定义按钮名称列表。

---

remove_cutlines

移除指定的切割线。

语法

remove_cutlines <stringList> [-plot <stringValue>]

返回值

列表。

示例

remove_cutlines {C1 C2}
#-> C1 C2

参数说明

参数	说明
<stringList>	切割线名称列表。
-plot <stringValue>	要从中移除切割线的 plot 名称。如未指定，命令使用当前活动 plot。

---

remove_cutplanes

移除指定的切割平面。

语法

remove_cutplanes <stringList> [-plot <stringValue>]

返回值

列表。

示例

remove_cutplanes {C1 C2}
#-> C1 C2

参数说明

参数	说明
<stringList>	切割平面名称列表。
-plot <stringValue>	要从中移除切割平面的 plot 名称。