---
title: SamplerPubResult (latest version)
description: API reference for qiskit.primitives.SamplerPubResult in the latest version of qiskit
source: https://eu-de.quantum.cloud.ibm.com/docs/en/api/qiskit/qiskit.primitives.SamplerPubResult
---

# SamplerPubResult

*class* `qiskit.primitives.SamplerPubResult(data, metadata=None)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/2.5/qiskit/primitives/containers/sampler_pub_result.py#L27-L80)

Bases: [`PubResult`](/docs/api/qiskit/qiskit.primitives.PubResult "qiskit.primitives.containers.pub_result.PubResult")

Result of Sampler Pub.

This is a `SamplerV2`-specific subclass of [`PubResult`](/docs/api/qiskit/qiskit.primitives.PubResult "qiskit.primitives.PubResult") that adds helper methods to deal with the bit-array like [`BitArray`](/docs/api/qiskit/qiskit.primitives.BitArray "qiskit.primitives.BitArray") data directly (implicitly going via the [`DataBin`](/docs/api/qiskit/qiskit.primitives.DataBin "qiskit.primitives.DataBin") in [`data`](#qiskit.primitives.SamplerPubResult.data "qiskit.primitives.SamplerPubResult.data")). See [`PubResult`](/docs/api/qiskit/qiskit.primitives.PubResult "qiskit.primitives.PubResult") for more documentation on how to use this class.

Initialize a pub result.

**Parameters**

- **data** ([*DataBin*](/docs/api/qiskit/qiskit.primitives.DataBin "qiskit.primitives.DataBin")) – Result data.
- **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*, Any] | None*) – Metadata specific to this pub. Keys are expected to be strings.

## Attributes

### data

Result data for the pub.

### metadata

Metadata for the pub.

## Methods

### join\_data

`join_data(names=None)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/2.5/qiskit/primitives/containers/sampler_pub_result.py#L36-L80)

Join data from many registers into one data container.

Data is joined along the bits axis. For example, for [`BitArray`](/docs/api/qiskit/qiskit.primitives.BitArray "qiskit.primitives.BitArray") data, this corresponds to bitstring concatenation.

**Parameters**

**names** ([*Iterable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*] | None*) – Which registers to join. Their order is maintained, for example, given `["alpha", "beta"]`, the data from register `alpha` is placed to the left of the data from register `beta`. When `None` is given, this value is set to the ordered list of register names, which will have been preserved from the input circuit order.

**Returns**

Joint data.

**Raises**

- [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError) – If specified names are empty.
- [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError) – If specified name does not exist.
- [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError) – If specified data comes from incompatible types.

**Return type**

[*BitArray*](/docs/api/qiskit/qiskit.primitives.BitArray "qiskit.primitives.containers.bit_array.BitArray") | [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)