VoltageSourceΒΆ
Class Arguments
Argument |
Type |
Default Value |
---|---|---|
min_voltage |
TFloat |
-inf |
max_voltage |
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
{
"voltagesource_example": {
"classname": "atomiq.components.electronics.voltagesource.VoltageSource",
"arguments": {
"min_voltage": -1e999,
"max_voltage": 1e999,
"default_ramp_steps": 30
}
}
}
Class Description
- class atomiq.components.electronics.voltagesource.VoltageSource(min_voltage=-inf, max_voltage=inf, default_ramp_steps=30, *args, **kwargs)[source]
Bases:
Component
,Parametrizable
Voltage Source
This abstract class represents any device that can output a defined, controllable voltage.
- Parameters:
min_voltage (TFloat) -- The minimum voltage the device can output [V]
max_voltage (TFloat) -- The maximum voltage the device can output [V]
default_ramp_steps (TInt32) -- The default number of steps that this device should use if the voltage is ramped. This value is only used if no ramp_steps are given in the
ramp_voltage()
method.
A Parametrizable is an entity that can be controlled by one or more continuous parameter(s)
- set_voltage(voltage)[source]
Set the voltage delivered by the voltage source
- Parameters:
voltage (artiq.compiler.types.TMono('float', OrderedDict())) -- Voltage in V
- ramp_voltage(duration, voltage_start, voltage_end, ramp_timestep=-1.0, ramp_steps=-1)[source]
Ramp voltage over a given duration.
This method advances the timeline by duration
- Parameters:
duration (artiq.compiler.types.TMono('float', OrderedDict())) -- ramp duration [s]
voltage_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial voltage [V]
voltage_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end voltage [V]
ramp_timestep (artiq.compiler.types.TMono('float', OrderedDict()))
ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)})))