tidy3d.plugins.design.ParameterInt

class ParameterInt

Bases: ParameterNumeric

Parameter containing integers.

Parameters:

• name (Attribute: name) –

  Type	str
  Default
  Description	Unique name for the variable. Used as a key into the parameter sweep results.

• values (Attribute: values) –

  Type	Optional[Tuple[Any, …]]
  Default	= None
  Description	If specified, the parameter scan uses these values for grid search methods.

• span (Attribute: span) –

  Type	Tuple[int, int]
  Default
  Description	(min, max) range within which the variable should be swept. 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

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.

__hash__()

Hash method.