org.youscope.plugin.composedimaging

Interface ComposedImagingJob

All Superinterfaces:

Component, ImageProducer, Job, java.rmi.Remote

public interface ComposedImagingJob
extends Job, ImageProducer

Author:

langmo

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getCameras() Gets the cameras.
java.lang.String	getChannel() Gets the channel.
java.lang.String	getChannelGroup() Gets the channel group.
double	getDeltaX() Returns the distance between two horizontally attached sub-images.
double	getDeltaY() Returns the distance between two vertically attached sub-images.
double	getExposure() Gets the exposure.
double[]	getExposures() Gets the exposures of the initialized cameras.
java.awt.Dimension	getSubImageNumber() Returns the number of sub-images.
void	setCameras(java.lang.String[] cameras) Sets the cameras with which it should be imaged.
void	setChannel(java.lang.String deviceGroup, java.lang.String channel) Sets the channel.
void	setDeltaX(double deltaX) Sets the distance between two horizontally attached sub-images.
void	setDeltaY(double deltaY) Sets the distance between two vertically attached sub-images.
void	setExposure(double exposure) Sets the exposure.
void	setExposures(double[] exposures) Sets the exposures of the cameras.
void	setSubImageNumber(java.awt.Dimension imageNumbers) Sets the number of sub-images

Methods inherited from interface org.youscope.common.job.Job

addJobListener, executeJob, initializeJob, removeJobListener, uninitializeJob

Methods inherited from interface org.youscope.common.Component

addMessageListener, getName, getPositionInformation, getUUID, removeMessageListener, setName

Methods inherited from interface org.youscope.common.image.ImageProducer

addImageListener, getImageDescription, getNumberOfImages, removeImageListener

Method Detail

setChannel

void setChannel(java.lang.String deviceGroup,
                java.lang.String channel)
         throws java.rmi.RemoteException,
                MeasurementRunningException

Sets the channel.

Parameters:

deviceGroup - The device group where the channel is defined.

channel - The channel.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getChannel

java.lang.String getChannel()
                     throws java.rmi.RemoteException

Gets the channel.

Returns:

The channel.

Throws:

java.rmi.RemoteException

getChannelGroup

java.lang.String getChannelGroup()
                          throws java.rmi.RemoteException

Gets the channel group.

Returns:

The channel group.

Throws:

java.rmi.RemoteException

setExposure

void setExposure(double exposure)
          throws java.rmi.RemoteException,
                 MeasurementRunningException

Sets the exposure. If more than one camera is initialized, it sets the exposure of all cameras. Set to -1 if exposure should not be set.

Parameters:

exposure - The exposure.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getExposure

double getExposure()
            throws java.rmi.RemoteException

Gets the exposure. If more than one camera is initialized, returns the exposure of the first camera.

Returns:

The exposure.

Throws:

java.rmi.RemoteException

setExposures

void setExposures(double[] exposures)
           throws java.rmi.RemoteException,
                  MeasurementRunningException,
                  java.lang.IllegalArgumentException

Sets the exposures of the cameras. Should have the same size as cameras, otherwise an exception is thrown. Each element can be set to -1 to not set the exposure for the given camera.

Parameters:

exposures - The exposures.

Throws:

java.rmi.RemoteException

MeasurementRunningException

java.lang.IllegalArgumentException - Thrown if number of elements in exposure array is unequal to the number of cameras.

getExposures

double[] getExposures()
               throws java.rmi.RemoteException

Gets the exposures of the initialized cameras.

Returns:

The exposures.

Throws:

java.rmi.RemoteException

setCameras

void setCameras(java.lang.String[] cameras)
         throws java.rmi.RemoteException,
                MeasurementRunningException

Sets the cameras with which it should be imaged. If set to null, the default (currently initialized) camera is used. Each camera should only appear ones in the array. One element of the array can be NULL, such that the default camera is used.

Parameters:

cameras - Device names of the cameras

Throws:

java.rmi.RemoteException

MeasurementRunningException

getCameras

java.lang.String[] getCameras()
                       throws java.rmi.RemoteException

Gets the cameras.

Returns:

The cameras.

Throws:

java.rmi.RemoteException

getDeltaX

double getDeltaX()
          throws java.rmi.RemoteException

Returns the distance between two horizontally attached sub-images.

Returns:

distance in micro meter.

Throws:

java.rmi.RemoteException

setDeltaX

void setDeltaX(double deltaX)
        throws java.rmi.RemoteException,
               MeasurementRunningException

Sets the distance between two horizontally attached sub-images.

Parameters:

deltaX - Distance in micro meter.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getDeltaY

double getDeltaY()
          throws java.rmi.RemoteException

Returns the distance between two vertically attached sub-images.

Returns:

distance in micro meter.

Throws:

java.rmi.RemoteException

setDeltaY

void setDeltaY(double deltaY)
        throws java.rmi.RemoteException,
               MeasurementRunningException

Sets the distance between two vertically attached sub-images.

Parameters:

deltaY - Distance in micro meter.

Throws:

java.rmi.RemoteException

MeasurementRunningException

getSubImageNumber

java.awt.Dimension getSubImageNumber()
                              throws java.rmi.RemoteException

Returns the number of sub-images.

Returns:

Number of sub-images

Throws:

java.rmi.RemoteException

setSubImageNumber

void setSubImageNumber(java.awt.Dimension imageNumbers)
                throws java.rmi.RemoteException,
                       MeasurementRunningException

Sets the number of sub-images

Parameters:

imageNumbers - Number of sub-images.

Throws:

java.rmi.RemoteException

MeasurementRunningException