Skip to main content
IBM Quantum Platform

get_annotation

samplomatic.utils.get_annotation(box: BoxOp, annotation_type: type[Annotation] | tuple[type[Annotation], ...]) → Annotation | None

GitHub

Return a box’s first annotation of the given type(s).

Parameters

  • box – The box to return the annotation for.
  • annotation_type – The type of the desired annotation.

Returns

The box’s first annotation of the given type(s), or None if it does not contain an annotation of the given type(s).

Was this page helpful?
Report a bug, typo, or request content on GitHub.