API reference - Class RExtractor

_const_cast

Signature: [const] RExtractor ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

extract

Signature: new RNetwork ptr extract (const Polygon polygon, Point[] vertex_ports = [], Polygon[] polygon_ports = [])

Description: Runs the extraction on the given polygon

This method will create a new RNetwork object from the given polygon.

'vertex_ports' is an array of points that define point-like ports. A port will create a RNode object in the resistor graph. This node object carries the type VertexPort and the index of the vertex in this array.

'polygon_ports' is an array of polygons that define distributed ports. The polygons should be inside the resistor polygon and convex. A port will create a RNode object in the resistor graph. For polygon ports, this node object carries the type PolygonPort and the index of the polygon in this array.

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

new

Signature: [static] new RExtractor ptr new

Description: Creates a new object of this class

Python specific notes:
This method is the default initializer of the object.

square_counting_extractor

Signature: [static] new RExtractor ptr square_counting_extractor (double dbu, bool skip_simplify = false)

Description: Creates a square counting R extractor

The square counting extractor extracts resistances from a polygon with ports using the following approach:

• Split the original polygon into convex parts using a Hertel-Mehlhorn decomposition
• Create internal nodes at the locations where the parts touch
• For each part, extract the resistance along the horizonal or vertical axis, whichever is longer

The square counting extractor assumes the parts are 'thin' - i.e. the long axis is much longer than the short axis - and the parts are either oriented horizontally or vertically. The current flow is assumed to be linear and homogenous along the long axis. Ports define probe points for the voltages along the long long axis. Polygon ports are considered points located at the center of the polygon's bounding box.

The results of the extraction is normalized to a sheet resistance of 1 Ohm/square - i.e. to obtain the actual resistor values, multiply the element resistance values by the sheet resistance.

tesselation_extractor

Signature: [static] new RExtractor ptr tesselation_extractor (double dbu, double min_b = 0.3, double max_area = 0, bool skip_reduction = false)

Description: Creates a tesselation R extractor

The tesselation extractor starts with a triangulation of the original polygon. The triangulation is turned into a resistor network and simplified.

The tesselation extractor is well suited for homogeneous geometries, but does not properly consider the boundary conditions at the borders of the region. It is good for extracting resistance networks of substrate or large sheet layers.

The square counting extractor assumes the parts are 'thin' - i.e. the long axis is much longer than the short axis - and the parts are either oriented horizontally or vertically. The current flow is assumed to be linear and homogenous along the long axis. Ports define probe points for the voltages along the long long axis. Polygon ports are considered points located at the center of the polygon's bounding box.

The tesselation extractor delivers a full matrix of resistors - there is a resistor between every pair of ports.

The results of the extraction is normalized to a sheet resistance of 1 Ohm/square - i.e. to obtain the actual resistor values, multiply the element resistance values by the sheet resistance.