tidy3d.plugins.design.ParameterAny

tidy3d.plugins.design.ParameterAny#

class ParameterAny[source]#

Bases: Parameter

Parameter containing a set of of anything.

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.

  • allowed_values (Tuple[Any, ...]) – The discrete set of values that this variable can take on.

Example

>>> import tidy3d.plugins.design as tdd
>>> var = tdd.ParameterAny(name="x", allowed_values=("a", "b", "c"))

Attributes

attrs

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.

Inherited Common Usage

allowed_values#
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.