Skip to main content
IBM Quantum Platform

PreInjectNoise

class samplomatic.pre_samplex.PreInjectNoise(subsystems: Partition[int], direction: Direction, register_type: VirtualType, ref: str, modifier_ref: str, sign_idx: str, *, trace_info: TraceInfo | None = None, twirl_gate: str | None = None)

GitHub

Bases: PreEmit

The inject noise emit node type used during samplex building.

Attributes Summary

Column 1
Column 2
directionThe direction of virtual gates that can interact with this node.
modifier_refUnique identifier for modifiers to apply to the Pauli Lindblad map on this node.
refUnique identifier of the Pauli Lindblad map to use for noise injection.
register_typeThe virtual register type of the noise injection.
sign_idxThe index of the output array to write the sign to.
subsystemsThe subsystems that virtual gates act on.
trace_infoDebug trace information, populated when building with debug=True.
twirl_gateThe gate name used for gate-dependent sampling, or None.

Methods Summary

Column 1
Column 2
get_style()Summarizes the style of this node when plotted via plot_graph().

Attributes Documentation

direction

Type: Direction

Default value: <dataclasses._MISSING_TYPE object>

The direction of virtual gates that can interact with this node.

modifier_ref

Type: str

Default value: <dataclasses._MISSING_TYPE object>

Unique identifier for modifiers to apply to the Pauli Lindblad map on this node.

ref

Type: str

Default value: <dataclasses._MISSING_TYPE object>

Unique identifier of the Pauli Lindblad map to use for noise injection.

register_type

Type: VirtualType

Default value: <dataclasses._MISSING_TYPE object>

The virtual register type of the noise injection.

sign_idx

Type: str

Default value: <dataclasses._MISSING_TYPE object>

The index of the output array to write the sign to.

subsystems

Type: Partition[int]

Default value: <dataclasses._MISSING_TYPE object>

The subsystems that virtual gates act on.

trace_info

Type: TraceInfo | None

Default value: None

Debug trace information, populated when building with debug=True.

twirl_gate

Type: str | None

Default value: None

The gate name used for gate-dependent sampling, or None.

Methods Documentation

get_style

get_style() → NodeStyle

GitHub

Summarizes the style of this node when plotted via plot_graph().

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