fdtdx.GaussianSmoothing2D

fdtdx.GaussianSmoothing2D#

class fdtdx.GaussianSmoothing2D(*, std_discrete=null, padding_low_axis0=None, padding_high_axis0=None, padding_low_axis1=None, padding_high_axis1=None)[source]#

Bases: SameShapeTypeParameterTransform

Applies Gaussian smoothing to 2D parameter arrays.

This transform convolves the input with a 2D Gaussian kernel, which helps reduce noise and smooth the data.

Quick Reference#

Attributes

Methods

Attributes#

GaussianSmoothing2D.padding_high_axis0: Array | None#

1D array of shape (ny,) used as padding after axis 0. None falls back to edge-repeat.

GaussianSmoothing2D.padding_high_axis1: Array | None#

1D array of shape (nx,) used as padding after axis 1. None falls back to edge-repeat.

GaussianSmoothing2D.padding_low_axis0: Array | None#

1D array of shape (ny,) used as padding before axis 0. None falls back to edge-repeat.

GaussianSmoothing2D.padding_low_axis1: Array | None#

1D array of shape (nx,) used as padding before axis 1. None falls back to edge-repeat.

GaussianSmoothing2D.std_discrete: int#

Integer specifying the standard deviation of the Gaussian kernel in discrete units.

Methods#

GaussianSmoothing2D.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

GaussianSmoothing2D.get_class_fields()#
Return type:

list[TreeClassField]

GaussianSmoothing2D.get_input_shape(output_shape)#
Return type:

dict[str, tuple[int, ...]]

GaussianSmoothing2D.get_output_type(input_type)#
Return type:

dict[str, ParameterType]

GaussianSmoothing2D.get_public_fields()#
Return type:

list[TreeClassField]

GaussianSmoothing2D.init_module(config, materials, matrix_voxel_grid_shape, single_voxel_size, output_shape)#
Return type:

Self

GaussianSmoothing2D.init_type(input_type)#
Return type:

Self

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