# {py:mod}`haniwers.v0.dataset`

```{py:module} haniwers.v0.dataset
```

```{autodoc2-docstring} haniwers.v0.dataset
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`PathSettings <haniwers.v0.dataset.PathSettings>`
  - ```{autodoc2-docstring} haniwers.v0.dataset.PathSettings
    :summary:
    ```
* - {py:obj}`Run <haniwers.v0.dataset.Run>`
  - ```{autodoc2-docstring} haniwers.v0.dataset.Run
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`reformat_datetime <haniwers.v0.dataset.reformat_datetime>`
  - ```{autodoc2-docstring} haniwers.v0.dataset.reformat_datetime
    :summary:
    ```
* - {py:obj}`load_raw_data <haniwers.v0.dataset.load_raw_data>`
  - ```{autodoc2-docstring} haniwers.v0.dataset.load_raw_data
    :summary:
    ```
* - {py:obj}`load_files <haniwers.v0.dataset.load_files>`
  - ```{autodoc2-docstring} haniwers.v0.dataset.load_files
    :summary:
    ```
````

### API

`````{py:class} PathSettings(/, **data: typing.Any)
:canonical: haniwers.v0.dataset.PathSettings

Bases: {py:obj}`pydantic.BaseModel`

```{autodoc2-docstring} haniwers.v0.dataset.PathSettings
```

```{rubric} Initialization
```

```{autodoc2-docstring} haniwers.v0.dataset.PathSettings.__init__
```

````{py:attribute} drive
:canonical: haniwers.v0.dataset.PathSettings.drive
:type: str
:value: >
   '.'

```{autodoc2-docstring} haniwers.v0.dataset.PathSettings.drive
```

````

````{py:method} _get_path(path: str) -> pathlib.Path
:canonical: haniwers.v0.dataset.PathSettings._get_path

```{autodoc2-docstring} haniwers.v0.dataset.PathSettings._get_path
```

````

````{py:method} raw_data_path(path: str = 'raw_data') -> pathlib.Path
:canonical: haniwers.v0.dataset.PathSettings.raw_data_path

```{autodoc2-docstring} haniwers.v0.dataset.PathSettings.raw_data_path
```

````

````{py:method} preprocessed_data_path(path: str = 'parsed') -> pathlib.Path
:canonical: haniwers.v0.dataset.PathSettings.preprocessed_data_path

```{autodoc2-docstring} haniwers.v0.dataset.PathSettings.preprocessed_data_path
```

````

````{py:method} resampled_data_path(path: str = 'parsed') -> pathlib.Path
:canonical: haniwers.v0.dataset.PathSettings.resampled_data_path

```{autodoc2-docstring} haniwers.v0.dataset.PathSettings.resampled_data_path
```

````

`````

`````{py:class} Run(/, **data: typing.Any)
:canonical: haniwers.v0.dataset.Run

Bases: {py:obj}`haniwers.v0.dataset.PathSettings`

```{autodoc2-docstring} haniwers.v0.dataset.Run
```

```{rubric} Initialization
```

```{autodoc2-docstring} haniwers.v0.dataset.Run.__init__
```

````{py:attribute} run_id
:canonical: haniwers.v0.dataset.Run.run_id
:type: int
:value: >
   None

```{autodoc2-docstring} haniwers.v0.dataset.Run.run_id
```

````

````{py:attribute} date
:canonical: haniwers.v0.dataset.Run.date
:type: str
:value: >
   None

```{autodoc2-docstring} haniwers.v0.dataset.Run.date
```

````

````{py:attribute} name
:canonical: haniwers.v0.dataset.Run.name
:type: str | None
:value: >
   None

```{autodoc2-docstring} haniwers.v0.dataset.Run.name
```

````

````{py:method} model_post_init(__context: typing.Any) -> None
:canonical: haniwers.v0.dataset.Run.model_post_init

````

````{py:method} _stem() -> str
:canonical: haniwers.v0.dataset.Run._stem

```{autodoc2-docstring} haniwers.v0.dataset.Run._stem
```

````

````{py:method} _osechi_raw_data(search_pattern='osechi_data_*.csv') -> list[pathlib.Path]
:canonical: haniwers.v0.dataset.Run._osechi_raw_data

```{autodoc2-docstring} haniwers.v0.dataset.Run._osechi_raw_data
```

````

````{py:method} _osechi_preprocessed_data() -> list[pathlib.Path]
:canonical: haniwers.v0.dataset.Run._osechi_preprocessed_data

```{autodoc2-docstring} haniwers.v0.dataset.Run._osechi_preprocessed_data
```

````

````{py:method} _osechi_resampled_data() -> list[pathlib.Path]
:canonical: haniwers.v0.dataset.Run._osechi_resampled_data

```{autodoc2-docstring} haniwers.v0.dataset.Run._osechi_resampled_data
```

````

````{py:method} _ondotori_raw_data() -> list[pathlib.Path]
:canonical: haniwers.v0.dataset.Run._ondotori_raw_data

```{autodoc2-docstring} haniwers.v0.dataset.Run._ondotori_raw_data
```

````

````{py:method} _threshlod_logs_data() -> list[pathlib.Path]
:canonical: haniwers.v0.dataset.Run._threshlod_logs_data

```{autodoc2-docstring} haniwers.v0.dataset.Run._threshlod_logs_data
```

````

````{py:method} _threshold_scan_data(search_pattern) -> list[pathlib.Path]
:canonical: haniwers.v0.dataset.Run._threshold_scan_data

```{autodoc2-docstring} haniwers.v0.dataset.Run._threshold_scan_data
```

````

````{py:method} _to_dataframe(fnames, **kwargs) -> pandas.DataFrame
:canonical: haniwers.v0.dataset.Run._to_dataframe

```{autodoc2-docstring} haniwers.v0.dataset.Run._to_dataframe
```

````

````{py:method} preprocessed_data() -> pandas.DataFrame
:canonical: haniwers.v0.dataset.Run.preprocessed_data

```{autodoc2-docstring} haniwers.v0.dataset.Run.preprocessed_data
```

````

````{py:method} resampled_data() -> pandas.DataFrame
:canonical: haniwers.v0.dataset.Run.resampled_data

```{autodoc2-docstring} haniwers.v0.dataset.Run.resampled_data
```

````

````{py:method} ondotori_data() -> pandas.DataFrame
:canonical: haniwers.v0.dataset.Run.ondotori_data

```{autodoc2-docstring} haniwers.v0.dataset.Run.ondotori_data
```

````

````{py:method} threshold_logs() -> pandas.DataFrame
:canonical: haniwers.v0.dataset.Run.threshold_logs

```{autodoc2-docstring} haniwers.v0.dataset.Run.threshold_logs
```

````

````{py:method} threshold_scan(search_pattern, **kwargs) -> pandas.DataFrame
:canonical: haniwers.v0.dataset.Run.threshold_scan

```{autodoc2-docstring} haniwers.v0.dataset.Run.threshold_scan
```

````

````{py:method} __str__()
:canonical: haniwers.v0.dataset.Run.__str__

````

`````

````{py:function} reformat_datetime(datetime: str) -> str
:canonical: haniwers.v0.dataset.reformat_datetime

```{autodoc2-docstring} haniwers.v0.dataset.reformat_datetime
```
````

````{py:function} load_raw_data(fname: pathlib.Path, **kwargs) -> pandas.DataFrame
:canonical: haniwers.v0.dataset.load_raw_data

```{autodoc2-docstring} haniwers.v0.dataset.load_raw_data
```
````

````{py:function} load_files(fnames: list[pathlib.Path]) -> pandas.DataFrame
:canonical: haniwers.v0.dataset.load_files

```{autodoc2-docstring} haniwers.v0.dataset.load_files
```
````