Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 1.39 KB

Gaussian.median.md

File metadata and controls

43 lines (29 loc) · 1.39 KB

Gaussian.median (function)

def median(self, unit=None, as_quantity=False, wrap_at=None)

Expose the median of the distribution.

See scipy docs

This method is just a wrapper around the scipy.stats method on Gaussian.dist_constructor_object with unit-conversions, support for quantity objects, and wrapping done on the returned result.

See also:

Arguments

  • unit (astropy.unit, optional, default=None): unit of the values in x to expose. If None or not provided, will assume they're in Gaussian.unit.
  • as_quantity (bool, optional, default=False): whether to return an astropy quantity object instead of just the value. Astropy must be installed.
  • wrap_at (float, None, or False, optional, default=None): value to use for wrapping. See Gaussian.wrap. If not provided or None, will use the value from Gaussian.wrap_at. Note: wrapping is computed before changing units, so wrap_at must be provided according to Gaussian.unit not unit.

Returns

  • (float) median of the distribution in units unit.