org.lsst.ccs.subsystem.ts8

Class TS8Subsystem

java.lang.Object

org.lsst.ccs.subsystem.ts8.TS8Subsystem

All Implemented Interfaces:

org.lsst.ccs.framework.AlertHandler, org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.monitor.Monitor.AlarmHandler

public class TS8Subsystem
extends Object
implements org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.monitor.Monitor.AlarmHandler

The TS8Subsystem is designed specifically for running test stand 8 at BNL, and the equivalent test stand at SLAC for I&T. It makes use of the Rafts subsystem, which contains the code common to all use of the DAQ system both for test stands and (eventually) for the construction of the full focal plane during I&T and eventually the operation of the camera. TOOD: Review whether the split between code which is in the TS8Subsystem and the rafts subsystem is consistent with the division described above.

Nested Class Summary

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

org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode

Field Summary

Fields

Modifier and Type	Field and Description
protected String	fileNamePattern
protected String	outputDirectory

Fields inherited from interface org.lsst.ccs.monitor.Monitor.AlarmHandler

alarms

Constructor Summary

Constructors

Constructor and Description
TS8Subsystem(org.lsst.ccs.utilities.ccd.Geometry geometry, org.lsst.ccs.drivers.reb.ClientFactory clientFactory) Main constructor for the TS8Subsystem, normally invoked from the corresponding groovy file.

Method Summary

Modifier and Type	Method and Description
void	addBinaryTable(String pddatfile, String fitsfile, String extnam, String c1name, String c2name, double tstart)
void	build()
String	checkCurrents(int rebnum)
String	checkCurrents(int rebnum, boolean checkCCDI)
String	checkCurrentsAndTemperatures()
String	checkCurrentsAndTemperatures(int rebnum)
String	checkCurrentsAndTemperatures(int rebnum, boolean checkCCDI)
boolean	checkREBState(int rebnum) check the power state of a REB
String	checkTemperatures(int rebnum)
double	chooseTestVolt(double proposedVoltage, double full_target) Choose the test voltage to use based on the target voltage
protected void	clearNonStickyHeaderKeywordValues()
String	clearREBCfg(int rebnum) Clear REB config
List<String>	exposeAcquireAndSave() Start an acquisition and save the resulting images for the given parameters.
List<String>	exposeAcquireAndSave(long exposureTimeInMillis) Start an acquisition and save the resulting images for the given parameters.
List<String>	exposeAcquireAndSave(long exposureTimeInMillis, boolean openShutter) Start an acquisition and save the resulting images for the given parameters.
List<String>	exposeAcquireAndSave(long exposureTimeInMillis, boolean openShutter, boolean actuateXED) Start an acquisition and save the resulting images for the given parameters.
List<String>	exposeAcquireAndSave(long exposureTimeInMillis, boolean openShutter, boolean actuateXED, String filePattern) Start an acquisition and save the resulting images for the given parameters.
String	exposeAcquireAndSaveVerbose(long exposureTimeInMillis, boolean openShutter, boolean actuateXED, String filePattern) Start an acquisition and save the resulting images for the given parameters.
double	getFluxStats(String fitsfile)
org.lsst.ccs.subsystem.rafts.data.RaftState	getFullState() Gets the full monitoring state.
List<Integer>	loadSequencerAndReDimension(String seq, int prerows, int readrows, int postrows, int precols, int readcols, int postcols) loadSequence with modified geometry
void	postInit()
void	postStart()
String	powerOff() Safely power off
String	powerOff(int rebnum) Safely power off
String	powerOffNow(int rebnum) power OFF sensors of a REB immediately
String	powerOn() Safely power on the Raft
String	powerOn(int rebnum) Safely power on the Raft
String	printGeometry(int depth)
String	printHeaderSpecifications()
boolean	processAlarm(int event, int parm, String cause, String alarmName)
void	raiseAlert(String alertmsg, org.lsst.ccs.bus.states.AlertState severity)
int	readRegister(String rebId, int address) Read a register address on a Reb.
String	resetREBCfg(org.lsst.ccs.subsystem.rafts.REBDevice rebDevice) Clear REB config
void	setCCDHeader(String ccdId, String headerName, Object headerValue, boolean sticky) Set a key for the Primary header of a given CCD identified by its id.
void	setCCDLocation(int serial, int parallel, String ccdName) Sets the name of the CCD at the given location.
void	setCcdType(String ccdType)
void	setDefaultActuateXED(boolean actuate) Set the exposure default Actuated XED.
void	setDefaultExposureTime(int millis) Set the default exposure time in milliseconds.
void	setDefaultOpenShutter(boolean open) Set the default open shutter flag for an exposure.
void	setHeader(String headerName, Object headerValue, boolean sticky) Set a key for the Primary header of all CCDs.
void	setImageType(String itype)
void	setLsstSerialNumber(String ccdId, String serialNumber)
void	setManufacturerSerialNumber(String ccdId, String serialNumber)
void	setMeasuredCCDBSS(String ccdId, double hvbss)
void	setMeasuredCCDTemperature(String ccdId, double ccdtemp)
void	setMonoWavelength(double wl)
void	setRaftName(String raftName) Set the name of the raft.
void	setRebName(int parallel, String rebName) Set the name of the reb at the given parallel position.
void	setRunNumber(String runNumber) Set the RunNumber.
void	setSeqInfo(Integer seqNum)
void	setSequencerExposureTime(int millis) Set the default exposure time in milliseconds.
void	setTestStand(String tsname)
void	setTestType(String ttype)
String	showAllREBCfg() Get the configuration for all REB devices
void	showPhotoDiodeAnalysis(String pddatfile)
String	showREBCfg(int rebnum)
void	Sleep(double secs) Sleep - what a waste **************************************************************************
void	writeRegister(String rebId, int address, int value) Write a register address on a Reb.

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.HasLifecycle

init, postBuild, postShutdown, shutdown, start

Methods inherited from interface org.lsst.ccs.monitor.Monitor.AlarmHandler

canClearAlert, getAlarmById, setAlarms

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

canClearAlert

Field Detail

outputDirectory

protected final String outputDirectory

See Also:

Constant Field Values

fileNamePattern

protected final String fileNamePattern

See Also:

Constant Field Values

Constructor Detail

TS8Subsystem

public TS8Subsystem(org.lsst.ccs.utilities.ccd.Geometry geometry,
                    org.lsst.ccs.drivers.reb.ClientFactory clientFactory)

Main constructor for the TS8Subsystem, normally invoked from the corresponding groovy file.

Parameters:

geometry - The initial geometry. This is used for ???

clientFactory - The ClientFactoryused to create the interfaces to the DAQ, or null to use the default ClientFactory. See TS8ClientFactorySimulation for an alternative factory which can be used for simulations.

Method Detail

postInit

public void postInit()

Specified by:

postInit in interface org.lsst.ccs.framework.HasLifecycle

build

public void build()

Specified by:

build in interface org.lsst.ccs.framework.HasLifecycle

postStart

public void postStart()

Specified by:

postStart in interface org.lsst.ccs.framework.HasLifecycle

setCcdType

@ConfigurationParameterChanger
public void setCcdType(String ccdType)

processAlarm

public boolean processAlarm(int event,
                            int parm,
                            String cause,
                            String alarmName)

Specified by:

processAlarm in interface org.lsst.ccs.monitor.Monitor.AlarmHandler

printHeaderSpecifications

@Command(description="Print Header specifications",
         type=QUERY)
public String printHeaderSpecifications()

printGeometry

@Command(description="Print Geometry",
         type=QUERY)
public String printGeometry(@Argument(defaultValue="0")
                                                                                        int depth)

setCCDLocation

@Command(description="Set the output directory for fits files",
         type=QUERY)
public void setCCDLocation(int serial,
                                                                                                                int parallel,
                                                                                                                String ccdName)
                                                                                                         throws IllegalArgumentException

Sets the name of the CCD at the given location. This will be called by the script running TS8 using data obtained from the eTraveler, and will enable appropriate headers to be added to the FitsFile generated. //TODO: Perhaps a better name would be setNameOfCCDAtLocation?

Parameters:

serial - The serial position of the CCD

parallel - The parallel position of the CCD

ccdName - The name of the CCD at the given position

Throws:

IllegalArgumentException - if the serial or parallel position are illegal.

setRaftName

@Command(description="Set the name of the raft",
         type=QUERY)
public void setRaftName(String raftName)

Set the name of the raft. This will be called by the script running TS8 using data obtained from the eTraveler, and will enable appropriate headers to be added to the FitsFile generated.

Parameters:

raftName - The name of the raft.

setRebName

@Command(description="Set the name of the reb at a given parallel position",
         type=QUERY)
public void setRebName(int parallel,
                                                                                                                         String rebName)
                                                                                                                  throws IllegalArgumentException

Set the name of the reb at the given parallel position. This will be called by the script running TS8 using data obtained from the eTraveler, and will enable appropriate headers to be added to the FitsFile generated.

Parameters:

parallel - The parallel position of the Reb.

rebName - The new name of the reb

Throws:

IllegalArgumentException - if the parallel position is illegal.

setRunNumber

@Command(description="Set the run number",
         type=QUERY)
public void setRunNumber(String runNumber)

Set the RunNumber.

Parameters:

runNumber - The run Number

checkCurrentsAndTemperatures

@Command(type=ACTION,
         description="checks all currents")
public String checkCurrentsAndTemperatures()

checkTemperatures

@Command(type=ACTION,
         description="checks all currents")
public String checkTemperatures(int rebnum)

checkCurrentsAndTemperatures

@Command(type=ACTION,
         description="checks all currents")
public String checkCurrentsAndTemperatures(int rebnum)

checkCurrentsAndTemperatures

@Command(type=ACTION,
         description="checks all currents")
public String checkCurrentsAndTemperatures(int rebnum,
                                                                                                             boolean checkCCDI)

checkCurrents

@Command(type=ACTION,
         description="checks all currents")
public String checkCurrents(int rebnum)

checkCurrents

@Command(type=ACTION,
         description="checks all currents")
public String checkCurrents(int rebnum,
                                                                                              boolean checkCCDI)

clearREBCfg

@Command(type=ACTION,
         description="clear REB config for a given REB ID")
public String clearREBCfg(int rebnum)
                                                                                                     throws Exception

Clear REB config

Parameters:

rebnum - The number of the REB to have its config cleared

Returns:

A String representing the state of the devices after they are powered off.

Throws:

Exception

resetREBCfg

@Command(type=ACTION,
         description="reset REB config")
public String resetREBCfg(org.lsst.ccs.subsystem.rafts.REBDevice rebDevice)
                                                                                  throws Exception

Clear REB config

Parameters:

rebDevice - The REB device to have its config cleared

Returns:

A String representing the state of the devices after they are powered off.

Throws:

Exception

raiseAlert

@Command(type=QUERY,
         description="raise subsystem alert")
public void raiseAlert(String alertmsg,
                                                                                          org.lsst.ccs.bus.states.AlertState severity)

showAllREBCfg

@Command(type=ACTION,
         description="show REB config for all REBS")
public String showAllREBCfg()

Get the configuration for all REB devices

Returns:

A string representing the configuration of the devices.

showREBCfg

@Command(type=ACTION,
         description="show REB config for a given REB ID")
public String showREBCfg(int rebnum)

chooseTestVolt

public double chooseTestVolt(double proposedVoltage,
                             double full_target)

Choose the test voltage to use based on the target voltage

powerOn

@Command(type=ACTION,
         description="safe power on")
public String powerOn()

Safely power on the Raft

Returns:

A string representing the final state of the system

powerOn

@Command(type=ACTION,
         description="safe power on")
public String powerOn(int rebnum)

Safely power on the Raft

Returns:

A string representing the final state of the system

checkREBState

@Command(type=ACTION,
         description="check state of REB biases")
public boolean checkREBState(int rebnum)

check the power state of a REB

Returns:

a boolean which if true indicate a valid state of the REB biases

powerOff

@Command(type=ACTION,
         description="safe power off")
public String powerOff()

Safely power off

Returns:

A string representing the state at the end of the power off exercise

powerOff

@Command(type=ACTION,
         description="safe power off")
public String powerOff(int rebnum)

Safely power off

Returns:

A string representing the state at the end of the power off exercise

powerOffNow

@Command(type=ACTION,
         description="immediate power off")
public String powerOffNow(int rebnum)

power OFF sensors of a REB immediately

Returns:

A string representing the state at the end of the power off exercise

readRegister

@Command(description="Read a register address",
         type=QUERY)
public int readRegister(String rebId,
                                                                                             int address)

Read a register address on a Reb.

Parameters:

rebId - The rebId: "Reb0", "R11:Reb0"

address - The address of the register to read.

Returns:

The value of the register.

loadSequencerAndReDimension

@Command(description="load sequencer and adjust row and col parameters")
public List<Integer> loadSequencerAndReDimension(@Argument(description="sequencer filename")
                                                                                                                          String seq,
                                                                                                                          @Argument(description="Number of rows to skip before window")
                                                                                                                          int prerows,
                                                                                                                          @Argument(description="Number of rows of the window")
                                                                                                                          int readrows,
                                                                                                                          @Argument(description="Number of rows after window")
                                                                                                                          int postrows,
                                                                                                                          @Argument(description="Number of columns to skip before readout window, including prescan")
                                                                                                                          int precols,
                                                                                                                          @Argument(description="Number of columns to read")
                                                                                                                          int readcols,
                                                                                                                          @Argument(description="Number of columns to discard after window ")
                                                                                                                          int postcols)
                                                                                                                   throws Exception

loadSequence with modified geometry

Parameters:

seq -

prerows -

readrows -

postrows -

precols -

readcols -

postcols -

Returns:

Throws:

Exception

writeRegister

@Command(description="Write a register address",
         type=ACTION)
public void writeRegister(String rebId,
                                                                                                 int address,
                                                                                                 int value)

Write a register address on a Reb.

Parameters:

rebId - The id of the Reb: "Reb0", "R11:Reb0"

address - The address to write to.

value - The value to set the address to.

setHeader

@Command(description="Set a primary header value for all CCDs",
         type=QUERY)
public void setHeader(String headerName,
                                                                                                           Object headerValue,
                                                                                                           @Argument(defaultValue="true")
                                                                                                           boolean sticky)

Set a key for the Primary header of all CCDs.

Parameters:

headerName - The name of the Header to set

headerValue - The corresponding value

sticky - Boolean value to specify if the provided Header keyword value should be used across exposures. The default value is true. If false is provided, the provided Header keyword value will be reset after each exposure.

setCCDHeader

@Command(description="Set a primary header value for a given CCD",
         type=QUERY)
public void setCCDHeader(String ccdId,
                                                                                                                 String headerName,
                                                                                                                 Object headerValue,
                                                                                                                 @Argument(defaultValue="true")
                                                                                                                 boolean sticky)

Set a key for the Primary header of a given CCD identified by its id. The Id could be an enumeration or a string ("S00", "R01:S00").

Parameters:

ccdId - The CCD id

headerName - The name of the Header to set

headerValue - The corresponding value

sticky - Boolean value to specify if the provided Header keyword value should be used across exposures. The default value is true. If false is provided, the provided Header keyword value will be reset after each exposure.

exposeAcquireAndSave

@Command(description="Start an acquisition and save the images to fits.",
         type=ACTION)
public List<String> exposeAcquireAndSave()
                                                                                                                                  throws IOException,
                                                                                                                                         InterruptedException,
                                                                                                                                         org.lsst.ccs.drivers.reb.REBException

Start an acquisition and save the resulting images for the given parameters. This method does not return until all of the files have been written. Events will be published on the buses when files are available (TODO:True?, if so which events).

Returns:

A list of the file written (as Strings)

Throws:

org.lsst.ccs.drivers.reb.REBException - If there is an error interacting with the REBs

IOException - if there is an error while writing the fits files.

InterruptedException - If there is an interrupt waiting for the image acquisition to complete

exposeAcquireAndSave

@Command(description="Start an acquisition and save the images to fits.",
         type=ACTION)
public List<String> exposeAcquireAndSave(long exposureTimeInMillis)
                                                                                                                                  throws IOException,
                                                                                                                                         InterruptedException,
                                                                                                                                         org.lsst.ccs.drivers.reb.REBException

Start an acquisition and save the resulting images for the given parameters. This method does not return until all of the files have been written. Events will be published on the buses when files are available (TODO:True?, if so which events).

Parameters:

exposureTimeInMillis - The exposure time in milliseconds

Returns:

A list of the file written (as Strings)

Throws:

org.lsst.ccs.drivers.reb.REBException - If there is an error interacting with the REBs

IOException - if there is an error while writing the fits files.

InterruptedException - If there is an interrupt waiting for the image acquisition to complete

exposeAcquireAndSave

@Command(description="Start an acquisition and save the images to fits.",
         type=ACTION)
public List<String> exposeAcquireAndSave(long exposureTimeInMillis,
                                                                                                                                         boolean openShutter)
                                                                                                                                  throws IOException,
                                                                                                                                         InterruptedException,
                                                                                                                                         org.lsst.ccs.drivers.reb.REBException

Start an acquisition and save the resulting images for the given parameters. This method does not return until all of the files have been written. Events will be published on the buses when files are available (TODO:True?, if so which events).

Parameters:

exposureTimeInMillis - The exposure time in milliseconds

openShutter - True/false if the shutter should be open

Returns:

A list of the file written (as Strings)

Throws:

org.lsst.ccs.drivers.reb.REBException - If there is an error interacting with the REBs

IOException - if there is an error while writing the fits files.

InterruptedException - If there is an interrupt waiting for the image acquisition to complete

exposeAcquireAndSave

@Command(description="Start an acquisition and save the images to fits.",
         type=ACTION)
public List<String> exposeAcquireAndSave(long exposureTimeInMillis,
                                                                                                                                         boolean openShutter,
                                                                                                                                         boolean actuateXED)
                                                                                                                                  throws IOException,
                                                                                                                                         InterruptedException,
                                                                                                                                         org.lsst.ccs.drivers.reb.REBException

Start an acquisition and save the resulting images for the given parameters. This method does not return until all of the files have been written. Events will be published on the buses when files are available (TODO:True?, if so which events).

Parameters:

exposureTimeInMillis - The exposure time in milliseconds

openShutter - True/false if the shutter should be open

actuateXED - True/false if the FE55 should be involved

Returns:

A list of the file written (as Strings)

Throws:

org.lsst.ccs.drivers.reb.REBException - If there is an error interacting with the REBs

IOException - if there is an error while writing the fits files.

InterruptedException - If there is an interrupt waiting for the image acquisition to complete

exposeAcquireAndSave

@Command(description="Start an acquisition and save the images to fits.",
         type=ACTION)
public List<String> exposeAcquireAndSave(long exposureTimeInMillis,
                                                                                                                                         boolean openShutter,
                                                                                                                                         boolean actuateXED,
                                                                                                                                         String filePattern)
                                                                                                                                  throws org.lsst.ccs.drivers.reb.REBException,
                                                                                                                                         IOException,
                                                                                                                                         InterruptedException

Start an acquisition and save the resulting images for the given parameters. This method does not return until all of the files have been written. Events will be published on the buses when files are available (TODO:True?, if so which events).

Parameters:

exposureTimeInMillis - The exposure time in milliseconds

openShutter - True/false if the shutter should be open

actuateXED - True/false if the FE55 should be involved

filePattern - The filePattern for the output fits files

Returns:

A list of the file written (as Strings)

Throws:

org.lsst.ccs.drivers.reb.REBException - If there is an error interacting with the REBs

IOException - if there is an error while writing the fits files.

InterruptedException - If there is an interrupt waiting for the image acquisition to complete

exposeAcquireAndSaveVerbose

@Command(description="Start an acquisition and save the images to fits.",
         type=ACTION)
public String exposeAcquireAndSaveVerbose(long exposureTimeInMillis,
                                                                                                                                          boolean openShutter,
                                                                                                                                          boolean actuateXED,
                                                                                                                                          String filePattern)
                                                                                                                                   throws IOException,
                                                                                                                                          InterruptedException,
                                                                                                                                          org.lsst.ccs.drivers.reb.REBException

Start an acquisition and save the resulting images for the given parameters. This method does not return until all of the files have been written. Events will be published on the buses when files are available (TODO:True?, if so which events).

Parameters:

exposureTimeInMillis - The exposure time in milliseconds

openShutter - True/false if the shutter should be open

Returns:

A list of the file written (as Strings)

Throws:

org.lsst.ccs.drivers.reb.REBException - If there is an error interacting with the REBs

IOException - if there is an error while writing the fits files.

InterruptedException - If there is an interrupt waiting for the image acquisition to complete

setDefaultExposureTime

@Command(description="Set the default exposure time.",
         type=ACTION)
public void setDefaultExposureTime(int millis)
                                                                                                         throws Exception

Set the default exposure time in milliseconds.

Parameters:

millis - Exposure time in milliseconds.

Throws:

Exception

setSequencerExposureTime

@Command(description="Set the sequencer exposure time.",
         type=ACTION)
public void setSequencerExposureTime(int millis)
                                                                                                             throws Exception

Set the default exposure time in milliseconds.

Parameters:

millis - Exposure time in milliseconds.

Throws:

Exception

setDefaultOpenShutter

@Command(description="Set the exposure default open shutter flag.",
         type=ACTION)
public void setDefaultOpenShutter(boolean open)

Set the default open shutter flag for an exposure.

Parameters:

open - True/False if the shutter should be opened during the exposure.

setDefaultActuateXED

@Command(description="Set the exposure default XED actuation.",
         type=ACTION)
public void setDefaultActuateXED(boolean actuate)

Set the exposure default Actuated XED.

Parameters:

actuate - True/False for XED actuation.

getFullState

@Command(type=QUERY,
         description="Gets the full Raft module state")
public org.lsst.ccs.subsystem.rafts.data.RaftState getFullState()

Gets the full monitoring state. This is intended to be called by GUIs during initialization

Returns:

The full Raft state

clearNonStickyHeaderKeywordValues

protected void clearNonStickyHeaderKeywordValues()

setLsstSerialNumber

@Command(type=QUERY,
         description="Set the LSST assigned CCD Serial Number")
public void setLsstSerialNumber(String ccdId,
                                                                                                                     String serialNumber)

setMeasuredCCDTemperature

@Command(type=QUERY,
         description="Set the Measured CCD Temperature")
public void setMeasuredCCDTemperature(String ccdId,
                                                                                                                    double ccdtemp)

setMeasuredCCDBSS

@Command(type=QUERY,
         description="Set the Measured CCD HVBias")
public void setMeasuredCCDBSS(String ccdId,
                                                                                                       double hvbss)

setMonoWavelength

@Command(type=QUERY,
         description="Set the Monochromator Wavelength")
public void setMonoWavelength(double wl)

setManufacturerSerialNumber

@Command(type=QUERY,
         description="Set the Manufacturer assigned CCD Serial Number")
public void setManufacturerSerialNumber(String ccdId,
                                                                                                                                     String serialNumber)

setTestType

@Command(type=QUERY,
         description="Sets the test type property for the output filename")
public void setTestType(String ttype)

setTestStand

@Command(type=QUERY,
         description="Sets the name of the test stand station")
public void setTestStand(String tsname)

setImageType

@Command(type=QUERY,
         description="Sets the image type property for the output filename")
public void setImageType(String itype)

setSeqInfo

@Command(type=QUERY,
         description="Sets the sequence info property for the output filename")
public void setSeqInfo(Integer seqNum)

showPhotoDiodeAnalysis

@Command
public void showPhotoDiodeAnalysis(String pddatfile)
                                     throws IOException,
                                            nom.tam.fits.FitsException

Throws:

IOException

nom.tam.fits.FitsException

addBinaryTable

@Command
public void addBinaryTable(String pddatfile,
                                    String fitsfile,
                                    String extnam,
                                    String c1name,
                                    String c2name,
                                    double tstart)
                             throws IOException,
                                    nom.tam.fits.FitsException

Throws:

IOException

nom.tam.fits.FitsException

getFluxStats

@Command
public double getFluxStats(String fitsfile)
                             throws nom.tam.fits.FitsException,
                                    IOException

Throws:

nom.tam.fits.FitsException

IOException

Sleep

public void Sleep(double secs)

Sleep - what a waste **************************************************************************