gdsfactory.typings.LayerLevel

class gdsfactory.typings.LayerLevel(*, name: str | None = None, layer: tuple[int, int] | None = None, thickness: float | None = None, thickness_tolerance: float | None = None, zmin: float | None = None, zmin_tolerance: float | None = None, material: str | None = None, sidewall_angle: float = 0.0, sidewall_angle_tolerance: float | None = None, width_to_z: float = 0.0, z_to_bias: tuple[list[float], list[float]] | None = None, mesh_order: int = 3, layer_type: Literal['grow', 'etch', 'doping', 'background'] = 'grow', mode: Literal['octagon', 'taper', 'round'] | None = None, into: list[str] | None = None, resistivity: float | None = None, bias: tuple[float, float] | float | None = None, derived_layer: tuple[int, int] | None = None, info: dict[str, Any] = None, background_doping_concentration: float | None = None, background_doping_ion: str | None = None, orientation: str | None = '100')

Level for 3D LayerStack.

Parameters:

• name – layer name.

• layer – (GDSII Layer number, GDSII datatype).

• thickness – layer thickness in um.

• thickness_tolerance – layer thickness tolerance in um.

• zmin – height position where material starts in um.

• zmin_tolerance – layer height tolerance in um.

• material – material name.

• sidewall_angle – in degrees with respect to normal.

• sidewall_angle_tolerance – in degrees.

• width_to_z – if sidewall_angle, relative z-position (0 –> zmin, 1 –> zmin + thickness).

• z_to_bias – parametrizes shrinking/expansion of the design GDS layer when extruding from zmin (0) to zmin + thickness (1). Defaults no buffering [[0, 1], [0, 0]].

• mesh_order – lower mesh order (1) will have priority over higher mesh order (2) in the regions where materials overlap.

• layer_type – grow, etch, implant, or background.

• mode – octagon, taper, round. https://gdsfactory.github.io/klayout_pyxs/DocGrow.html

• into – etch into another layer. https://gdsfactory.github.io/klayout_pyxs/DocGrow.html

• resistivity – for metals.

• bias – in um for the etch. Can be a single number or 2 numbers (bias_x, bias_y)

• derived_layer – Optional derived layer, used for layer_type=’etch’ to define the slab.

• info – simulation_info and other types of metadata.

• background_doping_concentration – uniform base doping level in the material (cm-3)

• background_doping_ion – uniform base doping ion in the material

• orientation – of the wafer (Miller indices of the plane)

__init__(**data: Any) → None

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

__init__(**data)	Create a new model by parsing and validating input data from keyword arguments.
construct([_fields_set])
copy(*[, include, exclude, update, deep])	Returns a copy of the model.
dict(*[, include, exclude, by_alias, ...])
from_orm(obj)
json(*[, include, exclude, by_alias, ...])
model_construct([_fields_set])	Creates a new instance of the Model class with validated data.
model_copy(*[, update, deep])	Usage docs: https://docs.pydantic.dev/2.7/concepts/serialization/#model_copy
model_dump(*[, mode, include, exclude, ...])	Usage docs: https://docs.pydantic.dev/2.7/concepts/serialization/#modelmodel_dump
model_dump_json(*[, indent, include, ...])	Usage docs: https://docs.pydantic.dev/2.7/concepts/serialization/#modelmodel_dump_json
model_json_schema([by_alias, ref_template, ...])	Generates a JSON schema for a model class.
model_parametrized_name(params)	Compute the class name for parametrizations of generic classes.
model_post_init(_BaseModel__context)	Override this method to perform additional initialization after __init__ and model_construct.
model_rebuild(*[, force, raise_errors, ...])	Try to rebuild the pydantic-core schema for the model.
model_validate(obj, *[, strict, ...])	Validate a pydantic model instance.
model_validate_json(json_data, *[, strict, ...])	Usage docs: https://docs.pydantic.dev/2.7/concepts/json/#json-parsing
model_validate_strings(obj, *[, strict, context])	Validate the given object contains string data against the Pydantic model.
parse_file(path, *[, content_type, ...])
parse_obj(obj)
parse_raw(b, *[, content_type, encoding, ...])
schema([by_alias, ref_template])
schema_json(*[, by_alias, ref_template])
update_forward_refs(**localns)
validate(value)

Attributes

bounds	Calculates and returns the bounds of the layer level in the z-direction.
model_computed_fields	A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_extra	Get extra fields set during validation.
model_fields	Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
model_fields_set	Returns the set of fields that have been explicitly set on this model instance.
name
layer
thickness
thickness_tolerance
zmin
zmin_tolerance
material
sidewall_angle
sidewall_angle_tolerance
width_to_z
z_to_bias
mesh_order
layer_type
mode
into
resistivity
bias
derived_layer
info
background_doping_concentration
background_doping_ion
orientation