org.lsst.ccs.drivers.reb

Class TestImage

java.lang.Object

org.lsst.ccs.drivers.reb.TestImage

All Implemented Interfaces:

ImageClient.Listener

public class TestImage
extends Object
implements ImageClient.Listener

Program to test the Java image client interface routines

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestImage.HdwType Enumeration for hardware type.
static class	TestImage.OnOff Enumeration for on/off.

Constructor Summary

Constructors

Constructor and Description
TestImage()

Method Summary

Modifier and Type	Method and Description
String	awaitImage() Waits for an image to arrive.
void	connect(int id) Connects to a REB.
void	connect(int id, String part) Connects to a REB connected via DAQ1/2/4.
void	connect(TestImage.HdwType type, int id, String ifcName) Connects to a REB.
void	disconnect() Disconnects from a REB.
String	display(int length) Displays image data.
String	display(int length, int offset) Displays image data.
String	display(int ccd, int length, int offset) Displays image data.
void	interrupt() Interrupts an image wait.
String	listen(TestImage.OnOff action) Turns the listener on or off.
String	metadata() Displays image metadata.
void	processImage(Image img) Handles each received image.
String	read() Reads an image.
void	region(int length) Sets the internal image display region.
void	region(int length, int offset) Sets the internal image display region.
void	reset() Resets the front end system.
void	reuse(TestImage.OnOff action) Turns image data buffer re-use on or off.
String	show() Displays parameters.
void	time(TestImage.OnOff action) Turns image acquisition time display on or off.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestImage

public TestImage()

Method Detail

connect

@Command(description="Connect to a REB")
public void connect(@Argument(description="REB ID")
                                                             int id)
                                                      throws REBException

Connects to a REB.

Parameters:

id - The REB ID

Throws:

REBException

connect

@Command(description="Connect to a REB")
public void connect(@Argument(description="REB ID")
                                                             int id,
                                                             @Argument(description="Partition name")
                                                             String part)
                                                      throws REBException

Connects to a REB connected via DAQ1/2/4.

Parameters:

id - The REB ID

part - The partition name

Throws:

REBException

connect

@Command(description="Connect to a REB")
public void connect(@Argument(description="Hardware type")
                                                             TestImage.HdwType type,
                                                             @Argument(description="REB ID")
                                                             int id,
                                                             @Argument(description="Network interface name")
                                                             String ifcName)
                                                      throws REBException

Connects to a REB.

Parameters:

type - The hardware type (DAQ, DAQ0, DAQ1, DAQ2. DAQ4, PCI0, PCI1)

id - The REB ID

ifcName - The partition, network interface, or PCI device name

Throws:

REBException

disconnect

@Command(description="Disconnect from a REB")
public void disconnect()
                                                              throws REBException

Disconnects from a REB.

Throws:

REBException

reuse

@Command(description="Enable or disable image buffer re-use")
public void reuse(@Argument(description="Action to take")
                                                                                TestImage.OnOff action)

Turns image data buffer re-use on or off.

Parameters:

action - The buffer re-use action: ON or OFF

time

@Command(description="Enable or disable time display")
public void time(@Argument(description="Action to take")
                                                                        TestImage.OnOff action)

Turns image acquisition time display on or off.

Parameters:

action - The display action: ON or OFF

listen

@Command(description="Enable or disable the listener")
public String listen(@Argument(description="Action to take")
                                                                            TestImage.OnOff action)
                                                                     throws REBException

Turns the listener on or off.

Parameters:

action - The listener action: ON or OFF

Returns:

"Cursor up" string if success; error message otherwise

Throws:

REBException

region

@Command(description="Set the image display region")
public void region(@Argument(description="The region length (pixels)")
                                                                        int length)

Sets the internal image display region.

Parameters:

length - The length of the display region

region

@Command(description="Set the image display region")
public void region(@Argument(description="The region length (pixels)")
                                                                        int length,
                                                                        @Argument(description="The offset to the region (pixels)")
                                                                        int offset)

Sets the internal image display region.

Parameters:

length - The length of the display region

offset - The offset to the start of the region

show

@Command(description="Display parameters")
public String show()

Displays parameters.

Returns:

The result string

awaitImage

@Command(name="wait",
         description="Wait for an image to arrive")
public String awaitImage()
                                                                                            throws REBException

Waits for an image to arrive.

Returns:

The result string

Throws:

REBException

read

@Command(description="Read an image")
public String read()
                                                  throws REBException

Reads an image.

Returns:

The result string

Throws:

REBException

interrupt

@Command(description="Interrupt an image wait")
public void interrupt()
                                                               throws REBException

Interrupts an image wait.

Throws:

REBException

display

@Command(description="Display image data")
public String display(@Argument(description="The display region length (pixels)")
                                                                 int length)

Displays image data.

Parameters:

length - The number of pixels to display

Returns:

The result string

display

@Command(description="Display image data")
public String display(@Argument(description="The display region length (pixels)")
                                                                 int length,
                                                                 @Argument(description="The offset to the display region (pixels)")
                                                                 int offset)

Displays image data.

Parameters:

length - The number of pixels to display

offset - The offset to the first pixel

Returns:

The result string

display

@Command(description="Display image data")
public String display(@Argument(description="The CCD number")
                                                                 int ccd,
                                                                 @Argument(description="The display region length (pixels)")
                                                                 int length,
                                                                 @Argument(description="The offset to the display region (pixels)")
                                                                 int offset)

Displays image data.

Parameters:

ccd - The CCD number

length - The number of pixels to display

offset - The offset to the first pixel

Returns:

The result string

metadata

@Command(description="Display image metadata")
public String metadata()

Displays image metadata.

Returns:

The result string

reset

@Command(description="Reset the front end")
public void reset()
                                                       throws REBException

Resets the front end system.

Throws:

REBException

processImage

public void processImage(Image img)

Handles each received image.

Specified by:

processImage in interface ImageClient.Listener

Parameters:

img - The received image