tidy3d.CustomSampling

class CustomSampling

Bases: FrequencySamplingSpec

Custom frequency sampling specification.

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().

• freqs (Union[tuple[float, ...], ArrayLike[dtype=float, ndim=1]]) – Custom array of frequency sampling points.

Attributes

attrs

Methods

sampling_points(freqs)

Return the custom frequency sampling points.

Inherited Common Usage

freqs

sampling_points(freqs)

Return the custom frequency sampling points.

Parameters:

freqs (FreqArray) – Target frequency array (not used, custom frequencies are returned as-is).

Returns:

Array of custom frequency points.

Return type:

FreqArray

__hash__()

Hash method.