fdtdx.StandardToCustomRange

fdtdx.StandardToCustomRange#

class fdtdx.StandardToCustomRange(*, min_value=0, max_value=1)[source]#

Bases: SameShapeTypeParameterTransform

Maps standard [0,1] range to custom range [min_value, max_value].

Linearly maps values from [0,1] to a custom range specified by min_value and max_value parameters.

Quick Reference#

Attributes

Methods

Attributes#

StandardToCustomRange.max_value: float#

Maximum value of target range. Defaults to one.

StandardToCustomRange.min_value: float#

Minimum value of target range. Defaults to zero.

Methods#

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

StandardToCustomRange.get_class_fields()#
Return type:

list[TreeClassField]

StandardToCustomRange.get_input_shape(output_shape)#
Return type:

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

StandardToCustomRange.get_output_type(input_type)#
Return type:

dict[str, ParameterType]

StandardToCustomRange.get_public_fields()#
Return type:

list[TreeClassField]

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

Self

StandardToCustomRange.init_type(input_type)#
Return type:

Self

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