org.lsst.ccs.subsystem.ocsbridge.sim

Interface FocalPlaneInterface

All Known Implementing Classes:

FocalPlaneSimulation

public interface FocalPlaneInterface

Interface to be implemented by subsystems which can take images.

Author:

tonyj

Method Summary

Modifier and Type	Method and Description
void	clear(int nClears) Clear the focal-plane.
void	clearAndStartIntegration(org.lsst.ccs.imagenaming.ImageName imageName, int nClears, Map<String,? extends Serializable> parsedKeyValueData, Set locations, String annotation, Duration stopGuiding)
void	clearROI()
void	definePlaylist(String playlist, String folder, String... images)
void	discardRows(int nRows)
void	endIntegration(boolean readout)
void	initGuiders(String roiSpec)
void	play(String playlist, boolean repeat)
void	setHeaderKeywords(Map<String,Serializable> headersMap)
void	start(String configName) Called when the MCM receives a start command.
void	startIntegration(org.lsst.ccs.imagenaming.ImageName imageName, Map<String,? extends Serializable> parsedKeyValueData, Set locations, String annotation, Duration stopGuiding) Start integration.Note that if focal-plane is configured to always to a clear, then a clear may be included.

Method Detail

clear

void clear(int nClears)
    throws ExecutionException

Clear the focal-plane. Note that if focal-plane is always going to do a clear before each image, this will be a NOOP.

Parameters:

nClears -

Throws:

ExecutionException

endIntegration

void endIntegration(boolean readout)
             throws ExecutionException

Throws:

ExecutionException

start

void start(String configName)
    throws ExecutionException

Called when the MCM receives a start command.

Parameters:

configName -

Throws:

ExecutionException

startIntegration

void startIntegration(org.lsst.ccs.imagenaming.ImageName imageName,
                      Map<String,? extends Serializable> parsedKeyValueData,
                      Set locations,
                      String annotation,
                      Duration stopGuiding)
               throws ExecutionException

Start integration.Note that if focal-plane is configured to always to a clear, then a clear may be included.

Parameters:

imageName -

parsedKeyValueData -

locations -

annotation -

stopGuiding - The time by which we should stop guiding

Throws:

ExecutionException

clearAndStartIntegration

void clearAndStartIntegration(org.lsst.ccs.imagenaming.ImageName imageName,
                              int nClears,
                              Map<String,? extends Serializable> parsedKeyValueData,
                              Set locations,
                              String annotation,
                              Duration stopGuiding)
                       throws ExecutionException

Throws:

ExecutionException

play

void play(String playlist,
          boolean repeat)
   throws ExecutionException

Throws:

ExecutionException

definePlaylist

void definePlaylist(String playlist,
                    String folder,
                    String... images)
             throws ExecutionException

Throws:

ExecutionException

discardRows

void discardRows(int nRows)
          throws ExecutionException

Throws:

ExecutionException

initGuiders

void initGuiders(String roiSpec)
          throws ExecutionException

Throws:

ExecutionException

clearROI

void clearROI()
       throws ExecutionException

Throws:

ExecutionException

setHeaderKeywords

void setHeaderKeywords(Map<String,Serializable> headersMap)
                throws ExecutionException

Throws:

ExecutionException