CfgLayer

class pyedb.configuration.cfg_stackup.CfgLayer(/, **data: Any)

Bases: pydantic.BaseModel

Represent one signal or dielectric layer entry.

Overview

Methods

set_huray_roughness	Configure Huray surface roughness on selected surfaces.
set_groisse_roughness	Configure Groisse surface roughness on selected surfaces.
set_etching	Configure trapezoidal etching on this conductor layer.

Properties

type	Alias for layer_type for backward compatibility.

Attributes

name
layer_type
material
fill_material
thickness
roughness
etching
color
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Import detail

from pyedb.configuration.cfg_stackup import CfgLayer

Property detail

property CfgLayer.type: str | None

Alias for layer_type for backward compatibility.

Attribute detail

CfgLayer.name: str | None = None

CfgLayer.layer_type: str | None = None

CfgLayer.material: str | None = None

CfgLayer.fill_material: str | None = None

CfgLayer.thickness: float | int | str | None = None

CfgLayer.roughness: CfgRoughnessModel | None = None

CfgLayer.etching: EtchingModel | None = None

CfgLayer.color: tuple | list | None = None

CfgLayer.model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Method detail

CfgLayer.set_huray_roughness(nodule_radius: str | float | int, surface_ratio: str | float | int, enabled: bool = True, top: bool = True, bottom: bool = True, side: bool = True) → CfgLayer

Configure Huray surface roughness on selected surfaces.

Parameters:

nodule_radiusstr , float, or int

Huray nodule radius, e.g. "0.1um".

surface_ratiostr , float, or int

Huray surface ratio.

enabledbool, optional

Enable roughness on this layer. Default is True.

topbool, optional

Apply roughness to the top surface. Default is True.

bottombool, optional

Apply roughness to the bottom surface. Default is True.

sidebool, optional

Apply roughness to the side surfaces. Default is True.

Returns:

CfgLayer

self — enables method chaining.

Examples

>>> layer.set_huray_roughness("0.1um", "2.9", top=True, bottom=False)

CfgLayer.set_groisse_roughness(roughness_value: str | float | int, enabled: bool = True, top: bool = True, bottom: bool = True, side: bool = True) → CfgLayer

Configure Groisse surface roughness on selected surfaces.

Parameters:

roughness_valuestr , float, or int

RMS roughness, e.g. 0.3e-6 (in metres).

enabledbool, optional

Enable roughness. Default is True.

topbool, optional

Default is True.

bottombool, optional

Default is True.

sidebool, optional

Default is True.

Returns:

CfgLayer

self — enables method chaining.

CfgLayer.set_etching(factor: float | int | str = 0.5, etch_power_ground_nets: bool = False, enabled: bool = True) → CfgLayer

Configure trapezoidal etching on this conductor layer.

Parameters:

factoroptional, str , float, or int

Etch factor (ratio). Default is 0.5.

etch_power_ground_netsbool, optional

Apply etching to power/ground nets as well. Default is False.

enabledbool, optional

Enable etching. Default is True.

Returns:

CfgLayer

self — enables method chaining.

Examples

>>> layer.set_etching(factor=0.4, etch_power_ground_nets=True)