REBDevice (LSST CCS - Rafts Subsystem 1.4.0 API)

java.lang.Object
- org.lsst.ccs.framework.ConfigurableComponent
- - org.lsst.ccs.subsystem.monitor.Device
  - - org.lsst.ccs.subsystem.rafts.REBDevice

All Implemented Interfaces:

org.lsst.ccs.framework.Configurable

Direct Known Subclasses:

REBSimDevice
```
public class REBDevice
extends org.lsst.ccs.subsystem.monitor.Device
```
Implements access to a REB device.

Author:

Owen Saxton

Nested Class Summary
- Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable
  org.lsst.ccs.framework.Configurable.Environment

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`CCD_MASK` Constants.
`protected int`	`ccdMask`
`protected org.lsst.ccs.drivers.reb.Image`	`currImage`
`protected int`	`hdwType`
`protected String`	`hdwTypeS`
`protected int`	`id`
`protected static String`	`ID` Constants.
`protected static String`	`IFC_NAME` Constants.
`protected String`	`ifcName`
`protected long`	`imageTime`
`protected int`	`maxCcdMask`
`protected int`	`numCcds`

Fields inherited from class org.lsst.ccs.subsystem.monitor.Device
chanMask, ctlChans, disabled, fullName, inited, lineMask, lineState, lineWarm, log, mon, online

Fields inherited from class org.lsst.ccs.framework.ConfigurableComponent
environment

Constructor Summary

Constructors
Constructor and Description
`REBDevice(int id, String ifcName, int ccdMask)` Constructor.
`REBDevice(String hdwType, int id, String ifcName, int ccdMask)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addConfigValues(Map<String,Object> values)` Adds to the map of configured values.
`int`	`checkAspics()` Checks loaded ASPIC configuration data.
`List<Integer>`	`checkCabacs()` Checks loaded CABAC configuration data.
`protected int[]`	`checkChannel(String name, int hwChan, String type, String subtype)` Checks a channel's parameters for validity.
`protected void`	`close()` Closes the connection.
`protected void`	`configure(org.lsst.ccs.subsystem.monitor.Monitor mon)` Performs configuration.
`void`	`enableScan(boolean value)` Enables or disables scan mode.
`int`	`getCabacPower()` Gets the CABAC power enable bits.
`int`	`getCcdMask()` Gets the mask of CCDs being used.
`int`	`getDataSource()` Gets the data source.
`int`	`getId()` Gets the REB ID.
`String`	`getIfcName()` Gets the network interface name.
`ImageData`	`getImage(int offset, int count)` Gets a portion of the current image.
`org.lsst.ccs.drivers.reb.ImageMetadata`	`getImageMetadata()` Gets the DAQ metadata for the current image.
`REB`	`getREBConfig()` Gets the REB configuration data.
`StatusData`	`getRebStatus()` Gets the REB status block.
`RegisterData`	`getRegister(int address, int count)` Gets the contents of REB registers.
`long`	`getTime()` Gets the time base as Unix time.
`long`	`getTime(String rSet)`
`protected void`	`initChannel(String name, int id, int hwChan, int type, int subtype)` Initializes a channel (in this case only checks HW channel number).
`protected void`	`initialize()` Performs basic initialization.
`boolean`	`isBackBiasOn()` Gets the back bias on state.
`boolean`	`isScanEnabled()` Gets the scan mode enabled state.
`int`	`loadAspics(boolean all)` Loads configuration data to the ASPICs.
`int`	`loadBiasDacs(boolean all)` Loads configured bias DAC values.
`int`	`loadCabacs()` Loads configuration data to the CABACs in a safe way.
`int`	`loadDacs(boolean all)` Loads configured DAC values.
`int`	`loadSequencer(String fileName)` Loads the sequencer from a file.
`protected double`	`readChannel(int hwChan, int type)` Reads a channel.
`protected void`	`readChannelGroup()` Reads grouped channels.
`void`	`resetFrontEnd()` Resets the front end.
`void`	`resetScan()` Resets scan mode.
`List<String>`	`saveFitsImage(String dName)` Saves the current image data as one or more FITS files.
`String`	`saveImage(String dName)` Saves the current image as raw bytes.
`void`	`sendStep()` Sends a sequencer step command.
`void`	`sendStop()` Sends a sequencer stop command.
`void`	`setBackBias(boolean value)` Turns back bias on or off.
`void`	`setCabacPower(int enables)` Sets the CABAC power enable bits.
`void`	`setCcdMask(int ccdMask)` Sets the mask of CCDs being used.
`protected void`	`setConstFitsMetadata(long serial)` Sets constant FITS metadata.
`void`	`setDataSource(int value)` Sets the data source.
`void`	`setFitsConditions(String filter, double temperature, double wavelength)` Sets the FITS file test conditions.
`void`	`setFitsParameters(String testType, String imageType, String[] ccdManufacturer, String[] ccdModel, String[] ccdSerialMfct, String[] ccdSerialLsst)` Sets the FITS file test parameters.
`void`	`setId(int id)` Sets the REB ID.
`void`	`setIfcName(String ifcName)` Sets the network interface name.
`void`	`setREBConfig(REB reb)` Sets the REB configuration data.
`void`	`setRegister(int address, int[] values)` Sets the contents of REB registers.
`void`	`setTime()` Sets the time base to the current system time.
`ByteBuffer[]`	`splitImage()` Splits the current image into its segments.
`void`	`startSequencer()` Starts the sequencer.

Methods inherited from class org.lsst.ccs.subsystem.monitor.Device
addChannel, addLine, checkHwLine, checkLine, checkOnline, checkTimeout, disable, dropChannel, enable, getConfigValues, getFullName, getOutputLines, initChannel, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readSensors, setHwLine, setLine, setLineWarm, setOnline, setOutputLines, testOnline

Methods inherited from class org.lsst.ccs.framework.ConfigurableComponent
getChildren, getEnvironment, setEnvironment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.lsst.ccs.framework.Configurable
change, getCheckedValueFromConfiguration, getComponentByName, getFullPath, getName, getParent, getParentObject, getSubsystem, init, injectResources, listChildren, notifyChange, notifyChangeWithoutPreliminaryChecks, postStart, setBulkParameter, shutdownNow, start, submitChange, submitChanges, validateBulkChange

Field Detail

ID
```
protected static final String ID
```
Constants.

See Also:

Constant Field Values

IFC_NAME
```
protected static final String IFC_NAME
```
Constants.

See Also:

Constant Field Values

CCD_MASK
```
protected static final String CCD_MASK
```
Constants.

See Also:

Constant Field Values

hdwType
```
protected int hdwType
```

id
```
protected int id
```

ccdMask
```
protected int ccdMask
```

maxCcdMask
```
protected int maxCcdMask
```

numCcds
```
protected int numCcds
```

hdwTypeS
```
protected String hdwTypeS
```

ifcName
```
protected String ifcName
```

currImage

protected org.lsst.ccs.drivers.reb.Image currImage

imageTime
```
protected long imageTime
```

Constructor Detail
- REBDevice
```
public REBDevice(int id,
                 String ifcName,
                 int ccdMask)
```
  Constructor.
  
  Parameters:
  
  id - The REB ID
  
  ifcName - The name of the network interface to use
  
  ccdMask - The mask of active CCDs
- REBDevice
```
public REBDevice(String hdwType,
                 int id,
                 String ifcName,
                 int ccdMask)
```
  Constructor.
  
  Parameters:
  
  hdwType - The hardware type (DAQ0, DAQ1 or PCI)
  
  id - The REB ID
  
  ifcName - The name of the network interface to use
  
  ccdMask - The mask of active CCDs

Method Detail

setId
```
@ConfigChanger
public void setId(int id)
```
Sets the REB ID.

Parameters:

id - The REB ID

getId

@Command(type=QUERY,
         description="Gets the REB ID")
public int getId()

Gets the REB ID.

Returns:: The REB ID

setIfcName
```
@ConfigChanger
public void setIfcName(String ifcName)
```
Sets the network interface name.

Parameters:

ifcName - The name of the network interface to use

getIfcName

@Command(type=QUERY,
         description="Gets the network interface name")
public String getIfcName()

Gets the network interface name.

Returns:: The name of the network interface being used

setCcdMask
```
@ConfigChanger
public void setCcdMask(int ccdMask)
```
Sets the mask of CCDs being used.

Parameters:

ccdMask - The mask of active CCDs

getCcdMask

@Command(type=QUERY,
         description="Gets the mask of CCDs being used")
public int getCcdMask()

Gets the mask of CCDs being used.

Returns:: The mask of active CCDs

configure
```
protected void configure(org.lsst.ccs.subsystem.monitor.Monitor mon)
```
Performs configuration.

Overrides:

configure in class org.lsst.ccs.subsystem.monitor.Device

Parameters:

mon - The monitor object

initialize
```
protected void initialize()
```
Performs basic initialization.

Specified by:

initialize in class org.lsst.ccs.subsystem.monitor.Device

close
```
protected void close()
```
Closes the connection.

Specified by:

close in class org.lsst.ccs.subsystem.monitor.Device

checkChannel
```
protected int[] checkChannel(String name,
                             int hwChan,
                             String type,
                             String subtype)
                      throws Exception
```
Checks a channel's parameters for validity.

Overrides:

checkChannel in class org.lsst.ccs.subsystem.monitor.Device

Parameters:

name - The channel name

hwChan - The hardware channel

type - The channel type string

subtype - The channel subtype string

Returns:

Two-element array containing the encoded type [0] and subtype [1]

Throws:

Exception - If parameters are invalid

initChannel
```
protected void initChannel(String name,
                           int id,
                           int hwChan,
                           int type,
                           int subtype)
```
Initializes a channel (in this case only checks HW channel number).

Overrides:

initChannel in class org.lsst.ccs.subsystem.monitor.Device

Parameters:

name - The channel name

id - The channel ID

hwChan - The hardware channel

type - The channel type string

subtype - The channel subtype string

readChannelGroup
```
protected void readChannelGroup()
```
Reads grouped channels.

Overrides:

readChannelGroup in class org.lsst.ccs.subsystem.monitor.Device

readChannel
```
protected double readChannel(int hwChan,
                             int type)
```
Reads a channel.

Overrides:

readChannel in class org.lsst.ccs.subsystem.monitor.Device

Parameters:

hwChan - The hardware channel number

type - The encoded channel type

Returns:

The read value

setREBConfig

@Command(type=ACTION,
         description="Sets the REB configuration data")
public void setREBConfig(@Argument(name="reb",description="REB configuration data")
                                                                                                       REB reb)
                                                                                                throws Exception

Sets the REB configuration data.

Parameters:: reb - The REB configuration (object)
Throws:: Exception

getREBConfig

@Command(type=QUERY,
         description="Gets the REB configuration data")
public REB getREBConfig()
                                                                                              throws RaftException

Gets the REB configuration data.

Returns:: The REB configuration (object)
Throws:: RaftException

addConfigValues
```
protected void addConfigValues(Map<String,Object> values)
```
Adds to the map of configured values.

Overrides:

addConfigValues in class org.lsst.ccs.subsystem.monitor.Device

Parameters:

values - Map to be added to

loadDacs

@Command(type=ACTION,
         description="Loads configured DAC values")
public int loadDacs(boolean all)
                                                                                       throws Exception

Loads configured DAC values.

Parameters:: all - If true, all data are loaded; otherwise only changes
Returns:: The number of DACs loaded
Throws:: Exception

loadBiasDacs

@Command(type=ACTION,
         description="Loads configured bias DAC values")
public int loadBiasDacs(boolean all)
                                                                                                throws Exception

Loads configured bias DAC values.

Parameters:: all - If true, all data are loaded; otherwise only changes
Returns:: The number of bias DACs loaded
Throws:: Exception

loadCabacs

@Command(type=ACTION,
         description=" Loads configuration data to the CABACs")
public int loadCabacs()
                                                                                                     throws Exception

Loads configuration data to the CABACs in a safe way.

Returns:: The number of CABACs loaded
Throws:: Exception

checkCabacs

@Command(type=QUERY,
         description="Checks loaded CABAC configuration data")
public List<Integer> checkCabacs()
                                                                                                              throws Exception

Checks loaded CABAC configuration data.

Returns:: A list containing, for each configured CABAC, a mask showing which fields don't match
Throws:: Exception

setCabacPower

@Command(type=ACTION,
         description="Sets the CABAC power enable bits")
public void setCabacPower(@Argument(description="Enable bits")
                                                                                                         int enables)
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Sets the CABAC power enable bits.

Parameters:: enables - The enable bits
Throws:: org.lsst.ccs.drivers.commons.DriverException

getCabacPower

@Command(type=QUERY,
         description="Gets the CABAC power enable bits")
public int getCabacPower()

Gets the CABAC power enable bits.

Returns:: The enable bits

loadAspics

@Command(type=ACTION,
         description=" Load configuration data to the ASPICs")
public int loadAspics(boolean all)
                                                                                                    throws Exception

Loads configuration data to the ASPICs.

Parameters:: all - If true, all data are loaded; otherwise only changes
Returns:: The number of ASPICs loaded
Throws:: Exception

checkAspics

@Command(type=ACTION,
         description=" Load configuration data to the ASPICs")
public int checkAspics()
                                                                                                     throws Exception

Checks loaded ASPIC configuration data.

Returns:: The mask of mismatched fields
Throws:: Exception

isBackBiasOn

@Command(type=QUERY,
         description="Get the back bias on state")
public boolean isBackBiasOn()
                                                                                             throws Exception

Gets the back bias on state.

Returns:: Whether back bias is turned on
Throws:: Exception

setBackBias

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

Turns back bias on or off.

Parameters:: value - The back bias on state to set (true or false)
Throws:: Exception

setTime

@Command(type=ACTION,
         description="Sets the time base to the current system time")
public void setTime()
                                                                                                         throws Exception

Sets the time base to the current system time.

Throws:: Exception

getTime

@Command(type=QUERY,
         description="Gets the time base as Unix time")
public long getTime()
                                                                                          throws Exception

Gets the time base as Unix time.

Returns:: The time base converted to Unix time
Throws:: Exception

getTime

@Command(type=QUERY,
         description="Gets a trigger time as Unix time")
public long getTime(@Argument(name="regset",description="Register set name")
                                                                                                  String rSet)
                                                                                           throws Exception

Throws:: Exception

setFitsParameters

@Command(type=ACTION,
         description="Sets the FITS file test parameters")
public void setFitsParameters(String testType,
                                                                                                               String imageType,
                                                                                                               String[] ccdManufacturer,
                                                                                                               String[] ccdModel,
                                                                                                               String[] ccdSerialMfct,
                                                                                                               String[] ccdSerialLsst)

Sets the FITS file test parameters.

Parameters:: testType - The test type; imageType - The image type; ccdManufacturer - Array of CCD manufacturer names; ccdModel - Array of CCD model names; ccdSerialMfct - Array of manufacturer's CCD serial numbers; ccdSerialLsst - Array of LSST CCD serial numbers

setFitsConditions

@Command(type=ACTION,
         description="Sets the FITS file test conditions")
public void setFitsConditions(String filter,
                                                                                                               double temperature,
                                                                                                               double wavelength)

Sets the FITS file test conditions.

Parameters:: filter - The filter name; temperature - The temperature set point; wavelength - The monochromator wavelength

loadSequencer

@Command(type=ACTION,
         description="Loads the sequencer from a file")
public int loadSequencer(@Argument(name="filename",description="Sequencer file name")
                                                                                                       String fileName)
                                                                                                throws Exception

Loads the sequencer from a file. The file format may be XML, LPNHE assembler, or simple instructions (SIF)

Parameters:: fileName - The name of the file containing sequencer instructions
Returns:: The number of slices expected to be read
Throws:: Exception; IOException

getDataSource

@Command(type=QUERY,
         description="Gets the data source")
public int getDataSource()
                                                                                    throws Exception

Gets the data source.

Returns:: The encoded data source: CCD or pattern
Throws:: Exception

setDataSource

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

Sets the data source.

Parameters:: value - The encoded data source: CCD or pattern
Throws:: Exception

isScanEnabled

@Command(type=QUERY,
         description="Gets the scan mode enabled state")
public boolean isScanEnabled()
                                                                                                    throws Exception

Gets the scan mode enabled state.

Returns:: Whether scan mode is enabled
Throws:: Exception

enableScan

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

Enables or disables scan mode.

Parameters:: value - The scan mode enabled state to set (true or false)
Throws:: Exception

resetScan

@Command(type=ACTION,
         description="Resets scan mode")
public void resetScan()
                                                                              throws Exception

Resets scan mode.

Throws:: Exception

startSequencer

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

Starts the sequencer.

Throws:: Exception

sendStop

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

Sends a sequencer stop command.

Throws:: Exception

sendStep

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

Sends a sequencer step command.

Throws:: Exception

resetFrontEnd

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

Resets the front end. This is the only way to stop a running sequencer program

Throws:: Exception

saveImage

@Command(type=ACTION,
         description="Saves the current image as raw bytes")
public String saveImage(@Argument(name="dirname",description="The directory to use")
                                                                                                           String dName)
                                                                                                    throws RaftException,
                                                                                                           IOException

Saves the current image as raw bytes. The name of the file is "Image_[reb]_[tag].dat", where [tag] is the 16-digit hexadecimal representation of the image tag, and [reb] is the name of the REB that produced the image.

Parameters:: dName - The name of the directory where the image file is to saved.
Returns:: The name of the saved file
Throws:: RaftException; IOException

saveFitsImage

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

Saves the current image data as one or more FITS files. Each active CCD on the REB produces a separate file. The name of each file is "Image_[reb]_[ccd]_[tag].fits", where [tag] is the 16-digit hexadecimal representation of the image tag, [reb] is the name of the REB, and [ccd] is the CCD number.

Parameters:: dName - 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

getImageMetadata

@Command(type=QUERY,
         description="Get the DAQ metadata for the current image")
public org.lsst.ccs.drivers.reb.ImageMetadata getImageMetadata()
                                                                                                                                                throws RaftException

Gets the DAQ metadata for the current image.

Returns:: The image metadata
Throws:: RaftException

getImage

@Command(type=QUERY,
         description="Gets a portion of the current image")
public ImageData getImage(@Argument(name="offset",description="Offset to the pixel data")
                                                                                                           int offset,
                                                                                                           @Argument(name="count",description="Number of pixels")
                                                                                                           int count)
                                                                                                    throws RaftException

Gets a portion of the current image.

Parameters:: offset - The offset (in pixels) to the first pixel data to obtain.; count - The number of data pixels to obtain. If zero, all the data, starting at offset, is obtained.
Returns:: The returned pixel data
Throws:: RaftException

getRegister

@Command(type=QUERY,
         description="Gets the contents of REB registers")
public RegisterData getRegister(@Argument(name="address",description="Address of the first register")
                                                                                                                int address,
                                                                                                                @Argument(name="count",description="Number of registers to read")
                                                                                                                int count)
                                                                                                         throws Exception

Gets the contents of REB registers.

Parameters:: address - The address of the first register to read; count - The number of registers to read
Returns:: The block of register values
Throws:: Exception

setRegister

@Command(type=ACTION,
         description="Sets the contents of REB registers")
public void setRegister(@Argument(name="address",description="Address of the first register")
                                                                                                         int address,
                                                                                                         @Argument(name="values",description="Values to write")
                                                                                                         int[] values)
                                                                                                  throws Exception

Sets the contents of REB registers.

Parameters:: address - The address of the first register to write; values - The array of values to write to consecutive registers
Throws:: Exception

getRebStatus

@Command(type=QUERY,
         description="Gets the REB status block")
public StatusData getRebStatus()
                                                                                               throws Exception

Gets the REB status block.

Returns:: The REB status block
Throws:: Exception

splitImage
```
public ByteBuffer[] splitImage()
                        throws RaftException
```
Splits the current image into its segments. Each active CCD on the REB produces 16 segments.

Returns:

The array of image segment buffers

Throws:

RaftException

setConstFitsMetadata
```
protected void setConstFitsMetadata(long serial)
```
Sets constant FITS metadata.

Parameters:

serial - The REB serial number

Class REBDevice

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable

Field Summary

Fields inherited from class org.lsst.ccs.subsystem.monitor.Device

Fields inherited from class org.lsst.ccs.framework.ConfigurableComponent

Constructor Summary

Method Summary

Methods inherited from class org.lsst.ccs.subsystem.monitor.Device

Methods inherited from class org.lsst.ccs.framework.ConfigurableComponent

Methods inherited from class java.lang.Object

Methods inherited from interface org.lsst.ccs.framework.Configurable

Field Detail

ID

IFC_NAME

CCD_MASK

hdwType

id

ccdMask

maxCcdMask

numCcds

hdwTypeS

ifcName

currImage

imageTime

Constructor Detail

REBDevice

REBDevice

Method Detail

setId

getId

setIfcName

getIfcName

setCcdMask

getCcdMask

configure

initialize

close

checkChannel

initChannel

readChannelGroup

readChannel

setREBConfig

getREBConfig

addConfigValues

loadDacs

loadBiasDacs

loadCabacs

checkCabacs

setCabacPower

getCabacPower

loadAspics

checkAspics

isBackBiasOn

setBackBias

setTime

getTime

getTime

setFitsParameters

setFitsConditions

loadSequencer

getDataSource

setDataSource

isScanEnabled

enableScan

resetScan

startSequencer

sendStop

sendStep

resetFrontEnd

saveImage

saveFitsImage

getImageMetadata

getImage

getRegister

setRegister

getRebStatus

splitImage

setConstFitsMetadata