NAME
Lab::XPRESS::Sweep::Magnet - Magnetic field sweep (deprecated)
VERSION
version 3.899
SYNOPSIS
use Lab::XPRESS::hub;
my $hub = new Lab::XPRESS::hub();
my $IPS = $hub->Instrument('IPS',
{
connection_type => 'VISA_GPIB',
gpib_address => 24
});
my $sweep_magnet = $hub->Sweep('Magnet',
{
instrument => $IPS,
points => [-10,10],
rate => [1.98,1],
mode => 'continuous',
interval => 1,
backsweep => 1
});.
DESCRIPTION
This module belongs to a deprecated legacy module stack, frozen and not under development anymore. Please port your code to the new API; its documentation can be found on the Lab::Measurement homepage, https://www.labmeasurement.de/.
Parent: Lab::XPRESS::Sweep
The Lab::XPRESS::Sweep::Magnet class implements a module for magnetic field Sweeps in the Lab::XPRESS::Sweep framework.
.
CONSTRUCTOR
my $sweep_magnet = $hub->Sweep('Magnet',
{
instrument => $IPS,
points => [-10,10],
rate => [1.98,1],
mode => 'continuous',
interval => 1,
backsweep => 1
});Instantiates a new Magnet-sweep.
.
SWEEP PARAMETERS
instrument [Lab::Instrument] (mandatory)
Instrument, conducting the sweep. Must be of type Lab:Instrument. Allowed instruments: Lab::Instrument::IPS, Lab::Instrument::IPSWeiss1, Lab::Instrument::IPSWeiss2, Lab::Instrument::IPSWeissDillFridge
.
mode [string] (default = 'continuous' | 'step' | 'list')
continuous: perform a continuous magnetic field sweep. Measurements will be performed constantly at the time-interval defined in interval.
step: measurements will be performed at discrete values of the magnetic field between start and end points defined in parameter points, seperated by the magnetic field values defined in parameter stepwidth
list: measurements will be performed at a list of magnetic field values defined in parameter points
.
points [float array] (mandatory)
array of magnetic field values (in Tesla) that defines the characteristic points of the sweep. First value is appraoched before measurement begins.
Case mode => 'continuous' : List of at least 2 values, that define start and end point of the sweep or a sequence of consecutive sweep-sections (e.g. if changing the sweep-rate for different sections or reversing the sweep direction). points => [-5, 5] # Start: -5 / Stop: 5
points => [-5, -1, 1, 5]
points => [0, -5, 5]Case mode => 'step' : Same as in 'continuous' but magnetic field will be swept in stop and go mode. I.e. Magnet approaches field values between start and stop at the interval defined in 'stepwidth'. A measurement is performed, when magnet is idle.
Case mode => 'list' : Array of magnetic field values, with minimum length 1, that are approached in sequence to perform a measurment.
.
rate [float array] (mandatory if not defined duration)
array of rates, at which the magnetic field is swept (Tesla / min). Has to be of length 1 or greater (Maximum length: length of points-array). The first value defines the rate to approach the starting point. The following values define the rates to approach the magnetic field values defined by the points-array. If the number of values in the rates-array is less than the length of the points-array, the last defined rate will be used for the remaining sweep sections.
points => [-5, -1, 1, 5],
rates => [1, 0.5, 0.2]
rate to approach -5 T (the starting point): 1 T/min
rate to approach -1 T : 0.5 T/min
rate to approach 1 T : 0.2 T/min
rate to approach 5 T : 0.2 T/min (last defined rate).
duration [float array] (mandatory if not defined rate)
can be used instead of 'rate'. Attention: Use only the 'duration' or the 'rate' parameter. Using both will cause an Error!
The first value defines the duration to approach the starting point. The second value defines the duration to approach the magnetic field value defined by the second value of the points-array. ... If the number of values in the duration-array is less than the length of the points-array, last defined duration will be used for the remaining sweep sections.
.
stepwidth [float array]
This parameter is relevant only if mode = 'step' has been selected. Stepwidth has to be an array of length '1' or greater. The values define the width for each step within the corresponding sweep sequence. If the length of the defined sweep sequence devided by the stepwidth is not an integer number, the last step will be smaller in order to reach the defined points-value.
points = [0, 0.5, 3]
stepwidth = [0.2, 0.5]
==> steps: 0, 0.2, 0.4, 0.5, 1.0, 1.5, 2.0, 2.5, 3.
number_of_points [int array]
can be used instead of 'stepwidth'. Attention: Use only the 'number_of_points' or the 'stepwidth' parameter. Using both will cause an Error! This parameter is relevant only if mode = 'step' has been selected. Number_of_points has to be an array of length '1' or greater. The values defines the number of steps within the corresponding sweep sequence.
points = [0, 0.5, 3]
number_of_points = [5, 2]
==> steps: 0, 0.1, 0.2, 0.3, 0.4, 0.5, 1.75, 3.
interval [float] (default = 1)
interval in seconds for taking measurement points. Only relevant in mode 'continuous'.
.
backsweep [int] (default = 0 | 1 | 2)
0 : no backsweep (default) 1 : a backsweep will be performed 2 : no backsweep performed automatically, but sweep sequence will be reverted every second time the sweep is started (relevant eg. if sweep operates as a slave. This way the sweep sequence is reverted at every second step of the master)
id [string] (default = 'Magnet_sweep')
Just an ID.
filename_extention [string] (default = 'B=')
Defines a postfix, that will be appended to the filenames if necessary.
delay_before_loop [int] (default = 0)
defines the time in seconds to wait after the starting point has been reached.
delay_in_loop [int] (default = 0)
This parameter is relevant only if mode = 'step' or 'list' has been selected. Defines the time in seconds to wait after the value for the next step has been reached.
delay_after_loop [int] (default = 0)
Defines the time in seconds to wait after the sweep has been finished. This delay will be executed before an optional backsweep or optional repetitions of the sweep.
CAVEATS/BUGS
probably none
SEE ALSO
COPYRIGHT AND LICENSE
This software is copyright (c) 2023 by the Lab::Measurement team; in detail:
Copyright 2012 Stefan Geissler
2013 Alois Dirnaichner, Andreas K. Huettel, Christian Butschkow, Stefan Geissler
2016 Simon Reinhardt
2017 Andreas K. Huettel, Simon Reinhardt
2020 Andreas K. HuettelThis is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.