# {py:mod}`ovo.core.logic.proteinqc_logic`

```{py:module} ovo.core.logic.proteinqc_logic
```

```{autodoc2-docstring} ovo.core.logic.proteinqc_logic
:allowtitles:
```

## Module Contents

### Functions

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

* - {py:obj}`tool_supports_scheduler <ovo.core.logic.proteinqc_logic.tool_supports_scheduler>`
  - ```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.tool_supports_scheduler
    :summary:
    ```
* - {py:obj}`get_available_schedulers <ovo.core.logic.proteinqc_logic.get_available_schedulers>`
  - ```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_available_schedulers
    :summary:
    ```
* - {py:obj}`get_available_tools <ovo.core.logic.proteinqc_logic.get_available_tools>`
  - ```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_available_tools
    :summary:
    ```
* - {py:obj}`get_descriptor_plot_setting <ovo.core.logic.proteinqc_logic.get_descriptor_plot_setting>`
  - ```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_descriptor_plot_setting
    :summary:
    ```
* - {py:obj}`get_descriptor_colormap <ovo.core.logic.proteinqc_logic.get_descriptor_colormap>`
  - ```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_descriptor_colormap
    :summary:
    ```
* - {py:obj}`get_plddt_color <ovo.core.logic.proteinqc_logic.get_plddt_color>`
  - ```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_plddt_color
    :summary:
    ```
* - {py:obj}`get_pae_colormap <ovo.core.logic.proteinqc_logic.get_pae_colormap>`
  - ```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_pae_colormap
    :summary:
    ```
* - {py:obj}`get_rmsd_colormap <ovo.core.logic.proteinqc_logic.get_rmsd_colormap>`
  - ```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_rmsd_colormap
    :summary:
    ```
* - {py:obj}`get_higher_is_better_colormap <ovo.core.logic.proteinqc_logic.get_higher_is_better_colormap>`
  - ```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_higher_is_better_colormap
    :summary:
    ```
* - {py:obj}`get_lower_is_better_colormap <ovo.core.logic.proteinqc_logic.get_lower_is_better_colormap>`
  - ```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_lower_is_better_colormap
    :summary:
    ```
* - {py:obj}`get_neutral_colormap <ovo.core.logic.proteinqc_logic.get_neutral_colormap>`
  - ```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_neutral_colormap
    :summary:
    ```
* - {py:obj}`get_descriptor_cmap <ovo.core.logic.proteinqc_logic.get_descriptor_cmap>`
  - ```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_descriptor_cmap
    :summary:
    ```
* - {py:obj}`get_flag_color <ovo.core.logic.proteinqc_logic.get_flag_color>`
  - ```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_flag_color
    :summary:
    ```
* - {py:obj}`get_descriptor_comment <ovo.core.logic.proteinqc_logic.get_descriptor_comment>`
  - ```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_descriptor_comment
    :summary:
    ```
````

### API

````{py:function} tool_supports_scheduler(tool: ovo.core.database.models_proteinqc.ProteinQCTool, scheduler: ovo.core.scheduler.base_scheduler.Scheduler) -> bool
:canonical: ovo.core.logic.proteinqc_logic.tool_supports_scheduler

```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.tool_supports_scheduler
```
````

````{py:function} get_available_schedulers(tools: typing.List[ovo.core.database.models_proteinqc.ProteinQCTool]) -> dict[str, ovo.core.scheduler.base_scheduler.Scheduler]
:canonical: ovo.core.logic.proteinqc_logic.get_available_schedulers

```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_available_schedulers
```
````

````{py:function} get_available_tools(tools: typing.List[ovo.core.database.models_proteinqc.ProteinQCTool], scheduler: ovo.core.scheduler.base_scheduler.Scheduler) -> typing.List[ovo.core.database.models_proteinqc.ProteinQCTool]
:canonical: ovo.core.logic.proteinqc_logic.get_available_tools

```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_available_tools
```
````

````{py:function} get_descriptor_plot_setting(descriptor: ovo.core.database.Descriptor) -> typing.Tuple[typing.List[float], bool, str]
:canonical: ovo.core.logic.proteinqc_logic.get_descriptor_plot_setting

```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_descriptor_plot_setting
```
````

````{py:function} get_descriptor_colormap(thresholds: typing.List[float], reverse_colors: bool = False, colors=None)
:canonical: ovo.core.logic.proteinqc_logic.get_descriptor_colormap

```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_descriptor_colormap
```
````

````{py:function} get_plddt_color(thresholds: typing.List[float] = [90, 70, 50], lighter: bool = False)
:canonical: ovo.core.logic.proteinqc_logic.get_plddt_color

```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_plddt_color
```
````

````{py:function} get_pae_colormap()
:canonical: ovo.core.logic.proteinqc_logic.get_pae_colormap

```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_pae_colormap
```
````

````{py:function} get_rmsd_colormap()
:canonical: ovo.core.logic.proteinqc_logic.get_rmsd_colormap

```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_rmsd_colormap
```
````

````{py:function} get_higher_is_better_colormap(min_val, max_val)
:canonical: ovo.core.logic.proteinqc_logic.get_higher_is_better_colormap

```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_higher_is_better_colormap
```
````

````{py:function} get_lower_is_better_colormap(min_val, max_val)
:canonical: ovo.core.logic.proteinqc_logic.get_lower_is_better_colormap

```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_lower_is_better_colormap
```
````

````{py:function} get_neutral_colormap(min_val, max_val)
:canonical: ovo.core.logic.proteinqc_logic.get_neutral_colormap

```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_neutral_colormap
```
````

````{py:function} get_descriptor_cmap(descriptor: ovo.core.database.Descriptor, min_val: float, max_val: float)
:canonical: ovo.core.logic.proteinqc_logic.get_descriptor_cmap

```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_descriptor_cmap
```
````

````{py:function} get_flag_color(value: float, descriptor: ovo.core.database.Descriptor) -> typing.Literal[green, yellow, orange, missing, None]
:canonical: ovo.core.logic.proteinqc_logic.get_flag_color

```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_flag_color
```
````

````{py:function} get_descriptor_comment(descriptor: ovo.core.database.Descriptor) -> str
:canonical: ovo.core.logic.proteinqc_logic.get_descriptor_comment

```{autodoc2-docstring} ovo.core.logic.proteinqc_logic.get_descriptor_comment
```
````