tidy3d.plugins.design.ParameterInt

class ParameterInt

Bases: ParameterNumeric

Parameter containing integers.

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.

• span (tuple[int, int]) – (min, max) range within which are allowed values for the variable. The min value is inclusive and the max value is exclusive. In other words, a grid search over this variable will iterate over np.arange(min, max).

Example

>>> import tidy3d.plugins.design as tdd
>>> var = tdd.ParameterInt(name="x", span=(1, 4))

Attributes

span
name
values

Methods

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.

span

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.