This is documentation for an old release of SciPy (version 0.10.1). Read this page Search for this page in the documentation of the latest stable release (version 1.15.1).

scipy.stats.mstats.trimtail

scipy.stats.mstats.trimtail(data, proportiontocut=0.2, tail='left', inclusive=(True, True), axis=None)

Trims the data by masking int(trim*n) values from ONE tail of the data along the given axis, where n is the number of unmasked values.

Parameters :

data : {ndarray}

Data to trim.

proportiontocut : {0.2, float} optional

Percentage of trimming. If n is the number of unmasked values before trimming, the number of values after trimming is (1-proportiontocut)*n.

tail : {‘left’,’right’} optional

If left (right), the proportiontocut lowest (greatest) values will be masked.

inclusive : {(True, True) tuple} optional

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

axis : {None, integer}, optional

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