Next: Tips Up: slsDetectorClient Previous: Detector setup

# Retrieving detector parameters (plus trimming and test modalities)

mythen_get [id[:/-]]var arg

is used to retrieve the detector parameter var e.g. mythen_get 0:exptime returns the exposure time in seconds

help
  This help
config fname
  writes the configuration file
parameters fname
  writes the main detector parameters for the measuremen tin the file
setup rootname
  writes the complete detector setup (including configuration, trimbits, flat field coefficients, badchannels etc.) is a set of files for which the extension is automatically generated
online
  return whether the detector is in online (1) or offline (0) state.
status
  gets the detector status - can be: running, error, transmitting, finished, waiting or idle
data
  gets all data from the detector (if any) processes them and writes them to file according to the preferences already setup
frame
  gets a single frame from the detector (if any) processes it and writes it to file according to the preferences already setup
hostname
  Gets the detector hostname (or IP address)
caldir
  Gets path of the calibration files
trimdir
  Gets path of the trim files
outdir
  directory to which the files will be written by default
fname
  filename to which the files will be written by default (to which file and position indexes will eventually be attached)
index
  start index of the files (automatically incremented by the acquisition functions)
nmod
  Gets number of detector modules
maxmod
  Gets maximum number of detector modules
extsig:i
  Gets usage of the external digital signal i. The return value can be: off, gate_in_active_high, gate_in_active_low, trigger_in_rising_edge, trigger_in_falling_edge, ro_trigger_in_rising_edge, ro_trigger_in_falling_edge, gate_out_active_high, gate_out_active_low, trigger_out_rising_edge, trigger_out_falling_edge, ro_trigger_out_rising_edge, ro_trigger_out_falling_edge
timing
  Sets the timing mode of the detector. Can be auto, gating (works only if at least one of the signals is configured as gate_in), trigger (works only if at least one of the signals is configured as trigger_in), ro_trigger (works only if at least one of the signals is configured as ro_trigger_in), triggered_gating (works only if one ofthe signals is configured as gate_in and one as trigger_in).
modulenumber
  Gets the module serial number
moduleversion
  Gets the module version
detectornumber
  Gets the detector number (MAC address)
detectorversion
  Gets the detector firmware version
softwareversion
  Gets the detector software version
digitest:i
  Makes a digital test of the detector module i. Returns 0 if it succeeds
bustest
  Makes a test of the detector bus. Returns 0 if it succeeds
settings
  Gets detector settings. Can be: standard fast highgain undefined
threshold
  Gets detector threshold in eV. It is precise only if the detector is calibrated
vthreshold
  Gets detector threshold in DAC units. A very rough calibration is dac=800-10*keV
exptime
  Gets the exposure time per frame (in s)
period
  Gets the frames period (in s)
delay
  Gets the delay after trigger (in s)
gates
  Gets the number of gates per frame
frames
  Gets the number of frames per cycle (e.g. after each trigger)
cycles
  Gets the number of cycles (e.g. number of triggers)
probes
  Gets the number of probes to accumulate (max 3)
timestamp
  Gets the internal time stamp of the nex frame acquired (i.e. during an acquisition, all timestamps of the frames are stored in a FIFO which can be read after the acquisition - returns -1 if the FIFO is empty)
dr
  Gets the dynamic range
trim:mode fname
  Trims the detector and writes the trimfile fname.snxxx. mode can be: noise beam improve fix offline - Check that the start conditions are OK!!!
flatfield
  fname returns whether the flat field corrections are enabled and if so writes the coefficients to the specified filename. If fname is none it is not written
ratecorr
  returns wether the rate corrections are enabled and what is the dead time used in ns
badchannels fname
  returns wether the bad channels corrections are enabled and if so writes the bad channels to the specified filename. If fname is none it is not written
angconv fname
  returns wether the angular conversion is enabled and if so writes the angular conversion coefficients to the specified filename. If fname is none, it is not written
globaloff
  returns the fixed angular offset of your encoder - should be almost constant!
fineoff
  returns a possible angualr offset of your setup - should be small but can be senseful to modify
binsize
  returns the binning size of the angular conversion
angdir
  gets the angular direction of the detector (can be 1 or -1 - by default 1, channel 0 is smaller angle)
positions
  returns the number of positions at which the detector is moved during the acquisition and their values
startscript script
  sets a script to be executed at the beginning of the measurements (e.g. open shutter). none unsets. Parameters will be parsed as `script nrun=i par=spar` where i is the run number and spar is the value of startscriptpar.
stopscript
  returns the script to be executed at the end of the measurement (e.g. close shutter). none unsets. Parameters will be parsed as `script nrun=i par=spar` where i is the run number and spar is the value of stopscriptpar.
startscriptpar
  returns the parameter passed to the start script as string with the syntax par=spar. Its meaning must be interpreted inside the script!
stopscriptpar
  returns the parameter passed to the start script as string with the syntax par=spar. Its meaning must be interpreted inside the script!
scan0script
  returns the scan script to be executed at higher level. Script can be none (unset), threshold (change threshold DAC values for all modules), energy (change energy threshold DAC values using calibration for each module), trimbits (change trimbits for all channels) or any script (e.g changing temperature or moving sample) which will be called with the syntax `script nrun=i fn=fname var=val par=spar` where i is the file index, fname is the file name val is the current value of the scan variable and spar is the value of the scan parameter
scan1script
  returns the scan script to be executed at lower level. Script can be none (unset), threshold (change threshold DAC values for all modules), energy (change energy threshold DAC values using calibration for each module), trimbits (change trimbits for all channels) or any script (e.g changing temperature or moving sample) which will be called with the syntax `script nrun=i fn=fname var=val par=spar` where i is the file index, fname is the file name val is the current value of the scan variable and spar is the value of the scan parameter
scan0par
  returns the scan parameter to be passed to scan0script as a string with syntax par=spar. Its meaning has to be interpreted insode the script!
scan1par
  returns the scan parameter to be passed to scan1script as a string with syntax par=spar. Its meaning has to be interpreted insode the script!
scan0prec
  returns the precision of the scan variable in order to properly generate the file names for scan0
scan1prec
  returns the precision of the scan variable in order to properly generate the file names for scan1
scan0steps
  returns the steps for the scan0script. n is the number of steps and the following values are the step values.
scan1steps
  returns the steps for the scan1script. n is the number of steps and the following values are the step values.
scan0range
  returns the steps for the scan0script. n is the number of steps and the following values are the step values.
scan1range
  returns the steps for the scan1script. n is the number of steps and the following values are the step values.
scriptbefore
  returns the script to be executed before each acquisition (before all positions) with the syntax `script nrun=i fn=fname par=spar sv0=svar0 sv1=svar1 p0=spar0 p1=spar1` where i is the file index, fname is the file name, sva0, svar1 are the current values of the scan variables 0 and 1, spar0, spar1 are tthe scan parameter 0 and 1.
scriptafter
  returns the script to be executed after each acquisition (after all positions) with the syntax `script nrun=i fn=fname par=spar sv0=svar0 sv1=svar1 p0=spar0 p1=spar1` where i is the file index, fname is the file name, sva0, svar1 are the current values of the scan variables 0 and 1, spar0, spar1 are tthe scan parameter 0 and 1.
scriptbeforepar
  returns the parameter to be passed to the script before witht he syntax par=spar
scriptafterpar
  returns the parameter to be passed to the script after witht he syntax par=spar
headerbefore
  returns the script to be executed before each acquisition (after moving the detector) with the syntax `script nrun=i fn=fname par=spar` where i is the run number, fname is the file name, spar is the header before parameter. The script is normally used to save a file header.
headerafter
  returns the script to be executed after each acquisition (after each position) with the syntax `script nrun=i fn=fname par=spar` where i is the run number, fname is the file name, spar is the header after parameter. The script is normally used to complete the file header.
headerbeforepar
  returns the parameter to be passed to the header before script with the syntax par=spar
headerafterpar
  returns the parameter to be passed to the header after script with the syntax par=spar

Next: Tips Up: slsDetectorClient Previous: Detector setup