Page History
Table of Contents | ||
---|---|---|
|
...
Package pyana
This package collects code which deals with various aspects of the analysis tasks.
...
This module is a collection of classes and methods to deal with the event data and everything related to it.
...
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 EpicsStoreInstance of this class contains current status of all EPICS channels. It is updated from event data on every new event. ConstructionUsage: Creates EPICS store object. Objects of this type are created by pyana itself and end users do not need to create new instances. Method update()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 value()Usage Returns current value of the EPICS channel with the given name. The type of returned data is either Parameters:
This is the primary method to access EPICS information in pyana jobs. |
...
Panel |
---|
Class BldInfoPython wrapper for pdsdata/xtc/BldInfo 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. Enum TypeIn addition to methods described here the class also defines Enum TypeThis 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 type()Usage: Returns BldInfo type which is a value of |
Panel | ||
---|---|---|
Class ClockTimePython wrapper for pdsdata/xtc/ClockTime class. In addition to methods described here the class also defines Construction
Creates new instance of type. Arguments:
If any argument is missing it is assumed to be 0. Method seconds()Usage: Returns the number of seconds as integer number. Method nanoseconds()Usage: Returns the number of nanoseconds as integer number. |