org.lsst.ccs.subsystem.rafts

Class RaftsCommands

java.lang.Object

org.lsst.ccs.subsystem.rafts.RaftsCommands

public class RaftsCommands
extends Object

A Class containing all the Rafts level commands.

Author:

Owen Saxton

Constructor Summary

Constructors

Constructor and Description
RaftsCommands(org.lsst.ccs.Subsystem subsys, List<REBDevice> rebDevices, GlobalProc globalProc, org.lsst.ccs.utilities.ccd.Geometry geometry, TempControl tempCtrl) Public constructor for the Raft level commands object.

Method Summary

Modifier and Type	Method and Description
void	acquireImage(String imageName) Starts image acquisition.
void	changeCcdType(String type)
List<Integer>	checkAspics() Checks all loaded ASPIC values against the configuration.
List<Integer>	checkCabacs() Checks all loaded CABAC values against the configuration.
void	checkSequencerState() We check the sequencer state.
void	clearBiasDacs() Clears bias DAC values.
void	clearDacs() Clears DAC values.
void	enableScan(boolean value) Sets the scan mode enables.
void	generateAlert(RaftAlert raftAlert, org.lsst.ccs.bus.states.AlertState state)
String	getCcdType() Gets the CCD type
double	getControlTemp() Gets the control temperature
List<Integer>	getDataSource() Gets the data sources from all REBs.
List<Map<String,Integer>>	getFunctionMap() Deprecated.
List<Map<String,Integer>>	getMainMap() Deprecated.
List<Integer>	getParameter(String name) Deprecated.
List<Map<String,Integer>>	getPointers() Deprecated.
List<String>	getREBDeviceNames() Gets the list of REB device names.
List<String>	getREBDevices() Deprecated.
List<Integer>	getREBHwVersions() Gets the list of REB hardware versions.
List<Integer>	getREBIds() Gets the list of REB IDs.
List<Long>	getREBSerialNumbers() Gets the list of REB serial numbers.
List<Map<String,Integer>>	getSequencerFunctionMap() Gets the list of all function maps.
List<Map<String,Integer>>	getSequencerMainMap() Gets the list of all main program maps.
List<Integer>	getSequencerParameter(String name) Gets the list of all values for a parameter.
List<Map<String,Integer>>	getSequencerPointers() Gets the list of all pointer information maps.
String	getSequencerStart() Get the name of the Main routine that will be invoked when the sequencer starts.
List<Map<String,Integer>>	getSequencerSubroutineMap() Gets the list of all subroutine maps.
List<Map<String,Integer>>	getSubroutineMap() Deprecated.
List	getTime() Gets all time base values.
Map<String,Long>	getTimes() Gets all time base values.
List<Boolean>	isBackBiasOn() Gets the back bias on states.
List<Boolean>	isScanEnabled() Gets the scan mode enabled states.
List<Boolean>	isSequencerRunning() Gets the running state of all sequencers.
boolean	isTempControlActive() Gets the temperature control state
int	loadAspics(boolean all) Loads ASPICs with their configured values.
int	loadBiasDacs(boolean all) Loads bias DACs with their configured values.
int	loadCabacs() Loads all CABACs with their configured values.
int	loadDacs(boolean all) Loads DACs with their configured values.
List<Integer>	loadSequencer(String fileName) Loads all sequencers from a file.
int	resetAspics() Resets ASPICs.
void	resetFirmware() Resets the front ends.
void	resetScan() Resets the scan modes.
List<String>	saveFitsImage(String dirName) Saves the current image data as one or more FITS files.
List<String>	saveFitsImage(String dirName, org.lsst.ccs.utilities.image.FitsHeaderMetadataProvider provider)
List<String>	saveImage(String dirName) Saves the current image data as one or more sets of raw bytes.
void	setBackBias(boolean value) Sets the back bias on states.
void	setCcdType(String type) Sets the CCD type
void	setControlTemp(double temp) Sets the control temperature
void	setDataSource(int value) Sets the data sources in all REBs.
void	setDefaultImageDirectory(String dirName) Sets the default image directory.
void	setExposureTime(double expTime) Sets the FITS image exposure time.
void	setFitsFileNamePattern(String pattern) Sets the FITS image file name pattern.
void	setImageDataFileNamePattern(String pattern) Sets the raw image data file name pattern.
void	setImageDataInversion(boolean invert) Sets whether image data values are inverted
void	setParameter(String name, int value) Deprecated.
void	setPatternProperty(String propertyName, String propertyValue) Set a pattern property for resolving file name and output directory.
void	setSequenceNumber(int sequenceNumber) Set an external sequence number.
void	setSequencerParameter(String name, int value) Sets a sequencer parameter value in all REBs.
List<Integer>	setSequencerStart(String mainName) Sets the start address for all sequencers.
List<Integer>	setStart(String mainName) Deprecated.
void	setTime() Sets the time base to the current system time.
void	startSequencer() Starts the sequencers.
void	startTempControl() Starts temperature control
void	stepSequencer() Sends a sequencer step command.
void	stopSequencer() Sends a sequencer stop command.
void	stopTempControl() Stops temperature control
int	waitForImage(int timeout) Waits for image to arrive
void	waitSequencerDone(int timeout) Waits for the sequencers to be done.

Methods inherited from class java.lang.Object

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

Constructor Detail

RaftsCommands

public RaftsCommands(org.lsst.ccs.Subsystem subsys,
                     List<REBDevice> rebDevices,
                     GlobalProc globalProc,
                     org.lsst.ccs.utilities.ccd.Geometry geometry,
                     TempControl tempCtrl)

Public constructor for the Raft level commands object.

Parameters:

subsys - The associated subsystem

rebDevices - The list of REBDevices for this raft.

globalProc - The global proc for the raft

geometry - The geometry for this raft

tempCtrl - The temperature controller

Method Detail

setCcdType

@Command(type=ACTION,
         description="Set the CCD type")
public void setCcdType(@Argument(name="type",description="The CCD type")
                                                                                      String type)

Sets the CCD type

Parameters:

type - The CCD type

changeCcdType

public void changeCcdType(String type)

setControlTemp

@Command(type=ACTION,
         description="Set the control temperature")
public void setControlTemp(@Argument(name="temp",description="Temperature value")
                                                                                                     double temp)

Sets the control temperature

Parameters:

temp - The temperature to set

getControlTemp

@Command(type=QUERY,
         description="Get the control temperature")
public double getControlTemp()

Gets the control temperature

Returns:

The set temperature

startTempControl

@Command(type=ACTION,
         description="Start temperature control")
public void startTempControl()

Starts temperature control

stopTempControl

@Command(type=ACTION,
         description="Stop temperature control")
public void stopTempControl()

Stops temperature control

isTempControlActive

@Command(type=QUERY,
         description="Get temperature control state")
public boolean isTempControlActive()

Gets the temperature control state

Returns:

Whether temperature control is active

getCcdType

@Command(type=QUERY,
         description="Get the CCD type")
public String getCcdType()

Gets the CCD type

Returns:

The CCD type

getREBDeviceNames

@Command(type=QUERY,
         description="Get the list of REB devices")
public List<String> getREBDeviceNames()

Gets the list of REB device names.

Returns:

The list of REB device names

getREBDevices

@Deprecated
 @Command(type=QUERY,
         description="Get the list of REB devices")
public List<String> getREBDevices()

Deprecated.

Gets the list of REB device names.

Returns:

The list of REB device names

getREBHwVersions

@Command(type=QUERY,
         description="Get the list of REB hardware versions")
public List<Integer> getREBHwVersions()

Gets the list of REB hardware versions.

Returns:

The list of REB hardware versions

getREBIds

@Command(type=QUERY,
         description="Get the list of REB IDs")
public List<Integer> getREBIds()

Gets the list of REB IDs.

Returns:

The list of REB IDs

getREBSerialNumbers

@Command(type=QUERY,
         description="Get the list of REB serial numbers")
public List<Long> getREBSerialNumbers()

Gets the list of REB serial numbers.

Returns:

The list of REB serial numbers

resetFirmware

@Command(type=ACTION,
         description="Reset the front end")
public void resetFirmware()
                                                                                     throws Exception

Resets the front ends.

Throws:

Exception

getDataSource

@Command(type=QUERY,
         description="Get the data source")
public List<Integer> getDataSource()
                                                                                             throws Exception

Gets the data sources from all REBs.

Returns:

A list of the encoded data sources (CCD or simulation) for each REB

Throws:

Exception

setDataSource

@Command(type=ACTION,
         description="Set the data sources")
public void setDataSource(@Argument(name="value",description="The data source value")
                                                                                             int value)
                                                                                      throws Exception

Sets the data sources in all REBs.

Parameters:

value - The encoded data source: CCD or simulation

Throws:

Exception

isScanEnabled

@Command(type=QUERY,
         description="Get the scan mode enabled states")
public List<Boolean> isScanEnabled()
                                                                                                          throws Exception

Gets the scan mode enabled states.

Returns:

A list of the scan mode states for each REB

Throws:

Exception

enableScan

@Command(type=ACTION,
         description="Set the scan mode enables")
public void enableScan(@Argument(name="value",description="The scan mode enabled state")
                                                                                               boolean value)
                                                                                        throws Exception

Sets the scan mode enables.

Parameters:

value - The enabled state to set, true or false

Throws:

Exception

resetScan

@Command(type=ACTION,
         description="Reset the scan modes")
public void resetScan()
                                                                                  throws Exception

Resets the scan modes.

Throws:

Exception

loadDacs

@Command(type=ACTION,
         description="Load DACs")
public int loadDacs(@Argument(name="all",description="If true, load all DACs")
                                                                            boolean all)
                                                                     throws Exception

Loads DACs with their configured values.

Parameters:

all - If true, all data are loaded; otherwise only changes

Returns:

The number of DACs loaded

Throws:

Exception

clearDacs

@Command(type=ACTION,
         description="Clear DACs")
public void clearDacs()
                                                                        throws Exception

Clears DAC values.

Throws:

Exception

loadBiasDacs

@Command(type=ACTION,
         description="Load bias DACs")
public int loadBiasDacs(@Argument(name="all",description="If true, load all bias DACs")
                                                                                     boolean all)
                                                                              throws Exception

Loads bias DACs with their configured values.

Parameters:

all - If true, all data are loaded; otherwise only changes

Returns:

The number of DACs loaded

Throws:

Exception

clearBiasDacs

@Command(type=ACTION,
         description="Clear bias DACs")
public void clearBiasDacs()
                                                                                 throws Exception

Clears bias DAC values.

Throws:

Exception

loadAspics

@Command(type=ACTION,
         description="Load ASPICs")
public int loadAspics(@Argument(name="all",description="If true, load all ASPICs")
                                                                                boolean all)
                                                                         throws Exception

Loads ASPICs with their configured values.

Parameters:

all - If true, all data are loaded; otherwise only changes

Returns:

The number of ASPICs loaded

Throws:

Exception

checkAspics

@Command(type=QUERY,
         description="Check all ASPICs")
public List<Integer> checkAspics()
                                                                                        throws Exception

Checks all loaded ASPIC values against the configuration.

Returns:

A list of mismatch masks, one per REB

Throws:

Exception

resetAspics

@Command(type=ACTION,
         description="Reset ASPICs")
public int resetAspics()
                                                                           throws Exception

Resets ASPICs.

Returns:

The number of ASPICs loaded

Throws:

Exception

loadCabacs

@Command(type=ACTION,
         description="Load all CABACs")
public int loadCabacs()
                                                                             throws Exception

Loads all CABACs with their configured values.

Returns:

The number of CABACs loaded

Throws:

Exception

checkCabacs

@Command(type=QUERY,
         description="Check all CABACs")
public List<Integer> checkCabacs()
                                                                                        throws Exception

Checks all loaded CABAC values against the configuration.

Returns:

A list of mismatch masks, one per configured CABAC

Throws:

Exception

setTime

@Command(type=ACTION,
         description="Set the REBs\' system time")
public void setTime()
                                                                                      throws Exception

Sets the time base to the current system time.

Throws:

Exception

getTimes

@Command(type=QUERY,
         description="Get the REBs\' system times")
public Map<String,Long> getTimes()
                                                                                                   throws Exception

Gets all time base values.

Returns:

The map of REB name vs. time value

Throws:

Exception

getTime

@Command(type=QUERY,
         description="Get the REBs\' system times")
public List getTime()
                                                                                      throws Exception

Gets all time base values.

Returns:

The list of (REB name, time values) pairs

Throws:

Exception

isBackBiasOn

@Command(type=QUERY,
         description="Get the back bias on states")
public List<Boolean> isBackBiasOn()
                                                                                                    throws Exception

Gets the back bias on states.

Returns:

A list of the back bias on states for each REB

Throws:

Exception

setBackBias

@Command(type=ACTION,
         description="Set the back bias on states")
public void setBackBias(@Argument(name="value",description="The back bias on state")
                                                                                                  boolean value)
                                                                                           throws Exception

Sets the back bias on states.

Parameters:

value - The on state to set, true or false

Throws:

Exception

loadSequencer

@Command(type=ACTION,
         description="Load all sequencers from a file")
public List<Integer> loadSequencer(@Argument(name="filename",description="Sequencer file name")
                                                                                                                 String fileName)
                                                                                                          throws Exception,
                                                                                                                 IOException

Loads all sequencers from a file.

Parameters:

fileName - The name of the file containing sequencer instructions

Returns:

A list of the number of slices expected to be read from each REB

Throws:

Exception

IOException

getSequencerMainMap

@Command(type=QUERY,
         description="Get the maps of mains")
public List<Map<String,Integer>> getSequencerMainMap()

Gets the list of all main program maps.

Returns:

The list of name-to-address maps of main programs

getMainMap

@Deprecated
 @Command(type=QUERY,
         description="Get the maps of mains")
public List<Map<String,Integer>> getMainMap()

Deprecated.

getSequencerSubroutineMap

@Command(type=QUERY,
         description="Get the maps of subroutines")
public List<Map<String,Integer>> getSequencerSubroutineMap()

Gets the list of all subroutine maps.

Returns:

The list of name-to-address maps of subroutines

getSubroutineMap

@Deprecated
 @Command(type=QUERY,
         description="Get the maps of subroutines")
public List<Map<String,Integer>> getSubroutineMap()

Deprecated.

getSequencerFunctionMap

@Command(type=QUERY,
         description="Get the maps of sequencer functions")
public List<Map<String,Integer>> getSequencerFunctionMap()

Gets the list of all function maps.

Returns:

The name-to-number map of functions

getFunctionMap

@Deprecated
 @Command(type=QUERY,
         description="Get the maps of functions")
public List<Map<String,Integer>> getFunctionMap()

Deprecated.

getSequencerPointers

@Command(type=QUERY,
         description="Get the maps of sequencer pointers")
public List<Map<String,Integer>> getSequencerPointers()

Gets the list of all pointer information maps.

Returns:

The list of name-to-type-and-address maps of pointers

getPointers

@Deprecated
 @Command(type=QUERY,
         description="Get the maps of pointers")
public List<Map<String,Integer>> getPointers()

Deprecated.

getSequencerParameter

@Command(type=QUERY,
         description="Get sequencer parameter values")
public List<Integer> getSequencerParameter(@Argument(name="name",description="The parameter name")
                                                                                                                       String name)
                                                                                                                throws Exception

Gets the list of all values for a parameter.

Parameters:

name - The parameter name

Returns:

The list of values, one per REB

Throws:

Exception

getParameter

@Deprecated
 @Command(type=QUERY,
         description="Get parameter values")
public List<Integer> getParameter(@Argument(name="name",description="The parameter name")
                                                                                                                 String name)
                                                                                                          throws Exception

Deprecated.

Throws:

Exception

setSequencerParameter

@Command(type=ACTION,
         description="Set a sequencer parameter value")
public void setSequencerParameter(@Argument(name="name",description="The parameter name")
                                                                                                                String name,
                                                                                                                @Argument(name="value",description="The value to set")
                                                                                                                int value)
                                                                                                         throws Exception

Sets a sequencer parameter value in all REBs.

Parameters:

name - The parameter name

value - The value to set

Throws:

Exception

setParameter

@Deprecated
 @Command(type=ACTION,
         description="Set a sequencer parameter value")
public void setParameter(@Argument(name="name",description="The parameter name")
                                                                                                                    String name,
                                                                                                                    @Argument(name="value",description="The value to set")
                                                                                                                    int value)
                                                                                                             throws Exception

Deprecated.

Throws:

Exception

setSequencerStart

@Command(type=ACTION,
         description="Set all sequencer start addresses")
public List<Integer> setSequencerStart(@Argument(name="mainName",description="Main routine name")
                                                                                                                       String mainName)
                                                                                                                throws Exception

Sets the start address for all sequencers.

Parameters:

mainName - The name of the main sequencer program to start at

Returns:

A list of the number of slices expected to be read from each REB by this main

Throws:

Exception

getSequencerStart

public String getSequencerStart()

Get the name of the Main routine that will be invoked when the sequencer starts.

Returns:

The name of the main routine.

setStart

@Deprecated
 @Command(type=ACTION,
         description="Set all sequencer start addresses")
public List<Integer> setStart(@Argument(name="mainName",description="Main routine name")
                                                                                                                           String mainName)
                                                                                                                    throws Exception

Deprecated.

Throws:

Exception

startSequencer

@Command(type=ACTION,
         description="Start the sequencers")
public void startSequencer()
                                                                                       throws Exception

Starts the sequencers.

Throws:

Exception

stopSequencer

@Command(type=ACTION,
         description="Send a sequencer stop command")
public void stopSequencer()
                                                                                               throws Exception

Sends a sequencer stop command.

Throws:

Exception

stepSequencer

@Command(type=ACTION,
         description="Send a sequencer step command")
public void stepSequencer()
                                                                                               throws Exception

Sends a sequencer step command.

Throws:

Exception

isSequencerRunning

@Command(type=QUERY,
         description="Get the running states of the sequencers")
public List<Boolean> isSequencerRunning()
                                                                                                                       throws Exception

Gets the running state of all sequencers.

Returns:

A list of the sequencer running states for each REB

Throws:

Exception

waitSequencerDone

@Command(type=ACTION,
         description="Start the sequencers")
public void waitSequencerDone(@Argument(name="timeout",description="Timeout (ms)")
                                                                                                 int timeout)
                                                                                          throws Exception

Waits for the sequencers to be done.

Parameters:

timeout - The maximum tiime to wait (ms)

Throws:

Exception

acquireImage

@Command(type=ACTION,
         description="Start image acquisition")
public void acquireImage(@Argument(name="imageName",defaultValue="")
                                                                                               String imageName)
                                                                                        throws Exception

Starts image acquisition.

Parameters:

imageName - Optional imageName. If absent subsystem makes up its own imageName,

Throws:

Exception

waitForImage

@Command(type=ACTION,
         description="Wait for images to arrive")
public int waitForImage(int timeout)

Waits for image to arrive

Parameters:

timeout - The timeout period (msec)

Returns:

The number of REB images received

saveImage

@Command(type=ACTION,
         description="Save the current image as raw bytes")
public List<String> saveImage(@Argument(name="dirname",description="The directory to use",defaultValue="")
                                                                                                                String dirName)
                                                                                                         throws RaftException,
                                                                                                                IOException

Saves the current image data as one or more sets of raw bytes.

Parameters:

dirName - The name of the directory where the image file is to be saved.

Returns:

A list containing the names of the saved files

Throws:

RaftException

IOException

saveFitsImage

@Command(type=ACTION,
         description="Save the current image as a FITS file")
public List<String> saveFitsImage(@Argument(name="dirname",description="The directory to use",defaultValue="")
                                                                                                                      String dirName)
                                                                                                               throws IOException,
                                                                                                                      RaftException

Saves the current image data as one or more FITS files.

Parameters:

dirName - The name of the directory where the FITS file is to be saved.

Returns:

A list containing the names of the saved files

Throws:

RaftException

IOException

saveFitsImage

public List<String> saveFitsImage(String dirName,
                                  org.lsst.ccs.utilities.image.FitsHeaderMetadataProvider provider)
                           throws IOException,
                                  RaftException

Throws:

IOException

RaftException

setImageDataInversion

@Command(type=ACTION,
         description="Set whether image data values are inverted")
public void setImageDataInversion(@Argument(name="invert",description="Whether to invert")
                                                                                                                           boolean invert)

Sets whether image data values are inverted

Parameters:

invert - Whether data values are to be inverted

setDefaultImageDirectory

@Command(type=ACTION,
         description="Set the default image directory")
public void setDefaultImageDirectory(@Argument(name="dirname",description="The directory name")
                                                                                                                   String dirName)

Sets the default image directory.

Parameters:

dirName - The directory name

setFitsFileNamePattern

@Command(type=ACTION,
         description="Set the FITS file name pattern")
public void setFitsFileNamePattern(@Argument(name="pattern",description="The file name pattern")
                                                                                                                String pattern)

Sets the FITS image file name pattern.

Parameters:

pattern - The file name pattern to set

setImageDataFileNamePattern

@Command(type=ACTION,
         description="Set the raw image data file name pattern")
public void setImageDataFileNamePattern(@Argument(name="pattern",description="The file name pattern")
                                                                                                                               String pattern)

Sets the raw image data file name pattern.

Parameters:

pattern - The file name pattern to set

setExposureTime

@Command(type=ACTION,
         description="Set the FITS exposure time")
public void setExposureTime(@Argument(name="exptime",description="The exposure time")
                                                                                                     double expTime)

Sets the FITS image exposure time.

Parameters:

expTime - The exposure time (secs)

setPatternProperty

@Command(type=ACTION,
         description="Set a pattern property for resolving file names and output directory")
public void setPatternProperty(String propertyName,
                                                                                                                                                  String propertyValue)

Set a pattern property for resolving file name and output directory.

Parameters:

propertyName - The name of the property

propertyValue - The value of the property

checkSequencerState

public void checkSequencerState()

We check the sequencer state. If any sequencer is running the state is RUNNING. If any sequencer throws an exception when checked we go into ERROR. Otherwise we are in IDLE state. TO-DO: should we go in ENGINEERING_FAULT if we are in ERROR?

setSequenceNumber

public void setSequenceNumber(int sequenceNumber)

Set an external sequence number.

Parameters:

sequenceNumber - the external sequence number.

generateAlert

@Command(simulation=true)
public void generateAlert(@Argument(name="raftAlert")
                                                    RaftAlert raftAlert,
                                                    @Argument(name="alertState")
                                                    org.lsst.ccs.bus.states.AlertState state)