Table of Contents

Class: Driver hwdriver/anyhw.py

Top-level hardware driver class.

All hardware classes are subclasses of this class. Common functionality is implemented largely in this class.

Methods   
GetLowPower
GetNominalPower
NominalVoltage
PointAlongY
PointToMicroscope
PointToSource
PointVertical
PowerOk
PowerUp
SetLowPower
SetNominalPower
__del__
  GetLowPower 
GetLowPower ( self )

Calculate an idle-power setting for the generator.

Return value: 2-tuple of kv,ma

Exceptions   
generatorerror( "No suitable operational range for generator" )
  GetNominalPower 
GetNominalPower ( self )

Calculate a good power to run the generator.

Return value: 2-tuple of kv,ma

Exceptions   
generatorerror( "No suitable operational range for generator" )
  NominalVoltage 
NominalVoltage ( self )

Calculate a good voltage to run the generator.

The good voltage depends on the generator limits and on the anode material.

Return value: kV setting

  PointAlongY 
PointAlongY (
        self,
        vector,
        psi=0,
        )

Calculate a position that corresponds to positioning a given carthesian vector along the Y axis

parameters:

vector

a vector

optional parameters:

psi

a rotation around the vector. At psi=0 the vector will pointing along the y-axis at the lowest possible chi.

Return value is a Position() object.

  PointToMicroscope 
PointToMicroscope (
        self,
        vector,
        psi=0,
        )

Calculate a position that corresponds to positioning a given carthesian vector towards the microscope.

parameters:

vector

a vector

optional parameters:

psi

a rotation around the vector. At psi=0 the vector will pointing in the direction of the microscope at the lowest possible chi.

Return value is a Position() object.

  PointToSource 
PointToSource (
        self,
        vector,
        psi=0,
        )

Calculate a position that corresponds to positioning a given carthesian vector towards the source.

parameters:

vector

a vector

optional parameters:

psi

a rotation around the vector. At psi=0 the vector will pointing in the direction of the source at the lowest possible chi.

Return value is a Position() object.

  PointVertical 
PointVertical (
        self,
        vector,
        psi=0,
        )

Calculate a position that corresponds to positioning a given carthesian vector vertically.

parameters:

vector

a vector

optional parameters:

psi

a rotation around the vector.

Return value is a Position() object.

  PowerOk 
PowerOk ( self )

See whether generator setting is sufficient for a measurement.

Return value: boolean.

  PowerUp 
PowerUp ( self )

Set the power to an acceptable level.

Return value is a PowerUp() instance that will re-lower the generator power upon its destruction.

  SetLowPower 
SetLowPower ( self )

Set the generator to stand-by power.

  SetNominalPower 
SetNominalPower ( self )

Set the generator to standard running power.

  __del__ 
__del__ ( self )


Table of Contents

This document was automatically generated on Fri Jul 3 09:28:36 2009 by HappyDoc version WORKING