tidy3d.ChebSampling

tidy3d.ChebSampling#

class ChebSampling[source]#

Bases: FrequencySamplingSpec

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

  • num_points (ConstrainedIntValue) – Number of Chebyshev nodes for frequency sampling.

Attributes

attrs

Methods

sampling_points(freqs)

Compute Chebyshev node frequency sampling points.

Inherited Common Usage

num_points#
sampling_points(freqs)[source]#

Compute Chebyshev node frequency sampling points.

Parameters:

freqs (FreqArray) – Target frequency array. Sampling points will span from min(freqs) to max(freqs).

Returns:

Array of Chebyshev node frequency points (second kind) in ascending order.

Return type:

FreqArray

__hash__()#

Hash method.