inspect_locations

Project.inspect_locations(element, indices, objs=[], mode='all')[source]

Shows the values of all props and/or labels for a given subset of pores or throats.

Parameters
  • element (str) – The type of locations to inspect, either ‘pores’, or ‘throats’

  • indices (array_like) – The pore or throat indices to inspect

  • objs (list[Base]) – If given, then only the properties on the recieved object are inspected. If not given, then all objects are inspected (default).

  • mode (list[str]) – Indicates whether to inspect ‘props’, ‘labels’, or ‘all’. The default is all

Returns

df – A data frame object with each location as a column and each row as a property and/or label.

Return type

Pandas DataFrame