bar

bar(results, h='pdf', **kwargs)[source]

Convenience wrapper for matplotlib’s bar.

This automatically:

  • Fetches the bin_centers

  • Fetches the bin heights from the specified h

  • Sets the bin widths

  • Sets the edges to black

Parameters:

  • results (object) – The objects returned by various functions in the porespy.metrics submodule, such as chord_length_distribution.

  • h (str) – The value to use for bin heights. The default is pdf, but cdf is another option. Depending on the function the named-tuple may have different options.

  • kwargs (keyword arguments) – All other keyword arguments are passed to bar, including edgecolor if you wish to overwrite the default black.

Returns:

fig

Return type:

Matplotlib figure handle

Examples

Click here to view online example.