mirror of https://github.com/KLayout/klayout.git
174 lines
6.3 KiB
XML
174 lines
6.3 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
|
|
|
|
<!-- generated by /home/matthias/klayout/master/scripts/extract_doc.rb -->
|
|
<!-- DO NOT EDIT! -->
|
|
|
|
<doc>
|
|
<title>LVS Reference: Global Functions</title>
|
|
<keyword name="global"/>
|
|
<p>
|
|
Some functions are available on global level and can be used without any object.
|
|
Most of them are convenience functions that basically act on some default object
|
|
or provide function-like alternatives for the methods.
|
|
</p><p>
|
|
LVS is built upon DRC. So all functions available in DRC are also available
|
|
in LVS. In LVS, DRC functions are used to derive functional layers from original
|
|
layers or specification of the layout source.
|
|
</p><p>
|
|
For more details about the DRC functions see <a href="/about/drc_ref_global.xml">DRC::global</a>.
|
|
</p>
|
|
<h2-index/>
|
|
<h2>"align" - Aligns the extracted netlist vs. the schematic by flattening circuits where required</h2>
|
|
<keyword name="align"/>
|
|
<a name="align"/><p>Usage:</p>
|
|
<ul>
|
|
<li><tt>align</tt></li>
|
|
</ul>
|
|
<p>
|
|
See <a href="/about/lvs_ref_netter.xml#align">Netter#align</a> for a description of that function.
|
|
</p>
|
|
<h2>"compare" - Compares the extracted netlist vs. the schematic</h2>
|
|
<keyword name="compare"/>
|
|
<a name="compare"/><p>Usage:</p>
|
|
<ul>
|
|
<li><tt>compare</tt></li>
|
|
</ul>
|
|
<p>
|
|
See <a href="/about/lvs_ref_netter.xml#compare">Netter#compare</a> for a description of that function.
|
|
</p>
|
|
<h2>"equivalent_pins" - Marks pins as equivalent</h2>
|
|
<keyword name="equivalent_pins"/>
|
|
<a name="equivalent_pins"/><p>Usage:</p>
|
|
<ul>
|
|
<li><tt>equivalent_pins(circuit, pins ...)</tt></li>
|
|
</ul>
|
|
<p>
|
|
See <a href="/about/lvs_ref_netter.xml#equivalent_pins">Netter#equivalent_pins</a> for a description of that function.
|
|
</p>
|
|
<h2>"join_symmetric_nets" - Joins symmetric nets of selected circuits on the extracted netlist</h2>
|
|
<keyword name="join_symmetric_nets"/>
|
|
<a name="join_symmetric_nets"/><p>Usage:</p>
|
|
<ul>
|
|
<li><tt>join_symmetric_nets(circuit_filter)</tt></li>
|
|
</ul>
|
|
<p>
|
|
See <a href="/about/lvs_ref_netter.xml#join_symmetric_nets">Netter#join_symmetric_nets</a> for a description of that function.
|
|
</p>
|
|
<h2>"max_branch_complexity" - Configures the maximum branch complexity for ambiguous net matching</h2>
|
|
<keyword name="max_branch_complexity"/>
|
|
<a name="max_branch_complexity"/><p>Usage:</p>
|
|
<ul>
|
|
<li><tt>max_branch_complexity(n)</tt></li>
|
|
</ul>
|
|
<p>
|
|
See <a href="/about/lvs_ref_netter.xml#max_branch_complexity">Netter#max_branch_complexity</a> for a description of that function.
|
|
</p>
|
|
<h2>"max_depth" - Configures the maximum search depth for net match deduction</h2>
|
|
<keyword name="max_depth"/>
|
|
<a name="max_depth"/><p>Usage:</p>
|
|
<ul>
|
|
<li><tt>max_depth(n)</tt></li>
|
|
</ul>
|
|
<p>
|
|
See <a href="/about/lvs_ref_netter.xml#max_depth">Netter#max_depth</a> for a description of that function.
|
|
</p>
|
|
<h2>"max_res" - Ignores resistors with a resistance above a certain value</h2>
|
|
<keyword name="max_res"/>
|
|
<a name="max_res"/><p>Usage:</p>
|
|
<ul>
|
|
<li><tt>max_res(threshold)</tt></li>
|
|
</ul>
|
|
<p>
|
|
See <a href="/about/lvs_ref_netter.xml#max_res">Netter#max_res</a> for a description of that function.
|
|
</p>
|
|
<h2>"min_caps" - Ignores capacitors with a capacitance below a certain value</h2>
|
|
<keyword name="min_caps"/>
|
|
<a name="min_caps"/><p>Usage:</p>
|
|
<ul>
|
|
<li><tt>min_caps(threshold)</tt></li>
|
|
</ul>
|
|
<p>
|
|
See <a href="/about/lvs_ref_netter.xml#min_caps">Netter#min_caps</a> for a description of that function.
|
|
</p>
|
|
<h2>"netter" - Creates a new netter object</h2>
|
|
<keyword name="netter"/>
|
|
<a name="netter"/><p>Usage:</p>
|
|
<ul>
|
|
<li><tt>netter</tt></li>
|
|
</ul>
|
|
<p>
|
|
See <a href="/about/lvs_ref_netter.xml">Netter</a> for more details
|
|
</p>
|
|
<h2>"report_lvs" - Specifies an LVS report for output</h2>
|
|
<keyword name="report_lvs"/>
|
|
<a name="report_lvs"/><p>Usage:</p>
|
|
<ul>
|
|
<li><tt>report_lvs([ filename [, long ] ])</tt></li>
|
|
</ul>
|
|
<p>
|
|
After the comparison step, the LVS database will be shown
|
|
in the netlist database browser in a cross-reference view.
|
|
If a filename is given, the LVS database is also written to
|
|
this file. If a file name is given and "long" is true, a
|
|
verbose version of the LVS DB format will be used.
|
|
</p><p>
|
|
If this method is called together with report_netlist and two files each, two
|
|
files can be generated - one for the extracted netlist (L2N database) and one for the
|
|
LVS database. However, report_netlist will only write the extracted netlist
|
|
while report_lvs will write the LVS database which also includes the
|
|
extracted netlist.
|
|
</p><p>
|
|
report_lvs is only effective if a comparison step is included.
|
|
</p>
|
|
<h2>"same_circuits" - Establishes an equivalence between the circuits</h2>
|
|
<keyword name="same_circuits"/>
|
|
<a name="same_circuits"/><p>Usage:</p>
|
|
<ul>
|
|
<li><tt>same_circuits(circuit_a, circuit_b)</tt></li>
|
|
</ul>
|
|
<p>
|
|
See <a href="/about/lvs_ref_netter.xml#same_circuits">Netter#same_circuits</a> for a description of that function.
|
|
</p>
|
|
<h2>"same_device_classes" - Establishes an equivalence between the device_classes</h2>
|
|
<keyword name="same_device_classes"/>
|
|
<a name="same_device_classes"/><p>Usage:</p>
|
|
<ul>
|
|
<li><tt>same_device_classes(class_a, class_b)</tt></li>
|
|
</ul>
|
|
<p>
|
|
See <a href="/about/lvs_ref_netter.xml#same_device_classes">Netter#same_device_classes</a> for a description of that function.
|
|
</p>
|
|
<h2>"same_nets" - Establishes an equivalence between the nets</h2>
|
|
<keyword name="same_nets"/>
|
|
<a name="same_nets"/><p>Usage:</p>
|
|
<ul>
|
|
<li><tt>same_nets(circuit, net_a, net_b)</tt></li>
|
|
<li><tt>same_nets(circuit_a, net_a, circuit_b, net_b)</tt></li>
|
|
</ul>
|
|
<p>
|
|
See <a href="/about/lvs_ref_netter.xml#same_nets">Netter#same_nets</a> for a description of that function.
|
|
</p>
|
|
<h2>"schematic" - Reads the reference netlist</h2>
|
|
<keyword name="schematic"/>
|
|
<a name="schematic"/><p>Usage:</p>
|
|
<ul>
|
|
<li><tt>schematic(filename)</tt></li>
|
|
<li><tt>schematic(filename, reader)</tt></li>
|
|
<li><tt>schematic(netlist)</tt></li>
|
|
</ul>
|
|
<p>
|
|
See <a href="/about/lvs_ref_netter.xml#schematic">Netter#schematic</a> for a description of that function.
|
|
</p>
|
|
<h2>"tolerance" - Specifies compare tolerances for certain device parameters</h2>
|
|
<keyword name="tolerance"/>
|
|
<a name="tolerance"/><p>Usage:</p>
|
|
<ul>
|
|
<li><tt>tolerance(device_class_name, parameter_name, absolute_tolerance [, relative_tolerance])</tt></li>
|
|
<li><tt>tolerance(device_class_name, parameter_name [, :absolute => absolute_tolerance] [, :relative => relative_tolerance])</tt></li>
|
|
</ul>
|
|
<p>
|
|
See <a href="/about/lvs_ref_netter.xml#tolerance">Netter#tolerance</a> for a description of that function.
|
|
</p>
|
|
</doc>
|