adsec.adSecArbClient Namespace Reference

Functions
def	str2bool (v)
def	getDefaultConnAddr (_side)
def	getDefaultSide ()
def	connectService (_side)
def	__read_fits (self, filename, datatype='< f8')
def	LoadSlopeFilter (args)
def	LoadModeFilter (args)
def	GetCurrentM2C (args)
def	GetM2C (args)
def	RunAo (args)
def	RefreshSlopeBuff (args)
def	ReadSecSlopeBuff (args)
def	ReadSecFrameCounter (args)
def	PauseAo (args)
def	ResumeAo (args)
def	StopAo (args)
def	SetDataDecimation (args)
def	LoadShape (args)
def	GetShape (args)
def	LoadGain (args)
def	LoadModeGain (args)
def	LoadDisturb (args)
def	LoadRecMat (args)
def	Offloading (args)
def	CalibrateCmd (args)
def	GetOffloads (args)
def	SaveStatus (args)
def	ApplyCommands (args)
def	initAlert (args)
def	getDefaultFitsFile ()
def	TestClient (args)

Variables
dictionary	ToBank = {'BankA': ADSEC.Bank.BankA, 'BankB': ADSEC.Bank.BankB}
	parent_parser = argparse.ArgumentParser(add_help=False)
	default
	help
	parser = argparse.ArgumentParser()
	subparsers = parser.add_subparsers(title="subcommands", metavar="<command>")
	loadSlopeFilterParser
	choices
	func
	loadModeFilterParser
	getCurrentM2CParser
	getM2CParser = subparsers.add_parser("GetM2C", help="get M2C", parents=[parent_parser])
	runAoParser = subparsers.add_parser("RunAo", help="run ao with parameters", parents=[parent_parser])
	type
	int
	float
	refreshSlopeBuffParser = subparsers.add_parser("RefreshSlopeBuff", help="Starts downloading slope buffer from secondary BCUs after applying disturbance matrix callable during open loop", parents=[parent_parser])
	readSecSlopeBuffParser = subparsers.add_parser("ReadSecSlopeBuff", help="Get one of the downloaded sloped from the downloaded slope buffer", parents=[parent_parser])
	readSecFrameCounterParser = subparsers.add_parser("ReadSecFrameCounter", help="Get the frame counter", parents=[parent_parser])
	pauseAoParser = subparsers.add_parser("PauseAo", help="Tell the AdSec system that we want to pause. Callable during closed loop.", parents=[parent_parser])
	resumeAoParser = subparsers.add_parser("ResumeAo", help="Resumes the loop after a pause. Callable when the system is paused.", parents=[parent_parser])
	stopAoParser = subparsers.add_parser("StopAo", help="Callable during closed loop", parents=[parent_parser])
	setDataDecimationParser = subparsers.add_parser("SetDataDecimation", help="Callable during open loop before diagnostic data is sent", parents=[parent_parser])
	loadShapeParser
	getShapeParser
	loadGainParser
	loadModeGainParser
	loadDisturbParserParser
	loadRecMatParserParser
	offloadingParser
	calibrateCmdParser
	getOffladsParser
	saveStatusParser = subparsers.add_parser("SaveStatus", help="Saves the current AdSec status to some data structure", parents=[parent_parser])
	applyCommandsParser
	initAlertParser = subparsers.add_parser("initAlert", help="Callable during closed loop", parents=[parent_parser])
	testClientParser
	True
	id = Ice.Identity()
	name
	args = parser.parse_args()

Function Documentation

__read_fits()

def adsec.adSecArbClient.__read_fits (   self,   filename,   datatype = '<f8'  )

private

Reads a FITS file located in the dataPath

Parameters
----------
filename : string
will be appended to the data Path
datatype : string
see numpy convention for data type interpretation

Returns
-------
out : ndarray

ApplyCommands()

def adsec.adSecArbClient.ApplyCommands

(

args

)

CalibrateCmd()

def adsec.adSecArbClient.CalibrateCmd

(

args

)

connectService()

def adsec.adSecArbClient.connectService

(

_side

)

GetCurrentM2C()

def adsec.adSecArbClient.GetCurrentM2C

(

args

)

getDefaultConnAddr()

def adsec.adSecArbClient.getDefaultConnAddr

(

_side

)

getDefaultFitsFile()

def adsec.adSecArbClient.getDefaultFitsFile

(

)

getDefaultSide()

def adsec.adSecArbClient.getDefaultSide

(

)

GetM2C()

def adsec.adSecArbClient.GetM2C

(

args

)

GetOffloads()

def adsec.adSecArbClient.GetOffloads

(

args

)

GetShape()

def adsec.adSecArbClient.GetShape

(

args

)

initAlert()

def adsec.adSecArbClient.initAlert

(

args

)

LoadDisturb()

def adsec.adSecArbClient.LoadDisturb

(

args

)

LoadGain()

def adsec.adSecArbClient.LoadGain

(

args

)

LoadModeFilter()

def adsec.adSecArbClient.LoadModeFilter

(

args

)

LoadModeGain()

def adsec.adSecArbClient.LoadModeGain

(

args

)

LoadRecMat()

def adsec.adSecArbClient.LoadRecMat

(

args

)

LoadShape()

def adsec.adSecArbClient.LoadShape

(

args

)

LoadSlopeFilter()

def adsec.adSecArbClient.LoadSlopeFilter

(

args

)

Offloading()

def adsec.adSecArbClient.Offloading

(

args

)

PauseAo()

def adsec.adSecArbClient.PauseAo

(

args

)

ReadSecFrameCounter()

def adsec.adSecArbClient.ReadSecFrameCounter

(

args

)

ReadSecSlopeBuff()

def adsec.adSecArbClient.ReadSecSlopeBuff

(

args

)

RefreshSlopeBuff()

def adsec.adSecArbClient.RefreshSlopeBuff

(

args

)

ResumeAo()

def adsec.adSecArbClient.ResumeAo

(

args

)

RunAo()

def adsec.adSecArbClient.RunAo

(

args

)

SaveStatus()

def adsec.adSecArbClient.SaveStatus

(

args

)

SetDataDecimation()

def adsec.adSecArbClient.SetDataDecimation

(

args

)

StopAo()

def adsec.adSecArbClient.StopAo

(

args

)

str2bool()

def adsec.adSecArbClient.str2bool

(

v

)

TestClient()

def adsec.adSecArbClient.TestClient

(

args

)

Variable Documentation

applyCommandsParser

adsec.adSecArbClient.applyCommandsParser

Initial value:

=  subparsers.add_parser("ApplyCommands", help="Sends a vector of commands to be applied to the AdSec."
                                       "Each element of the <commands> vector is an actuator command in meters."
                                       "This command will be applied as an offset from the last loaded shape."
                                       "Dim: 672",
                                       parents=[parent_parser])

args

adsec.adSecArbClient.args = parser.parse_args()

calibrateCmdParser

adsec.adSecArbClient.calibrateCmdParser

Initial value:

=  subparsers.add_parser("CalibrateCmd", 
          help="A stub for future implementation", parents=[parent_parser])

choices

adsec.adSecArbClient.choices

default

adsec.adSecArbClient.default

float

adsec.adSecArbClient.float

func

adsec.adSecArbClient.func

getCurrentM2CParser

adsec.adSecArbClient.getCurrentM2CParser

Initial value:

=  subparsers.add_parser("GetCurrentM2C", help="get current M2C"
            "Callable during close and open loop", parents=[parent_parser])

getM2CParser

adsec.adSecArbClient.getM2CParser = subparsers.add_parser("GetM2C", help="get M2C", parents=[parent_parser])

getOffladsParser

adsec.adSecArbClient.getOffladsParser

Initial value:

=  subparsers.add_parser("GetOffloads", 
          help="If offloading is enabled the currently offloaded Tip/Tilt/Focus is requested."
            "Callable during close loop only."
            "has to be polled frequently by us.", parents=[parent_parser])

getShapeParser

adsec.adSecArbClient.getShapeParser

Initial value:

=  subparsers.add_parser("GetShape", help="Callabel only during open-loop"
             "Get the current applied shape name", parents=[parent_parser])

help

adsec.adSecArbClient.help

id

adsec.adSecArbClient.id = Ice.Identity()

initAlertParser

adsec.adSecArbClient.initAlertParser = subparsers.add_parser("initAlert", help="Callable during closed loop", parents=[parent_parser])

int

adsec.adSecArbClient.int

loadDisturbParserParser

adsec.adSecArbClient.loadDisturbParserParser

Initial value:

=  subparsers.add_parser("LoadDisturb", 
            help="setting/loading a history of disturbance matrices." 
                 "Offsetting triggered by slope sending. Used for calibration setting"
                 "modes in command space"
                 "Dim: 4000x672load slope filter", parents=[parent_parser])

loadGainParser

adsec.adSecArbClient.loadGainParser

Initial value:

=  subparsers.add_parser("LoadGain", help="loop gain, reconstruction filter gain"
            "mode gains, Dim: 672", parents=[parent_parser])

loadModeFilterParser

adsec.adSecArbClient.loadModeFilterParser

Initial value:

=  subparsers.add_parser("LoadModeFilter", help="Callable during close and open loop"
            "Dim: 672,672,2", parents=[parent_parser])

loadModeGainParser

adsec.adSecArbClient.loadModeGainParser

Initial value:

=  subparsers.add_parser("LoadModeGain", help="loop gain, reconstruction filter gain for TipTilt"
            "mode gain, single value for a single mode", parents=[parent_parser])

loadRecMatParserParser

adsec.adSecArbClient.loadRecMatParserParser

Initial value:

=  subparsers.add_parser("LoadRecMat", 
            help="Callable during close and open loop. During open loop the"
            "m2cFile is set. During close loop the passed m2c file is cross checked"
            "to the current m2c. If the m2cFile does not match the current m2c an error"
            "status is passed back."  
            "Dim: 672,672", parents=[parent_parser])

loadShapeParser

adsec.adSecArbClient.loadShapeParser

Initial value:

=  subparsers.add_parser("LoadShape", help="Callabel only during open-loop"
             "Applies a shape to the secondary by name."
             "Also a flat can be applied to the secondary.", parents=[parent_parser])

loadSlopeFilterParser

adsec.adSecArbClient.loadSlopeFilterParser

Initial value:

=  subparsers.add_parser("LoadSlopeFilter", help="Callable during close and open loop"
            "Dim: 627,1600, 1", parents=[parent_parser])

name

adsec.adSecArbClient.name

offloadingParser

adsec.adSecArbClient.offloadingParser

Initial value:

=  subparsers.add_parser("Offloading", 
            help="Enables/Disables Tip/Tilt/Focus offloading from FLAOS"
                 "Callable in open loop only", parents=[parent_parser])

parent_parser

adsec.adSecArbClient.parent_parser = argparse.ArgumentParser(add_help=False)

parser

adsec.adSecArbClient.parser = argparse.ArgumentParser()

pauseAoParser

adsec.adSecArbClient.pauseAoParser = subparsers.add_parser("PauseAo", help="Tell the AdSec system that we want to pause. Callable during closed loop.", parents=[parent_parser])

readSecFrameCounterParser

adsec.adSecArbClient.readSecFrameCounterParser = subparsers.add_parser("ReadSecFrameCounter", help="Get the frame counter", parents=[parent_parser])

readSecSlopeBuffParser

adsec.adSecArbClient.readSecSlopeBuffParser = subparsers.add_parser("ReadSecSlopeBuff", help="Get one of the downloaded sloped from the downloaded slope buffer", parents=[parent_parser])

refreshSlopeBuffParser

adsec.adSecArbClient.refreshSlopeBuffParser = subparsers.add_parser("RefreshSlopeBuff", help="Starts downloading slope buffer from secondary BCUs after applying disturbance matrix callable during open loop", parents=[parent_parser])

resumeAoParser

adsec.adSecArbClient.resumeAoParser = subparsers.add_parser("ResumeAo", help="Resumes the loop after a pause. Callable when the system is paused.", parents=[parent_parser])

runAoParser

adsec.adSecArbClient.runAoParser = subparsers.add_parser("RunAo", help="run ao with parameters", parents=[parent_parser])

saveStatusParser

adsec.adSecArbClient.saveStatusParser = subparsers.add_parser("SaveStatus", help="Saves the current AdSec status to some data structure", parents=[parent_parser])

setDataDecimationParser

adsec.adSecArbClient.setDataDecimationParser = subparsers.add_parser("SetDataDecimation", help="Callable during open loop before diagnostic data is sent", parents=[parent_parser])

stopAoParser

adsec.adSecArbClient.stopAoParser = subparsers.add_parser("StopAo", help="Callable during closed loop", parents=[parent_parser])

subparsers

adsec.adSecArbClient.subparsers = parser.add_subparsers(title="subcommands", metavar="<command>")

testClientParser

adsec.adSecArbClient.testClientParser

Initial value:

=  subparsers.add_parser("TestClient",
          help="Test the whole AdSec interface with dummy data.", parents=[parent_parser])

ToBank

dictionary adsec.adSecArbClient.ToBank = {'BankA': ADSEC.Bank.BankA, 'BankB': ADSEC.Bank.BankB}

True

adsec.adSecArbClient.True

type

adsec.adSecArbClient.type