Table of Contents

Module: hints experiment/hints.py

Global variables for the collect programs.

All of the collect programs are written in such a way that they can be helped by the presence of these global variables, but they should also work when no global variables are available (such as when the user is running straight off a CD/ROM disk!)

Functions   
avoidedlongestaxis
axcrit
balloonhelp
bestresolution
cell
cryogenic
degreetime
delete
expert
frameangle
get
gooddx
habitusfilename
hklcell
kcdwavelength
maxaxis
overhead
reciprocalaxes
set
thetamax
wavelength
xfilename
xwavelength
  avoidedlongestaxis 
avoidedlongestaxis ( newvalue=None )

Retrieve (no arg) or set (with arg) the boolean variable that stores whether we are avoiding the longest axis in the data collection strategy.

  axcrit 
axcrit ( newvalue=None )

Retrieve (no arg) or set (with arg) the axis criterion to be used for cell standardizations

  balloonhelp 
balloonhelp ( newvalue=None )

Retrieve (no arg) or set (with arg) the global boolean variable storing the status of the balloon-help.

  bestresolution 
bestresolution ( verbose=0 )

Use all information available to guess the highest resolution that should be obtained for a data set

  cell 
cell ( scafile=None,  verbose=1 )

Locate the unit cell (returned as a 2-tuple of a 6-tuple with cell parameters and a 6-tuple with standard deviations) based on the name of a .sca or .hkl reflection file

  cryogenic 
cryogenic ( newvalue=None )

Retrieve (no arg) or set (with arg) the global boolean variable storing whether we are doing a cryogenic data collection.

  degreetime 
degreetime ()

  delete 
delete ( variablename )

Delete a global variable

  expert 
expert ( newvalue=None )

Get (no arg) or set (with arg) the expert mode boolean variable.

  frameangle 
frameangle ()

  get 
get ( variablename )

Get the current value of a global variable

  gooddx 
gooddx ( verbose=1 )

Propose a good dx value for the measurement

  habitusfilename 
habitusfilename ( newvalue=None )

Retrieve (no arg) or set (with arg) the last name used for a crystal habitus file name

  hklcell 
hklcell ( hklfile,  verbose=1 )

Locate the unit cell (returned as a 2-tuple of a 6-tuple with cell parameters and a 6-tuple with standard deviations) based on the name of a .hkl file

  kcdwavelength 
kcdwavelength ( verbose=1 )

Retrieve the wavelength used for an experiment from a .kcd file in the current directory. In principle for internal use by this module.

  maxaxis 
maxaxis ()

Use all information available to guess how far unit cell axes can be reduced without losing accuracy in the strategy predictions.

  overhead 
overhead ( newvalue=None )

Retrieve (no arg) or set (with arg) the global variable storing the overhead time in seconds taken by 1 frame of data collection.

  reciprocalaxes 
reciprocalaxes ( cell=None )

Retrieve (no arg) or store (with argument) the length of the reciprocal axes of the unit cell under consideration.

  set 
set ( variablename,  value )

Set a global variable to a new value

  thetamax 
thetamax ( verbose=1 )

Use all information available to guess the best value for thetamax

  wavelength 
wavelength ( newvalue=None )

Use all information available to figure out what wavelength we are using for the current experiment. With argument, store the current wavelength in a global variable.

  xfilename 
xfilename ()

Use all information available to determine a good default filename for retrieving a unit cell

  xwavelength 
xwavelength ( verbose=1 )

Retrieve the wavelength used for an experiment from a .x file in the current directory. In principle for internal use by this module.

Classes   
InitFunc

Class of which instances will retrieve the value of a hint as late as possible.


Table of Contents

This document was automatically generated on Tue Nov 25 12:18:58 2008 by HappyDoc version WORKING