DESY ACOP Beans Home

de.desy.acop.video.analysis
Class AImage

java.lang.Object
  de.desy.tine.structUtils.TTaggedStructure
      de.desy.acop.video.analysis.AImage

All Implemented Interfaces:

java.lang.Cloneable

public class AImage
extends de.desy.tine.structUtils.TTaggedStructure

AImage is the object that is transferred across the system from the video analysis server to the video client. This object carries with it the raw tine IMAGE and analysis results and parameters. For details on parameters see the constructor documentation.

Author:

Jaka Bobnar

Constructor Summary

AImage()
Constructs a new AImage, with default values (empty image and 0 value parameters and results).

AImage(AImage image)
Constructs a new AImage from the given AImage.

AImage(de.desy.tine.types.IMAGE image, int roiX, int roiY, int roiW, int roiH, int roi2X, int roi2Y, int roi2W, int roi2H, double threshold, double[] sideViewX, double meanX, double stdX, double sideAmplitudeX, double sideConstX, double meanXFit, double stdXFit, double sideAmplitudeXFit, double sideConstXFit, double slopeXFit, double[] sideViewY, double meanY, double stdY, double sideAmplitudeY, double sideConstY, double meanYFit, double stdYFit, double sideAmplitudeYFit, double sideConstYFit, double slopeYFit, double stdA, double stdB, double angle2D, double amplitude2D, double const2D, int thresholdPoints, boolean calculateThreshold, boolean performFit, boolean performSmoothing)
Constructs a new AImage.

Method Summary

double	getAmplitude2D() Returns the maximum amplitude of pixel value (as returned by ColorDecoder assigned to this AnalyzedImage) across the entire image.
double	getAmplitudeXFit() Returns the fitted amplitude in x axis.
double	getAmplitudeYFit() Returns the fitted amplitude in y axis.
double	getAngle2D() Returns the angle of rotation of the 2-dimensional intensity profile around its center (the angle between x and a and y and b axes).
double	getConst2D() Returns the minimum pixel value (as returned by ColorDecoder assigned to this AnalyzedImage) across the entire image.
double	getConstXFit() Returns the fitted constant in x axis.
double	getConstYFit() Returns the fitted constant in y axis.
de.desy.tine.types.IMAGE	getImage() Returns the image which was analyzed.
int	getImageH() The height of the image.
int	getImageW() The width of the image.
double	getMeanX() Returns the mean value of the side view projection of the image on the x axis.
double	getMeanXFit() Returns the fitted mean value in x axis.
double	getMeanY() Returns the mean value of the side view projection of the image on the y axis.
double	getMeanYFit() Returns the fitted mean value in y axis.
int	getRoi2H() The height of the second region of interest.
int	getRoi2W() The width of the second region of interest.
int	getRoi2X() Left coordinate of the second region of interest.
int	getRoi2Y() Upper coordinate of the second region of interest.
int	getRoiH() The height of the region of interest.
int	getRoiW() The width of the region of interest.
int	getRoiX() Left coordinate of the region of interest.
int	getRoiY() Upper coordinate of the region of interest.
double	getSideViewAmplitudeX() Returns the amplitude (maximum minus minimum) value of the side view projection of the image on the x axis.
double	getSideViewAmplitudeY() Returns the amplitude (maximum minus minimum) value of the side view projection of the image on the y axis.
double	getSideViewConstX() Returns the constant (minimum) value of the side view projection of the image on the x axis.
double	getSideViewConstY() Returns the constant (minimum) value of the side view projection of the image on the y axis.
double[]	getSideViewX() Returns the array representing the side projection of the intensity image on the X axis.
double[]	getSideViewY() Returns the array representing the side projection of the intensity image on the Y axis.
double	getSlopeXFit() Returns the slope of the linear function in the fit.
double	getSlopeYFit() Returns the slope of the linear function in the fit.
double	getStdA() Returns the standard deviation of the 2-dimensional intensity image in the direction of the "a" axis of the profile (assuming an elliptical profile).
double	getStdB() Returns the standard deviation of the 2-dimensional intensity image in the direction of the "b" axis of the profile (assuming an elliptical profile).
double	getStdX() Returns the standard deviation of the side view projection of the image on the x axis.
double	getStdXFit() Returns the fitted std value in x axis.
double	getStdY() Returns the standard deviation of the side view projection of the image on the y axis.
double	getStdYFit() Returns the fitted std value in y axis.
double	getThreshold() The threshold value used for analysis of the image.
int	getThresholdPoints() Returns the number of points on which the threshold was calculated.
boolean	isCalculateThreshold() Returns true if the calculation of threshold was automatic or false if threshold was user defined.
boolean	isPerformFit() Returns true if the fitting algorithm was used during analysis.
boolean	isPerformSmoothing() Returns true if the smoothing algorithm was used during analysis.

Methods inherited from class de.desy.tine.structUtils.TTaggedStructure

addField, addField, addField, addField, addField, addField, addField, addField, addField, addField, addField, addField, addField, clone, getByteArray, getName, getSizeInBytes, initDone, toByteArray, toString, toStruct

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AImage

public AImage()

Constructs a new AImage, with default values (empty image and 0 value parameters and results).

AImage

public AImage(AImage image)

Constructs a new AImage from the given AImage. This method creates a clone of the given image.

Parameters:

image - the image

AImage

public AImage(de.desy.tine.types.IMAGE image,
              int roiX,
              int roiY,
              int roiW,
              int roiH,
              int roi2X,
              int roi2Y,
              int roi2W,
              int roi2H,
              double threshold,
              double[] sideViewX,
              double meanX,
              double stdX,
              double sideAmplitudeX,
              double sideConstX,
              double meanXFit,
              double stdXFit,
              double sideAmplitudeXFit,
              double sideConstXFit,
              double slopeXFit,
              double[] sideViewY,
              double meanY,
              double stdY,
              double sideAmplitudeY,
              double sideConstY,
              double meanYFit,
              double stdYFit,
              double sideAmplitudeYFit,
              double sideConstYFit,
              double slopeYFit,
              double stdA,
              double stdB,
              double angle2D,
              double amplitude2D,
              double const2D,
              int thresholdPoints,
              boolean calculateThreshold,
              boolean performFit,
              boolean performSmoothing)

Constructs a new AImage.

Parameters:

image - the raw image, which was analyzed and all data was obtained from

roiX - the region of interest right coordinate (image is analyzed inside region of interest)

roiY - the region of interest upper coordinate (image is analyzed inside region of interest)

roiW - the width of region of interest (image is analyzed inside region of interest)

roiH - the height of region of interest (image is analyzed inside region of interest)

roi2X - the region of interest used for automatic threshold calculation right coordinate

roi2Y - the region of interest used for automatic threshold calculation upper coordinate

roi2W - the region of interest used for automatic threshold calculation width

roi2H - the region of interest used for automatic threshold calculation height

threshold - the used threshold value (calculated or user defined)

sideViewX - horizontal side view values

meanX - horizontal statistical mean value

stdX - horizontal statistical standard deviation value

sideAmplitudeX - horizontal statistical amplitude value

sideConstX - horizontal statistical constant value

meanXFit - horizontal fitted mean value

stdXFit - horizontal fitted standard deviation value

sideAmplitudeXFit - horizontal fitted amplitude value

sideConstXFit - horizontal fitted constant value

slopeXFit - the slope of the linear function in the fit

sideViewY - vertical side view values

meanY - vertical statistical mean value

stdY - vertical statistical standard deviation value

sideAmplitudeY - vertical statistical amplitude value

sideConstY - vertical statistical constant value

meanYFit - vertical fitted mean value

stdYFit - vertical fitted standard deviation value

sideAmplitudeYFit - vertical fitted amplitude value

sideConstYFit - vertical fitted constant value

slopeYFit - the slope of the linear function in the fit

stdA - main 2D axis statistical standard deviation

stdB - secondary 2D axis statistical standard deviation

angle2D - the statistical rotation angle of the main axis according to x-y coordinate system

amplitude2D - the statistical 2D amplitude

const2D - the statistical 2D constant (minimum value)

thresholdPoints - the number of points on which the threshold was calculated

calculateThreshold - flag indicating if threshold calculation is automatic

performFit - flag indicating if fitting was performed (if false the 'fit' parameters are a-priori invalid)

performSmoothing - flag indicating if smoothing should be performed

Method Detail

getImage

public de.desy.tine.types.IMAGE getImage()

Returns the image which was analyzed.

Returns:

the original image

getImageW

public int getImageW()

The width of the image.

Returns:

the width

See Also:

#getImage()}

getImageH

public int getImageH()

The height of the image.

Returns:

the height

See Also:

#getImage()}

getRoiX

public int getRoiX()

Left coordinate of the region of interest.

Returns:

the left coordinate

getRoiY

public int getRoiY()

Upper coordinate of the region of interest.

Returns:

the upper coordinate

getRoiW

public int getRoiW()

The width of the region of interest.

Returns:

the width

getRoiH

public int getRoiH()

The height of the region of interest.

Returns:

the height

getRoi2X

public int getRoi2X()

Left coordinate of the second region of interest.

Returns:

the left coordinate

getRoi2Y

public int getRoi2Y()

Upper coordinate of the second region of interest.

Returns:

the upper coordinate

getRoi2W

public int getRoi2W()

The width of the second region of interest.

Returns:

the width

getRoi2H

public int getRoi2H()

The height of the second region of interest.

Returns:

the height

getThreshold

public double getThreshold()

The threshold value used for analysis of the image.

Returns:

the threshold value

getStdA

public double getStdA()

Returns the standard deviation of the 2-dimensional intensity image in the direction of the "a" axis of the profile (assuming an elliptical profile).

Returns:

the standard deviation in a direction

See Also:

#getImage()}

getStdB

public double getStdB()

Returns the standard deviation of the 2-dimensional intensity image in the direction of the "b" axis of the profile (assuming an elliptical profile).

Returns:

the standard deviation in b direction

See Also:

#getImage()}

getAmplitude2D

public double getAmplitude2D()

Returns the maximum amplitude of pixel value (as returned by ColorDecoder assigned to this AnalyzedImage) across the entire image. Maximum pixel value is amplitude2D plus const2D.

Returns:

the amplitude

See Also:

#getImage()}

getAngle2D

public double getAngle2D()

Returns the angle of rotation of the 2-dimensional intensity profile around its center (the angle between x and a and y and b axes).

Returns:

the angle of rotation of the 2-dimensional intensity profile

See Also:

#getImage()}

getConst2D

public double getConst2D()

Returns the minimum pixel value (as returned by ColorDecoder assigned to this AnalyzedImage) across the entire image. This value indicates the background level of the image.

Returns:

the constant value of the intensity profile

See Also:

#getImage()}

getSideViewX

public double[] getSideViewX()

Returns the array representing the side projection of the intensity image on the X axis.

Returns:

the projection on the x axis

See Also:

#getImage()}

getSideViewY

public double[] getSideViewY()

Returns the array representing the side projection of the intensity image on the Y axis.

Returns:

the projection on the y axis

See Also:

#getImage()}

getStdX

public double getStdX()

Returns the standard deviation of the side view projection of the image on the x axis. This is calculated from the values returned by the getSideViewX().

Returns:

the standard deviation

getStdY

public double getStdY()

Returns the standard deviation of the side view projection of the image on the y axis. This is calculated from the values returned by the getSideViewY().

Returns:

the standard deviation

getMeanX

public double getMeanX()

Returns the mean value of the side view projection of the image on the x axis. This is calculated from the values returned by the getSideViewX().

Returns:

the mean value

getMeanY

public double getMeanY()

Returns the mean value of the side view projection of the image on the y axis. This is calculated from the values returned by the getSideViewY().

Returns:

the mean value

getSideViewAmplitudeX

public double getSideViewAmplitudeX()

Returns the amplitude (maximum minus minimum) value of the side view projection of the image on the x axis. This is calculated from the values returned by the getSideViewX().

Returns:

the amplitude

getSideViewAmplitudeY

public double getSideViewAmplitudeY()

Returns the amplitude (maximum minus minimum) value of the side view projection of the image on the y axis. This is calculated from the values returned by the getSideViewY().

Returns:

the amplitude

getSideViewConstX

public double getSideViewConstX()

Returns the constant (minimum) value of the side view projection of the image on the x axis. This is calculated from the values returned by the getSideViewX().

Returns:

the constant

getSideViewConstY

public double getSideViewConstY()

Returns the constant (minimum) value of the side view projection of the image on the y axis. This is calculated from the values returned by the getSideViewY().

Returns:

the constant

isCalculateThreshold

public boolean isCalculateThreshold()

Returns true if the calculation of threshold was automatic or false if threshold was user defined.

Returns:

true if calculation of threshold is automatic

isPerformFit

public boolean isPerformFit()

Returns true if the fitting algorithm was used during analysis.

Returns:

true if fitting was performed

isPerformSmoothing

public boolean isPerformSmoothing()

Returns true if the smoothing algorithm was used during analysis.

Returns:

true if fitting was performed

getAmplitudeXFit

public double getAmplitudeXFit()

Returns the fitted amplitude in x axis.

Returns:

getConstXFit

public double getConstXFit()

Returns the fitted constant in x axis.

Returns:

getMeanXFit

public double getMeanXFit()

Returns the fitted mean value in x axis.

Returns:

getStdXFit

public double getStdXFit()

Returns the fitted std value in x axis.

Returns:

getAmplitudeYFit

public double getAmplitudeYFit()

Returns the fitted amplitude in y axis.

Returns:

getSlopeXFit

public double getSlopeXFit()

Returns the slope of the linear function in the fit.

Returns:

the slope

getConstYFit

public double getConstYFit()

Returns the fitted constant in y axis.

Returns:

getMeanYFit

public double getMeanYFit()

Returns the fitted mean value in y axis.

Returns:

getStdYFit

public double getStdYFit()

Returns the fitted std value in y axis.

Returns:

getSlopeYFit

public double getSlopeYFit()

Returns the slope of the linear function in the fit.

Returns:

getThresholdPoints

public int getThresholdPoints()

Returns the number of points on which the threshold was calculated.

Returns:

the number of points threshold was calculated on