tidy3d.plugins.design.parameter.Parameter#

class Parameter[source]#

Specification for a single variable / dimension in a design problem.

Parameters:

attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().
name (str) – Unique name for the variable. Used as a key into the parameter sweep results.
values (Optional[Tuple[Any, ...]] = None) – If specified, the parameter scan uses these values for grid search methods.

Attributes

Methods

`sample_grid`()	Sample design variable on grid, checking for custom values.
`sample_random`(num_samples)	Sample this design variable randomly 'num_samples' times.
`select_from_01`(pts_01)	Select values given a set of points between 0, 1.

Inherited Common Usage

sample_grid()[source]#: Sample design variable on grid, checking for custom values.

abstract sample_random(num_samples)[source]#: Sample this design variable randomly ‘num_samples’ times.

abstract select_from_01(pts_01)[source]#: Select values given a set of points between 0, 1.

tidy3d.plugins.design.parameter.Parameter