Package | Description |
---|---|
org.youscope.addon.microscopeaccess | |
org.youscope.common.microscope | |
org.youscope.plugin.microscopeaccess | |
org.youscope.server |
Modifier and Type | Method and Description |
---|---|
void |
ChannelInternal.activateChannel(int accessID)
Activates the channel, i.e.
|
void |
MicroscopeConfigurationInternal.addImageSynchronizationDevice(java.lang.String device,
int accessID)
Adds the given device to the list of image synchronization devices.
|
void |
MicroscopeConfigurationInternal.addSystemShutdownSetting(DeviceSetting setting,
int accessID)
Adds a setting to the list of settings which will be applied at shutdown.
|
void |
MicroscopeConfigurationInternal.addSystemStartupSetting(DeviceSetting setting,
int accessID)
Adds a setting to the list of settings which will be applied at startup.
|
void |
MicroscopeInternal.applyDeviceSetting(DeviceSetting setting,
int accessID)
Sets the given device property to the given value.
|
void |
MicroscopeInternal.applyDeviceSettingAsync(DeviceSetting setting,
int accessID)
Sets the given device property to the given value.
|
void |
MicroscopeInternal.applyDeviceSettings(DeviceSetting[] settings,
int accessID)
Sets the given device properties to the given values.
|
void |
MicroscopeInternal.applyDeviceSettingsAsync(DeviceSetting[] settings,
int accessID)
Sets the given device properties to the given values.
|
void |
ChannelInternal.closeShutter(int accessID)
Closes the shutter associated to the channel.
|
void |
ChannelInternal.deactivateChannel(int accessID)
Deactivates the channel, i.e.
|
java.awt.Dimension |
CameraDeviceInternal.getImageSize(int accessID)
Returns the size (in pixels) of the images this camera produces.
|
void |
AvailableDeviceDriverInternal.initializeDevice(DeviceSetting[] preInitSettings,
int accessID)
Initializes a previously loaded device.
|
void |
MicroscopeInternal.initializeMicroscope(int accessID)
Initializes the microscope.
|
boolean |
AvailableDeviceDriverInternal.isSerialPortDriver(int accessID)
Returns true if this driver communicates over a serial port.
|
PreInitDevicePropertyInternal[] |
AvailableDeviceDriverInternal.loadDevice(java.lang.String deviceID,
int accessID)
Loads the specified device driver, but yet does not initialize it.
|
void |
MicroscopeInternal.lockExclusiveWrite(int accessID)
Locks the microscope for a longer time (e.g.
|
ImageEvent<?> |
CameraDeviceInternal.makeImage(ChannelInternal channel,
double exposure,
int accessID)
Makes an image with the given settings.
|
ImageEvent<?>[] |
CameraDeviceInternal.makeParallelImages(ChannelInternal channel,
java.lang.String[] cameraIDs,
double[] exposures,
int accessID)
Deprecated.
|
void |
ChannelInternal.openShutter(int accessID)
Opens the shutter associated to the channel.
|
void |
DeviceLoaderInternal.removeDevice(java.lang.String name,
int accessID)
Removes a previously added device.
|
void |
MicroscopeConfigurationInternal.removeImageSynchronizationDevice(java.lang.String device,
int accessID)
Removes the given device to the list of image synchronization devices.
|
void |
AutoFocusDeviceInternal.runFullFocus(int accessID)
Runs a full focus search.
|
void |
AutoFocusDeviceInternal.runIncrementalFocus(int accessID)
Runs an incremental focus search.
|
void |
SerialDeviceInternal.sendCommand(java.lang.String command,
int accessID)
Sends a serial command to the corresponding port
|
void |
MicroscopeInternal.setAutoFocusDevice(java.lang.String deviceID,
int accessID)
Sets the default auto-focus device.
|
void |
MicroscopeInternal.setCameraDevice(java.lang.String cameraDevice,
int accessID)
Sets the current default camera device.
|
void |
MicroscopeConfigurationInternal.setCommunicationPingPeriod(int pingPeriod,
int accessID)
Sets the wait time used when pinging a device if a certain action is finished.
|
void |
MicroscopeConfigurationInternal.setCommunicationTimeout(int timeout,
int accessID)
Sets the timeout between in the communication with the devices.
|
void |
AutoFocusDeviceInternal.setEnabled(boolean enable,
int accessID)
Enables or disables the auto-focus device.
|
void |
DeviceInternal.setExplicitDelay(double delay,
int accessID)
Sets the explicit delay in ms.
|
void |
CameraDeviceInternal.setExposure(double exposure,
int accessID)
Sets the exposure for imaging.
|
void |
MicroscopeInternal.setFocusDevice(java.lang.String deviceID,
int accessID)
Sets the default focus device.
|
void |
FocusDeviceInternal.setFocusPosition(double position,
int accessID)
Sets the position of the current focus device.
|
void |
MicroscopeConfigurationInternal.setImageBufferSize(int sizeMB,
int accessID)
Sets the size of an internally used image buffer.
|
void |
MicroscopeConfigurationInternal.setImageSynchronizationDevices(java.lang.String[] devices,
int accessID)
Sets the devices for which the microscope waits before an image is made.
|
void |
AutoFocusDeviceInternal.setOffset(double offset,
int accessID)
Sets the current offset.
|
void |
ShutterDeviceInternal.setOpen(boolean open,
int accessID)
Opens (open == true) or closes (open == false) the shutter.
|
void |
StageDeviceInternal.setPosition(double x,
double y,
int accessID)
Sets the absolute position of the stage.
|
void |
FocusDeviceInternal.setRelativeFocusPosition(double offset,
int accessID)
Sets the position of the current focus device relative to the current
focus.
|
void |
StageDeviceInternal.setRelativePosition(double dx,
double dy,
int accessID)
Sets the position of the stage relative to the current position.
|
void |
MicroscopeInternal.setShutterDevice(java.lang.String deviceID,
int accessID)
Sets the default shutter device.
|
void |
MicroscopeInternal.setStageDevice(java.lang.String deviceID,
int accessID)
Sets the default stage device.
|
void |
StateDeviceInternal.setState(int state,
int accessID)
Sets the current state.
|
void |
StateDeviceInternal.setState(java.lang.String label,
int accessID)
Sets the current state.
|
void |
StateDeviceInternal.setStateLabel(int state,
java.lang.String label,
int accessID)
Sets the label for the given state.
|
void |
StateDeviceInternal.setStateLabels(java.lang.String[] labels,
int accessID)
Sets all state labels.
|
void |
CameraDeviceInternal.setSwitchXY(boolean switchXY,
int accessID)
Sets if the x and the y direction should be switched for images made by this camera.
|
void |
MicroscopeConfigurationInternal.setSystemShutdownSettings(DeviceSetting[] settings,
int accessID)
Set the setting which will be applied at shutdown.
|
void |
MicroscopeConfigurationInternal.setSystemStartupSettings(DeviceSetting[] settings,
int accessID)
Set the setting which will be applied at startup.
|
void |
StageDeviceInternal.setTransposeX(boolean transpose,
int accessID)
Sets if the x-direction should be transposed.
|
void |
CameraDeviceInternal.setTransposeX(boolean transpose,
int accessID)
Sets if the x-direction of images made by this camera should be transposed.
|
void |
StageDeviceInternal.setTransposeY(boolean transpose,
int accessID)
Sets if the y-direction should be transposed.
|
void |
CameraDeviceInternal.setTransposeY(boolean transpose,
int accessID)
Sets if the y-direction of images made by this camera should be transposed.
|
void |
StageDeviceInternal.setUnitMagnifier(double unitMagnifier,
int accessID)
Sets the magnification factor from native stage device units to micro meters:
microMeters = units * unitMagnifier
|
void |
FloatPropertyInternal.setValue(float value,
int accessID)
Sets the current value of the property.
|
void |
IntegerPropertyInternal.setValue(int value,
int accessID)
Sets the current value of the property.
|
void |
StringPropertyInternal.setValue(java.lang.String value,
int accessID) |
void |
PropertyInternal.setValue(java.lang.String value,
int accessID)
Sets the current value of the property.
|
void |
FloatPropertyInternal.setValueRelative(float offset,
int accessID)
Sets the value of the microscope relative to its current value.
|
void |
IntegerPropertyInternal.setValueRelative(int offset,
int accessID)
Sets the value of the microscope relative to its current value.
|
void |
CameraDeviceInternal.startContinuousSequenceAcquisition(ChannelInternal channel,
double exposure,
ImageListener listener,
int accessID)
Starts a continuous sequence acquisition.
|
void |
CameraDeviceInternal.stopContinuousSequenceAcquisition(int accessID)
Stops the previously started continuous acquisition.
|
void |
MicroscopeInternal.uninitializeMicroscope(int accessID)
Uninitializes the microscope.
|
void |
AvailableDeviceDriverInternal.unloadDevice(int accessID)
Unloads a previously loaded, but yet not initialized device.
|
void |
MicroscopeInternal.unlockExclusiveWrite(int accessID)
Unlocks the previously acquired lock.
|
Modifier and Type | Method and Description |
---|---|
Channel |
ChannelManager.addChannel(java.lang.String channelGroupID,
java.lang.String channelID)
Adds the channel in the given config group.
|
void |
Channel.addChannelOffSetting(DeviceSetting setting)
Adds a setting to the list of settings which get deactivated if this channel gets deactivated.
|
void |
Channel.addChannelOnSetting(DeviceSetting setting)
Adds a setting to the list of settings which get activated if this channel gets activated.
|
void |
MicroscopeConfiguration.addImageSynchronizationDevice(java.lang.String device)
Adds the given device to the list of image synchronization devices.
|
PixelSize |
PixelSizeManager.addPixelSize(java.lang.String pixelSizeID)
Adds a new pixel size setting with the given ID.
|
void |
PixelSize.addPixelSizeSetting(DeviceSetting setting)
Adds a setting to the list of settings.
|
void |
MicroscopeConfiguration.addSystemShutdownSetting(DeviceSetting setting)
Adds a setting to the list of settings which will be applied at shutdown.
|
void |
MicroscopeConfiguration.addSystemStartupSetting(DeviceSetting setting)
Adds a setting to the list of settings which will be applied at startup.
|
void |
Microscope.applyDeviceSetting(DeviceSetting setting)
Sets the given device property to the given value.
|
void |
Microscope.applyDeviceSettingAsync(DeviceSetting setting)
Sets the given device property to the given value.
|
void |
Microscope.applyDeviceSettings(DeviceSetting[] settings)
Sets the given device properties to the given values.
|
void |
Microscope.applyDeviceSettingsAsync(DeviceSetting[] settings)
Sets the given device properties to the given values.
|
java.awt.Dimension |
CameraDevice.getImageSize()
Returns the size (in pixels) of the images this camera produces.
|
void |
AvailableDeviceDriver.initializeDevice(DeviceSetting[] preInitSettings)
Initializes a previously loaded device.
|
boolean |
AvailableDeviceDriver.isSerialPortDriver()
Returns true if this driver communicates over a serial port.
|
java.lang.String |
Microscope.loadConfiguration(RMIReader configurationReader)
Initializes the microscope with the configuration read from the reader (e.g.
|
PreInitDeviceProperty[] |
AvailableDeviceDriver.loadDevice(java.lang.String deviceID)
Loads the specified device driver, but yet does not initialize it.
|
void |
Microscope.lockExclusiveWrite()
Locks the microscope for a longer time (e.g.
|
ImageEvent<?> |
CameraDevice.makeImage(java.lang.String channelGroupID,
java.lang.String channelID,
double exposure)
Makes an image with the given settings.
|
ImageEvent<?>[] |
CameraDevice.makeParallelImages(java.lang.String channelGroupID,
java.lang.String channelID,
java.lang.String[] cameraIDs,
double[] exposures)
Deprecated.
|
void |
ChannelManager.removeChannel(java.lang.String channelGroupID,
java.lang.String channelID)
Removes the channel in the given channel group.
|
void |
DeviceLoader.removeDevice(java.lang.String name)
Removes a previously added device.
|
void |
MicroscopeConfiguration.removeImageSynchronizationDevice(java.lang.String device)
Removes the given device to the list of image synchronization devices.
|
void |
PixelSizeManager.removePixelSize(java.lang.String pixelSizeID)
Removes the pixel size setting with the given ID.
|
void |
AutoFocusDevice.runFullFocus()
Runs a full focus search.
|
void |
AutoFocusDevice.runIncrementalFocus()
Runs an incremental focus search.
|
void |
Microscope.saveConfiguration(RMIWriter configurationWriter)
Writes the current microscope configuration to the supplied writer (e.g.
|
void |
SerialDevice.sendCommand(java.lang.String command)
Sends a serial command to the corresponding port
|
void |
Microscope.setAutoFocusDevice(java.lang.String deviceID)
Sets the default auto-focus device.
|
void |
Microscope.setCameraDevice(java.lang.String cameraDevice)
Sets the current default camera device.
|
void |
Channel.setChannelOffSettings(DeviceSetting[] settings)
Sets all device settings which get set if this channel is deactivated.
|
void |
Channel.setChannelOnSettings(DeviceSetting[] settings)
Sets all device settings which get set if this channel is activated.
|
void |
Channel.setChannelTimeout(int timeOutInMillis)
Sets a timeout when changing the channel for synchronization
purposes.
|
void |
MicroscopeConfiguration.setCommunicationPingPeriod(int pingPeriod)
Sets the wait time used when pinging a device if a certain action is finished.
|
void |
MicroscopeConfiguration.setCommunicationTimeout(int timeout)
Sets the timeout between in the communication with the devices.
|
void |
AutoFocusDevice.setEnabled(boolean enable)
Enables or disables the auto-focus device.
|
void |
Device.setExplicitDelay(double delay)
Sets the explicit delay in ms.
|
void |
CameraDevice.setExposure(double exposure)
Sets the exposure for imaging.
|
void |
Microscope.setFocusDevice(java.lang.String deviceID)
Sets the default focus device.
|
void |
FocusDevice.setFocusPosition(double position)
Sets the position of the current focus device.
|
void |
MicroscopeConfiguration.setImageBufferSize(int sizeMB)
Sets the size of an internally used image buffer.
|
void |
MicroscopeConfiguration.setImageSynchronizationDevices(java.lang.String[] devices)
Sets the devices for which the microscope waits before an image is made.
|
void |
AutoFocusDevice.setOffset(double offset)
Sets the current offset.
|
void |
ShutterDevice.setOpen(boolean open)
Opens (open == true) or closes (open == false) the shutter.
|
void |
PixelSize.setPixelSize(double pixelSize)
Sets the pixel size in micro meters.
|
void |
PixelSize.setPixelSizeSettings(DeviceSetting[] newSettings)
Sets all device settings corresponding to this pixel size.
|
void |
StageDevice.setPosition(double x,
double y)
Sets the absolute position of the stage.
|
void |
FocusDevice.setRelativeFocusPosition(double offset)
Sets the position of the current focus device relative to the current
focus.
|
void |
StageDevice.setRelativePosition(double dx,
double dy)
Sets the position of the stage relative to the current position.
|
void |
Channel.setShutter(java.lang.String deviceID)
Sets the shutter device of this channel.
|
void |
Microscope.setShutterDevice(java.lang.String deviceID)
Sets the default shutter device.
|
void |
Microscope.setStageDevice(java.lang.String deviceID)
Sets the default stage device.
|
void |
StateDevice.setState(int state)
Sets the current state.
|
void |
StateDevice.setState(java.lang.String label)
Sets the current state.
|
void |
StateDevice.setStateLabel(int state,
java.lang.String label)
Sets the label for the given state.
|
void |
StateDevice.setStateLabels(java.lang.String[] labels)
Sets all state labels.
|
void |
CameraDevice.setSwitchXY(boolean switchXY)
Sets if the x and the y direction should be switched for images made by this camera.
|
void |
MicroscopeConfiguration.setSystemShutdownSettings(DeviceSetting[] settings)
Set the setting which will be applied at shutdown.
|
void |
MicroscopeConfiguration.setSystemStartupSettings(DeviceSetting[] settings)
Set the setting which will be applied at startup.
|
void |
StageDevice.setTransposeX(boolean transpose)
Sets if the x-direction should be transposed.
|
void |
CameraDevice.setTransposeX(boolean transpose)
Sets if the x-direction of images made by this camera should be transposed.
|
void |
StageDevice.setTransposeY(boolean transpose)
Sets if the y-direction should be transposed.
|
void |
CameraDevice.setTransposeY(boolean transpose)
Sets if the y-direction of images made by this camera should be transposed.
|
void |
StageDevice.setUnitMagnifier(double unitMagnifier)
Sets the magnification factor from native stage device units to micro meters:
microMeters = units * unitMagnifier
|
void |
FloatProperty.setValue(float value)
Sets the current value of the property.
|
void |
IntegerProperty.setValue(int value)
Sets the current value of the property.
|
void |
StringProperty.setValue(java.lang.String value) |
void |
Property.setValue(java.lang.String value)
Sets the current value of the property.
|
void |
FloatProperty.setValueRelative(float offset)
Sets the value of the microscope relative to its current value.
|
void |
IntegerProperty.setValueRelative(int offset)
Sets the value of the microscope relative to its current value.
|
void |
CameraDevice.startContinuousSequenceAcquisition(java.lang.String channelGroupID,
java.lang.String channelID,
double exposure,
ImageListener listener)
Starts a continuous sequence acquisition.
|
void |
CameraDevice.stopContinuousSequenceAcquisition()
Stops the previously started continuous acquisition.
|
void |
Microscope.uninitializeMicroscope()
Uninitializes the microscope.
|
void |
AvailableDeviceDriver.unloadDevice()
Unloads a previously loaded, but yet not initialized device.
|
void |
Microscope.unlockExclusiveWrite()
Unlocks the previously acquired lock.
|
Modifier and Type | Method and Description |
---|---|
void |
SerialDeviceImpl.sendCommand(java.lang.String command,
int accessID)
Sends a serial command to the corresponding port
|
void |
FocusDeviceImpl.setFocusPosition(double position,
int accessID) |
void |
FocusDeviceImpl.setRelativeFocusPosition(double offset,
int accessID) |
protected void |
PropertyImpl.setStringValue(java.lang.String value,
int accessID) |
abstract void |
PropertyImpl.setValue(java.lang.String value,
int accessID) |
Modifier and Type | Method and Description |
---|---|
void |
AvailableDeviceDriverRMI.initializeDevice(DeviceSetting[] preInitSettings) |
boolean |
AvailableDeviceDriverRMI.isSerialPortDriver() |
PreInitDeviceProperty[] |
AvailableDeviceDriverRMI.loadDevice(java.lang.String deviceID) |
void |
AvailableDeviceDriverRMI.unloadDevice() |