__init__ (
        self,
        frametime=None,
        degreetime=None,
        frameangle=1.0 * projtls.degrees,
        fnpattern='s' + config.hashfilepattern,
        numimg=2,
        scanlimit=99,
        imagelimit=999,
        firstscan=1,
        avoidclash=0,
        )

Constructor:

optional parameters:

frametime

Collect data at give number of seconds per frame.

degreetime

Collect at given number of seconds per degree. If this is given, no frametime should be specified. If none of the two is specified, the default of 10 seconds per frame is used.

frameangle

Collect frames at given intervals.

fnpattern

The file name pattern to be used.

numimg

number of times each image has to be measured. Normally 2 for dezingering.

scanlimit

Maximum number of scans that the scan pattern must accommodate.

imagelimit

The ## in the filename are checked to see if there is space for this many images per scan

firstscan

number of the first scan to be collected

avoidclash

if 1, repeatedly increment firstscan until file does not exist

__repr__ ( self )

A one-line summary string of the scan parameters.

curscan ( self )

Return the current scan number.

filename (
        self,
        scannr=None,
        sector=None,
        extension='kcd',
        )

Calculate a file name.

optional parameters:

scannr

Number of the scan for which the prefix should be created. If not given, the currently active scan will be used.

sector

The image number withing the scan. If not given, the hash pattern for the scan is returned.

extension

The file name extension.

Return value: the file name.

newdarkname ( self )

Return a new proposed name for a dark current image.

The returned name will be dark##.kcd with the exposure time on the ## marks for the first dark image; for subsequent dark images it will be dark##-#.kcd with the last # representing a sequence number.

newscan ( self )

Progress to the next scan.

This should be called once before each scan is started. Those calls are normally handled by the scanset.Perform() method

prefix ( self,  scannr=None )

Calculate the file name prefix.

optional parameters:

scannr

Number of the scan for which the prefix should be created. If not given, the currently active scan will be used.

Return value: the prefix string.

resetscan ( self )

Reset the current scan number.

This should be called once before each scan set. That call is normally handled by the scanset.Perform() method