The Balance API provides the programmer with an interface to perform balancing of the IF Rack, Spectral Processor, Spectrometer and Prime Focus receivers. It is written in python and can be used within other programs, from the Python Console, from the Astrid "Command Console", or within a session of the config_tool application.

The Balance API provides the programmer with an interface to perform balancing of the IF Rack, Spectral Processor, Spectrometer and Prime Focus receivers. It is written in python and can be used within other programs, from the Python Console, from the Astrid "Command Console", or within a session of the config_tool application.

The astronomical observer has three choices:

• Issue commands to balance within your Scheduling Block
• Balance interactively, if you need to do so while a scan is in progress
• Balance interactively using the config_tool application, if you are not observing using Scheduling Blocks

The astronomical observer has three choices, and should follow the instructions on other pages, linked here:

• Issue commands to balance within your Scheduling Block (turtle script)
• Balance interactively using Astrid, if you need to do so while a scan is in progress
• Balance interactively using the config_tool application, if you are not observing using Scheduling Blocks (turtle scripts)

The Balance API consists of the following classes: Balance, acs, pf, sp and ifrack. The user of the API needs only to create a Balance object. All functionality of the underlying classes are exposed through the Balance class interface.

The Balance API consists of the following classes: Balance, acs, pf, sp and ifrack. The programmer using the API needs only to create a Balance object. All functionality of the underlying classes are exposed through the Balance class interface.

The Balance class serves as the interface to the API. Its function is to promote a clean interface to the observing API. Its use can most easily be described by an example.

The Balance class serves as the interface to the API. Its function is to promote a clean interface to the observing API. Its use can most easily be described by an example.

The Balance API is a programmer's interface to balancing. The Observation API (and thus Scheduling Blocks and the turtle application) provide a simplified syntax to balancing. The observer should be aware that when he or she is writing a Scheduling Block, the syntax described in the "Balance" section of ObservingDirectives should be used. If the observer is balancing manually to satisfy special requirements of his or her observing, and does so from the Python command line or the Astrid "Command Console", the slightly more verbose syntax described at BalanceAPI must be used.

The Balance API is a programmer's interface to balancing. The Observation API (and thus Scheduling Blocks and the turtle application) provide a simplified syntax to balancing. The observer should be aware that when he or she is writing a Scheduling Block, the syntax described in the "Balance" section of ObservingDirectives should be used. If the observer is balancing manually to satisfy special requirements of his or her observing, and does so from the Python command line or the Astrid "Command Console", the slightly more verbose syntax described at BalanceUsage#BalancingWithAstrid must be used.

The Balance API provides the user with an interface to perform balancing of the IFRack, SpectralProcessor, Spectrometer and the Prime Focus receivers. It is written in python and can be used from the Python Console, the Astrid "Command Console", or the config_tool (if it is launched separately).

The Balance API provides the programmer with an interface to perform balancing of the IF Rack, Spectral Processor, Spectrometer and Prime Focus receivers. It is written in python and can be used within other programs, from the Python Console, from the Astrid "Command Console", or within a session of the config_tool application.

The astronomical observer has three choices:

• Issue commands to balance within your Scheduling Block
• Balance interactively, if you need to do so while a scan is in progress
• Balance interactively using the config_tool application, if you are not observing using Scheduling Blocks

Anyone who used the Balance API prior to December 2004 will notice that there were changes made so that the new Balance API is not backwards compatible with the old one. These changes were requested by FrankGhigo, so please send him comments if you have problems.

The Balance API is a programmer's interface to balancing. The Observation API (and thus Scheduling Blocks and the turtle application) provide a simplified syntax to balancing. The observer should be aware that when he or she is writing a Scheduling Block, the syntax described in the "Balance" section of ObservingDirectives should be used. If the observer is balancing manually to satisfy special requirements of his or her observing, and does so from the Python command line or the Astrid "Command Console", the slightly more verbose syntax described at BalanceAPI must be used.

1. Introduction

1. Introduction

The Balance API provides the user with an interface to perform balancing of the IFRack, SpectralProcessor, Spectrometer and the Prime Focus receivers. It is written in python and can be used from the python command prompt, the config tool or the Observation API.

The Balance API provides the user with an interface to perform balancing of the IFRack, SpectralProcessor, Spectrometer and the Prime Focus receivers. It is written in python and can be used from the Python Console, the Astrid "Command Console", or the config_tool (if it is launched separately).

1.1 The Basic design

2. The Basic Design

The balance api consists of the following classes: Balance, acs, pf, sp and ifrack. The user of the API need only create a Balance object. If desired, the other classes can be instantiated, but no additional functionality is gained by doing so. All functionality of the underlying classes are exposed through the

The Balance API consists of the following classes: Balance, acs, pf, sp and ifrack. The user of the API needs only to create a Balance object. All functionality of the underlying classes are exposed through the

2. The Balance class

2.1 The Balance class

The Balance class serves as the interface to the API. Its function is to promote a clean interface to the observing API.

First a Balance object is created with a list of the managers to be balanced.

First a Balance object is created with a list of the managers to be balanced.

If no parameters are specifed, the ifrack is the default device.

If no parameters are specifed (e.g. if b = Balance() is used), the ifrack is the default device.

The balance method performs a balance on each of the devices specified in the constructor. In this example, balancing is performed with the default balancing options for each device. The devices are balanced in the order specified in the list. In the above example, the Prime Focus receiver is balanced first, followed by the IFRack.

The balance method performs a balance on each of the devices specified. In this example, balancing is performed with the default balancing options for each device. The devices are balanced in the order specified in the list. In the above example, the Prime Focus receiver is balanced first, followed by the IFRack.

2.2 Optional Parameters

3. Known Issues

3. Known Issues

The old balancing API but is deprecated. Its use is currently still supported through the config tool API and the python command line, but will be removed in the first quarter of 2005.

Anyone who used the Balance API prior to December 2004 will notice that there were changes made so that the new Balance API is not backwards compatible with the old one. These changes were requested by FrankGhigo, so please send him comments if you have problems.

4. Core Team

4. Core Team

b = Balance(("pf", "ifrack"))

b = Balance(["pf", "ifrack"])

The Balance API provides the user with an interface to perform balancing of the IFRack, SpectralProcessor?, Spectrometer and the Prime Focus receivers.

The Balance API provides the user with an interface to perform balancing of the IFRack, SpectralProcessor, Spectrometer and the Prime Focus receivers.

The default values are:

The supported keywords and their default values are:

SpectralProcess? (sp) : target_level = -11 Spectrometer (acs) : port = (1..41) PrimeFocusReceivers?(pf) : sample_time = 2, cal = 'off' IFrack(ifrack) : NA

target_level = -11 Applicable when balancing the SpectralProcessor? (sp) port = (1..41) Applicable to theSpectrometer (acs) : sample_time = 2 Applicable when balancing the Prime Focus Receivers (pf) cal = 'off' Applicable when balancing the Prime Focus Receivers (pf)

The old balancing API but is deprecated. Its use is currently still supported through the config tool API and the python command line, but will be removed in the first quarter of 2005.

The balance api consists of the following classes: Balance, ACS, Pf, Spp and IFRack.

The balance api consists of the following classes: Balance, acs, pf, sp and ifrack.

b = Balance(("Pf", "IFrack"))

b = Balance(("pf", "ifrack"))

If no parameters are specifed, the IFRack is the default device.

If no parameters are specifed, the ifrack is the default device.

SpectralProcess? (Spp) : target_level = -11 Spectrometer (ACS) : port = (1..41) PrimeFocusReceivers?(Pf) : sample_time = 2, cal = 'off' IFrack(Ifrack) : NA

SpectralProcess? (sp) : target_level = -11 Spectrometer (acs) : port = (1..41) PrimeFocusReceivers?(pf) : sample_time = 2, cal = 'off' IFrack(ifrack) : NA

b = Balance(("Pf", "IFRack"))

b = Balance(("Pf", "IFrack"))

IFRack(IFRack) : NA

IFrack(Ifrack) : NA

%META:TOPICINFO{author="MelindaMello" date="1102017060" format="1.0" version="1.1"}%

GBT Balance API

• GBT Balance API
• 1. Introduction
  • 1.1 The Basic design
• 2. The Balance class
• 3. Known Issues
• 4. Core Team

1. Introduction

The Balance API provides the user with an interface to perform balancing of the IFRack, SpectralProcessor?, Spectrometer and the Prime Focus receivers. It is written in python and can be used from the python command prompt, the config tool or the Observation API.

1.1 The Basic design

The balance api consists of the following classes: Balance, ACS, Pf, Spp and IFRack. The user of the API need only create a Balance object. If desired, the other classes can be instantiated, but no additional functionality is gained by doing so. All functionality of the underlying classes are exposed through the Balance class interface.

2. The Balance class

First a Balance object is created with a list of the managers to be balanced.

b = Balance(("Pf", "IFRack"))

If no parameters are specifed, the IFRack is the default device.

To perform the balance, the balance method is called.

b.balance()

The balance method performs a balance on each of the devices specified in the constructor. In this example, balancing is performed with the default balancing options for each device. The devices are balanced in the order specified in the list. In the above example, the Prime Focus receiver is balanced first, followed by the IFRack.

An optional parameter to the balance method can be provided. This parameter must be a dictionary that contains 1 or more of the following balancing options. Items which are not in the dictionary are assigned their default values. Non applicable options are ignored.

The default values are:

              SpectralProcess (Spp)    : target_level =  -11
              Spectrometer (ACS)       : port = (1..41)
              PrimeFocusReceivers(Pf)  : sample_time = 2,    cal = 'off'
              IFRack(IFRack)           :  NA

Supported dictionary keys/value type are:

        target_level / float
        sample_time  / int
        cal / string containing "on" or "off" -- other values will be treated as if "on" was specified
        port/ tuple containing integers from 1 to 41

An example of a dictionary containing valid options and its use in a balance method call is:

         opt = { "target_level": 4, 
                 "sample_time" : 5,
                 "cal"         : "on",
                 "port"        : (9,13)
                }
         b.balance(opt)

3. Known Issues

4. Core Team

-- MelindaMello - 02 Dec 2004