\(\renewcommand\AA{\unicode{x212B}}\)

FakeISISHistoDAE v1

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Simulates ISIS histogram DAE.

See Also

FakeISISEventDAE

Properties

Name	Direction	Type	Default	Description
NPeriods	Input	number	1	Number of periods.
NSpectra	Input	number	100	Number of spectra.
NBins	Input	number	30	Number of bins.
Port	Input	number	56789	The port to broadcast on (default 56789, ISISDAE 6789).

Description

Simulates ISIS histogram DAE. It runs continuously until canceled and listens to port 6789 for ISIS DAE commands.

Data is generated starting at 10000 microseconds Time of flight, and each bin requested covers 100 microseconds. The algorithm silently defines three additional spectra with numbers NSpectra+1, NSpectra+2 and NSpectra+3 in a different time regime (they have different binning to the rest of the spectra).

Usage

Example:

from threading import Thread
import time

def startFakeHistoDAE():
    # This will generate 100 spectra with 100 bins
    try:
        FakeISISHistoDAE(NPeriods=1,NSpectra=100,nBins=100)
    except RuntimeError:
        pass

def captureLive():
    ConfigService.setFacility("TEST_LIVE")

    try:
        # start a Live data listener updating every second, that rebins the data
        # and replaces the results each time with those of the last second.
        StartLiveData(Instrument='ISIS_Histogram', OutputWorkspace='wsOut', UpdateEvery=1,
                      AccumulationMethod='Replace')

        # give it a couple of seconds before stopping it
        time.sleep(2)
    finally:
        # This will cancel both algorithms
        # you can do the same in the GUI
        # by clicking on the details button on the bottom right
        AlgorithmManager.cancelAll()
        time.sleep(1)
#--------------------------------------------------------------------------------------------------

oldFacility = ConfigService.getFacility().name()
thread = Thread(target = startFakeHistoDAE)
thread.start()
time.sleep(2) # give it a small amount of time to get ready
if not thread.is_alive():
    raise RuntimeError("Unable to start FakeDAE")

try:
    captureLive()
except:
    print("Error occurred starting live data")
finally:
    thread.join() # this must get hit

# put back the facility
ConfigService.setFacility(oldFacility)

#get the output workspace
wsOut = mtd["wsOut"]
print("The workspace contains %i histograms" % wsOut.getNumberHistograms())

Output:

 The workspace contains 100 histograms

Categories: AlgorithmIndex | DataHandling\DataAcquisition

Source

C++ header: FakeISISHistoDAE.h

C++ source: FakeISISHistoDAE.cpp