org.youscope.addon.microscopeaccess

Interface CameraDeviceInternal

All Superinterfaces:

DeviceInternal

public interface CameraDeviceInternal
extends DeviceInternal

Internal interface used to control a camera.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
java.awt.Dimension	getImageSize(int accessID) 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(ChannelInternal channel, double exposure, int accessID) Makes an image with the given settings.
ImageEvent<?>[]	makeParallelImages(ChannelInternal channel, java.lang.String[] cameraIDs, double[] exposures, int accessID) Deprecated.
void	setExposure(double exposure, int accessID) Sets the exposure for imaging.
void	setSwitchXY(boolean switchXY, int accessID) Sets if the x and the y direction should be switched for images made by this camera.
void	setTransposeX(boolean transpose, int accessID) Sets if the x-direction of images made by this camera should be transposed.
void	setTransposeY(boolean transpose, int accessID) Sets if the y-direction of images made by this camera should be transposed.
void	startContinuousSequenceAcquisition(ChannelInternal channel, double exposure, ImageListener listener, int accessID) Starts a continuous sequence acquisition.
void	stopContinuousSequenceAcquisition(int accessID) Stops the previously started continuous acquisition.

Methods inherited from interface org.youscope.addon.microscopeaccess.DeviceInternal

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

Method Detail

setExposure

void setExposure(double exposure,
                 int accessID)
          throws MicroscopeLockedException,
                 MicroscopeException,
                 java.lang.InterruptedException

Sets the exposure for imaging.

Parameters:

exposure - The exposure in ms.

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

Throws:

MicroscopeLockedException

MicroscopeException

java.lang.InterruptedException

makeImage

ImageEvent<?> makeImage(ChannelInternal channel,
                        double exposure,
                        int accessID)
                 throws MicroscopeException,
                        MicroscopeLockedException,
                        java.lang.InterruptedException,
                        SettingException

Makes an image with the given settings.

Parameters:

channel - The channel in which it should be imaged, or null.

exposure - The exposure time 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 image which was taken.

Throws:

MicroscopeException

MicroscopeLockedException

java.lang.InterruptedException

SettingException

startContinuousSequenceAcquisition

void startContinuousSequenceAcquisition(ChannelInternal channel,
                                        double exposure,
                                        ImageListener listener,
                                        int accessID)
                                 throws MicroscopeException,
                                        MicroscopeLockedException,
                                        java.lang.InterruptedException,
                                        SettingException,
                                        DeviceException

Starts a continuous sequence acquisition. Due to implementation reasons, don't use this method if sequence acquisition should be started on multiple cameras in parallel, but use startParallelContinuousSequenceAcquisition.

Parameters:

channel - The channel in which it should be imaged, or null.

exposure - The exposure time in ms.

listener - Listener which receives all new images.

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

Throws:

MicroscopeException

MicroscopeLockedException

java.lang.InterruptedException

SettingException

DeviceException

stopContinuousSequenceAcquisition

void stopContinuousSequenceAcquisition(int accessID)
                                throws MicroscopeException,
                                       MicroscopeLockedException,
                                       java.lang.InterruptedException,
                                       SettingException,
                                       DeviceException

Stops the previously started continuous acquisition.

Parameters:

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

Throws:

MicroscopeException

MicroscopeLockedException

java.lang.InterruptedException

SettingException

DeviceException

setTransposeX

void setTransposeX(boolean transpose,
                   int accessID)
            throws MicroscopeLockedException

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

Parameters:

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

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

Throws:

MicroscopeLockedException

setTransposeY

void setTransposeY(boolean transpose,
                   int accessID)
            throws MicroscopeLockedException

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

Parameters:

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

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

Throws:

MicroscopeLockedException

setSwitchXY

void setSwitchXY(boolean switchXY,
                 int accessID)
          throws MicroscopeLockedException

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.

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

Throws:

MicroscopeLockedException

isTransposeX

boolean isTransposeX()

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

Returns:

True, if the x-direction is transposed.

isTransposeY

boolean isTransposeY()

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

Returns:

True, if the y-direction is transposed.

isSwitchXY

boolean isSwitchXY()

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.

getImageSize

java.awt.Dimension getImageSize(int accessID)
                         throws MicroscopeLockedException,
                                MicroscopeException

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

Parameters:

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

Returns:

Size of images in pixels.

Throws:

MicroscopeLockedException

MicroscopeException

makeParallelImages

@Deprecated
ImageEvent<?>[] makeParallelImages(ChannelInternal channel,
                                                java.lang.String[] cameraIDs,
                                                double[] exposures,
                                                int accessID)
                                         throws MicroscopeException,
                                                MicroscopeLockedException,
                                                java.lang.InterruptedException,
                                                SettingException,
                                                DeviceException

Deprecated.

Makes images with the given cameras in parallel.

Parameters:

channel - The channel in which it should be imaged, or null.

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