ptfkit.zhao2016

def calc_ptf_zhao2016_m2_1(
    *,
    bulk_density: float | ArrayLike,
    silt: float | ArrayLike,
    clay: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    """Estimate saturated hydraulic conductivity using reconstructed M2-1.

    Arguments:
        bulk_density: Soil bulk density measured on undisturbed cores. (g/cm^3)
        silt: Silt content measured by laser diffraction using USDA taxonomy (Section 2.2.2). (%)
        clay: Clay content measured by laser diffraction using USDA taxonomy (Section 2.2.2). (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        ks: Saturated hydraulic conductivity, measured by the constant-head method. (mm/min)

    Notes:
        Prediction target: Saturated hydraulic conductivity
        Highest-ranked fitted PTF, ranked by descending R-squared (Section 3.3).
        Uses Table 1 means and standard deviations for Jia et al. (2012) Equation 3 on both
            predictors and response, as a reviewed reconstruction.

    Warning:
        The publication does not explicitly confirm Table 1 statistics as the fitted scaling
            constants or the application of response scaling. This reconstruction has not been
            verified against author software.
        Observed ranges describe the sampled soils; predictions are not clamped.

    """
    return _call(
        _calc_ptf_zhao2016_m2_1,
        bulk_density,
        silt,
        clay,
        out=out,
    )

def calc_ptf_zhao2016_m2_2(
    *,
    bulk_density: float | ArrayLike,
    silt: float | ArrayLike,
    clay: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    """Estimate saturated hydraulic conductivity using reconstructed M2-2.

    Arguments:
        bulk_density: Soil bulk density measured on undisturbed cores. (g/cm^3)
        silt: Silt content measured by laser diffraction using USDA taxonomy (Section 2.2.2). (%)
        clay: Clay content measured by laser diffraction using USDA taxonomy (Section 2.2.2). (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        ks: Saturated hydraulic conductivity, measured by the constant-head method. (mm/min)

    Notes:
        Prediction target: Saturated hydraulic conductivity
        Mean coefficients of the top 25 percent, ranked by descending R-squared (Section 3.3).
        Uses Table 1 means and standard deviations for Jia et al. (2012) Equation 3 on both
            predictors and response, as a reviewed reconstruction.

    Warning:
        The publication does not explicitly confirm Table 1 statistics as the fitted scaling
            constants or the application of response scaling. This reconstruction has not been
            verified against author software.
        Observed ranges describe the sampled soils; predictions are not clamped.

    """
    return _call(
        _calc_ptf_zhao2016_m2_2,
        bulk_density,
        silt,
        clay,
        out=out,
    )

def calc_ptf_zhao2016_m2_3(
    *,
    bulk_density: float | ArrayLike,
    silt: float | ArrayLike,
    clay: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    """Estimate saturated hydraulic conductivity using reconstructed M2-3.

    Arguments:
        bulk_density: Soil bulk density measured on undisturbed cores. (g/cm^3)
        silt: Silt content measured by laser diffraction using USDA taxonomy (Section 2.2.2). (%)
        clay: Clay content measured by laser diffraction using USDA taxonomy (Section 2.2.2). (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        ks: Saturated hydraulic conductivity, measured by the constant-head method. (mm/min)

    Notes:
        Prediction target: Saturated hydraulic conductivity
        Mean coefficients of the top 50 percent, ranked by descending R-squared (Section 3.3).
        Uses Table 1 means and standard deviations for Jia et al. (2012) Equation 3 on both
            predictors and response, as a reviewed reconstruction.

    Warning:
        The publication does not explicitly confirm Table 1 statistics as the fitted scaling
            constants or the application of response scaling. This reconstruction has not been
            verified against author software.
        Observed ranges describe the sampled soils; predictions are not clamped.

    """
    return _call(
        _calc_ptf_zhao2016_m2_3,
        bulk_density,
        silt,
        clay,
        out=out,
    )

def calc_ptf_zhao2016_m2_4(
    *,
    bulk_density: float | ArrayLike,
    silt: float | ArrayLike,
    clay: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    """Estimate saturated hydraulic conductivity using reconstructed M2-4.

    Arguments:
        bulk_density: Soil bulk density measured on undisturbed cores. (g/cm^3)
        silt: Silt content measured by laser diffraction using USDA taxonomy (Section 2.2.2). (%)
        clay: Clay content measured by laser diffraction using USDA taxonomy (Section 2.2.2). (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        ks: Saturated hydraulic conductivity, measured by the constant-head method. (mm/min)

    Notes:
        Prediction target: Saturated hydraulic conductivity
        Mean coefficients of the top 75 percent, ranked by descending R-squared (Section 3.3).
        Uses Table 1 means and standard deviations for Jia et al. (2012) Equation 3 on both
            predictors and response, as a reviewed reconstruction.

    Warning:
        The publication does not explicitly confirm Table 1 statistics as the fitted scaling
            constants or the application of response scaling. This reconstruction has not been
            verified against author software.
        Observed ranges describe the sampled soils; predictions are not clamped.

    """
    return _call(
        _calc_ptf_zhao2016_m2_4,
        bulk_density,
        silt,
        clay,
        out=out,
    )

def calc_ptf_zhao2016_m2_5(
    *,
    bulk_density: float | ArrayLike,
    silt: float | ArrayLike,
    clay: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    """Estimate saturated hydraulic conductivity using reconstructed M2-5.

    Arguments:
        bulk_density: Soil bulk density measured on undisturbed cores. (g/cm^3)
        silt: Silt content measured by laser diffraction using USDA taxonomy (Section 2.2.2). (%)
        clay: Clay content measured by laser diffraction using USDA taxonomy (Section 2.2.2). (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        ks: Saturated hydraulic conductivity, measured by the constant-head method. (mm/min)

    Notes:
        Prediction target: Saturated hydraulic conductivity
        Mean coefficients of all 400 PTFs, ranked by descending R-squared (Section 3.3).
        Uses Table 1 means and standard deviations for Jia et al. (2012) Equation 3 on both
            predictors and response, as a reviewed reconstruction.

    Warning:
        The publication does not explicitly confirm Table 1 statistics as the fitted scaling
            constants or the application of response scaling. This reconstruction has not been
            verified against author software.
        Observed ranges describe the sampled soils; predictions are not clamped.

    """
    return _call(
        _calc_ptf_zhao2016_m2_5,
        bulk_density,
        silt,
        clay,
        out=out,
    )

def calc_ptf_zhao2016_m2_6(
    *,
    bulk_density: float | ArrayLike,
    silt: float | ArrayLike,
    clay: float | ArrayLike,
    out: NDArray[floating] | None = None,
) -> floating | NDArray[floating]:
    """Estimate saturated hydraulic conductivity using reconstructed M2-6.

    Arguments:
        bulk_density: Soil bulk density measured on undisturbed cores. (g/cm^3)
        silt: Silt content measured by laser diffraction using USDA taxonomy (Section 2.2.2). (%)
        clay: Clay content measured by laser diffraction using USDA taxonomy (Section 2.2.2). (%)
        out: Optional output arrays for in-place calculation.

    Returns:
        ks: Saturated hydraulic conductivity, measured by the constant-head method. (mm/min)

    Notes:
        Prediction target: Saturated hydraulic conductivity
        Lowest-ranked fitted PTF, ranked by descending R-squared (Section 3.3).
        Uses Table 1 means and standard deviations for Jia et al. (2012) Equation 3 on both
            predictors and response, as a reviewed reconstruction.

    Warning:
        The publication does not explicitly confirm Table 1 statistics as the fitted scaling
            constants or the application of response scaling. This reconstruction has not been
            verified against author software.
        Observed ranges describe the sampled soils; predictions are not clamped.

    """
    return _call(
        _calc_ptf_zhao2016_m2_6,
        bulk_density,
        silt,
        clay,
        out=out,
    )