org.lsst.ccs.subsystem.ts8

Class TS8Subsystem

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystem.ts8.TS8Subsystem

All Implemented Interfaces:

Observer, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.SignalHandler

public class TS8Subsystem
extends org.lsst.ccs.framework.Module
implements org.lsst.ccs.framework.HardwareController

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.framework.Module

org.lsst.ccs.framework.Module.ValueUpdate

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 String	fileNamePattern
protected String	outputDirectory

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

environment, name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
TS8Subsystem(String name, int tickMillis, org.lsst.ccs.utilities.ccd.Geometry geometry, org.lsst.ccs.drivers.reb.ClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
void	addBinaryTable(String pddatfile, String fitsfile, String extnam, String c1name, String c2name, double tstart)
String	checkAllCurrents() Check all currents
org.lsst.ccs.framework.TreeWalkerDiag	checkHardware() Initializes the hardware.
void	checkStarted() Checks whether hardware is started.
void	checkStopped() Checks whether hardware is stopped.
protected void	clearNonStickyHeaderKeywordValues()
List<String>	exposeAcquireAndSave() Start an acquisition and save the resulting images.
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.
double	getFluxStats(String fitsfile)
org.lsst.ccs.subsystem.rafts.data.RaftFullState	getFullState() Gets the full monitoring state.
void	initModule()
String	powerOff() Safely power Off REB
String	powerOffREB() Power OFF REB outputs
String	powerOn() Safely power On REB
String	printGeometry(int depth)
String	printHeaderSpecifications()
int	readRegister(String rebId, int address) Read a register address on a Reb.
String	resetREBCfg(org.lsst.ccs.subsystem.rafts.REBDevice rebDevice) Reset REB config values
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) What does this method do?
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	setInstitution(String inst)
void	setRaftLoc(String rloc)
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	setSeqInfo(String sinf)
void	setTestType(String ttype)
String	showAllREBCfg() show REB config values for all REBs
void	showPhotoDiodeAnalysis(String pddatfile)
String	showREBCfg(org.lsst.ccs.subsystem.rafts.REBDevice rebDevice) show REB config values
void	start()
void	startTicking() Starts the subsystem.
void	tick() Performs periodic trending data broadcast.
void	writeRegister(String rebId, int address, int value) Write a register address on a Reb.

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

getComponentTree, getEnvironment, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, listens, postStart, processUpdate, sendSignal, sendSignalWithTimeLimit, setEnvironment, setName, setNObserverThreads, setObservables, setTickMillis, shutdownNow, signal, update

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

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, dropSubmittedChanges, getCheckedValueFromConfiguration, getChildren, getComponentByName, getParent, getParentObject, getSubmittedChanges, isParameterConfigurable, notifyChange, notifyChangeWithoutPreliminaryChecks, printConfigurableParameters, setBulkParameter, submitChange, submitChanges, validateBulkChange

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(String name,
                    int tickMillis,
                    org.lsst.ccs.utilities.ccd.Geometry geometry,
                    org.lsst.ccs.drivers.reb.ClientFactory clientFactory)

Method Detail

initModule

public void initModule()

Overrides:

initModule in class org.lsst.ccs.framework.Module

checkHardware

public org.lsst.ccs.framework.TreeWalkerDiag checkHardware()

Initializes the hardware. * * @return GO * **************************************************************************

Specified by:

checkHardware in interface org.lsst.ccs.framework.HardwareController

checkStarted

public void checkStarted()

Checks whether hardware is started. * **************************************************************************

Specified by:

checkStarted in interface org.lsst.ccs.framework.HardwareController

checkStopped

public void checkStopped()

Checks whether hardware is stopped. * **************************************************************************

Specified by:

checkStopped in interface org.lsst.ccs.framework.HardwareController

startTicking

public void startTicking()

Starts the subsystem. * **************************************************************************

Overrides:

startTicking in class org.lsst.ccs.framework.Module

tick

public void tick()

Performs periodic trending data broadcast. * **************************************************************************

Overrides:

tick in class org.lsst.ccs.framework.Module

start

public void start()

Specified by:

start in interface org.lsst.ccs.framework.Configurable

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

What does this method do?

Parameters:

serial - The serial position of the CCD

parallel - The parallel position of the CCD

ccdName - The name of the CCD.

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.

Parameters:

raftName -

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.

Parameters:

parallel - The parallel position of the Reb.

rebName - The new name of the reb

Throws:

IllegalArgumentException - if the parallel position is illegal.

checkAllCurrents

@Command(type=ACTION,
         description="checks all currents")
public String checkAllCurrents()
                                                                                          throws Exception,
                                                                                                 IOException

Check all currents

Throws:

IOException - * **************************************************************************

Exception

powerOffREB

@Command(type=ACTION,
         description="power off REB outputs")
public String powerOffREB()
                                                                                       throws Exception,
                                                                                              IOException

Power OFF REB outputs

Throws:

IOException - * **************************************************************************

Exception

resetREBCfg

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

Reset REB config values

Throws:

IOException - * **************************************************************************

Exception

showAllREBCfg

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

show REB config values for all REBs

Throws:

IOException - * **************************************************************************

Exception

showREBCfg

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

show REB config values

Throws:

IOException - * **************************************************************************

Exception

powerOn

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

Safely power On REB

Returns:

Throws:

IOException - * **************************************************************************

Exception

powerOff

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

Safely power Off REB

Returns:

Throws:

IOException - * **************************************************************************

Exception

readRegister

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

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.

Throws:

Exception

writeRegister

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

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.

Throws:

Exception

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 Exception,
                                                                                                                                         IOException,
                                                                                                                                         nom.tam.fits.FitsException,
                                                                                                                                         InterruptedException,
                                                                                                                                         org.lsst.ccs.subsystem.rafts.data.RaftException

Start an acquisition and save the resulting images. This method returns immediately. Events will be published on the buses when files are available.

Returns:

Throws:

org.lsst.ccs.subsystem.rafts.data.RaftException

IOException

nom.tam.fits.FitsException

InterruptedException

Exception

exposeAcquireAndSave

@Command(description="Start an acquisition and save the images to fits.",
         type=ACTION)
public List<String> exposeAcquireAndSave(long exposureTimeInMillis)
                                                                                                                                  throws Exception,
                                                                                                                                         IOException,
                                                                                                                                         nom.tam.fits.FitsException,
                                                                                                                                         InterruptedException,
                                                                                                                                         org.lsst.ccs.subsystem.rafts.data.RaftException

Start an acquisition and save the resulting images for the given parameters. This method returns immediately. Events will be published on the buses when files are available.

Parameters:

exposureTimeInMillis - The exposure time in milliseconds

Returns:

Throws:

org.lsst.ccs.subsystem.rafts.data.RaftException

IOException

nom.tam.fits.FitsException

InterruptedException

Exception

exposeAcquireAndSave

@Command(description="Start an acquisition and save the images to fits.",
         type=ACTION)
public List<String> exposeAcquireAndSave(long exposureTimeInMillis,
                                                                                                                                         boolean openShutter)
                                                                                                                                  throws Exception,
                                                                                                                                         IOException,
                                                                                                                                         nom.tam.fits.FitsException,
                                                                                                                                         InterruptedException,
                                                                                                                                         org.lsst.ccs.subsystem.rafts.data.RaftException

Start an acquisition and save the resulting images for the given parameters. This method returns immediately. Events will be published on the buses when files are available.

Parameters:

exposureTimeInMillis - The exposure time in milliseconds

openShutter - True/false if the shutter should be open

Returns:

Throws:

org.lsst.ccs.subsystem.rafts.data.RaftException

IOException

nom.tam.fits.FitsException

InterruptedException

Exception

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 Exception,
                                                                                                                                         IOException,
                                                                                                                                         nom.tam.fits.FitsException,
                                                                                                                                         InterruptedException,
                                                                                                                                         org.lsst.ccs.subsystem.rafts.data.RaftException

Start an acquisition and save the resulting images for the given parameters. This method returns immediately. Events will be published on the buses when files are available.

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:

Throws:

org.lsst.ccs.subsystem.rafts.data.RaftException

IOException

nom.tam.fits.FitsException

InterruptedException

Exception

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 Exception,
                                                                                                                                         IOException,
                                                                                                                                         nom.tam.fits.FitsException,
                                                                                                                                         InterruptedException,
                                                                                                                                         org.lsst.ccs.subsystem.rafts.data.RaftException

Start an acquisition and save the resulting images for the given parameters. This method returns immediately. Events will be published on the buses when files are available.

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:

Throws:

org.lsst.ccs.subsystem.rafts.data.RaftException

IOException

nom.tam.fits.FitsException

InterruptedException

Exception

setDefaultExposureTime

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

Set the default exposure time in milliseconds.

Parameters:

millis - Exposure time in milliseconds.

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.RaftFullState getFullState()

Gets the full monitoring state. * * This is intended to be called by GUIs during initialization * * @return The full Raft state * **************************************************************************

clearNonStickyHeaderKeywordValues

protected void clearNonStickyHeaderKeywordValues()

setTestType

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

setImageType

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

setRaftLoc

@Command(type=QUERY,
         description="Sets the raft location property for the output filename")
public void setRaftLoc(String rloc)

setSeqInfo

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

setInstitution

@Command(type=QUERY,
         description="Sets the institution property for the output filename")
public void setInstitution(String inst)

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