Ctrl+K

tidy3d.plugins.design.ParameterFloat

tidy3d.plugins.design.ParameterFloat#

class ParameterFloat[source]#

Bases: ParameterNumeric

Parameter containing floats.

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[Union[float, int], Union[float, int]]) – (min, max) inclusive range within which the variable should be swept.

  • num_points (Optional[PositiveInt] = None) – Number of uniform sampling points for this variable. Only used for ‘MethodGrid’.

Example

>>> import tidy3d.plugins.design as tdd
>>> var = tdd.ParameterFloat(name="x", num_points=10, span=(1, 2.5))

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.
num_points#
sample_random(num_samples)[source]#

Sample this design variable randomly ‘num_samples’ times.

select_from_01(pts_01)[source]#

Select values given a set of points between 0, 1.

__hash__()#

Hash method.