---
title: Twirl (latest version)
description: API reference for samplomatic.Twirl in the latest version of samplomatic
source: https://eu-de.quantum.cloud.ibm.com/docs/en/api/samplomatic/auto/twirl
---

# samplomatic.Twirl

*class* `samplomatic.Twirl(group: GroupMode | Literal['pauli', 'balanced_pauli', 'local_c1', 'local_pauli', 'phase'] = GroupMode.PAULI, dressing: DressingMode | Literal['left', 'right'] = DressingMode.LEFT, decomposition: DecompositionMode | Literal['rzsx', 'rzrx'] = DecompositionMode.RZSX)`

[GitHub](https://github.com/Qiskit/samplomatic/tree/main/samplomatic/annotations/twirl.py#L22-L60)

Directive to twirl the contents of a `box` instruction.

**Parameters**

- **group** – Which group to twirl with.
- **dressing** – Which side of the box to attach the dressing instructions.
- **decomposition** – How to decompose single-qubit gates.

### \_\_init\_\_

`__init__(group: GroupMode | Literal['pauli', 'balanced_pauli', 'local_c1', 'local_pauli', 'phase'] = GroupMode.PAULI, dressing: DressingMode | Literal['left', 'right'] = DressingMode.LEFT, decomposition: DecompositionMode | Literal['rzsx', 'rzrx'] = DecompositionMode.RZSX)`

[GitHub](https://github.com/Qiskit/samplomatic/tree/main/samplomatic/annotations/twirl.py#L35-L43)

## Methods

|                                                                                                           |   |
| --------------------------------------------------------------------------------------------------------- | - |
| [`__init__`](#samplomatic.Twirl.__init__ "samplomatic.Twirl.__init__")(\[group, dressing, decomposition]) |   |

## Attributes

|                 |   |
| --------------- | - |
| `group`         |   |
| `dressing`      |   |
| `decomposition` |   |
| `namespace`     |   |
