public class ComposedImagingMeasurementConfiguration extends MeasurementConfiguration
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
TYPE_IDENTIFIER
The identifier for this measurement type.
|
Constructor and Description |
---|
ComposedImagingMeasurementConfiguration() |
Modifier and Type | Method and Description |
---|---|
void |
checkConfiguration()
Checks the current state of the configuration.
|
java.lang.Object |
clone() |
java.lang.String |
getCameraDevice()
Returns the camera device used for imaging.
|
java.lang.String |
getChannel()
Returns the channel in which is imaged.
|
java.lang.String |
getChannelGroup() |
double |
getExposure()
Returns the exposure time.
|
java.lang.String |
getImageSaveName()
Returns the name under which the images are saved.
|
java.awt.Dimension |
getNumPixels()
Returns the number of pixels in one image.
|
int |
getNx()
Returns the number of images which should be made in the x-direction.
|
int |
getNy()
Returns the number of images which should be made in the y-direction.
|
double |
getOverlap()
Returns the overlap (0.0-1.0) of the two neighboring images.
|
PeriodConfiguration |
getPeriod() |
double |
getPixelSize()
Returns the size of one pixel in micro meters.
|
java.lang.String |
getPixelSizeID()
Returns the ID of the pixel size setting, or null if the pixel size does not correspond to a predefined pixel size setting.
|
java.lang.String |
getTypeIdentifier()
Returns a unique identifier for this configuration type.
|
boolean |
isSaveImages()
Returns if taken images should be saved to disk
|
void |
setCameraDevice(java.lang.String cameraDevice)
Sets the camera device used for imaging.
|
void |
setChannel(java.lang.String channelGroup,
java.lang.String channel)
Sets the channel for imaging.
|
void |
setExposure(double exposure)
Sets the exposure in ms.
|
void |
setImageSaveName(java.lang.String name)
Sets the name under which the images are saved.
|
void |
setNumPixels(java.awt.Dimension numPixels)
Sets the number of pixels in one image.
|
void |
setNx(int nx)
Sets the number of images which should be made in the x-direction.
|
void |
setNy(int ny)
Sets the number of images which should be made in the y-direction.
|
void |
setOverlap(double overlap)
Sets the overlap (0.0-1.0) between neighboring images.
|
void |
setPeriod(PeriodConfiguration period)
Sets the period length between single repetitions of the imaging process.
|
void |
setPixelSize(double pixelSize)
Sets the size of one pixel in micro meters.
|
void |
setPixelSizeID(java.lang.String pixelSizeID)
Sets the ID of the pixel size setting, or null if the pixel size does not correspond to a predefined pixel size setting.
|
void |
setSaveImages(boolean saveImages)
Sets if taken images should be saved to disk
|
getDeviseSettingsOff, getDeviseSettingsOn, getMeasurementRuntime, getName, getSaveSettings, setDeviseSettingsOff, setDeviseSettingsOn, setMeasurementRuntime, setName, setSaveSettings
public static final java.lang.String TYPE_IDENTIFIER
public ComposedImagingMeasurementConfiguration()
public void setPeriod(PeriodConfiguration period)
period
- Period time between making several composed images.public PeriodConfiguration getPeriod()
public void setChannel(java.lang.String channelGroup, java.lang.String channel)
channelGroup
- channel
- public java.lang.String getChannel()
public java.lang.String getChannelGroup()
public void setExposure(double exposure)
exposure
- Exposure time in ms.public double getExposure()
public void setSaveImages(boolean saveImages)
saveImages
- true if images should be saved.public boolean isSaveImages()
public java.lang.String getImageSaveName()
public void setImageSaveName(java.lang.String name)
name
- Name of the imaging job.public void setNx(int nx)
nx
- Number of images in the x-direction.public int getNx()
public void setNy(int ny)
ny
- Number of images in the y-direction.public int getNy()
public void setPixelSize(double pixelSize)
pixelSize
- Size of one pixel.public double getPixelSize()
public void setNumPixels(java.awt.Dimension numPixels)
numPixels
- Number of pixels in one image.public java.awt.Dimension getNumPixels()
public void setOverlap(double overlap)
overlap
- Overlap between neighboring images.public double getOverlap()
public java.lang.String getTypeIdentifier()
Configuration
public void setPixelSizeID(java.lang.String pixelSizeID)
pixelSizeID
- ID of the pixel size setting.public java.lang.String getPixelSizeID()
public void setCameraDevice(java.lang.String cameraDevice)
cameraDevice
- Name of the camera device, or null if standard camera should be used.public java.lang.String getCameraDevice()
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class MeasurementConfiguration
java.lang.CloneNotSupportedException
public void checkConfiguration() throws ConfigurationException
Configuration
ConfigurationException
is thrown describing the error, and what has to be changed in the configuration, by the user,
such that it becomes valid. This error can then e.g. be displayed to the user
(see ConfigurationAddonTools.displayConfigurationInvalid(ConfigurationException, YouScopeClient).checkConfiguration
in interface Configuration
checkConfiguration
in class MeasurementConfiguration
ConfigurationException