Page History
...
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. |
...
This module is a collection classes and methods to create and manage histograms from user analysis modules.
...
Panel | ||||||
---|---|---|---|---|---|---|
Class HistoMgrRootThis class represents histogram manager implementation based on ROOT library. Histograms that are created by this manager reside either in memory or in a ROOT file. ConstructionUsage: Creates new histogram manager object. Users should not instantiate new objects, instead the environment method Keyword arguments:
Method h1d()Usage: Creates 1-dimensional histogram with bin contents stored as double precision numbers. Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TH1D. The returned object also inherits most of the methods of the C++ class. Method h1f()Usage: Creates 1-dimensional histogram with bin contents stored as single precision numbers. Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TH1F. The returned object also inherits most of the methods of the C++ class. Method h1i()Usage: Creates 1-dimensional histogram with bin contents stored as integer numbers. Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TH1I. The returned object also inherits most of the methods of the C++ class. Method h2d()Usage: Creates 2-dimensional histogram with bin contents stored as double precision numbers. Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TH2D. The returned object also inherits most of the methods of the C++ class. Method h2f()Usage: Creates 2-dimensional histogram with bin contents stored as single precision numbers. Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TH2F. The returned object also inherits most of the methods of the C++ class. Method h2i()Usage: Creates 2-dimensional histogram with bin contents stored as integer numbers. Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TH2F. The returned object also inherits most of the methods of the C++ class. Method prof()Usage: Creates 1-dimensional profile histogram with bin contents stored as double precision numbers. Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TProfile. The returned object also inherits most of the methods of the C++ class. Method prof2d()Usage: Creates 2-dimensional profile histogram with bin contents stored as double precision numbers. Method accepts the same arguments as the constructors of the corresponding C++ ROOT class TProfile2D. The returned object also inherits most of the methods of the C++ class. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Function HistoMgr()Usage: Do not call it, it's for pyana internal use. |
...
The main difference in use is that in C++ to get enum value one needs to write DetInfo.AmoIms
when in Python it needs to be DetInfo.Detector.AmoIms
.
...
Panel | ||||||
---|---|---|---|---|---|---|
Class ErrorThis is the type for the exception generated by few methods in _pdsdata package. ConstructionUsage: Arguments:
|
...
This module contains classes corresponding to those in C++ pdsdata/xtc package.
Panel | ||||||
---|---|---|---|---|---|---|
Class BldInfoPython 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. In 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. |
...
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
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:
|
...
Anchor | ||||
---|---|---|---|---|
|
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 Device
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 DgramPython wrapper for pdsdata/xtc/Dgram class. ConstructionUsage: One of the ways to create Dgram objects is from a Python buffer objects. Arguments:
Property envUsage: Returns the env field as an integer number. Property seqUsage: Returns the seq field as an object of type Property xtcUsage: Returns top-level Xtc as object of type |
...
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 ProcInfoClass ProcInfoPython wrapper for pdsdata/xtc/ProcInfo 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 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 ipAddr()Usage: Returns host IP address as an integer number. |
...
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 TimeStampPython wrapper for pdsdata/xtc/TimeStamp class. In addition to methods described here the class also defines Construction
Creates new instance of this type. All arguments are of integer type and have the same meaning as in corresponding C++ constructor. Method ticks()Usage: Returns the ticks value as integer number. Method fiducials()Usage: Returns the fiducials value as integer number. Method control()Usage: Returns the control value as integer number. Method vector()Usage: Returns the vector value as integer number. |
...
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Class TransitionIdPython wrapper for pdsdata 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 XtcPython wrapper for pdsdata/xtc/Xtc class. In addition to methods described below this class implements Python iterator interface. Instance can be used as iterator only when its ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Property damageUsage: Returns damage bitmask as an object of Property srcUsage: Returns data source object. Depending on the source level the type of the returned object will be one of Property containsUsage: Returns the type of the object contained in XTC as object od Property extentUsage: Returns the extent (total size) of the XTC. Method sizeofPayload()Usage: Returns the size of payload object. Method payload()Usage: Returns data object. If |
...
Panel | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Class XtcFileIteratorUnlike its C++ counterpart class pdsdata/xtc/XtcFileIterator this Python class implements true Python iterator interface. Like the C++ class it also returns objects of type
ConstructionUsage: Arguments:
|
...
Panel | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Class XtcIteratorThis class is not like its C++ counterpart pdsdata/xtc/XtcIterator. It implements true Python iterator interface, the return type for the iterator is
ConstructionUsage: Arguments:
|
...
This module contains classes corresponding to those in C++ pdsdata/acqiris package.
Panel | ||||||
---|---|---|---|---|---|---|
Class ConfigV1Python wrapper for pdsdata/acqiris/ConfigV1 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method nbrConvertersPerChannel()Usage: Returns integer number. Method channelMask()Usage: Returns integer number. Method nbrChannels()Usage: Returns integer number. Method nbrBanks()Usage: Returns integer number. Method horiz()Usage: Returns object of Method trig()Usage: Returns object of Method vert()Usage: Returns object of Arguments:
|
...
Panel | ||||||
---|---|---|---|---|---|---|
Class DataDescV1Python wrapper for pdsdata/acqiris/DataDescV1 class. Class DataDescV1Python wrapper for pdsdata/acqiris/DataDescV1 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method nbrSamplesInSeg()Usage: Returns integer number. Method nbrSegments()Usage: Returns integer number. Method indexFirstPoint()Usage: Returns integer number. Method timestamp()Usage: Returns object of Arguments:
Method waveform()Usage: Returns waveform array of Arguments:
Method nextChannel()Usage: Returns data object of Arguments:
|
...
Panel | ||||||
---|---|---|---|---|---|---|
Class HorizV1Python wrapper for pdsdata/acqiris/HorizV1 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method sampInterval()Usage: Returns floating number. Method delayTime()Usage: Returns floating number. Method nbrSamples()Usage: Returns integer number. Method nbrSegments()Usage: Returns integer number. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class TimestampV1Python wrapper for pdsdata/acqiris/TimestampV1 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method pos()Usage: Returns floating number. Method value()Usage: Returns 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. |