TANGO
Device Server


Image Analyzer
Device Attributes Description

ImgBeamAnalyzer Class

Revision: release_3_1_2 - Author: julien_malik

Scalar Attributes
Attribute name
Data Type
R/W Type
Expert
EnableImageStats: enables the computation of image moments (centroid, variance, skew) and maximal intensity
DEV_BOOLEAN
READ_WRITE
No
EnableProfiles: enables the computation of the X and Y profiles, and the corresponding gaussian fit
DEV_BOOLEAN
READ_WRITE
No
EnableHistogram: enables the computation of the histogram of the image
DEV_BOOLEAN
READ_WRITE
No
EnableUserROI: enables the use of the UserROIOriginX, UserROIOriginY, UserROIWidth, UserROIHeight to define the ROI that will be processed
DEV_BOOLEAN
READ_WRITE
No
EnableAutoROI: if true, the ROI is detected automatically to encompass the biggest particle in the image
DEV_BOOLEAN
READ_WRITE
No
Enable2DGaussianFit: enables the 2D gaussian fitting
DEV_BOOLEAN
READ_WRITE
No
ComputationPeriod: period in millisecond at which a new image is read and processed
DEV_LONG
READ_WRITE
No
EstimComputTime: time spent, in ms, to process the image
DEV_LONG
READ
No
Rotation: the rotation applied in preprocessing. only multiple of 90 are recognized as valid values
DEV_LONG
READ_WRITE
No
HorizontalFlip: if true, the image is flipped horizontally in preprocessing, after having been rotated
DEV_BOOLEAN
READ_WRITE
No
BitsPerPixel: the pixel depth for significative information in the image (usually 8 or 10). it is used only in the gamma correction to keep a constant dynamic range of pixel values when raising these values to a power
DEV_LONG
READ_WRITE
No
HistogramNbBins: the number of bins in the histogram. if set to 0, the maximum possible number of bins is used
DEV_LONG
READ_WRITE
No
HistogramRangeMin: the lower bound of the histogram bins. must be >= 0
DEV_LONG
READ_WRITE
No
HistogramRangeMax: the upper bound of the histogram bins. must be <= 2^BitsPerPixel - 1 if set to 0, the maximal possible value is taken (2^BitsPerPixel - 1)
DEV_LONG
READ_WRITE
No
GammaCorrection: the gamma value of the camera, used to correct the ROI image by raising to its inverse power
DEV_DOUBLE
READ_WRITE
No
AutoROIMagFactorX: the scaling factor in the X direction applied to the AutoROI
DEV_DOUBLE
READ_WRITE
No
AutoROIMagFactorY: the scaling factor in the Y direction applied to the AutoROI
DEV_DOUBLE
READ_WRITE
No
AutoROIThreshold: the threshold, used only if AutoROIMethod is set to THRESHOLD
DEV_LONG
READ_WRITE
No
BgSubstraction: the scalar value to substract to each pixel
DEV_DOUBLE
READ_WRITE
No
AlarmZone: if EnableAutoROI is set to true and if the distance between a beam box corner and the border of the image falls below this threshold, attributes quality are set to ALARM
DEV_LONG
READ_WRITE
No
PixelSizeX: the correspondence between pixel width and mm
DEV_DOUBLE
READ_WRITE
No
PixelSizeY: the correspondence between pixel height and mm
DEV_DOUBLE
READ_WRITE
No
OpticalMagnification: the magnification factor of the optical system (no unit)
DEV_DOUBLE
READ_WRITE
No
ProfileFitFixedBg: if true, the background noise is estimated from the border of the whole image and this background value stays fixed during the fit
DEV_BOOLEAN
READ_WRITE
No
LineProfileOriginX: the X coordinate of the origin point of the line profile
DEV_LONG
READ_WRITE
No
LineProfileOriginY: the Y coordinate of the origin point of the line profile
DEV_LONG
READ_WRITE
No
LineProfileEndX: the X coordinate of the endpoint of the line profile
DEV_LONG
READ_WRITE
No
LineProfileEndY: the Y coordinate of the endpoint of the line profile
DEV_LONG
READ_WRITE
No
LineProfileThickness: defines the number of lines used to average a local line profile
DEV_LONG
READ_WRITE
No
UserROIOriginX: the X coordinate of the origin of the ROI (up-left corner) in pixels
DEV_LONG
READ_WRITE
No
UserROIOriginY: the Y coordinate of the origin of the ROI (up-left corner)
DEV_LONG
READ_WRITE
No
UserROIWidth: the width of the ROI in pixels
DEV_LONG
READ_WRITE
No
UserROIHeight: the height of the ROI in pixels
DEV_LONG
READ_WRITE
No
AutoROIFound: true if the AutoROI algorithm was used and did found a beam inside the image
DEV_BOOLEAN
READ
No
AutoROIOriginX: the X coordinate of the origin of the ROI (up-left corner) in pixels
DEV_LONG
READ
No
AutoROIOriginY: the Y coordinate of the origin of the ROI (up-left corner) in pixels
DEV_LONG
READ
No
AutoROIWidth: the width of the automatically detected ROI
DEV_LONG
READ
No
AutoROIHeight: the height of the automatically detected ROI
DEV_LONG
READ
No
MaxIntensity: the maximal intensity inside the ROI
DEV_DOUBLE
READ
No
MeanIntensity: the mean intensity inside the ROI
DEV_DOUBLE
READ
No
CentroidX: the X coordinate of the centroid
DEV_DOUBLE
READ
No
CentroidY: the Y coordinate of the centroid
DEV_DOUBLE
READ
No
VarianceX: the variance along the X axis
DEV_DOUBLE
READ
No
VarianceY: the variance along the Y axis
DEV_DOUBLE
READ
No
CovarianceXY: the covariance with respect to the X and Y axis
DEV_DOUBLE
READ
No
CorrelationXY: the correlation coefficient between the X and Y axises
DEV_DOUBLE
READ
No
SkewX: the skew along the X axis
DEV_DOUBLE
READ
No
SkewY: the skew along the Y axis
DEV_DOUBLE
READ
No
SkewX2Y: the skew cross coefficient for X�.Y
DEV_DOUBLE
READ
No
SkewXY2: the skew cross coefficient for X.Y�
DEV_DOUBLE
READ
No
XProjFitConverged: true of the projection fitting algorithm has converged
DEV_BOOLEAN
READ
No
XProjFitCenter: the X position of the center of the fitted gaussian corresponding to the X projection
DEV_DOUBLE
READ
No
XProjFitMag: the magnitude of fitted gaussian corresponding to the X projection
DEV_DOUBLE
READ
No
XProjFitSigma: the standard deviation of fitted gaussian corresponding to the X projection
DEV_DOUBLE
READ
No
XProjFitFWHM: the full width at half maximum of the fitted gaussian corresponding to the X projection, calculated as approximately 2.35 * XProjFitSigma
DEV_DOUBLE
READ
No
XProjFitBG: the background of fitted gaussian corresponding to the X projection
DEV_DOUBLE
READ
No
XProjFitChi2: the chi-2 of fitted gaussian corresponding to the X projection
DEV_DOUBLE
READ
No
YProjFitConverged: true of the projection fitting algorithm has converged
DEV_BOOLEAN
READ
No
YProjFitCenter: the Y position of the center of the fitted gaussian corresponding to the Y projection
DEV_DOUBLE
READ
No
YProjFitMag: the magnitude of fitted gaussian corresponding to the Y projection
DEV_DOUBLE
READ
No
YProjFitSigma: the standard deviation of fitted gaussian corresponding to the Y projection
DEV_DOUBLE
READ
No
YProjFitFWHM: the full width at half maximum of the fitted gaussian corresponding to the Y projection, calculated approximately as 2.35 * YProjFitSigma
DEV_DOUBLE
READ
No
YProjFitBG: the background of fitted gaussian corresponding to the Y projection
DEV_DOUBLE
READ
No
YProjFitChi2: the chi-2 of fitted gaussian corresponding to the Y projection
DEV_DOUBLE
READ
No
LineProfileFitConverged: true of the profile fitting algorithm has converged
DEV_BOOLEAN
READ
No
LineProfileFitCenter: the Y position of the center of the fitted gaussian corresponding to the line profile
DEV_DOUBLE
READ
No
LineProfileFitMag: the magnitude of fitted gaussian corresponding to the line profile
DEV_DOUBLE
READ
No
LineProfileFitSigma: the standard deviation of fitted gaussian corresponding to the line profile
DEV_DOUBLE
READ
No
LineProfileFitFWHM: the full width at half maximum of the fitted gaussian corresponding to the line profile, calculated approximately as 2.35 * LineProfileFitSigma
DEV_DOUBLE
READ
No
LineProfileFitBG: the background of fitted gaussian corresponding to the line profile
DEV_DOUBLE
READ
No
LineProfileFitChi2: the chi-2 of fitted gaussian corresponding to the line profile
DEV_DOUBLE
READ
No
GaussianFitConverged: true of the 2D gaussian fitting algorithm has converged
DEV_BOOLEAN
READ
No
GaussianFitMagnitude: the magnitude of the fitted gaussian
DEV_DOUBLE
READ
No
GaussianFitCenterX: the X coordinate of the centroid of the 2D gaussian fitted to the image
DEV_DOUBLE
READ
No
GaussianFitCenterY: the Y coordinate of the centroid of the 2D gaussian fitted to the image
DEV_DOUBLE
READ
No
GaussianFitVarianceX: the variance of the 2D gaussian along the X axis
DEV_DOUBLE
READ
No
GaussianFitVarianceY: the variance of the 2D gaussian along the Y axis
DEV_DOUBLE
READ
No
GaussianFitCovarianceXY: the covariance of the 2D gaussian
DEV_DOUBLE
READ
No
GaussianFitMajorAxisFWHM: the FWHM along the major axis of the fitted gaussian, calculated approximately as 2.35 * sqrt(GaussianFitVarianceX)
DEV_DOUBLE
READ
No
GaussianFitMinorAxisFWHM: the FWHM along the minor axis of the fitted gaussian, calculated approximately as 2.35 * sqrt(GaussianFitVarianceY)
DEV_DOUBLE
READ
No
GaussianFitTilt: the angle made by the major axis of the gaussian and the X axis
DEV_DOUBLE
READ
No
GaussianFitBG: the background of the fitted gaussian
DEV_DOUBLE
READ
No
GaussianFitChi2: the chi-2 of the fitted gaussian
DEV_DOUBLE
READ
No
Fit1DNbIterMax: the maximal number of iteration to converge to a solution
DEV_LONG
READ_WRITE
Yes
Fit1DMaxRelChange: optimization stops when the relative change between 2 iterations falls below this threshold
DEV_DOUBLE
READ_WRITE
Yes
Fit2DNbIterMax: the maximal number of iteration to converge to a solution
DEV_LONG
READ_WRITE
Yes
Fit2DMaxRelChange: optimization stops when the relative change between 2 iterations falls below this threshold
DEV_DOUBLE
READ_WRITE
Yes
XProjFitNbIter: the number of iterations needed to converge to the fitted profile
DEV_LONG
READ
Yes
XProjFitRelChange: the relative change in the fit parameters between the two last iterations
DEV_DOUBLE
READ
Yes
YProjFitNbIter: the number of iterations needed to converge to the fitted profile
DEV_LONG
READ
Yes
YProjFitRelChange: the relative change in the fit parameters between the two last iterations
DEV_DOUBLE
READ
Yes
LineProfileFitNbIter: the number of iterations needed to converge to the fitted profile
DEV_LONG
READ
Yes
LineProfileFitRelChange: the relative change in the fit parameters between the two last iterations
DEV_DOUBLE
READ
Yes
GaussianFitNbIter: the number of iterations needed to converge to the fitted image
DEV_LONG
READ
Yes
GaussianFitRelChange: the relative change in the fit parameters between the two last iterations
DEV_DOUBLE
READ
Yes





Spectrum Attributes
Attribute name
Data Type
X Data Length
Expert
XProj: the mean value along the X axis
DEV_DOUBLE
131072
No
XProjFitted: the gaussian fit result of XProj
DEV_DOUBLE
131072
Yes
XProjError: the fitted profile error along the X axis
DEV_DOUBLE
131072
Yes
YProj: the mean value along the Y axis
DEV_DOUBLE
131072
No
YProjFitted: the gaussian fit result of XProj
DEV_DOUBLE
131072
Yes
YProjError: the fitted profile error along the Y axis
DEV_DOUBLE
131072
Yes
LineProfile: the line profile values
DEV_DOUBLE
131072
No
LineProfileFitted: the fitted line profile
DEV_DOUBLE
131072
Yes
LineProfileError: the fitted line profile error
DEV_DOUBLE
131072
Yes
Histogram
DEV_FLOAT
131072
No





Image Attributes
Attribute name
Data Type
X Data Length
Y Data Length
Expert
InputImage: raw copy of the input image
DEV_USHORT
131072
131072
No
ROIImage: the effective image on which are done all the calculation
DEV_USHORT
131072
131072
No
LineProfileHelperImg: the intermediate image used in the calculation of the Line Profile. this corresponds to the input rectangle defined by origin, end and thickness, affine transformed to fit in a rectangular image. The colums of this image are averaged to give the LineProfile attribute
DEV_FLOAT
131072
131072
Yes
GaussianFitParameterCovariance: the covariance matrix of the best fit parameters (7x7). the 7 parameters are ordered as [A, xc, yc, s_xx, s_xy, s_yy, b]
DEV_DOUBLE
7
7
Yes

ESRF - Software Engineering Group