HBridgedCurrentSource¶

Class Arguments

Argument	Type	Default Value
current_source	CurrentSource
min_current	TFloat	-inf
max_current	TFloat	inf
default_ramp_steps	TInt32	30

Bold arguments are mandatory. For more documentation on the listed arguments refer to the class definition below. If parameters appear in this list but not in the class definition below, please recursively check the linked base classes for the definition of the parameter.

Inheritance Diagram

Example Component Dictionary

   {
    "currentsource_example": {
        "classname": "atomiq.components.electronics.currentsource.HBridgedCurrentSource",
        "arguments": {
            "current_source": "<mandatory parameter (CurrentSource)>",
            "min_current": -1e999,
            "max_current": 1e999,
            "default_ramp_steps": 30
        }
    }
}

Class Description

class atomiq.components.electronics.currentsource.HBridgedCurrentSource(current_source, *args, **kwargs)[source]

Bases: CurrentSource, Switchable

Combination of an H-bridge and a current source

Combining an H-bridge with a unipolar current source allows to create a bipolar current source. This class bundles these two comoponents an exposes them as a bipolar current source.

Parameters:: current_source (CurrentSource) -- The current source connected to the H-bridge

A Parametrizable is an entity that can be controlled by one or more continuous parameter(s)

class HBridgeState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntEnum

conjugate(): Returns self, the complex conjugate of any int.

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

to_bytes(length=1, byteorder='big', *, signed=False)

Return an array of bytes representing an integer.

length: Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.
byteorder: The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. Default is to use 'big'.
signed: Determines whether two's complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

from_bytes(byteorder='big', *, signed=False)

Return the integer represented by the given array of bytes.

bytes: Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
byteorder: The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. Default is to use 'big'.
signed: Indicates whether two's complement is used to represent the integer.

as_integer_ratio()

Return a pair of integers, whose ratio is equal to the original int.

The ratio is in lowest terms and has a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

is_integer(): Returns True. Exists for duck type compatibility with float.is_integer.

real: the real part of a complex number

imag: the imaginary part of a complex number

numerator: the numerator of a rational number in lowest terms

denominator: the denominator of a rational number in lowest terms

ramp_current(duration, current_end, current_start=nan, ramp_timestep=-1.0, ramp_steps=-1)

Ramp current over a given duration.

This method advances the timeline by duration

Parameters:

duration (artiq.compiler.types.TMono('float', OrderedDict())) -- ramp duration [s]
current_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end current [A]
current_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial current [A]. If not given, the ramp starts from the current operating current.
ramp_timestep (artiq.compiler.types.TMono('float', OrderedDict()))
ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)})))

set_current(current)

Set the current delivered by the current source

Parameters:: current (artiq.compiler.types.TMono('float', OrderedDict())) -- Current in A