Skip to content
Snippets Groups Projects
Commit dbdd7438 authored by Ludmlila Klenov's avatar Ludmlila Klenov
Browse files

add device documentation

parent b242378c
Branches
No related tags found
No related merge requests found
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<Title> Tango Device Server User's Guide </Title>
</HEAD>
<BODY TEXT="#000000" BGCOLOR="#FFFFFF" LINK="#0000FF" VLINK="#7F00FF" ALINK="#FF0000">
<P><!-------TITLE------></P>
<TABLE BORDER="0" WIDTH="100%">
<TR>
<TD ALIGN="left">
<A HREF="http://www.esrf.fr/" TARGET=new>
<IMG SRC="http://www.esrf.fr/gifs/logo/80.gif" BORDER=0 Height="60"></A>
</Td>
<TD ALIGN="center">
<A HREF="http://www.elettra.trieste.it/" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/elettra_logo.gif" BORDER=0 Height="60"></A>
</Td>
<TD ALIGN="center">
<A HREF="http://www.synchrotron-soleil.fr/" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/soleil_logo.gif" BORDER=0 Height="60"></A>
</Td>
<TD ALIGN="right">
<A HREF="http://www.cells.es/" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/alba.jpg" BORDER=0 Height="54"></A>
</Td>
<TD ALIGN="right">
<A HREF="http://www.desy.de/html/home/index_eng.html" TARGET=new>
<IMG SRC="http://www.esrf.fr/computing/cs/tango/desy.gif" BORDER=0 Height="60"></A>
</Td>
<Td>
<H2><FONT COLOR="#7F00FF">
<Center><A HREF="http://www.tango-controls.org/" TARGET="_top">
TANGO </a> <Br> Device Server
</Center></FONT>
</Td>
</TR>
</TABLE>
<HR WIDTH="100%"></H5>
<Br>&nbsp;<Br><Br>&nbsp;<Br><Br>&nbsp;<Br><center><Table Border=2 Cellpadding=3 CELLSPACING=0 WIDTH="100%">
<Tr><Td><Br>&nbsp;<Br>
<center>
<h1>
DataFitter <Br>
User's Guide<Br>&nbsp;<Br> <Br><Br>
DataFitter Class<Br>&nbsp;<Br></Td></Tr>
</h1>
<Tr><Td>
<b><Center>Revision: - Author: buteau <Br>
Implemented in C++
</Center></b>
</Td></Tr>
</center>
</Table>
</center>
<Br>
<Br>
<Br>
<Br>
<Br>&nbsp;<Br><Br>&nbsp;<Br>
<h2>Introduction:</h2>
<ul>
<Br>
</ul>
<Br>
<Br>
<Br><h2>Class Identification:</h2>
<ul>
<li><b>Contact :</b> at synchrotron-soleil.fr - buteau
<li><b>Class Family :</b> Calculation
<li><b>Platform :</b> All Platforms
<li><b>Bus :</b> Not Applicable
</ul><Br>&nbsp;<Br><Br>
<h2>Class Inheritance:</h2>
<ul>
<li> <a href="http://www.esrf.fr/computing/cs/tango/tango_doc/kernel_doc/cpp_doc/"> Tango::Device_4Impl</a></li>
<ul>
<li> DataFitter</li>
</ul>
</ul>
</ul>
</ul>
<Br>&nbsp;<Br>
<Br>&nbsp;<Br><Br>&nbsp;<Br><h2>Properties:</h2>
<Center>
<Br> <Br> <Br>
<Table Border=2 Cellpadding=3 CELLSPACING=0 WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<Td COLSPAN=3> <Font Size=+2><Center><b>Device Properties</b></td></Font></Center>
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<Td><Center><b>Property name</b></td></Center>
<Td><Center><b>Property type</b></td></Center>
<Td><Center><b>Description</b></td></Center>
<Tr><Td><b><a href=#Dev_DefaultValues>DeviceAttributeNameX </a></b></Td>
<Td><Font Size=-1>Tango::DEV_STRING</Font></Td>
<Td><Font Size=-1>Path to the attribute X of the device providing the X values of the spectrum.</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>DeviceAttributeNameY </a></b></Td>
<Td><Font Size=-1>Tango::DEV_STRING</Font></Td>
<Td><Font Size=-1>Path to the attribute Y of the device providing the Y values of the spectrum.</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>DeviceAttributeNameSigma </a></b></Td>
<Td><Font Size=-1>Tango::DEV_STRING</Font></Td>
<Td><Font Size=-1>Path to the attribute Sigma of the device providing the Sigma values of the spectrum.</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>UseSigma </a></b></Td>
<Td><Font Size=-1>Tango::DEV_BOOLEAN</Font></Td>
<Td><Font Size=-1>This property indicate of sigma values are provided.</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>AutoSaveData </a></b></Td>
<Td><Font Size=-1>Tango::DEV_BOOLEAN</Font></Td>
<Td><Font Size=-1>This porperty is used to define if the experimental data and the fitted data
must be saved after each fit
If this property is set to : true, the properties :
FilePath (path to the directory to save the data)
ExperimentalDataFileName (filename for the experimental data file)
FittedDataFileName (filename for the fitted data file)
each filename will be postfixed by a number to avoid losing an old file</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>FilePath </a></b></Td>
<Td><Font Size=-1>Tango::DEV_STRING</Font></Td>
<Td><Font Size=-1>The path to the directory where to save the data</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>ExperimentalDataFileName </a></b></Td>
<Td><Font Size=-1>Tango::DEV_STRING</Font></Td>
<Td><Font Size=-1>The filename to use to save the experimental data
This filename will be postfixed by _number.txt</Font></Td></Tr>
<Tr><Td><b><a href=#Dev_DefaultValues>FittedDataFileName </a></b></Td>
<Td><Font Size=-1>Tango::DEV_STRING</Font></Td>
<Td><Font Size=-1>The filename to used to save the fitted data
This filename will be postfixed by _number.txt</Font></Td></Tr>
</Table>
</Center>
<Br><Br><Br>
<Br><Br><Br>
<A name=Dev_DefaultValues><!--- ---></a>
<Font Size=+1>Device Properties Default Values:</Font><Br>
<Table Border=2 Cellpadding=2 CELLSPACING=2>
<tr BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<Td><b>Property Name</b></td>
<td><b>Default Values</b></td>
</Tr>
<Tr>
<Td>DeviceAttributeNameX</Td>
<td>No default value</td>
</Tr>
<Tr>
<Td>DeviceAttributeNameY</Td>
<td>No default value</td>
</Tr>
<Tr>
<Td>DeviceAttributeNameSigma</Td>
<td>No default value</td>
</Tr>
<Tr>
<Td>UseSigma</Td>
<td>false</td>
</Tr>
<Tr>
<Td>AutoSaveData</Td>
<td>false</td>
</Tr>
<Tr>
<Td>FilePath</Td>
<td>No default value</td>
</Tr>
<Tr>
<Td>ExperimentalDataFileName</Td>
<td>No default value</td>
</Tr>
<Tr>
<Td>FittedDataFileName</Td>
<td>No default value</td>
</Tr>
</Table>
<Br><Br><Br>
<Center><b>
There is no Class properties.<Br><Br>
</Center></b>
<Br> <Br> <Br>
</center>
<Br>&nbsp;<Br><Br>&nbsp;<Br><h2>States:</h2>
<Center>
<Br> <Br> <Br>
<Table Border=2 Cellpadding=3 CELLSPACING=0 WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<Td COLSPAN=2> <Font Size=+2><Center><b>States</b></td></Font></Center>
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<Td><Center><b>Names</b></td></Center>
<Td><Center><b>Descriptions</b></td></Center>
<Tr><Td><b>ALARM</b></Td>
<Td><Font Size=-1>The fit may is probably not good.</Font></Td></Tr>
<Tr><Td><b>FAULT</b></Td>
<Td><Font Size=-1>Unable to at least reach one of the X, Y or Sigma proxies.</Font></Td></Tr>
<Tr><Td><b>STANDBY</b></Td>
<Td><Font Size=-1>The device is in standby state. This the normal state. The device is ready to accept
requests.</Font></Td></Tr>
</Table>
</Center>
</center>
<Br>&nbsp;<Br><Br>&nbsp;<Br><h2>Attributes:</h2>
<Br>
<Table Border=2 Cellpadding=3 CELLSPACING=0 WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<Td COLSPAN=4> <Font Size=+2><Center><b>Scalar Attributes</b></td></Font></Center>
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<Td><Center><b>Attribute name</b></td></Center>
<Td><Center><b>Data Type</b></td></Center>
<Td><Center><b>R/W Type</b></td></Center>
<Td><Center><b>Expert</b></td></Center>
<Tr><Td><b>deviceAttributeNameX</b>: <Font Size=-1> Name of the attribute which will be fitted by this DataFittingDevice. It may be : a) a fully qualified attribute name . For instance : - D13-1_C07/DT/IMAGEUR.1-ECR/PROFILX b) an alias (if defined in the TANGO Control System): PROFILX</Font></Td>
<Td><Center><Font Size=-1>DEV_STRING</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>Yes</Font></Center></Td></Tr>
<Tr><Td><b>deviceAttributeNameY</b>: <Font Size=-1> Name of the attribute which will be fitted by this DataFittingDevice. It may be : a) a fully qualified attribute name . For instance : - D13-1_C07/DT/IMAGEUR.1-ECR/PROFILY b) an alias (if defined in the TANGO Control System): PROFILY</Font></Td>
<Td><Center><Font Size=-1>DEV_STRING</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>Yes</Font></Center></Td></Tr>
<Tr><Td><b>deviceAttributeNameSigma</b>: <Font Size=-1> Name of the attribute which will be fitted by this DataFittingDevice. It may be : a) a fully qualified attribute name . For instance : - D13-1_C07/DT/IMAGEUR.1-ECR/PROFILSIGMA b) an alias (if defined in the TANGO Control System): PROFILSIGMA</Font></Td>
<Td><Center><Font Size=-1>DEV_STRING</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>Yes</Font></Center></Td></Tr>
<Tr><Td><b>useSigma</b>: <Font Size=-1>This attribute is used to know if error sigma values are provided to the fit. If false, all the values are set to 1.</Font></Td>
<Td><Center><Font Size=-1>DEV_BOOLEAN</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>nbData</b></Td>
<Td><Center><Font Size=-1>DEV_LONG</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>fittingFunctionType</b>: <Font Size=-1>Type of the function used for fitting (gaussian, lorenzian, sigmoid with or without background)</Font></Td>
<Td><Center><Font Size=-1>DEV_STRING</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>functionEquation</b>: <Font Size=-1>The equation of the fitting function choosen.</Font></Td>
<Td><Center><Font Size=-1>DEV_STRING</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>nbIterationMax</b>: <Font Size=-1>Number of maximum iteration for the fitting algorithm. If the algorithm doesn't go to a final solution after nbIterationMax it is stopped to avoid infinite loop.</Font></Td>
<Td><Center><Font Size=-1>DEV_LONG</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>epsilon</b>: <Font Size=-1>This value is the stopping value. When the difference between the values of two consecutives steps is under this value, the algorithm stop and succeed.</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>reverseY</b>: <Font Size=-1>hint given to the fitter which specifies that y-data is reversed regarding the expected shape (generally speaking, when the </Font></Td>
<Td><Center><Font Size=-1>DEV_BOOLEAN</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>startingX</b>: <Font Size=-1>Starting value for X to generate the fittedDataX spectrum values.</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>Yes</Font></Center></Td></Tr>
<Tr><Td><b>resolutionX</b>: <Font Size=-1>Resolution according the X axis to calculate the values of the dataFittedY spectrum.</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>Yes</Font></Center></Td></Tr>
<Tr><Td><b>nbPointsToGenerate</b>: <Font Size=-1>Number of points to generate for the fitted functions.</Font></Td>
<Td><Center><Font Size=-1>DEV_LONG</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>Yes</Font></Center></Td></Tr>
<Tr><Td><b>fitMode</b>: <Font Size=-1>0 : Automatic Mode (data are fitted continuously) 1: Manual Mode . You need to do the StartFit command to launch fit calculations</Font></Td>
<Td><Center><Font Size=-1>DEV_BOOLEAN</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>Yes</Font></Center></Td></Tr>
<Tr><Td><b>nbParameters</b>: <Font Size=-1>Number of parameters according the choosen fitting function.</Font></Td>
<Td><Center><Font Size=-1>DEV_LONG</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>initialsParametersMode</b>: <Font Size=-1>Set the mode for choosing the initials parameters. FALSE = Manual --> the initials parameters (initialParameterPos, initialParameterWidth, initialParameterHeight, initialParameterBackground) are used to initialize the algorithm. TRUE = Automatic --> initials values are choosen automatically by finding the max value in the Y. This value gives the height. The X value associated to this Y value gives the position. Width is taken at a value of 1.0 and background is given by the first Y value.</Font></Td>
<Td><Center><Font Size=-1>DEV_BOOLEAN</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>initialPosition</b>: <Font Size=-1>The initial value for the parameter position</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ_WRITE</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>initialWidth</b>: <Font Size=-1>The initial value for the parameter width</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ_WRITE</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>initialHeight</b>: <Font Size=-1>The initial value for the parameter height</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ_WRITE</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>initialBackground</b>: <Font Size=-1>The initial value for the parameter background</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ_WRITE</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>initialBackgroundA</b>: <Font Size=-1>The initial value of the parameter a where background = a*x+b </Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ_WRITE</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>initialBackgroundB</b>: <Font Size=-1>The initial value of the parameter b where background = a*x+b </Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ_WRITE</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>position</b>: <Font Size=-1>The value of the position of the curve fitted</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>width</b>: <Font Size=-1>The value of the width of the curve fitted</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>height</b>: <Font Size=-1>The value of the height of the curve fitted</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>background</b>: <Font Size=-1>The value of the background of the curve fitted</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>backgroundA</b>: <Font Size=-1>The value of the parameter a of the background = a*x+b of the curve fitted</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>backgroundB</b>: <Font Size=-1>The value of the parameter b of the background = a*x+b of the curve fitted</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>fittedDataSameSizeAsData</b>: <Font Size=-1>This attribute is used to indicate if the FittedData are of the same size as the experimental data. If TRUE the attribute startingX, resolutionX, nbPointToGenerate are not used and the startingX value used is the first X value of the experimental data, the number of points generated is the number of point of experimental data</Font></Td>
<Td><Center><Font Size=-1>DEV_BOOLEAN</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>Yes</Font></Center></Td></Tr>
<Tr><Td><b>hwhm</b>: <Font Size=-1>the half width at half medium</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>fwhm</b>: <Font Size=-1>the full width at half medium</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>nbIterations</b>: <Font Size=-1>Number of iteration for the algorithm to converge</Font></Td>
<Td><Center><Font Size=-1>DEV_LONG</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>searchStoppingMethod</b>: <Font Size=-1>This attribute is used to choose the search stopping method used : 1 : the test delta method 2 : the gradient method</Font></Td>
<Td><Center><Font Size=-1>DEV_LONG</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>Yes</Font></Center></Td></Tr>
<Tr><Td><b>useScaled</b>: <Font Size=-1>If true, the Jacobian matrix is scaled to avoid conditioning problem (must be always set to TRUE)</Font></Td>
<Td><Center><Font Size=-1>DEV_BOOLEAN</Font></Center></Td><Td><Center><Font Size=-1>WRITE</Font></Center></Td><Td><Center><Font Size=-1>Yes</Font></Center></Td></Tr>
<Tr><Td><b>xLow</b>: <Font Size=-1>The value of the xlow is equal to the intersection between the background and the tangente to the sigmoid. This attribute is only valid for sigmoid(b) fit.</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>xHigh</b>: <Font Size=-1>The value of the xhigh is equal to the intersection between the background+height and the tangente to the sigmoid. This attribute is only valid for sigmoid(b) fit.</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>determinationQualityFactor</b>: <Font Size=-1>Percentage of quality fit (represent a percentage of matching between experimental and fitted data)</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>fStatisticQualityFactor</b>: <Font Size=-1>Other quality factor higher the value better the fit)</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>centroid</b>: <Font Size=-1>centroid of the experimental data</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>minimum</b>: <Font Size=-1>the minimum value of the experimental data</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>minimumPos</b>: <Font Size=-1>the minimum position of the experimental data</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>maximum</b>: <Font Size=-1>the maximum value of the experimental data</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>maximumPos</b>: <Font Size=-1>the maximum position of the experimental data</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>minimumDeriv</b>: <Font Size=-1>the minimum value of the derivative of the fitted data</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>minimumDerivPos</b>: <Font Size=-1>the minimum position of the derivative of fitted data</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>maximumDeriv</b>: <Font Size=-1>the maximum value of the derivative of the fitted data</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>maximumDerivPos</b>: <Font Size=-1>the maximum position of the derivative of fitted data</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>READ</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
</Table>
</Center>
<Br><Br><Br><Br><Br>
<Table Border=2 Cellpadding=3 CELLSPACING=0 WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<Td COLSPAN=4> <Font Size=+2><Center><b>Spectrum Attributes</b></td></Font></Center>
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<Td><Center><b>Attribute name</b></td></Center>
<Td><Center><b>Data Type</b></td></Center>
<Td><Center><b>X Data Length</b></td></Center>
<Td><Center><b>Expert</b></td></Center>
<Tr><Td><b>knownFittersList</b>: <Font Size=-1>List of the known functions used for fitting</Font></Td>
<Td><Center><Font Size=-1>DEV_STRING</Font></Center></Td><Td><Center><Font Size=-1>20</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>experimentalDataX</b>: <Font Size=-1> Data copied from original X spectrum attribute </Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>100000</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>experimentalDataY</b>: <Font Size=-1> Data copied from original Y spectrum attribute </Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>100000</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>experimentalDataSigma</b>: <Font Size=-1>Data copied from original Sigma spectrum attribute </Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>100000</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>fittedFunctionParameters</b>: <Font Size=-1>This spectrum is composed of the differents calculated parameters of the function used to fit. The number of parameters depends on the function. </Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>10</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>fittedDataX</b>: <Font Size=-1>Spectrum providing the fitted data according the X axis. These datas are calculated thanks to the fitted parameters and the resolutionX, nbPointToGenerate and startingX values.</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>1000000</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>fittedDataY</b>: <Font Size=-1>Spectrum providing the fitted data according the Y axis. These datas are calculated thanks to the fitted parameters and the resolutionX, nbPointToGenerate and startingX values.</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>100000</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
<Tr><Td><b>derivedFittedDataY</b>: <Font Size=-1>derivative of the fitted data</Font></Td>
<Td><Center><Font Size=-1>DEV_DOUBLE</Font></Center></Td><Td><Center><Font Size=-1>100000</Font></Center></Td><Td><Center><Font Size=-1>No</Font></Center></Td></Tr>
</Table>
</Center>
<Br><Br><Br><Br><Br>
</center>
<Br>&nbsp;<Br><Br>&nbsp;<Br><h2>Commands:</h2>
<Center>
<Br><Br>
<A Href="DevCommandsFrame.html"> More Details on commands.... </a><Br>
<Br> <Br>
<Table Border=2 Cellpadding=3 CELLSPACING=0 WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<Td COLSPAN=3> <Font Size=+2><Center><b>Device Commands for Operator Level</b></td></Font></Center>
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<Td><Center><b>Command name</b></td></Center>
<Td><Center><b>Argument In</b></td></Center>
<Td><Center><b>Argument Out</b></td></Center>
<Tr><Td><b>Init</b></Td>
<Td><Font Size=-1>DEV_VOID</Font></Td>
<Td><Font Size=-1>DEV_VOID</Font></Td>
<Tr><Td><b>State</b></Td>
<Td><Font Size=-1>DEV_VOID</Font></Td>
<Td><Font Size=-1>DEV_STATE</Font></Td>
<Tr><Td><b>Status</b></Td>
<Td><Font Size=-1>DEV_VOID</Font></Td>
<Td><Font Size=-1>CONST_DEV_STRING</Font></Td>
<Tr><Td><b>StartFit</b></Td>
<Td><Font Size=-1>DEV_VOID</Font></Td>
<Td><Font Size=-1>DEV_VOID</Font></Td>
<Tr><Td><b>WriteExperimentalData</b></Td>
<Td><Font Size=-1>DEV_STRING</Font></Td>
<Td><Font Size=-1>DEV_VOID</Font></Td>
<Tr><Td><b>WriteFittedData</b></Td>
<Td><Font Size=-1>DEV_STRING</Font></Td>
<Td><Font Size=-1>DEV_VOID</Font></Td>
</Table></Center>
</center>
<Br>&nbsp;<Br>
<Br>
<Br>
<Br>
<A NAME="Init"><!-- --></A>
<A NAME="Init"><!-- --></A>
<h2>1 - Init</h2>
<ul>
<Li><Strong>Description: </Strong> This commands re-initialise a device keeping the same network connection.<Br>
After an Init command executed on a device, it is not necessary for client to re-connect to the device.<Br>
This command first calls the device <i> delete_device() </i>method and then execute its <i> init_device()</i> method.<Br>
For C++ device server, all the memory allocated in the <i> nit_device() </i> method must be freed in the <i> delete_device() </i> method.<Br>
The language device desctructor automatically calls the <i> delete_device() </i> method.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_VOID</Strong>
: none.<Br>&nbsp
<Li><Strong>Argout:<Br>DEV_VOID</Strong>
: none.<Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::ALARM<Li>Tango::FAULT<Li>Tango::STANDBY</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="State"><!-- --></A>
<A NAME="State"><!-- --></A>
<h2>2 - State</h2>
<ul>
<Li><Strong>Description: </Strong> This command gets the device state (stored in its <i>device_state</i> data member) and returns it to the caller.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_VOID</Strong>
: none.<Br>&nbsp
<Li><Strong>Argout:<Br>DEV_STATE</Strong>
: State Code<Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::ALARM<Li>Tango::FAULT<Li>Tango::STANDBY</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="Status"><!-- --></A>
<A NAME="Status"><!-- --></A>
<h2>3 - Status</h2>
<ul>
<Li><Strong>Description: </Strong> This command gets the device status (stored in its <i>device_status</i> data member) and returns it to the caller.<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_VOID</Strong>
: none.<Br>&nbsp
<Li><Strong>Argout:<Br>CONST_DEV_STRING</Strong>
: Status description<Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::ALARM<Li>Tango::FAULT<Li>Tango::STANDBY</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="StartFit"><!-- --></A>
<A NAME="StartFit"><!-- --></A>
<h2>4 - StartFit</h2>
<ul>
<Li><Strong>Description: </Strong> Method to start fit with entry values :
- experimentalDataX
- experimentalDataY
- experimentalDataSigma
If the fitting succeed the output result are in :
- fittedDataX
- fittedDataY
- fittedFunctionParameters<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_VOID</Strong>
: <Br>&nbsp
<Li><Strong>Argout:<Br>DEV_VOID</Strong>
: <Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::ALARM<Li>Tango::FAULT<Li>Tango::STANDBY</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="WriteExperimentalData"><!-- --></A>
<A NAME="WriteExperimentalData"><!-- --></A>
<h2>5 - WriteExperimentalData</h2>
<ul>
<Li><Strong>Description: </Strong> This command can be used to save in the argin string file path, the experimental data in
an ASCII file of the form
X1 Y1
X2 Y2<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_STRING</Strong>
: The file path<Br>&nbsp
<Li><Strong>Argout:<Br>DEV_VOID</Strong>
: <Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::ALARM<Li>Tango::FAULT<Li>Tango::STANDBY</Ul>
<Br>&nbsp
</ul><Br>
<Br>
<A NAME="WriteFittedData"><!-- --></A>
<A NAME="WriteFittedData"><!-- --></A>
<h2>6 - WriteFittedData</h2>
<ul>
<Li><Strong>Description: </Strong> This command can be used to save in the argin string file path, the fitted data in
an ASCII file of the form
X1 Y1
X2 Y2<Br>&nbsp
<Li><Strong>Argin:<Br>DEV_STRING</Strong>
: The path of the file to save<Br>&nbsp
<Li><Strong>Argout:<Br>DEV_VOID</Strong>
: <Br>&nbsp
<Li><Strong>Command allowed for: </Strong><Ul>
<Li>Tango::ALARM<Li>Tango::FAULT<Li>Tango::STANDBY</Ul>
<Br>&nbsp
</ul><Br>
<Br>
</center>
<Br>&nbsp;<Br><Br>&nbsp;<Br>
<!--- html Footer --->
<Center>
<Font size=-1>
<br>
<br>
<TABLE BORDER="1" WIDTH="100%">
<Tr>
<!--- Hosted by Sourceforge --->
<Td Align="Center">
<Font size=-1>
<b>TANGO</b> is an open source project hosted by :<br>
<A href="http://sourceforge.net" Target="new">
<IMG title="Sourceforge logo"
alt="Sourceforge logo small"
src="http://www.esrf.fr/computing/cs/tango/sourceforge.gif"
border=0> </a>
</Font>
</Td>
<!--- 2 Sourceforge Repositories --->
<Td Align="Center">
<Font size=-1>
Core and Tools :
<a href="http://tango-cs.cvs.sourceforge.net/tango-cs/" Target="new">
CVS repository</a> on
<a href="https://sourceforge.net/projects/tango-cs" Target=new>
tango-cs project</a>
<br>
Device Servers :
<a href="http://tango-ds.cvs.sourceforge.net/tango-ds/" Target="new">
CVS repository</a> on
<a href="https://sourceforge.net/projects/tango-ds" Target=new>
tango-ds project</a>
</Font>
</Td>
</Tr>
</Table>
</Font>
</Center>
</body>
</html>
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment