# {py:mod}`chimcla.util_step_history_from_logfile`

```{py:module} chimcla.util_step_history_from_logfile
```

```{autodoc2-docstring} chimcla.util_step_history_from_logfile
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`TimeDeltaManager <chimcla.util_step_history_from_logfile.TimeDeltaManager>`
  - ```{autodoc2-docstring} chimcla.util_step_history_from_logfile.TimeDeltaManager
    :summary:
    ```
* - {py:obj}`Container <chimcla.util_step_history_from_logfile.Container>`
  - ```{autodoc2-docstring} chimcla.util_step_history_from_logfile.Container
    :summary:
    ```
* - {py:obj}`MainManager <chimcla.util_step_history_from_logfile.MainManager>`
  - ```{autodoc2-docstring} chimcla.util_step_history_from_logfile.MainManager
    :summary:
    ```
````

### Functions

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

* - {py:obj}`load_lines <chimcla.util_step_history_from_logfile.load_lines>`
  - ```{autodoc2-docstring} chimcla.util_step_history_from_logfile.load_lines
    :summary:
    ```
* - {py:obj}`get_relevant_lines <chimcla.util_step_history_from_logfile.get_relevant_lines>`
  - ```{autodoc2-docstring} chimcla.util_step_history_from_logfile.get_relevant_lines
    :summary:
    ```
* - {py:obj}`get_img_filenames_from_dir <chimcla.util_step_history_from_logfile.get_img_filenames_from_dir>`
  - ```{autodoc2-docstring} chimcla.util_step_history_from_logfile.get_img_filenames_from_dir
    :summary:
    ```
* - {py:obj}`get_img_filenames_from_file <chimcla.util_step_history_from_logfile.get_img_filenames_from_file>`
  - ```{autodoc2-docstring} chimcla.util_step_history_from_logfile.get_img_filenames_from_file
    :summary:
    ```
* - {py:obj}`_get_fpath_container_from_path_list <chimcla.util_step_history_from_logfile._get_fpath_container_from_path_list>`
  - ```{autodoc2-docstring} chimcla.util_step_history_from_logfile._get_fpath_container_from_path_list
    :summary:
    ```
* - {py:obj}`get_img_filenames_from_logfile <chimcla.util_step_history_from_logfile.get_img_filenames_from_logfile>`
  - ```{autodoc2-docstring} chimcla.util_step_history_from_logfile.get_img_filenames_from_logfile
    :summary:
    ```
* - {py:obj}`plot_histogram_of_time_deltas <chimcla.util_step_history_from_logfile.plot_histogram_of_time_deltas>`
  - ```{autodoc2-docstring} chimcla.util_step_history_from_logfile.plot_histogram_of_time_deltas
    :summary:
    ```
* - {py:obj}`main <chimcla.util_step_history_from_logfile.main>`
  - ```{autodoc2-docstring} chimcla.util_step_history_from_logfile.main
    :summary:
    ```
````

### Data

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

* - {py:obj}`df_csv <chimcla.util_step_history_from_logfile.df_csv>`
  - ```{autodoc2-docstring} chimcla.util_step_history_from_logfile.df_csv
    :summary:
    ```
* - {py:obj}`line_cache <chimcla.util_step_history_from_logfile.line_cache>`
  - ```{autodoc2-docstring} chimcla.util_step_history_from_logfile.line_cache
    :summary:
    ```
````

### API

````{py:data} df_csv
:canonical: chimcla.util_step_history_from_logfile.df_csv
:value: >
   'DataFrame(...)'

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.df_csv
```

````

````{py:function} load_lines(logfile_path)
:canonical: chimcla.util_step_history_from_logfile.load_lines

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.load_lines
```
````

````{py:data} line_cache
:canonical: chimcla.util_step_history_from_logfile.line_cache
:value: >
   None

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.line_cache
```

````

````{py:function} get_relevant_lines(raw_lines, regex=None, return_indices=False)
:canonical: chimcla.util_step_history_from_logfile.get_relevant_lines

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.get_relevant_lines
```
````

`````{py:class} TimeDeltaManager(relevant_lines)
:canonical: chimcla.util_step_history_from_logfile.TimeDeltaManager

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.TimeDeltaManager
```

```{rubric} Initialization
```

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.TimeDeltaManager.__init__
```

````{py:method} get_position_time_vector(end_time: str, N: int = 1400, return_abs_times=False)
:canonical: chimcla.util_step_history_from_logfile.TimeDeltaManager.get_position_time_vector

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.TimeDeltaManager.get_position_time_vector
```

````

`````

````{py:class} Container
:canonical: chimcla.util_step_history_from_logfile.Container

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.Container
```

````

````{py:function} get_img_filenames_from_dir(image_dir)
:canonical: chimcla.util_step_history_from_logfile.get_img_filenames_from_dir

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.get_img_filenames_from_dir
```
````

````{py:function} get_img_filenames_from_file(fpaths_file)
:canonical: chimcla.util_step_history_from_logfile.get_img_filenames_from_file

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.get_img_filenames_from_file
```
````

````{py:function} _get_fpath_container_from_path_list(path_list) -> chimcla.util_step_history_from_logfile.Container
:canonical: chimcla.util_step_history_from_logfile._get_fpath_container_from_path_list

```{autodoc2-docstring} chimcla.util_step_history_from_logfile._get_fpath_container_from_path_list
```
````

````{py:function} get_img_filenames_from_logfile(all_lines)
:canonical: chimcla.util_step_history_from_logfile.get_img_filenames_from_logfile

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.get_img_filenames_from_logfile
```
````

````{py:function} plot_histogram_of_time_deltas(time_deltas)
:canonical: chimcla.util_step_history_from_logfile.plot_histogram_of_time_deltas

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.plot_histogram_of_time_deltas
```
````

`````{py:class} MainManager()
:canonical: chimcla.util_step_history_from_logfile.MainManager

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.MainManager
```

```{rubric} Initialization
```

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.MainManager.__init__
```

````{py:method} parse_args()
:canonical: chimcla.util_step_history_from_logfile.MainManager.parse_args

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.MainManager.parse_args
```

````

````{py:method} load_logfile()
:canonical: chimcla.util_step_history_from_logfile.MainManager.load_logfile

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.MainManager.load_logfile
```

````

````{py:method} main()
:canonical: chimcla.util_step_history_from_logfile.MainManager.main

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.MainManager.main
```

````

````{py:method} handle_csv_mode()
:canonical: chimcla.util_step_history_from_logfile.MainManager.handle_csv_mode

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.MainManager.handle_csv_mode
```

````

````{py:method} handle_csv_mode_count_value()
:canonical: chimcla.util_step_history_from_logfile.MainManager.handle_csv_mode_count_value

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.MainManager.handle_csv_mode_count_value
```

````

````{py:method} _create_combined_image_csv(img_row)
:canonical: chimcla.util_step_history_from_logfile.MainManager._create_combined_image_csv

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.MainManager._create_combined_image_csv
```

````

````{py:method} _create_combined_image(img_row)
:canonical: chimcla.util_step_history_from_logfile.MainManager._create_combined_image

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.MainManager._create_combined_image
```

````

````{py:method} _get_original_file(img_row) -> typing.Tuple[str, numpy.ndarray]
:canonical: chimcla.util_step_history_from_logfile.MainManager._get_original_file

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.MainManager._get_original_file
```

````

````{py:method} _fig_to_array(fig)
:canonical: chimcla.util_step_history_from_logfile.MainManager._fig_to_array

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.MainManager._fig_to_array
```

````

````{py:method} _get_relevant_images() -> pandas.DataFrame
:canonical: chimcla.util_step_history_from_logfile.MainManager._get_relevant_images

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.MainManager._get_relevant_images
```

````

````{py:method} create_db_with_filenames()
:canonical: chimcla.util_step_history_from_logfile.MainManager.create_db_with_filenames

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.MainManager.create_db_with_filenames
```

````

````{py:method} create_position_time_images()
:canonical: chimcla.util_step_history_from_logfile.MainManager.create_position_time_images

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.MainManager.create_position_time_images
```

````

`````

````{py:function} main()
:canonical: chimcla.util_step_history_from_logfile.main

```{autodoc2-docstring} chimcla.util_step_history_from_logfile.main
```
````