porespy.tools.results_to_df

porespy.tools.results_to_df(obj)

A helper function to convert Results objects to pandas DataFrames.

Parameters:

obj (porespy.tools.Results) – The custom Results object to be converted to a DataFrame

Returns:

df – A DataFrame containing all of the custom attributes on the inputted Results object.

Return type:

pandas.DataFrame

Notes

The contents of the Results object are expected to be DataFrame compatible data types.