Package org.lsst.ccs.subsystem.focalplane

Class LSE71Commands

java.lang.Object

org.lsst.ccs.subsystem.focalplane.LSE71Commands

public class LSE71Commands
extends Object

Focal Plane level commands. These are normal level commands required by LSE-71.

Author:

The LSST CCS Team

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LSE71Commands.ReadoutMode

Method Summary

Modifier and Type	Method	Description
org.lsst.ccs.imagenaming.ImageName	allocateImageName()	Allocate an imageName to be used with a future call to startNamedIntegration
void	clear(int nClears)	Performs a clear operation.
org.lsst.ccs.imagenaming.ImageName	clearAndStartIntegration(int nClears, String annotation, Set locations)	Performs clears and then starts an integration operation for a named image.
void	clearAndStartNamedIntegration(org.lsst.ccs.imagenaming.ImageName imageName, int nClears, String annotation, Set locations)	Performs clears and then starts an integration operation for a named image.
void	clearROI()
void	endIdleFlush(int nClears)	Ends an IDLE_FLUSH operation and performs zero or more clears This command is of limited use, because if idleFlushTimeout is on, the sequencer will go back to IDLE_FLUSH after performing any requested clears anyway,
void	endIntegration(LSE71Commands.ReadoutMode readout)
int	initGuiders(String roiSpec)
void	shiftNRows(int nRows)
void	sleepGuider()
void	startGuiding(org.lsst.ccs.imagenaming.ImageName imageName)
void	startIdleFlush()	Starts an IDLE_FLUSH operation.
org.lsst.ccs.imagenaming.ImageName	startIntegration(String annotation, Set locations)	Starts an integration operation.
void	startNamedIntegration(org.lsst.ccs.imagenaming.ImageName imageName, String annotation, Set locations)	Starts an integration operation for a named image.
int	stopGuiding()

Methods inherited from class java.lang.Object

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

Method Details

clear

@Command(type=ACTION,
         description="Perform a clear operation",
         level=0,
         autoAck=false)
public void clear(@Argument(defaultValue="1")
 int nClears)

Performs a clear operation. This method returns immediately and does not wait for the sequencer to stop.

Parameters:

nClears -

allocateImageName

@Command(type=ACTION,
         description="Allocate an image for a future call to startNamedIntegration",
         level=0,
         autoAck=false)
public org.lsst.ccs.imagenaming.ImageName allocateImageName()

Allocate an imageName to be used with a future call to startNamedIntegration

Returns:

The allocated image name

startIntegration

@Command(type=ACTION,
         description="Start integration",
         level=0,
         autoAck=false)
public org.lsst.ccs.imagenaming.ImageName startIntegration(@Argument(defaultValue="")
 String annotation,
 @Argument(defaultValue="***NULL_VALUE_FOR_COMMAND_ARGUMENT***")
 Set locations)

Starts an integration operation. This method returns immediately.

Parameters:

annotation - The image annotation

locations - The set of locations to read

Returns:

The image name allocated

clearAndStartIntegration

@Command(type=ACTION,
         description="Clear and start integration",
         level=0,
         autoAck=false)
public org.lsst.ccs.imagenaming.ImageName clearAndStartIntegration(@Argument(defaultValue="1")
 int nClears,
 @Argument(defaultValue="")
 String annotation,
 @Argument(defaultValue="***NULL_VALUE_FOR_COMMAND_ARGUMENT***")
 Set locations)

Performs clears and then starts an integration operation for a named image. This method returns once the integration has started.

Parameters:

nClears - The number of clears (may be zero)

annotation - The image annotation

locations - The set of locations to read

Returns:

The image name allocated

startNamedIntegration

@Command(type=ACTION,
         description="Start integration",
         level=0,
         autoAck=false)
public void startNamedIntegration(@Argument
 org.lsst.ccs.imagenaming.ImageName imageName,
 @Argument(defaultValue="")
 String annotation,
 @Argument(defaultValue="***NULL_VALUE_FOR_COMMAND_ARGUMENT***")
 Set locations)

Starts an integration operation for a named image. This method returns immediately.

Parameters:

imageName - The image name to use

annotation - The image annotation

locations - The set of locations to read

clearAndStartNamedIntegration

@Command(type=ACTION,
         description="Clear and start integration",
         level=0,
         autoAck=false)
public void clearAndStartNamedIntegration(@Argument
 org.lsst.ccs.imagenaming.ImageName imageName,
 @Argument(defaultValue="1")
 int nClears,
 @Argument(defaultValue="")
 String annotation,
 @Argument(defaultValue="***NULL_VALUE_FOR_COMMAND_ARGUMENT***")
 Set locations)

Performs clears and then starts an integration operation for a named image. This method returns once the integration has started.

Parameters:

imageName - The image name to use

nClears - The number of clears (may be zero)

annotation - The image annotation

locations - The set of locations to read

shiftNRows

@Command(type=ACTION,
         description="Shift n rows",
         level=0,
         autoAck=false)
public void shiftNRows(int nRows)

endIntegration

@Command(type=ACTION,
         description="End exposure, and optionally read out",
         level=0,
         autoAck=false)
public void endIntegration(@Argument(defaultValue="TRUE")
 LSE71Commands.ReadoutMode readout)

startIdleFlush

@Command(type=ACTION,
         description="Start idle flush",
         level=0,
         autoAck=false)
public void startIdleFlush()

Starts an IDLE_FLUSH operation. This method returns immediately.

endIdleFlush

@Command(type=ACTION,
         description="End idle flush",
         level=0,
         autoAck=false)
public void endIdleFlush(@Argument(defaultValue="1")
 int nClears)

Ends an IDLE_FLUSH operation and performs zero or more clears This command is of limited use, because if idleFlushTimeout is on, the sequencer will go back to IDLE_FLUSH after performing any requested clears anyway,

Parameters:

nClears - The number of clears to do (may be zero)

initGuiders

@Command(type=ACTION,
         description="Initialize Guiders",
         level=0,
         autoAck=false)
public int initGuiders(@Argument
 String roiSpec)

startGuiding

@Command(type=ACTION,
         description="Start Guiders",
         level=0,
         autoAck=false)
public void startGuiding(org.lsst.ccs.imagenaming.ImageName imageName)

stopGuiding

@Command(type=ACTION,
         description="Stop Guiders",
         level=0,
         autoAck=false)
public int stopGuiding()

clearROI

@Command(type=ACTION,
         description="Clear ROI",
         level=0,
         autoAck=false)
public void clearROI()

sleepGuider

@Command(type=ACTION,
         description="Clear ROI",
         level=0,
         autoAck=false)
public void sleepGuider()