Package org.lsst.ccs.subsystem.focalplane

Class ScriptingCommands

java.lang.Object

org.lsst.ccs.subsystem.focalplane.ScriptingCommands

public class ScriptingCommands
extends Object

Commands that are useful when running the focal plane subsystem with scripting

Author:

tonyj

Method Summary

Modifier and Type	Method	Description
Map<SequencerType,String>	getSequencerPaths()	Get the full path of the loaded sequencer files.
void	raiseBadPixelAlert()	Temporary commands for testing alerts
void	raiseImageTimedOutAlert()
void	setHeaderKeywords(Map<String,Serializable> headersMap)	Adds meta-data to be associated with the next image.
org.lsst.ccs.subsystem.imagehandling.data.FileList	waitForFitsFiles(Duration timeout)	Wait until all FITS files have been written.
void	waitForImages(Duration timeout)	Wait until all images have been received from the DAQ (but not necessarily written as FITS files)
void	waitForSequencer(Duration timeout)	Wait until the sequencer stops.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

waitForFitsFiles

@Command(type=QUERY,
         description="Wait for FITS files to be saved",
         level=0,
         autoAck=false)
public org.lsst.ccs.subsystem.imagehandling.data.FileList waitForFitsFiles(@Argument(defaultValue="PT30S")
 Duration timeout)

Wait until all FITS files have been written.

Parameters:

timeout - The maximum duration to wait

Returns:

The list of files which were written

waitForImages

@Command(type=QUERY,
         description="Wait for image data to arrive",
         level=0,
         autoAck=false)
public void waitForImages(@Argument(defaultValue="PT30S")
 Duration timeout)

Wait until all images have been received from the DAQ (but not necessarily written as FITS files)

Parameters:

timeout - The maximum duration to wait

waitForSequencer

@Command(type=QUERY,
         description="Wait for sequencer to stop",
         level=0,
         autoAck=false)
public void waitForSequencer(@Argument(defaultValue="PT30S")
 Duration timeout)

Wait until the sequencer stops.

Parameters:

timeout -

setHeaderKeywords

@Command(type=ACTION,
         description="Set a header keyword value shared by all extensions",
         level=0,
         autoAck=false)
public void setHeaderKeywords(Map<String,Serializable> headersMap)

Adds meta-data to be associated with the next image. This meta-data can potentially be stored in the image database, and be sent to the image handlers for inclusion in the FITS headers. This command is called by the MCM and bot_data scripts, so must be a NORMAL mode command.

Parameters:

headersMap -

getSequencerPaths

@Command(type=QUERY,
         description="Get the Map of reb path, sequencer file full path",
         level=0)
public Map<SequencerType,String> getSequencerPaths()

Get the full path of the loaded sequencer files.

Returns:

A Map containing the reb path - sequencer path

raiseBadPixelAlert

@Command(type=ACTION,
         description="Raise badPixels alert")
public void raiseBadPixelAlert()

Temporary commands for testing alerts

raiseImageTimedOutAlert

@Command(type=ACTION,
         description="Raise imageTimedOut alert")
public void raiseImageTimedOutAlert()