org.youscope.plugin.slimjob

Interface SlimJob

All Superinterfaces:

Component, ImageProducer, Job, JobContainer, java.rmi.Remote

public interface SlimJob
extends Job, ImageProducer, JobContainer

Job to take SLIM images with four different phase shift patterns.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
int	getInnerRadius() Returns the radius of the inner circle (the hole in the "donut").
java.lang.String	getMaskFileName() Returns the file name of the mask which should be used to define foreground and background.
int	getMaskX() Returns the X position of the center of the inner and outer circle (the "donut").
int	getMaskY() Returns the Y position of the center of the inner and outer circle (the "donut").
int	getOuterRadius() Returns the radius of the outer circle (the "donut").
int	getPhaseShiftMask(int maskID) Returns the phase shift of the mask (the donut) for the maskID mask.
int	getPhaseShiftOutside() Returns the phase shift outside of the mask (background of donut).
java.lang.String	getReflectorDevice() Returns the name of the reflector device which should be used to generate the pattern.
int	getSlimDelayMs() Returns the time delay in ms between changing the SLIM reflector settings and taking an image.
void	setImageDescription(java.lang.String description) Sets a short string describing the images which are made by this job.
void	setInnerRadius(int innerRadius) Sets the radius of the inner circle (the hole in the "donut").
void	setMaskFileName(java.lang.String maskFileName) Sets the file name of the mask which should be used to define foreground and background.
void	setMaskX(int maskX) Sets the X position of the center of the inner and outer circle (the "donut").
void	setMaskY(int maskY) Sets the Y position of the center of the inner and outer circle (the "donut").
void	setOuterRadius(int outerRadius) Sets the radius of the outer circle (the "donut").
void	setPhaseShiftMask(int maskID, int phaseShift) Sets the phase shift of the mask (the donut) for the maskID mask.
void	setPhaseShiftOutside(int phaseShiftOutside) Sets the phase shift outside of the mask (background of donut).
void	setReflectorDevice(java.lang.String reflectorDevice) Returns the name of the reflector device which should be used to generate the pattern.
void	setSlimDelayMs(int delayMs) Sets the time delay in ms between changing the SLIM reflector settings and taking an image.

Methods inherited from interface org.youscope.common.job.Job

addJobListener, executeJob, initializeJob, removeJobListener, uninitializeJob

Methods inherited from interface org.youscope.common.Component

addMessageListener, getName, getPositionInformation, getUUID, removeMessageListener, setName

Methods inherited from interface org.youscope.common.image.ImageProducer

addImageListener, getImageDescription, getNumberOfImages, removeImageListener

Methods inherited from interface org.youscope.common.job.JobContainer

getJob, getJobs, getNumJobs

Method Detail

setMaskX

void setMaskX(int maskX)
       throws java.rmi.RemoteException,
              MeasurementRunningException

Sets the X position of the center of the inner and outer circle (the "donut").

Parameters:

maskX - X-position.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getMaskX

int getMaskX()
      throws java.rmi.RemoteException

Returns the X position of the center of the inner and outer circle (the "donut").

Returns:

X-position.

Throws:

java.rmi.RemoteException

setMaskY

void setMaskY(int maskY)
       throws java.rmi.RemoteException,
              MeasurementRunningException

Sets the Y position of the center of the inner and outer circle (the "donut").

Parameters:

maskY - Y-position.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getMaskY

int getMaskY()
      throws java.rmi.RemoteException

Returns the Y position of the center of the inner and outer circle (the "donut").

Returns:

Y-position.

Throws:

java.rmi.RemoteException

setInnerRadius

void setInnerRadius(int innerRadius)
             throws java.rmi.RemoteException,
                    MeasurementRunningException

Sets the radius of the inner circle (the hole in the "donut").

Parameters:

innerRadius - the inner radius. Must be > 0.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getInnerRadius

int getInnerRadius()
            throws java.rmi.RemoteException

Returns the radius of the inner circle (the hole in the "donut").

Returns:

the inner radius. Must be > 0.

Throws:

java.rmi.RemoteException

setOuterRadius

void setOuterRadius(int outerRadius)
             throws java.rmi.RemoteException,
                    MeasurementRunningException

Sets the radius of the outer circle (the "donut").

Parameters:

outerRadius - the outer radius. Must be > innerRadius.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getOuterRadius

int getOuterRadius()
            throws java.rmi.RemoteException

Returns the radius of the outer circle (the "donut").

Returns:

the outer radius.

Throws:

java.rmi.RemoteException

setPhaseShiftOutside

void setPhaseShiftOutside(int phaseShiftOutside)
                   throws java.rmi.RemoteException,
                          MeasurementRunningException

Sets the phase shift outside of the mask (background of donut).

Parameters:

phaseShiftOutside - the outer phase shift. Must be >=0 and < 256.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getPhaseShiftOutside

int getPhaseShiftOutside()
                  throws java.rmi.RemoteException

Returns the phase shift outside of the mask (background of donut).

Returns:

the outer phase shift.

Throws:

java.rmi.RemoteException

getPhaseShiftMask

int getPhaseShiftMask(int maskID)
               throws java.rmi.RemoteException

Returns the phase shift of the mask (the donut) for the maskID mask.

Parameters:

maskID - the phase shift. Must be >=0 and < 4.

Returns:

phaseShift the phase shift.

Throws:

java.rmi.RemoteException

setPhaseShiftMask

void setPhaseShiftMask(int maskID,
                       int phaseShift)
                throws java.rmi.RemoteException,
                       MeasurementRunningException

Sets the phase shift of the mask (the donut) for the maskID mask.

Parameters:

phaseShift - the phase shift. Must be >=0 and < 256.

maskID - the phase shift. Must be >=0 and < 4.

Throws:

java.rmi.RemoteException

MeasurementRunningException

setImageDescription

void setImageDescription(java.lang.String description)
                  throws java.rmi.RemoteException,
                         MeasurementRunningException

Sets a short string describing the images which are made by this job.

Parameters:

description - The description which should be returned for the images produced by this job, or null, to switch to the default description.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getReflectorDevice

java.lang.String getReflectorDevice()
                             throws java.rmi.RemoteException

Returns the name of the reflector device which should be used to generate the pattern.

Returns:

Name of the reflector device.

Throws:

java.rmi.RemoteException

setReflectorDevice

void setReflectorDevice(java.lang.String reflectorDevice)
                 throws java.rmi.RemoteException,
                        MeasurementRunningException

Returns the name of the reflector device which should be used to generate the pattern.

Parameters:

reflectorDevice - Name of the reflector device.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getSlimDelayMs

int getSlimDelayMs()
            throws java.rmi.RemoteException

Returns the time delay in ms between changing the SLIM reflector settings and taking an image.

Returns:

Delay in ms.

Throws:

java.rmi.RemoteException

setSlimDelayMs

void setSlimDelayMs(int delayMs)
             throws java.rmi.RemoteException,
                    MeasurementRunningException

Sets the time delay in ms between changing the SLIM reflector settings and taking an image.

Parameters:

delayMs - delay in ms. Must be >= 0.

Throws:

java.rmi.RemoteException

MeasurementRunningException

setMaskFileName

void setMaskFileName(java.lang.String maskFileName)
              throws java.rmi.RemoteException,
                     MeasurementRunningException

Sets the file name of the mask which should be used to define foreground and background. Set to null to use donut mode instead.

Parameters:

maskFileName - Name of file which defines background and foreground, or null for donut mode.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getMaskFileName

java.lang.String getMaskFileName()
                          throws java.rmi.RemoteException

Returns the file name of the mask which should be used to define foreground and background. Returns null if donut mode is active.

Returns:

Name of file which defines background and foreground, or null for donut mode.

Throws:

java.rmi.RemoteException