RootSaturation.sample_curve

RootSaturation.sample_curve(parameters=FieldInfo(annotation=NoneType, required=True, description='Parameters of the saturation transformation.'), max_value=FieldInfo(annotation=NoneType, required=False, default=1.0, description='Maximum range value.', metadata=[Gt(gt=0)]), num_points=FieldInfo(annotation=NoneType, required=False, default=100, description='Number of points between 0 and max_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.

num_pointsint, optional

Number of points between 0 and max_value, by default 100.

Returns:

xr.DataArray

Curve of the saturation transformation.