starepandas.read_pods#
- read_pods(pod_root, sids=None, tids=None, pattern=None, add_podname=False, path_format=None, path_delimiter=None, temporal_pattern=None, temporal_pattern_tid_index=None, verbose=False)#
Reads a STAREDataframe from a directory of STAREPods
- Parameters:
- verbose
- path_delimiter
- pod_root: str
Root directory containing the pods
- sids: array-like
STARE index values to read pods for
- tids: array-like
STARE temporal index values to read pods for
- pattern: str
name pattern of chunks to read
- add_podname: bool
toggle if the podname should be read as a parameter
- path_format: str
default: ‘{pod_root}/{sid}/’
- temporal_pattern: str
The regexp including a field containing a tid for matching. default: ‘{pod_path}(.*)-.*’
- temporal_pattern_tid_index: int
The field of the regexp temporal_pattern from which to extract a tid for matching. default: 0
- Returns:
- df: starepandas.STAREDataFrame
A dataframe containing the data of the read pods