++ed by:
AMBA

1 PAUSE user
1 non-PAUSE user.

Andreas K. Hüttel
and 4 contributors

NAME

        Lab::XPRESS::Sweep::Frequency - Frequency-Sweep

.

SYNOPSIS

        use Lab::XPRESS::hub;
        my $hub = new Lab::XPRESS::hub();
        
        
        my $Osc = $hub->Instrument('SignalRecovery726x', 
                {
                connection_type => 'VISA_GPIB',
                gpib_address => 2
                });
        
        my $sweep_voltage = $hub->Sweep('Frequency',
                {
                instrument => $Osc,
                points => [100,1e5],
                stepwidth => [1e5,100],
                mode => 'step',         
                backsweep => 0 
                });
                

.

DESCRIPTION

Parent: Lab::XPRESS::Sweep::Sweep

The Lab::XPRESS::Sweep::Frequency class implements a module for frequncy sweeps in the Lab::XPRESS::Sweep framework.

.

CONSTRUCTOR

                my $sweep_voltage = $hub->Sweep('Frequency',
                {
                instrument => $Osc,
                points => [100,1e5],
                stepwidth => [1e5,100],
                mode => 'step',         
                backsweep => 0 
                });

Instantiates a new frequency-sweep.

.

PARAMETERS

instrument [Lab::Instrument] (mandatory)

Instrument, conducting the sweep. Must be of type Lab:Instrument. Allowed instruments: Lab::Instrument::SignalRecovery726x

.

mode [string] (default = 'step' | 'list')

step: measurements will be performed at discrete values of the frequency between start and end points defined in parameter points, seperated by steps defined in parameter stepwidth

list: measurements will be performed at a list frequencies defined in parameter points

.

points [float array] (mandatory)

array of values (in Hz) that defines the characteristic points of the sweep. First value is appraoched before measurement begins.

Case mode => 'step' : Same as in 'continuous' but frequency will be swept in stop and go mode.

Case mode => 'list' : Array of values, with minimum length 1, that are approached in sequence to perform a measurment.

.

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 = [100, 3000, 300]
        stepwidth = [500, 1000]
        
        ==> steps: 100, 600, 1100, 1600, 2100, 2600, 3000, 2000, 1000, 300

.

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 = [100, 3000, 300]
        number_of_points = [10, 2]
        
        ==> steps: 100, 390, 680, 970, 1260, 1550, 1840, 2130, 2420, 2710, 3000, 1650, 300

.

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 = 'Frequency_Sweep')

Just an ID.

.

filename_extention [string] (default = 'FRQ=')

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

Lab::XPRESS::Sweep

.

AUTHOR/COPYRIGHT

Christian Butschkow and Stefan Geißler

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

.