TanhSaturation.sample_curve

TanhSaturation.sample_curve(parameters=FieldInfo(annotation=Dataset, required=True, description='Parameters of the saturation transformation.', metadata=[InstanceOf()]), max_value=FieldInfo(annotation=float, required=False, default=1.0, description='Maximum range value.', metadata=[Gt(gt=0)]))

Sample the curve of the saturation transformation given parameters.

Parameters:

parametersxr.Dataset

Dataset with the parameters of the saturation transformation.

max_valuefloat, optional

Maximum value of the curve, by default 1.0.

Returns:

xr.DataArray

Curve of the saturation transformation.