---
title: filter_annotations (latest version)
description: API reference for samplomatic.utils.filter_annotations in the latest version of samplomatic
source: https://quantum.cloud.ibm.com/docs/en/api/samplomatic/auto/utils-filter-annotations
---

# filter\_annotations

`samplomatic.utils.filter_annotations(circuit: QuantumCircuit, keep: type[Annotation] | tuple[type[Annotation], ...]) → QuantumCircuit`

[GitHub](https://github.com/Qiskit/samplomatic/tree/main/samplomatic/utils/map_annotations.py#L88-L114)

Return a new circuit keeping only annotations of the given type(s) on each box.

**Parameters**

- **circuit** – The circuit whose box annotations to filter.
- **keep** – Annotation type or tuple of types to retain.

**Returns**

A new circuit where each box’s annotations contain only instances of `keep`.

```python
from qiskit.circuit import QuantumCircuit
from samplomatic import Twirl, InjectNoise
from samplomatic.utils import filter_annotations

circuit = QuantumCircuit(2)
with circuit.box([Twirl(), InjectNoise("ref")]):
    circuit.cx(0, 1)

twirl_only = filter_annotations(circuit, Twirl)
```
