org.youscope.common.microscope

Interface CameraDevice

All Superinterfaces:

Device, java.rmi.Remote

public interface CameraDevice
extends Device

Author:

langmo

Method Summary

Modifier and Type	Method and Description
java.awt.Dimension	getImageSize() Returns the size (in pixels) of the images this camera produces.
boolean	isSwitchXY() Returns if the x and the y direction should be switched for images made by this camera.
boolean	isTransposeX() Returns if the x-direction of images made by this camera should be transposed.
boolean	isTransposeY() Returns if the if the y-direction of images made by this camera should be transposed.
ImageEvent<?>	makeImage(java.lang.String channelGroupID, java.lang.String channelID, double exposure) Makes an image with the given settings.
ImageEvent<?>[]	makeParallelImages(java.lang.String channelGroupID, java.lang.String channelID, java.lang.String[] cameraIDs, double[] exposures) Deprecated.
void	setExposure(double exposure) Sets the exposure for imaging.
void	setSwitchXY(boolean switchXY) Sets if the x and the y direction should be switched for images made by this camera.
void	setTransposeX(boolean transpose) Sets if the x-direction of images made by this camera should be transposed.
void	setTransposeY(boolean transpose) Sets if the y-direction of images made by this camera should be transposed.
void	startContinuousSequenceAcquisition(java.lang.String channelGroupID, java.lang.String channelID, double exposure, ImageListener listener) Starts a continuous sequence acquisition.
void	stopContinuousSequenceAcquisition() Stops the previously started continuous acquisition.

Methods inherited from interface org.youscope.common.microscope.Device

getDeviceID, getDriverID, getEditableProperties, getExplicitDelay, getLibraryID, getProperties, getProperty, getType, setExplicitDelay, waitForDevice

Method Detail

setExposure

void setExposure(double exposure)
          throws MicroscopeLockedException,
                 MicroscopeException,
                 java.lang.InterruptedException,
                 java.rmi.RemoteException

Sets the exposure for imaging.

Parameters:

exposure - The exposure in ms.

Throws:

MicroscopeLockedException

MicroscopeException

java.lang.InterruptedException

java.rmi.RemoteException

makeImage

ImageEvent<?> makeImage(java.lang.String channelGroupID,
                        java.lang.String channelID,
                        double exposure)
                 throws MicroscopeException,
                        java.rmi.RemoteException,
                        MicroscopeLockedException,
                        java.lang.InterruptedException,
                        SettingException

Makes an image with the given settings.

Parameters:

channelGroupID - The ID of the channel group the channel is in.

channelID - The ID of the channel.

exposure - The exposure time in ms.

Returns:

the Image taken.

Throws:

MicroscopeException

java.rmi.RemoteException

MicroscopeLockedException

java.lang.InterruptedException

SettingException

startContinuousSequenceAcquisition

void startContinuousSequenceAcquisition(java.lang.String channelGroupID,
                                        java.lang.String channelID,
                                        double exposure,
                                        ImageListener listener)
                                 throws MicroscopeException,
                                        java.rmi.RemoteException,
                                        MicroscopeLockedException,
                                        java.lang.InterruptedException,
                                        SettingException,
                                        DeviceException

Starts a continuous sequence acquisition.

Parameters:

channelGroupID - The ID of the channel group the channel is in.

channelID - The ID of the channel.

exposure - The exposure time in ms.

listener - Listener which gets notified if a new image is made.

Throws:

MicroscopeException

java.rmi.RemoteException

MicroscopeLockedException

java.lang.InterruptedException

SettingException

DeviceException

makeParallelImages

@Deprecated
ImageEvent<?>[] makeParallelImages(java.lang.String channelGroupID,
                                                java.lang.String channelID,
                                                java.lang.String[] cameraIDs,
                                                double[] exposures)
                                         throws MicroscopeException,
                                                MicroscopeLockedException,
                                                java.lang.InterruptedException,
                                                SettingException,
                                                DeviceException,
                                                java.rmi.RemoteException

Deprecated.

Makes images with the given cameras in parallel.

Parameters:

channelGroupID - The ID of the channel group the channel is in.

channelID - The ID of the channel.

cameraIDs - Array of IDs of the cameras.

exposures - The exposure times of the cameras in ms.

accessID - The access ID of the current microscope object. If the microscope is locked with a different accessID, a MicroscopeLockedException is thrown.

Returns:

The images made with the cameras, in the same order as the camera IDs.

Throws:

MicroscopeException

MicroscopeLockedException

java.lang.InterruptedException

SettingException

DeviceException

java.rmi.RemoteException

stopContinuousSequenceAcquisition

void stopContinuousSequenceAcquisition()
                                throws MicroscopeException,
                                       MicroscopeLockedException,
                                       java.rmi.RemoteException,
                                       java.lang.InterruptedException,
                                       SettingException,
                                       DeviceException

Stops the previously started continuous acquisition.

Throws:

MicroscopeException

MicroscopeLockedException

java.rmi.RemoteException

java.lang.InterruptedException

SettingException

DeviceException

setTransposeX

void setTransposeX(boolean transpose)
            throws MicroscopeLockedException,
                   java.rmi.RemoteException

Sets if the x-direction of images made by this camera should be transposed.

Parameters:

transpose - True, if the x-direction should be transposed.

Throws:

MicroscopeLockedException

java.rmi.RemoteException

setTransposeY

void setTransposeY(boolean transpose)
            throws MicroscopeLockedException,
                   java.rmi.RemoteException

Sets if the y-direction of images made by this camera should be transposed.

Parameters:

transpose - True, if the y-direction should be transposed.

Throws:

MicroscopeLockedException

java.rmi.RemoteException

setSwitchXY

void setSwitchXY(boolean switchXY)
          throws MicroscopeLockedException,
                 java.rmi.RemoteException

Sets if the x and the y direction should be switched for images made by this camera.

Parameters:

switchXY - True, if the x and y direction should be switched.

Throws:

MicroscopeLockedException

java.rmi.RemoteException

isTransposeX

boolean isTransposeX()
              throws java.rmi.RemoteException

Returns if the x-direction of images made by this camera should be transposed.

Returns:

True, if the x-direction is transposed.

Throws:

java.rmi.RemoteException

isTransposeY

boolean isTransposeY()
              throws java.rmi.RemoteException

Returns if the if the y-direction of images made by this camera should be transposed.

Returns:

True, if the y-direction is transposed.

Throws:

java.rmi.RemoteException

isSwitchXY

boolean isSwitchXY()
            throws java.rmi.RemoteException

Returns if the x and the y direction should be switched for images made by this camera.

Returns:

True, if the x and y direction should be switched.

Throws:

java.rmi.RemoteException

getImageSize

java.awt.Dimension getImageSize()
                         throws java.rmi.RemoteException,
                                MicroscopeLockedException,
                                MicroscopeException

Returns the size (in pixels) of the images this camera produces.

Returns:

Size of images in pixels.

Throws:

java.rmi.RemoteException

MicroscopeLockedException

MicroscopeException