physt.examples package

Module contents

A set of examples used for demonstrating the physt capabilities / in tests.

physt.examples.fist()

A simple histogram in the shape of a fist.

Returns:h
Return type:physt.histogram1d.Histogram1D
physt.examples.load_dataset(name)

Load example dataset.

If seaborn is present, its datasets can be loaded. Physt also includes some datasets in CSV format.

Parameters:name (str) –
Returns:dataset
Return type:pandas.DataFrame
physt.examples.normal_h1(size=10000, mean=0, sigma=1)

A simple 1D histogram with normal distribution.

Parameters:
  • size (int) – Number of points
  • mean (float) – Mean of the distribution
  • sigma (float) – Sigma of the distribution
Returns:

h

Return type:

physt.histogram1d.Histogram1D

physt.examples.normal_h2(size=10000)

A simple 2D histogram with normal distribution.

Parameters:size (int) – Number of points
Returns:h
Return type:physt.histogram_nd.Histogram2D
physt.examples.normal_h3(size=10000)

A simple 3D histogram with normal distribution.

Parameters:size (int) – Number of points
Returns:h
Return type:physt.histogram_nd.Histogram2D