tidy3d.FrequencyUtils#

class FrequencyUtils[source]#

Bases: Tidy3dBaseModel

Utilities for classifying frequencies/wavelengths and generating samples for standard optical bands.

Parameters:

use_wavelength (bool = False) – Indicate whether to use wavelengths instead of frequencies for the return values of functions and parameters.

Attributes

Methods

c_band([n])

Optical C band frequencies/wavelengths sorted by wavelength.

classification(value)

Band classification for a given frequency/wavelength.

e_band([n])

Optical E band frequencies/wavelengths sorted by wavelength.

l_band([n])

Optical L band frequencies/wavelengths sorted by wavelength.

o_band([n])

Optical O band frequencies/wavelengths sorted by wavelength.

s_band([n])

Optical S band frequencies/wavelengths sorted by wavelength.

u_band([n])

Optical U band frequencies/wavelengths sorted by wavelength.

Inherited Common Usage

use_wavelength#
classification(value)[source]#

Band classification for a given frequency/wavelength.

Frequency values must be given in hertz (Hz). Wavelengths must be given in micrometers (μm).

Parameters:

value (float) – Value to classify.

Returns:

String tuple with classification.

Return type:

tuple[str]

o_band(n=11)[source]#

Optical O band frequencies/wavelengths sorted by wavelength.

The returned samples are equally spaced in wavelength.

Parameters:

n (int) – Desired number of samples.

Returns:

Samples list.

Return type:

list[float]

e_band(n=11)[source]#

Optical E band frequencies/wavelengths sorted by wavelength.

The returned samples are equally spaced in wavelength.

Parameters:

n (int) – Desired number of samples.

Returns:

Samples list.

Return type:

list[float]

s_band(n=15)[source]#

Optical S band frequencies/wavelengths sorted by wavelength.

The returned samples are equally spaced in wavelength.

Parameters:

n (int) – Desired number of samples.

Returns:

Samples list.

Return type:

list[float]

c_band(n=8)[source]#

Optical C band frequencies/wavelengths sorted by wavelength.

The returned samples are equally spaced in wavelength.

Parameters:

n (int) – Desired number of samples.

Returns:

Samples list.

Return type:

list[float]

l_band(n=13)[source]#

Optical L band frequencies/wavelengths sorted by wavelength.

The returned samples are equally spaced in wavelength.

Parameters:

n (int) – Desired number of samples.

Returns:

Samples list.

Return type:

list[float]

u_band(n=11)[source]#

Optical U band frequencies/wavelengths sorted by wavelength.

The returned samples are equally spaced in wavelength.

Parameters:

n (int) – Desired number of samples.

Returns:

Samples list.

Return type:

list[float]