fdtdx.TukeyWindow

class fdtdx.TukeyWindow(*, start_time=null, end_time=null, alpha=0.5)

Bases: TemporalWindow

Tukey (tapered-cosine) window over [start_time, end_time].

Flat top of value 1 with cosine-tapered edges occupying a fraction alpha of the window (alpha=1 is a Hann window, alpha=0 a rectangular one).

Quick Reference

Attributes

• alpha

• end_time

• start_time

Methods

• aset

• get_class_fields

• get_public_fields

• get_window

Attributes

TukeyWindow.alpha: float

Fraction of the window occupied by the cosine tapers (0 = rectangular, 1 = Hann).

TukeyWindow.end_time: float

End of the window in seconds.

TukeyWindow.start_time: float

Start of the window in seconds.

Methods

TukeyWindow.aset(attr_name, val, create_new_ok=False)

Sets an attribute of this class. In contrast to the classical .at[].set(), this method updates the class attribute directly and does not only operate on jax pytree leaf nodes. Instead, replaces the full attribute with the new value.

The attribute can either be the attribute name of this class, or for nested classes it can also be the attribute name of a class, which itself is an attribute of this class. The syntax for this operation could look like this: “a->b->[0]->[‘name’]”. Here, the current class has an attribute a, which has an attribute b, which is a list, which we index at index 0, which is an element of type dictionary, which we index using the dictionary key ‘name’.

Note that dictionary keys cannot contain square brackets or single quotes (even if they are escaped).

Parameters:

• attr_name (str) – Name of attribute to set

• val (Any) – Value to set the attribute to

• create_new_ok (bool, optional) – If false (default), throw an error if the attribute does not exist. If true, creates a new attribute if the attribute name does not exist yet.

Returns:

Updated instance with new attribute value

Return type:

Self

TukeyWindow.get_class_fields()

Return type:

list[TreeClassField]

TukeyWindow.get_public_fields()

Return type:

list[TreeClassField]

TukeyWindow.get_window(time)

Evaluate the window at the given time points.

Parameters:

time (jax.Array) – Time points in seconds.

Returns:

Non-negative window weights, same shape as time.

Return type:

jax.Array

If you find any errors in the documentation, please report them in the Github Issues!