C++ API¶

class _sls_detector.DetectorApi¶

Interface to the multiSlsDetector class through Detector.h These functions are used by the python classes Eiger and Jungfrau and normally it is better to use them than to directly access functions here.

However it is possible to access these functions…

#Using the python class
from sls_detector import Eiger
d = Eiger()
d._api.getThresholdEnergy()

#creating a DetectorApi object (remember to set online flags)
from _sls_detector import DetectorApi
api = DetectorApi(0)
api.setOnline(True)
api.setReceiverOnline(True)
api.getNumberOfFrames()

#But the Pythonic way is almost alway simpler
d = Eiger()
d.n_frames
>> 10

acq(self: _sls_detector.DetectorApi) → None¶

checkOnline(self: _sls_detector.DetectorApi) → str¶

clearBitInRegister(self: _sls_detector.DetectorApi, arg0: int, arg1: int) → None¶

clearErrorMask(self: _sls_detector.DetectorApi) → None¶

configureNetworkParameters(self: _sls_detector.DetectorApi) → None¶

freeSharedMemory(self: _sls_detector.DetectorApi) → None¶

getAcquiringFlag(self: _sls_detector.DetectorApi) → bool¶

getActive(self: _sls_detector.DetectorApi, arg0: int) → bool¶

getAdc(self: _sls_detector.DetectorApi, arg0: str, arg1: int) → int¶

getAllTrimbits(self: _sls_detector.DetectorApi) → int¶

getClientVersion(self: _sls_detector.DetectorApi) → int¶

getCounterBit(self: _sls_detector.DetectorApi) → bool¶

getCycles(self: _sls_detector.DetectorApi) → int¶

getDac(self: _sls_detector.DetectorApi, arg0: str, arg1: int) → int¶

getDacFromIndex(self: _sls_detector.DetectorApi, arg0: int, arg1: int) → int¶

getDacVthreshold(self: _sls_detector.DetectorApi) → int¶

getDac_mV(self: _sls_detector.DetectorApi, arg0: str, arg1: int) → int¶

getDbitClock(self: _sls_detector.DetectorApi) → int¶

getDbitPhase(self: _sls_detector.DetectorApi) → int¶

getDbitPipeline(self: _sls_detector.DetectorApi) → int¶

getDelay(self: _sls_detector.DetectorApi) → int¶

getDelayFrame(self: _sls_detector.DetectorApi, arg0: int) → int¶

getDelayLeft(self: _sls_detector.DetectorApi, arg0: int) → int¶

getDelayRight(self: _sls_detector.DetectorApi, arg0: int) → int¶

getDetectorGeometry(self: _sls_detector.DetectorApi) → Tuple[int, int]¶

getDetectorNumber(self: _sls_detector.DetectorApi, arg0: int) → int¶

getDetectorType(self: _sls_detector.DetectorApi) → List[str]¶

getDynamicRange(self: _sls_detector.DetectorApi) → int¶

getErrorMask(self: _sls_detector.DetectorApi) → int¶

getErrorMessage(self: _sls_detector.DetectorApi) → str¶

getExposureTime(self: _sls_detector.DetectorApi) → int¶

getFileFormat(self: _sls_detector.DetectorApi) → str¶

getFileIndex(self: _sls_detector.DetectorApi) → int¶

getFileName(self: _sls_detector.DetectorApi) → str¶

getFileOverWrite(self: _sls_detector.DetectorApi) → bool¶

getFilePath(*args, **kwargs)¶

Overloaded function.

getFilePath(self: _sls_detector.DetectorApi) -> str

Using multiSlsDetector

getFilePath(self: _sls_detector.DetectorApi, arg0: int) -> str

File path for individual detector

getFileWrite(self: _sls_detector.DetectorApi) → bool¶

getFirmwareVersion(self: _sls_detector.DetectorApi) → int¶

getFlippedDataX(self: _sls_detector.DetectorApi, arg0: int) → bool¶

getFlippedDataY(self: _sls_detector.DetectorApi, arg0: int) → bool¶

getFramesCaughtByReceiver(*args, **kwargs)¶

Overloaded function.

getFramesCaughtByReceiver(self: _sls_detector.DetectorApi) -> int
getFramesCaughtByReceiver(self: _sls_detector.DetectorApi, arg0: int) -> int

getGapPixels(self: _sls_detector.DetectorApi) → bool¶

getHostname(self: _sls_detector.DetectorApi) → str¶

getImageSize(self: _sls_detector.DetectorApi) → Tuple[int, int]¶

getJCTBSamples(self: _sls_detector.DetectorApi) → int¶

getLastClientIP(self: _sls_detector.DetectorApi) → str¶

getMeasuredPeriod(self: _sls_detector.DetectorApi) → List[float]¶

getMeasuredSubPeriod(self: _sls_detector.DetectorApi) → List[float]¶

getMultiDetectorId(self: _sls_detector.DetectorApi) → int¶

getNetworkParameter(self: _sls_detector.DetectorApi, arg0: str) → List[str]¶

getNumberOfDetectors(self: _sls_detector.DetectorApi) → int¶

getNumberOfFrames(self: _sls_detector.DetectorApi) → int¶

getNumberOfGates(self: _sls_detector.DetectorApi) → int¶

getNumberOfMeasurements(self: _sls_detector.DetectorApi) → int¶

getOnline(self: _sls_detector.DetectorApi) → bool¶

getPeriod(self: _sls_detector.DetectorApi) → int¶

getRateCorrection(self: _sls_detector.DetectorApi) → List[float]¶

getReadoutClockSpeed(self: _sls_detector.DetectorApi) → int¶

getReadoutFlags(self: _sls_detector.DetectorApi) → List[str]¶

getReceiverCurrentFrameIndex(self: _sls_detector.DetectorApi) → int¶

getReceiverFrameDiscardPolicy(self: _sls_detector.DetectorApi) → str¶

getReceiverFramesPerFile(self: _sls_detector.DetectorApi) → int¶

getReceiverLastClientIP(self: _sls_detector.DetectorApi) → str¶

getReceiverLock(self: _sls_detector.DetectorApi) → bool¶

getReceiverOnline(self: _sls_detector.DetectorApi) → bool¶

getReceiverPartialFramesPadding(self: _sls_detector.DetectorApi) → bool¶

getReceiverVersion(self: _sls_detector.DetectorApi) → int¶

getRunStatus(self: _sls_detector.DetectorApi) → str¶

getRxDataStreamStatus(self: _sls_detector.DetectorApi) → bool¶

getRxTcpport(self: _sls_detector.DetectorApi, arg0: int) → int¶

getServerLock(self: _sls_detector.DetectorApi) → bool¶

getServerVersion(self: _sls_detector.DetectorApi) → int¶

getSettings(self: _sls_detector.DetectorApi) → str¶

getSettingsDir(self: _sls_detector.DetectorApi) → str¶

getSubExposureDeadTime(self: _sls_detector.DetectorApi) → int¶

getSubExposureTime(self: _sls_detector.DetectorApi) → int¶

getTemperatureControl(self: _sls_detector.DetectorApi) → bool¶

getTemperatureEvent(self: _sls_detector.DetectorApi) → bool¶

getTenGigabitEthernet(self: _sls_detector.DetectorApi) → bool¶

getThreadedProcessing(self: _sls_detector.DetectorApi) → bool¶

getThresholdEnergy(self: _sls_detector.DetectorApi) → int¶

getThresholdTemperature(self: _sls_detector.DetectorApi) → float¶

getTimingMode(self: _sls_detector.DetectorApi) → str¶

getTrimEnergies(self: _sls_detector.DetectorApi) → List[int]¶

getUserDetails(self: _sls_detector.DetectorApi) → str¶

isChipPowered(self: _sls_detector.DetectorApi) → bool¶

isClientAndDetecorCompatible(self: _sls_detector.DetectorApi) → bool¶

isClientAndReceiverCompatible(self: _sls_detector.DetectorApi) → bool¶

loadTrimbitFile(self: _sls_detector.DetectorApi, arg0: str, arg1: int) → None¶

powerChip(self: _sls_detector.DetectorApi, arg0: bool) → None¶

pulseAllPixels(self: _sls_detector.DetectorApi, arg0: int) → None¶

pulseChip(self: _sls_detector.DetectorApi, arg0: int) → None¶

pulseDiagonal(self: _sls_detector.DetectorApi, arg0: int) → None¶

readConfigurationFile(self: _sls_detector.DetectorApi, arg0: str) → None¶

readParametersFile(self: _sls_detector.DetectorApi, arg0: str) → None¶

readRegister(self: _sls_detector.DetectorApi, arg0: int) → int¶

resetFramesCaught(self: _sls_detector.DetectorApi) → None¶

resetTemperatureEvent(self: _sls_detector.DetectorApi) → None¶

setAcquiringFlag(self: _sls_detector.DetectorApi, arg0: bool) → None¶

setActive(self: _sls_detector.DetectorApi, arg0: int, arg1: bool) → None¶

setAllTrimbits(self: _sls_detector.DetectorApi, arg0: int) → None¶

setBitInRegister(self: _sls_detector.DetectorApi, arg0: int, arg1: int) → None¶

setCounterBit(self: _sls_detector.DetectorApi, arg0: bool) → None¶

setCycles(self: _sls_detector.DetectorApi, arg0: int) → None¶

setDac(self: _sls_detector.DetectorApi, arg0: str, arg1: int, arg2: int) → None¶

setDacFromIndex(self: _sls_detector.DetectorApi, arg0: int, arg1: int, arg2: int) → int¶

setDacVthreshold(self: _sls_detector.DetectorApi, arg0: int) → None¶

setDac_mV(self: _sls_detector.DetectorApi, arg0: str, arg1: int, arg2: int) → None¶

setDbitClock(self: _sls_detector.DetectorApi, arg0: int) → None¶

setDbitPhase(self: _sls_detector.DetectorApi, arg0: int) → None¶

setDbitPipeline(self: _sls_detector.DetectorApi, arg0: int) → None¶

setDelay(self: _sls_detector.DetectorApi, arg0: int) → None¶

setDelayFrame(self: _sls_detector.DetectorApi, arg0: int, arg1: int) → None¶

setDelayLeft(self: _sls_detector.DetectorApi, arg0: int, arg1: int) → None¶

setDelayRight(self: _sls_detector.DetectorApi, arg0: int, arg1: int) → None¶

setDynamicRange(self: _sls_detector.DetectorApi, arg0: int) → None¶

setErrorMask(self: _sls_detector.DetectorApi, arg0: int) → None¶

setExposureTime(self: _sls_detector.DetectorApi, arg0: int) → None¶

setFileFormat(self: _sls_detector.DetectorApi, arg0: str) → None¶

setFileIndex(self: _sls_detector.DetectorApi, arg0: int) → None¶

setFileName(self: _sls_detector.DetectorApi, arg0: str) → None¶

setFileOverWrite(self: _sls_detector.DetectorApi, arg0: bool) → None¶

setFilePath(*args, **kwargs)¶

Overloaded function.

setFilePath(self: _sls_detector.DetectorApi, arg0: str) -> None
setFilePath(self: _sls_detector.DetectorApi, arg0: str, arg1: int) -> None

setFileWrite(self: _sls_detector.DetectorApi, arg0: bool) → None¶

setFlippedDataX(self: _sls_detector.DetectorApi, arg0: int, arg1: bool) → None¶

setFlippedDataY(self: _sls_detector.DetectorApi, arg0: int, arg1: bool) → None¶

setGapPixels(self: _sls_detector.DetectorApi, arg0: bool) → None¶

setHostname(self: _sls_detector.DetectorApi, arg0: str) → None¶

setImageSize(self: _sls_detector.DetectorApi, arg0: int, arg1: int) → None¶

setJCTBSamples(self: _sls_detector.DetectorApi, arg0: int) → None¶

setNetworkParameter(self: _sls_detector.DetectorApi, arg0: str, arg1: str, arg2: int) → None¶

setNumberOfFrames(self: _sls_detector.DetectorApi, arg0: int) → None¶

setNumberOfGates(self: _sls_detector.DetectorApi, arg0: int) → None¶

setNumberOfMeasurements(self: _sls_detector.DetectorApi, arg0: int) → None¶

setOnline(self: _sls_detector.DetectorApi, arg0: bool) → None¶

setPeriod(self: _sls_detector.DetectorApi, arg0: int) → None¶

setRateCorrection(self: _sls_detector.DetectorApi, arg0: List[float]) → None¶

setReadoutClockSpeed(self: _sls_detector.DetectorApi, arg0: int) → None¶

setReadoutFlag(self: _sls_detector.DetectorApi, arg0: str) → None¶

setReceiverFramesDiscardPolicy(self: _sls_detector.DetectorApi, arg0: str) → None¶

setReceiverFramesPerFile(self: _sls_detector.DetectorApi, arg0: int) → None¶

setReceiverLock(self: _sls_detector.DetectorApi, arg0: bool) → None¶

setReceiverOnline(self: _sls_detector.DetectorApi, arg0: bool) → None¶

setReceiverPartialFramesPadding(self: _sls_detector.DetectorApi, arg0: bool) → None¶

setRxDataStreamStatus(self: _sls_detector.DetectorApi, arg0: bool) → None¶

setRxTcpport(self: _sls_detector.DetectorApi, arg0: int, arg1: int) → None¶

setServerLock(self: _sls_detector.DetectorApi, arg0: bool) → None¶

setSettings(self: _sls_detector.DetectorApi, arg0: str) → None¶

setSettingsDir(self: _sls_detector.DetectorApi, arg0: str) → None¶

setSubExposureDeadTime(self: _sls_detector.DetectorApi, arg0: int) → None¶

setSubExposureTime(self: _sls_detector.DetectorApi, arg0: int) → None¶

setTemperatureControl(self: _sls_detector.DetectorApi, arg0: bool) → None¶

setTenGigabitEthernet(self: _sls_detector.DetectorApi, arg0: bool) → None¶

setThreadedProcessing(self: _sls_detector.DetectorApi, arg0: bool) → None¶

setThresholdEnergy(self: _sls_detector.DetectorApi, arg0: int) → None¶

setThresholdTemperature(self: _sls_detector.DetectorApi, arg0: float) → None¶

setTimingMode(self: _sls_detector.DetectorApi, arg0: str) → None¶

setTrimEnergies(self: _sls_detector.DetectorApi, arg0: List[int]) → None¶

startAcquisition(self: _sls_detector.DetectorApi) → None¶

startReceiver(self: _sls_detector.DetectorApi) → None¶

stopAcquisition(self: _sls_detector.DetectorApi) → None¶

stopReceiver(self: _sls_detector.DetectorApi) → None¶

writeAdcRegister(self: _sls_detector.DetectorApi, arg0: int, arg1: int) → None¶

writeRegister(self: _sls_detector.DetectorApi, arg0: int, arg1: int) → None¶