traveler.core.omx.OMX.get_dataframe#

OMX.get_dataframe(matrix, index=None, columns=None)[source]#

Get a matrix array as a pandas.DataFrame.

This will return the entire content from a single matrix array as a pandas.DataFrame, using index or column labels from lookup vectors contained in the OMX file, or as provided directly.

Parameters:

  • matrix (str) – The name of the matrix to extract

  • index (str or array-like, optional) – The name of the lookup to use as the index, or an array of length equal to the first shape dimension. If not given, a RangeIndex is used.

  • columns (str, optional) – The name of the lookup to use as the columns, or an array of length equal to the second shape dimension. If not given, a RangeIndex is used.

Return type:

pandas.DataFrame