Package schrodinger :: Package application :: Package jaguar :: Module scan :: Class Scan

Class Scan

object --+
         |
        Scan

A class for storing information about geometry scan variables.

Instance Methods

[hide private]

__init__(self, var_name, initial=None, final=None, steps=None, step_size=None, at_values=None)
This constructor can be used for two different types of scans - regular and irregular.

_getFinal(self)

_getInitial(self)

_getSteps(self)

_getStepSize(self)

_getAtValues(self)

__eq__(self, other)
Equality comparison only looks at numeric quantities, not the variable name.

__ne__(self, other)

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods

[hide private]

parse(zvarstring)
Parse a scan definition string and return a Scan object.

Class Variables

[hide private]

precision = 0.001

Properties

[hide private]

final
final scan value

initial
initial scan value

steps
number of steps in the scan

step_size
step size (None for 'at values' scans)

at_values
an array of the scan values for 'at values' scans

Inherited from object: __class__

Method Details

[hide private]

init(self, var_name, initial=None, final=None, steps=None, step_size=None, at_values=None)
(Constructor)


This constructor can be used for two different types of scans -
regular and irregular. For regular scans, the 'initial' argument
must be specified along with two out of the three arguments 'final,'
'steps,' or 'step_size.' For irregular scans, the only argument that
should be specified is 'at_values.'

Attributes

var_name (str)
    The name of the variable the scan is based on.

initial (float)
    The starting point for a scan.

final (float)
    The final point for a scan.

steps (float)
    The number of steps in the scan

step_size (float)
    The step size of a regular scan.

at_values (sequence of floats)
    Specific values at which a

Overrides: object.__init__

Property Details

[hide private]

final

final scan value

Get Method:: _getFinal(self)

initial

initial scan value

Get Method:: _getInitial(self)

steps

number of steps in the scan

Get Method:: _getSteps(self)

step_size

step size (None for 'at values' scans)

Get Method:: _getStepSize(self)

at_values

an array of the scan values for 'at values' scans

Get Method:: _getAtValues(self)

Class Scan

__init__(self, var_name, initial=None, final=None, steps=None, step_size=None, at_values=None) (Constructor)

final

initial

steps

step_size

at_values

init(self, var_name, initial=None, final=None, steps=None, step_size=None, at_values=None)
(Constructor)