tidy3d.plugins.design.parameter.Parameter

tidy3d.plugins.design.parameter.Parameter#

class Parameter[source]#

Bases: Tidy3dBaseModel, ABC

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

Parameters:

  • 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

name

values

Methods

sample_first()

Output the first allowed sample.

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.
name#
values#
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.

abstract sample_first()[source]#

Output the first allowed sample.