Rontec Tango Class User‘s Guide · Tango name of the serial line device the other serial line properties are fixed for the RONTEC RCL : N( no parity),8( data bits),1(stop bit),

Rontec Tango Cpp Class

Contents :DescriptionPropertiesCommands

StateStatusAbortArmClearDataGetPartOfSpectrumGetPauseStatusGetSpeedAndResolutionConfigurationResetSendRontecMessageSetROIsSetSingleROISetSpeedAndResolutionConfigurationStart

AttributescountRatecycleTimedataSourcedeadTimedetectorTemperaturespectrumEndValueenergyRangeintegrationTimeliveTimenbChannelsreadDataSpectrumrealTimeroi1roi2roi3roi4roi5roi6roi7roi8spectrumStartValuetimingTypeenergyModedataSpectrumoffsetGainroisEndsroisStartsroisStartsEndsenergySpectrum

States

Rontec Class Identification : Rontec Class Inheritance :

Contact : at null - null Tango::DeviceImplRontec

http://www.esrf.fr/

http://www.elettra.trieste.it/

http://www.synchrotron-soleil.fr/

http://www.cells.es/

http://www.tango-controls.org/

http://www.desy.de/html/home/index_eng.html

http://www.maxlab.lu.se/maxlab/max4/index.html

http://www.frm2.tum.de/en/index.html

http://www.synchrotron.uj.edu.pl/

http://www.anka.kit.edu/english/28.php

http://www.eli-hu.hu/

http://www.esrf.eu/computing/cs/tango/tango_doc/kernel_doc/cpp_doc/

Class Family :Platform :

Bus :

Manufacturer :

Manufacturer ref. :

Rontec Class Description :

handles Rontec MCA channel analyser through a serail RS232 line

Rontec Properties :

There is no class properties

Device Properties

Name Description Type Default Value

ConnectedROIMask

list of the TTL outputs connected to a counterjust for control and throw exception if try to configure a ROI that is not in the list8 TTL outputs are available with the current RONTEC MCA hardwareexample : 1 4 represents : ouptut1, output 4 connecteddefault : 1

String 1 2 3 4

MaxFluoEnergymaximum fluo energy of the last MCA channel.with the current RONTEC MCA Hardware can be 10, 20, 40, or 80 KeVdefault : 80.0

double 80

NumberOfChannels

number of channels of the MCA.The current RONTEC MCA hardware has 4096 channels.this is for extentions purpose only,let the default value of 4096

int 4096

SerialLineUrlTango name of the serial line devicethe other serial line properties are fixed for the RONTEC RCL :N( no parity),8( data bits),1(stop bit), hardware handshake ( RTS/CTS

String test/rontec/serial

SpectrumPacketSize Spectrum read packet size used in reading thread int 256

EnergyCoeff0 Energy conversion polynomial coefficient order 0 double[] 0



IsLiveTimeImplemented

some RONTEC have live time implemented, some not.If live time is implemented, set this attribute to TRUEotherwise to falseimportant for performance and memory leak

boolean true

Rontec Class Commands

Name Input type Output type Level Description

State DEV_VOID DEV_STATE OPERATOR

This command gets thedevice state (stored in itsdevice_state data member)and returns it to the caller.

This command gets the

Status DEV_VOID CONST_DEV_STRING OPERATORdevice status (stored in itsdevice_status datamember) and returns it tothe caller.

Abort DEV_VOID DEV_VOID OPERATORstops acquisition alreadyrunning

Arm DEV_VOID DEV_VOID OPERATORwill Arm the MCA (ieprepare the MCA).

ClearData DEV_VOID DEV_VOID OPERATORclears the acquisitionmemory

GetPartOfSpectrum DEVVAR_DOUBLEARRAY DEVVAR_LONGARRAY OPERATOR

returns the data starting atargin[0] (exception ifargin[0] < starting channelcofiguredfor argin[1] channeltruncated if exceeds theend_channel configured

GetPauseStatus DEV_VOID DEV_STRING OPERATOR

returns PAUSE orRUNNING according toacquisition stopped orrunning

GetSpeedAndResolutionConfiguration DEV_VOID DEV_LONG OPERATOR

returns the processorconfigured :0 : max cps 1 : ... cps 2 : .....cps 3 : min cps

Reset DEV_VOID DEV_STRING OPERATOR None.

SendRontecMessage DEV_STRING DEV_STRING OPERATOR None.

SetROIs DEVVAR_DOUBLEARRAY DEV_VOID OPERATOR

Set the ROIs. the parameteris an array with valuesgoing by pair: tab[0]=126,tab[1]=238 -> first ROI startsfrom 126, ends to 238tab[2]=1569,tab[3]=2368 ->second ROI starts from1569, ends to 2368.

SetSingleROI DEVVAR_DOUBLEARRAY DEV_VOID OPERATOR

configures the TTL outputnumber for pulse outputphotons processed withlow_channel < energy <high_channelthe RONTEC waits forenergy so we retreiveenergy in DServer fromchannel andMaxFluoEnergychannels are retreivedaccording amplifier andenergy calibration.not alowed if acquisition isrunningException if ROI numbernot in theConnectedROIMaskproperty

SetSpeedAndResolutionConfiguration DEV_LONG DEV_VOID OPERATOR

selects the processor0 : max cps ...... 3 : min cpsdepends on real hardwareexception if error

Start DEV_VOID DEV_VOID OPERATOR

starts a acquisitionpreviously configured withattributes startingChannel,endingChannel,integrationTimefor time given inintegrationTime

clears memory in the MCAif not done.for continuous acquisition :integrationTime=0

Command State :

This command gets the device state (stored in its device_state data member) and returns it to the caller.

State Definition

Input Argument Tango::DEV_VOID none.

Output Argument Tango::DEV_STATE State Code

DisplayLevel OPERATOR ..

Inherited true ..

Abstract true ..

Polling Period Not polled ..

Command allowed for All states ..

Command Status :

This command gets the device status (stored in its device_status data member) and returns it to the caller.

Status Definition

Input Argument Tango::DEV_VOID none.

Output Argument Tango::CONST_DEV_STRING Status description


Inherited true ..

Abstract true ..


Command allowed for All states ..

Command Abort :

stops acquisition already running

Abort Definition

Input Argument Tango::DEV_VOIDOutput Argument Tango::DEV_VOID


Inherited false ..

Abstract false ..


Command NOT allowed for UNKNOWNINIT ..

Command Arm :

will Arm the MCA (ie prepare the MCA).

Arm Definition

Input Argument Tango::DEV_VOID

Output Argument Tango::DEV_VOID


Inherited false ..

Abstract false ..



Command ClearData :

clears the acquisition memory

ClearData Definition




Inherited false ..

Abstract false ..



Command GetPartOfSpectrum :

returns the data starting at argin[0] (exception if argin[0] < starting channel cofiguredfor argin[1] channel truncated if exceeds the end_channel configured

GetPartOfSpectrum Definition

Input Argument Tango::DEVVAR_DOUBLEARRAY [0]starting channel, [1] size of channel

Output Argument Tango::DEVVAR_LONGARRAY the data


Inherited false ..

Abstract false ..



Command GetPauseStatus :

returns PAUSE or RUNNING according to acquisition stopped or running

GetPauseStatus Definition


Output Argument Tango::DEV_STRING PAUSE/RUNNING


Inherited false ..

Abstract false ..



Command GetSpeedAndResolutionConfiguration :

returns the processor configured :0 : max cps 1 : ... cps 2 : ..... cps 3 : min cps

GetSpeedAndResolutionConfiguration Definition


Output Argument Tango::DEV_LONG processor number actually selected


Inherited false ..

Abstract false ..



Command Reset :

Reset Definition


Output Argument Tango::DEV_STRING string returend by the rontec


Inherited false ..

Abstract false ..



Command SendRontecMessage :

SendRontecMessage Definition

Input Argument Tango::DEV_STRING the command and arguments to be sent

Output Argument Tango::DEV_STRING the rontec answer as string


Inherited false ..

Abstract false ..



Command SetROIs :

Set the ROIs. the parameter is an array with values going by pair: tab[0]=126, tab[1]=238 -> first ROI starts from 126, ends to 238tab[2]=1569,tab[3]=2368 -> second ROI starts from 1569, ends to 2368.

SetROIs Definition

Input Argument Tango::DEVVAR_DOUBLEARRAYstarts and ends of the ROI. eg: tab[0]=126, tab[1]=238,tab[2]=1569,tab[3]=2368



Inherited false ..

Abstract false ..


Command NOT allowedfor

UNKNOWNINIT ..

Command SetSingleROI :

configures the TTL output number for pulse output photons processed withlow_channel < energy < high_channelthe RONTEC waits for energy so we retreive energy in DServer from channel and MaxFluoEnergychannels are retreived according amplifier and energy calibration.not alowed if acquisition is runningException if ROI number not in the ConnectedROIMask property

SetSingleROI Definition

Input Argument Tango::DEVVAR_DOUBLEARRAY [0] : TTL output number, [1] low energy (eV), [2] high energy (eV)



Inherited false ..

Abstract false ..



Command SetSpeedAndResolutionConfiguration :

selects the processor0 : max cps ...... 3 : min cpsdepends on real hardwareexception if error

SetSpeedAndResolutionConfiguration Definition

Input Argument Tango::DEV_LONG the processor selected 0..3



Inherited false ..

Abstract false ..


Command NOT allowed for UNKNOWN ..

INIT

Command Start :

starts a acquisition previously configured with attributes startingChannel, endingChannel, integrationTimefor time given in integrationTimeclears memory in the MCA if not done.for continuous acquisition : integrationTime=0

Start Definition




Inherited false ..

Abstract false ..


Command NOT allowed forRUNNINGUNKNOWNINIT

..

Rontec Class Attributes

Name Inherited Abstract Attr.type

R/W type Data type Level Description

countRate false false Scalar READ Tango::DEV_DOUBLE OPERATOR

This is the input count rate.\nRem : output count rate =countRate * (1-deadTime /100)

cycleTime false false Scalar READ_WRITE Tango::DEV_DOUBLE OPERATOR

dataSource false false Scalar READ Tango::DEV_STRING OPERATORDisplay the current datasource or NONE if not open

deadTime false false Scalar READ Tango::DEV_DOUBLE OPERATORDead time = [(Real - Live ) /Real] * 100

detectorTemperature false false Scalar READ Tango::DEV_DOUBLE OPERATOR

spectrumEndValue false false Scalar WRITE Tango::DEV_DOUBLE OPERATOR

energyRange false false Scalar READ_WRITE Tango::DEV_LONG OPERATOR

integrationTime false false Scalar READ_WRITE Tango::DEV_DOUBLE OPERATORTime of integration (iecounting time)

liveTime false false Scalar READ Tango::DEV_DOUBLE OPERATOR

Live Time: time which doesnot take into account thedead time.\nShould beshorter than real time

nbChannels false false Scalar READ_WRITE Tango::DEV_SHORT OPERATORNumber of Channels to getfrom the DataSource

readDataSpectrum false false Scalar WRITE Tango::DEV_BOOLEAN OPERATOR

realTime false false Scalar READ Tango::DEV_DOUBLE OPERATORReal Time : time taking intoaccount the dead time

roi1 false false Scalar READ Tango::DEV_LONG OPERATOR








spectrumStartValue false false Scalar WRITE Tango::DEV_DOUBLE OPERATOR

timingType false false Scalar READ_WRITE Tango::DEV_SHORT EXPERT

Type of timing:\n0 -> Live (like an OS time)\n1 -> Real (the real timeaccording to deadTime).

energyMode false false Scalar WRITE Tango::DEV_BOOLEAN OPERATOR

dataSpectrum false false Spectrum READ Tango::DEV_DOUBLE OPERATOR

fluo spectrum returned by theRONTEC MCA\nmaxchannels number set inNumberOfChannelsproperty\nstarting channelfixed bySetStartingChannel,\nendingchannel set bySetEndingChannel

offsetGain false false Spectrum READ Tango::DEV_DOUBLE OPERATOR

roisEnds false false Spectrum READ Tango::DEV_DOUBLE OPERATOR End Positions of the ROIs

roisStarts false false Spectrum READ Tango::DEV_DOUBLE OPERATOR

roisStartsEnds false false Spectrum READ Tango::DEV_DOUBLE EXPERTAll the ROIs starts ends: theyare in pair\n: start-end.

energySpectrum false false Spectrum READ Tango::DEV_DOUBLE OPERATOR

There is no dynamic attribute defined.

Attribute countRate :

This is the input count rate. \nRem : output count rate = countRate * (1-deadTime / 100)

Attribute Definition

Attribute Type Scalar

R/W Type READ

Data Type Tango::DEV_DOUBLE

Display Level OPERATOR

Inherited false

Abstract false

Polling Period Not polled

Memorized Not set

Read NOT allowed for UNKNOWNINIT

Attribute Properties

label

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

Attribute Event Criteria

Periodic Not set

Relative Change Not set

Absolute Change Not set

Archive Periodic Not set

Archive Relative Change Not set

Archive Absolute Change Not set

Push Change event by user code false

Push Archive event by user code false

delta_time

delta_val

Push DataReady event by user code Not set

Attribute cycleTime :



R/W Type READ_WRITE



Inherited false

Abstract false


Memorized Not set


Write allowed for All states


label

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


Periodic Not set









Attribute dataSource :

Display the current data source or NONE if not open

AttributeDefinition


R/W Type READ

Data Type Tango::DEV_STRING


Inherited false

Abstract false


Memorized Not set

Read NOT allowedfor

UNKNOWNINIT

AttributeProperties

label DataSource

unit

standard unit

display unit

format %s

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time


PeriodicNotset

Relative ChangeNotset

Absolute ChangeNotset

Archive PeriodicNotset

Archive Relative ChangeNotset

Archive Absolute ChangeNotset


delta_valPush Archive event by user code false

Push DataReady event by usercode

Notset

Attribute deadTime :

Dead time = [(Real - Live ) / Real] * 100

AttributeDefinition


R/W Type READ



Inherited false

Abstract false


Memorized Not set

Read NOT allowedfor

UNKNOWNINIT

AttributeProperties

labelDeadTime

unit

standard unit

display unit %

format %9.3f

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


PeriodicNotset









Notset

Attribute detectorTemperature :



R/W Type READ



Inherited false

Abstract false


Memorized Not set


label

unit

standard unit

display unit

format

max_value

min_value

max_alarm


Periodic Not set








min_alarmmax_warning

min_warning

delta_time

delta_val



Attribute spectrumEndValue :



R/W Type WRITE



Inherited false

Abstract false


Memorized true

Write hardware at init. true



label

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


Periodic Not set









Attribute energyRange :



R/W Type READ_WRITE

Data Type Tango::DEV_LONG


Inherited false

Abstract false


Memorized Not set




label

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time


Periodic Not set









delta_val

Attribute integrationTime :

Time of integration (ie counting time)

AttributeDefinition


R/W Type READ_WRITE



Inherited false

Abstract false


Memorized Not set

Read NOTallowed for

UNKNOWNINIT


AttributeProperties

labelIntegrationTime

unit

standard unit

display unit s.

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


PeriodicNotset









Notset

Attribute liveTime :

Live Time: time which does not take into account the dead time.\nShould be shorter than real time

AttributeDefinition


R/W Type READ



Inherited false

Abstract false


Memorized Not set

AttributeProperties

labelLiveTime

unit

standard unit

display unit s

format %4.1f

max_value

min_value

max_alarm


PeriodicNotset





Read NOT allowedfor

UNKNOWNINIT

min_alarm

max_warning

min_warning

delta_time

delta_val





Notset

Attribute nbChannels :

Number of Channels to get from the DataSource

AttributeDefinition


R/W Type READ_WRITE

Data Type Tango::DEV_SHORT


Inherited false

Abstract false


Memorized Not set

Read NOT allowedfor

UNKNOWNINIT


AttributeProperties

labelNbChannels

unit

standard unit

display unit

format

max_value 16384

min_value 0

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


PeriodicNotset









Notset

Attribute readDataSpectrum :



R/W Type WRITE

Data Type Tango::DEV_BOOLEAN



label

unit

standard unit

display unit

format


Periodic Not set



Inherited falseAbstract false


Memorized Not set


max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val

Archive Periodic Not setArchive Relative Change Not set





Attribute realTime :

Real Time : time taking into account the dead time

AttributeDefinition


R/W Type READ



Inherited false

Abstract false


Memorized Not set

Read NOT allowedfor

UNKNOWNINIT

AttributeProperties

labelRealTime

unit

standard unit

display unit s

format %4.1f

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


PeriodicNotset









Notset

Attribute roi1 :



R/W Type READ



label

unit

standard unit

display unit


Periodic Not set



Display Level OPERATORInherited false

Abstract false


Memorized Not set

Read allowed for All states

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val







Attribute roi2 :



R/W Type READ



Inherited false

Abstract false


Memorized Not set



label

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


Periodic Not set









Attribute roi3 :



R/W Type READ



Inherited false

Abstract false



label

unit

standard unit

display unit

format

max_value

min_value


Periodic Not set






Memorized Not set


max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val




Attribute roi4 :



R/W Type READ



Inherited false

Abstract false


Memorized Not set



label

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


Periodic Not set









Attribute roi5 :



R/W Type READ



Inherited false

Abstract false


Memorized Not set



label

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning


Periodic Not set








min_warning

delta_time

delta_val


Attribute roi6 :



R/W Type READ



Inherited false

Abstract false


Memorized Not set



label

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


Periodic Not set









Attribute roi7 :



R/W Type READ



Inherited false

Abstract false


Memorized Not set



label

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


Periodic Not set









Attribute roi8 :



R/W Type READ



Inherited false

Abstract false


Memorized Not set



label

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


Periodic Not set









Attribute spectrumStartValue :



R/W Type WRITE



Inherited false

Abstract false


Memorized true




label

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


Periodic Not set









Attribute timingType :

Type of timing:\n0 -> Live (like an OS time)\n1 -> Real (the real time according to deadTime).

AttributeDefinition


R/W Type READ_WRITE

Data Type Tango::DEV_SHORT

Display Level EXPERT

Inherited false

Abstract false


Memorized Not set

Read NOT allowedfor

UNKNOWNINIT


AttributeProperties

labelTimingType

unit

standard unit

display unit

format %1d

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


PeriodicNotset









Notset

Attribute energyMode :



R/W Type WRITE

Data Type Tango::DEV_BOOLEAN


Inherited false

Abstract false


Memorized true




label

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


Periodic Not set









Attribute dataSpectrum :

fluo spectrum returned by the RONTEC MCA\nmax channels number set in NumberOfChannels property\nstarting channel fixed bySetStartingChannel,\nending channel set by SetEndingChannel

AttributeDefinition

Attribute Type Spectrum ( 8192 )

R/W Type READ



Inherited false

Abstract false


Memorized Not set

Read NOT allowedfor

UNKNOWNINIT

AttributeProperties

labelfluospectrum

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


PeriodicNotset









Notset

Attribute offsetGain :



R/W Type READ



Inherited false

Abstract false


Memorized Not set



label

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time


Periodic Not set









delta_val

Attribute roisEnds :

End Positions of the ROIs

AttributeDefinition


R/W Type READ



Inherited false

Abstract false


Memorized Not set

Read NOT allowedfor

UNKNOWNINIT

AttributeProperties

labelROIsEnds

unit

standard unit

display unit

format %6d

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


PeriodicNotset









Notset

Attribute roisStarts :



R/W Type READ



Inherited false

Abstract false


Memorized Not set



label

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning


Periodic Not set








min_warning

delta_time

delta_val


Attribute roisStartsEnds :

All the ROIs starts ends: they are in pair\n: start-end.



R/W Type READ


Display Level EXPERT

Inherited false

Abstract false


Memorized Not set



label ROIs

unit

standard unit

display unit

format %6d

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time

delta_val


Periodic Not set









Attribute energySpectrum :



R/W Type READ



Inherited false

Abstract false


Memorized Not set



label

unit

standard unit

display unit

format

max_value

min_value

max_alarm

min_alarm

max_warning

min_warning

delta_time


Periodic Not set









delta_val

Rontec Class States

Name Description

FAULT command error

INIT *

RUNNING acquisition in progress

STANDBY RONTEC OK, ready to accept command

UNKNOWN communication loosed with RONTEC

Documents

Rontec Tango Class User‘s Guide · Tango name of the serial line device the other serial line properties are fixed for the RONTEC RCL : N( no parity),8( data bits),1(stop bit),