public class SlimJobConfiguration extends JobConfiguration implements ImageProducerConfiguration
Modifier and Type | Field and Description |
---|---|
static int |
MAX_PHASE_SHIFT
Maximal phase shift value
|
static int |
MIN_PHASE_SHIFT
Minimal phase shift value
|
static int |
NUM_PHASE_SHIFT_MASK
Number of different phase shifts of the mask
|
static java.lang.String |
TYPE_IDENTIFIER
The identifier for this job type.
|
Constructor and Description |
---|
SlimJobConfiguration() |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone() |
java.lang.String |
getCamera()
Returns the ID of the camera with which should be imaged, or null, if imaging with the default camera.
|
java.lang.String |
getChannel() |
java.lang.String |
getChannelGroup() |
java.lang.String |
getDescription()
Returns a short description of this job.
|
double |
getExposure() |
java.lang.String |
getImageSaveName()
Returns the name under which the images should be saved.
|
java.lang.String[] |
getImageSaveNames()
Should return the names of all images produced by this job and which should be saved to disk.
|
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 |
getNumberOfImages()
Returns the number of images which get produced per evaluation of a job initialized with this configuration.
|
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.
|
java.lang.String |
getTypeIdentifier()
Returns a unique identifier for this configuration type.
|
boolean |
isSaveImages() |
void |
setCamera(java.lang.String camera)
Sets the camera with which should be imaged.
|
void |
setChannel(java.lang.String channelGroup,
java.lang.String channel)
Sets the channel which should be imaged.
|
void |
setExposure(double exposure) |
void |
setImageSaveName(java.lang.String name)
Sets the name under which the images should be saved.
|
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 |
setSaveImages(boolean saveImages) |
void |
setSlimDelayMS(int slimDelayMS)
Sets the time delay in ms between changing the SLIM reflector settings and taking an image.
|
checkConfiguration, toString
public static final java.lang.String TYPE_IDENTIFIER
public static final int MIN_PHASE_SHIFT
public static final int MAX_PHASE_SHIFT
public static final int NUM_PHASE_SHIFT_MASK
public java.lang.String getTypeIdentifier()
Configuration
getTypeIdentifier
in interface Configuration
public java.lang.String getDescription()
JobConfiguration
getDescription
in class JobConfiguration
public void setChannel(java.lang.String channelGroup, java.lang.String channel)
channelGroup
- The group of the channel.channel
- The channel.public java.lang.String getChannel()
public java.lang.String getChannelGroup()
public void setExposure(double exposure)
exposure
- the exposure to setpublic double getExposure()
public void setSaveImages(boolean saveImages)
saveImages
- the saveImages to setpublic boolean isSaveImages()
public java.lang.String getImageSaveName()
public void setImageSaveName(java.lang.String name)
name
- Name of imaging job.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class JobConfiguration
java.lang.CloneNotSupportedException
public java.lang.String[] getImageSaveNames()
ImageProducerConfiguration
getImageSaveNames
in interface ImageProducerConfiguration
public int getNumberOfImages()
ImageProducerConfiguration
getNumberOfImages
in interface ImageProducerConfiguration
public void setMaskX(int maskX)
maskX
- X-position.public int getMaskX()
public void setMaskY(int maskY)
maskY
- Y-position.public int getMaskY()
public void setInnerRadius(int innerRadius)
innerRadius
- the inner radius. Must be > 0.public int getInnerRadius()
public void setOuterRadius(int outerRadius)
outerRadius
- the outer radius. Must be > innerRadius.public int getOuterRadius()
public void setPhaseShiftOutside(int phaseShiftOutside)
phaseShiftOutside
- the outer phase shift. Must be >=0 and < 256.public int getPhaseShiftOutside()
public int getPhaseShiftMask(int maskID)
maskID
- the phase shift. Must be >=0 and < 4.public void setPhaseShiftMask(int maskID, int phaseShift)
phaseShift
- the phase shift. Must be >=0 and < 256.maskID
- the phase shift. Must be >=0 and < 4.public java.lang.String getReflectorDevice()
public void setReflectorDevice(java.lang.String reflectorDevice)
reflectorDevice
- Name of the reflector device.public void setCamera(java.lang.String camera)
camera
- ID of camera device, or null.public java.lang.String getCamera()
public int getSlimDelayMS()
public void setSlimDelayMS(int slimDelayMS)
slimDelayMS
- delay in ms. Must be >= 0.public void setMaskFileName(java.lang.String maskFileName)
maskFileName
- Name of file which defines background and foreground, or null for donut mode.public java.lang.String getMaskFileName()