{ } Raw JSON

bundles / scipy 1.17.1 / scipy / stats / _mstats_basic / trimboth

function

scipy.stats._mstats_basic:trimboth

source: /scipy/stats/_mstats_basic.py :2051

Signature

def   trimboth ( data proportiontocut = 0.2 inclusive = (True, True) axis = None )

Summary

Trims the smallest and largest data values.

Extended Summary

Trims the data by masking the int(proportiontocut * n) smallest and int(proportiontocut * n) largest values of data along the given axis, where n is the number of unmasked values before trimming.

Parameters

data : ndarray

Data to trim.

proportiontocut : float, optional

Percentage of trimming (as a float between 0 and 1). If n is the number of unmasked values before trimming, the number of values after trimming is (1 - 2*proportiontocut) * n. Default is 0.2.

inclusive : {(bool, bool) tuple}, optional

Tuple indicating whether the number of data being masked on each side should be rounded (True) or truncated (False).

axis : int, optional

Axis along which to perform the trimming. If None, the input array is first flattened.

Aliases

  • scipy.stats._mstats_basic.trimboth