2.17 sddsimagemonitor

• description: sddsimagemonitor reads EPICS image process variables and writes the image data to an SDDS file at regular intervals. Image PVs may be supplied from an input file or directly on the command line. Optional scalar PVs can be logged as parameters, and data may be conditioned on other PV values. Two-dimensional images produce one page per acquisition, while multi-plane data result in one page per plane.
• examples: The following command logs a set of camera images once per minute.
  sddsimagemonitor cam.mon cam.sdds -interval=1,minute -steps=10

  where the contents of the file cam.mon are

  SDDS1  
  &column name=WaveformPV, type=string &end  
  &data mode=ascii no_row_counts=1 &end  
  AR:SLM1:image1

• synopsis:
  usage: sddsimagemonitor [<inputfile> | -PVnames=<name>[,<name>]] <outputfile>  
      [{-erase | -generations[=digits=<integer>][,delimiter=<string>]} [-pendIOtime=<seconds>]  
      [-steps=<integer> | -time=<value>[,<units>]] [-interval=<value>[,<units>]]  
      [-enforceTimeLimit] [-offsetTimeOfDay]  
      [-verbose] [-singleShot{=noprompt|stdout}] [-precision={single|double}]  
      [-dataType={short|long|float|double|character|string}]  
      [-onCAerror={useZero|skipPage|exit}]  
      [-scalars=<filename>] [-flushSteps=<integer>]  
      [-conditions=<filename>,{allMustPass|oneMustPass}[,touchOutput][,retakeStep]]  
      [-comment=<parameterName>,<text>] [-nowarnings]  
      [-xParameter=dimension=<value>[,name=<name>][,minimum=<value>][,maximum=<value>][,interval=<value>]]  
      [-yParameter=dimension=<value>[,name=<name>][,minimum=<value>][,maximum=<value>][,interval=<value>]]  
  [-singleColumn] [-logOnChange] [-device=<name>] [-retakeStep]

• files:
  • input file: optional SDDS file with string column WaveformPV naming image PVs.
  • output file: SDDS file containing the logged images and related parameters.
• switches:
  • -PVnames=<name>[,<name>] — specifies image PV names to read.
  • -scalars=<filename> — logs scalar PVs as parameters in the output file.
  • -erase — overwrites the output file if it exists.
  • -generations[=digits=<integer>][,delimiter=<string>] — writes to a unique generation file.
  • -pendIOtime=<seconds> — sets the wait time for channel access searches.
  • -steps=<integer> — number of image acquisitions to perform.
  • -time=<value>[,<units>] — total acquisition time; seconds, minutes, hours, or days.
  • -interval=<value>[,<units>] — desired time between acquisitions.
  • -enforceTimeLimit — enforces the time limit given with -time.
  • -offsetTimeOfDay — adjusts the starting TimeOfDay value.
  • -verbose — prints a message when data are taken.
  • -singleShot[=noprompt|stdout] — single acquisition triggered by a key press.
  • -precision={single|double} — sets data precision for image PVs.
  • -dataType={short|long|float|double|character|string} — forces an SDDS data type.
  • -onCAerror={useZero|skipPage|exit} — action to take on channel access errors.
  • -flushSteps=<integer> — buffers this many steps before writing to the file.
  • -conditions=<filename>,{allMustPass|oneMustPass}[,touchOutput][,retakeStep] — applies limits from a conditions file to gate data logging.
  • -comment=<parameterName>,<text> — inserts a comment parameter with the given text.
  • -nowarnings — suppresses warning messages.
  • -xParameter=dimension=<value>[,name=<name>][,minimum=<value>][,maximum=<value>][,interval=<value>] — defines X-axis parameter information.
  • -yParameter=dimension=<value>[,name=<name>][,minimum=<value>][,maximum=<value>][,interval=<value>] — defines Y-axis parameter information.
  • -singleColumn — writes image data to a single column with index parameters.
  • -logOnChange — writes data only if scalar PVs change.
  • -device=<name> — selects the device type (e.g., areadector or FLID).
  • -retakeStep — repeats a step if timestamps or scalar values do not change.
• see also:
  • sddsmonitor()
  • sddsvmonitor()
  • sddswmonitor()
• author: Michael Borland, Louis Emery, Hairong Shang, Robert Soliday, ANL/APS.