CoilPair

Class Arguments

Argument	Type	Default Value
current_source_coil1	CurrentSource
current_source_coil2	CurrentSource
calibration_field	Calibration
calibration_gradient	Calibration
switch	Switchable	None
helmholtz_config	TInt32	1
default_field	TFloat	0.0
default_gradient	TFloat	0.0

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

   {
    "coil_example": {
        "classname": "atomiq.components.coil.CoilPair",
        "arguments": {
            "current_source_coil1": "<mandatory parameter (CurrentSource)>",
            "current_source_coil2": "<mandatory parameter (CurrentSource)>",
            "calibration_field": "<mandatory parameter (Calibration)>",
            "calibration_gradient": "<mandatory parameter (Calibration)>",
            "switch": null,
            "helmholtz_config": 1,
            "default_field": 0.0,
            "default_gradient": 0.0
        }
    }
}

Class Description

class atomiq.components.coil.CoilPair(current_source_coil1, current_source_coil2, calibration_field, calibration_gradient, switch=None, helmholtz_config=1, default_field=0.0, default_gradient=0.0, *args, **kwargs)

Bases: Component, Parametrizable, Switchable

A pair of identical coils driven by a common or two individual current sources.

It is assumed that the pair of coils is placed symmetrically around the region of interest. It is characterized by a calibration (field_calibration) for the returns the B field for a given current through the coil and a calibration of the field gradient

Parameters:

• current_source_coil1 (CurrentSource) -- The current source for the first coil.

• current_source_coil2 (CurrentSource) -- The current source for the second coil. If the second coil is tied to the same current source as the first coil, specify the same current source here. Use the helmholtz_config parameter to specifiy the b-field orientation of the second coil.

• field_calibration -- Calibration that gives the B field as a function of the current at the position of interest if the coilpair is in Helmholtz configuration

• gradient_calibration -- Calibration that gives the B field gradient as a function of the current difference between the coils at the position of interest if the coilpair is in anti-Helmholtz configuration

• switch (Switchable) -- Switch that switches the coil pair on and off. If none is given the current source is used to switch the coils (if it supports switching). (default None)

• helmholtz_config (TInt32) -- if set to 1, same polarity of current in both coils creates a Helmholtz field. If set to -1 same polarity of current in both coils creates an anti-Helmholtz field. (default 1)

• default_field (TFloat) -- Field to initialize the coil pair with (defaul 0)

• default_gradient (TFloat) -- Gradient to initialize the coil pair with (default 0)

• calibration_field (Calibration) --

• calibration_gradient (Calibration) --

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

set_field(field, update=True)

Set the field of the coil pair at the position if interest

Parameters:

• field (TFloat) -- Field to be set in the units of the calibration field_calibration

• update (TBool) --

set_gradient(gradient, update=True)

Set the field gradient of the coil pair at the position if interest

Parameters:

• gradient (TFloat) -- Field gradient to be set in the units of the calibration field_calibration

• update (TBool) --