Page History
...
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
Class EventInstance of this class contains all event data. ConstructionUsage: Creates event object from the corresponding XTC datagram object. Parameters:
Method seq()Usage: Returns Method getTime()Usage: Returns Method find()Usage: Returns possibly empty list of data objects contained in the event. This method accepts a number of arguments, but all arguments are optional. If no arguments are given then a list of all data objects is returned. If some arguments are given then only those objects that satisfy a particular criteria are returned. The list of possible keyword arguments:
The parameters Method findFirst()Usage: Accepts the same set of arguments as Method getAcqConfig()Usage: Returns Acqiris configuration data of type Parameters:
Ordinary configuration objects are contained in a Method getOpal1kConfig()Usage: Returns Opal1k configuration data of type Parameters:
Same caveats apply as for Method getAcqValue()Usage: Returns Acqiris data object of type Parameters:
Channel number is an integer number, total number of channels can be extracted from the Acqiris configuration object. Method getPnCcdValue()Usage: returns pnCCD data object of type Parameters:
Method getFeeGasDet()Usage:
Method getPhaseCavity()Usage: Returns data object of type Method getEBeam()Usage: Returns data object of type |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class EnvInstance of this class is a container for all sorts of environment data. ConstructionUsage: Creates environment object. Parameters:
Objects of this type are created by pyana itself and end users do not need to create new instances. Method jobName()Usage: Returns analysis job name string. Method hmgr()Usage: Returns histogram manager object of type Method mkfile()Usage: Opens file for writing output data. This is pyana's alternative for Python open() function which supports multi-processing. If user needs the data in this file to be merged with the files produced by other processes then mkfile() has to be used in place of open(). Parameters:
In case of single-process job this method is equivalent to a regular Python open() method. In case of multi-processing when this method is called from a sub-process then the file is created somewhere in a temporary location (with unique name). At the end of the job files from all sub-processes are merged into one file with name filename and the temporary files are deleted. Method epicsStore()Usage: This is the primary method for user code to access EPICS data. It returns Method update()Usage: This method updates environment contents with selected data from event object. This is equivalent to calling env.updateEpics() and env.updateConfig(). Parameters:
This method is not supposed to be called from user code, pyana takes care of all updates itself. Method updateEpics()Usage: This method updates environment EPICS data from event object. Parameters:
This method is not supposed to be called from user code, pyana takes care of all updates itself. Method updateConfig()Usage: This method copies configuration objects from event object into environment. Parameters:
This method is not supposed to be called from user code, pyana takes care of all updates itself. Method getAcqConfig()Usage: Returns Acqiris configuration object for a given device address. If more than one object is matched by the parameters then first arbitrary object is returned. Keyword arguments:
Method getPnCCDConfig()Usage: Returns pnCCD configuration object for a given device address. If more than one object is matched by the parameters then first arbitrary object is returned. Accepts the same keyword arguments as the getAcqConfig() method. Method getOpal1kConfig()Usage: Returns Opal1k configuration object for a given device address. If more than one object is matched by the parameters then first arbitrary object is returned. Accepts the same keyword arguments as the getAcqConfig() method. Method result()Usage: Method used by pyana to extract the data produced by a single sub-process in multi-processing setup. Not to be used by end users. |
...
Panel | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Class DamagePython wrapper for pdsdata/xtc/Damage class.
Enum ValueThis enum is an internal type of
The values of enum constants define the bit number in the damage mask.
Enum Mask
This enum is an internal type of
The values of enum constants define the bit mask in the damage mask. Mask enum is equivalent to 1<<Value enum. Construction
Arguments:
Method value()Usage: Returns complete damage mask as integer number. Method hasDamage()Usage: Returns true if the corresponding damage bit is set. Arguments:
|
...
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Class DetInfoPython wrapper for pdsdata/xtc/DetInfo class. Unlike C++ this class does not inherit from Src class (Src class does not exist in this module) but uses dynamic Python features to implement the same interface as in Src class. In addition to methods described here the class also defines
Enum DetectorThis enum is an embedded type of
Enum DeviceThis enum is an embedded type of
ConstructionUsage: Arguments:
Method level()Usage: Returns enum value of type Method log()Usage: Returns logical address of data source as integer number. Method phy()Usage: Returns physical address of data source as integer number. Method processId()Usage: Returns process ID as integer number. Method detector()Usage: Returns detector enum which is a value of Method device()Usage: Returns device enum which is a value of Method detId()Usage: Returns detector ID as integer number. Method devId()Usage: Returns device ID as integer number. |
...
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Class LevelPython wrapper for pdsdata/xtc/Level class. C++ class does not define any data members or methods, it only defines single enum type. C++ cannot be instantiated in any meaningful way. Python class in addition to defining corresponding enum constants can also be instantiated, the instances are regular integer numbers with additional printing enhancements.
Enum TypeUnlike other enum types which create separate new type inside original Python type, the enums in Level class are defined directly in the class. Known enums:
ConstructionUsage: Arguments:
Method __str__Usage: Returns a name of the corresponding enum. Method __repr__Usage: Returns a string in the form "<Level(num):name>" where num and name are the value and the name of the corresponding enum. |
...
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Class SequencePython wrapper for pdsdata/xtc/Sequence class.
Enum TypeThis enum is an embedded type of
ConstructionThis class cannot be instantiated directly, it is instantiated by some other classes, e.g. by Dgram.seq property. Method type()Usage: Returns the type of this sequence, one of Method service()Usage: Returns the transition type as object of Method isExtended()Usage: Returns True for extended sequence. Method isEvent()Usage: Returns True for event sequence. Method clock()Usage: Returns clock value for sequence as an object of Method stamp()Usage: Returns timestamp value for sequence as an object of |
...
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Class TransitionIdPython wrapper for pdsdata/xtc/TransitionId class. C++ class does not define any data members or methods, it only defines single enum type. C++ cannot be instantiated in any meaningful way. Python class in addition to defining corresponding enum constants can also be instantiated, the instances are regular integer numbers with additional printing enhancements.
Enum ValueUnlike other enum types which create separate new type inside original Python type, the enums in TransitionId class are defined directly in the class. Known enums:
ConstructionUsage: Arguments:
Method __str__Usage: Returns a name of the corresponding enum. Method __repr__Usage: Returns a string in the form "<TransitionId(num):name>" where num and name are the value and the name of the corresponding enum. |
...
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Class TypeIdPython wrapper for pdsdata/xtc/TypeId class. In addition to methods described here the class also defines
Enum TypeThis enum is an embedded type of
Construction
Arguments:
Method value()Usage: Returns the whole type ID number including version as integer number. Method id()Usage: Returns the type ID number without version as enum object of Method version()Usage: Returns the type ID version number as integer number. |
...
Panel | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Class TrigV1Python wrapper for pdsdata/acqiris/TrigV1 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type.
Enum CouplingThis enum is an embedded type of
Enum SlopeThis enum is an embedded type of
Enum SourceThis enum is an embedded type of
Method coupling()Usage: Returns enum of Method input()Usage: Returns enum of Method slope()Usage: Returns enum of Method level()Usage: Returns floating number. |