Filtering of models based on their score

Module contents

Filter models based on their score.

This module filters the input models based on their score using a threshold value. Models having higher score than the threshold value are filtered out.

The number of models to be selected is unknown, and is the set of models that have a score below the defined threshold. For this module to be functional, a score must be first computed. This can be performed by running a CNS module or a scoring module. If scores are not accessible, the workflow will terminate with an error message.

If the threshold value is too stringent, resulting in no models passed to the next module, the workflow will stop with an error message.

class haddock.modules.analysis.filter.HaddockModule(order: int, path: Path, *ignore: Any, init_params: str | Path = PosixPath('/opt/hostedtoolcache/Python/3.10.17/x64/lib/python3.10/site-packages/haddock/modules/analysis/filter/defaults.yaml'), **everything: Any)[source]

Bases: BaseHaddockModule

HADDOCK3 module to select top cluster/model.

classmethod confirm_installation() → None[source]: Confirm if module is installed.

name: str = 'filter'

Default Parameters

Easy

threshold

default: 0.0
type: float
title: Threshold value to filter models.
min: -99999.99
max: 99999.99
short description: Threshold value to filter models based on their score.
long description: Threshold value to filter models based on their score. Models having higher score than the threshold value will be filtered out.
group: analysis
explevel: easy