Class Event

Instance of this class contains all event data.

Construction

Usage: evt = pyana.event.Event(dg)

Creates event object from the corresponding XTC datagram object.

Parameters:

• dg – datagram object of type _pdsdata.xtc.Dgram

Method seq()

Usage: s = evt.seq()

Returns _pdsdata.xtc.Sequence object, equivalent to dg.seq

Method getTime()

Usage: t = evt.getTime()

Returns _pdsdata.xtc.ClockTime object, equivalent to dg.seq.clock()

Method find()

Usage: objects = evt.find(...)

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:

• typeId – accepts enum xtc.TypeId.Type, only return objects which have that TypeId
• version – accepts number, only return objects whose type version number is equal to number
• level – accepts one of xtc.Level values, only returns objects originated at that level
• detector – accepts enum xtc.DetInfo.Detector values, only returns objects produced by this detector
• detId – accepts number, only returns objects produced by this detector ID
• device – accepts enum xtc.DetInfo.Device values, only returns objects produced by this device
• devId – accepts number, only returns objects produced by this device ID
• address – xtc.DetInfo object or an address string (see User Manual)

The parameters address and any of the detector, detId, device, devId are incompatible, specify only one or another.

Method findFirst()

Usage: object = evt.findFirst(...)

Accepts the same set of arguments as find() methods but instead of list of objects returns fist object found. If no object is satisfying all selection criteria then None is returned.

Method getAcqConfig()

Usage: acqConfig = evt.getAcqConfig(address)

Returns Acqiris configuration data of type acqiris.ConfigV* for specific device. If address given is not very specific then the first matching object is returned.

Parameters:

• address – xtc.DetInfo object or an address string (see User Manual)

Ordinary configuration objects are contained in a Configure type datagrams only. For client code that means that this method can be used in beginjob() or beginrun() methods only. Note also that configuration objects are stored in the Pyana environment and preferred way to access configuration information is through the environment. This makes this method of little utility to end users.

Method getOpal1kConfig()

Usage: opalConfig = evt.getOpal1kConfig(address)

Returns Opal1k configuration data of type opal1k.ConfigV* for specific device. If address given is not very specific then the first matching object is returned.

Parameters:

• address – xtc.DetInfo object or an address string (see User Manual)

Same caveats apply as for getAcqConfig() method.

Method getAcqValue()

Usage: acqData = evt.getAcqValue(address, channel, env)

Returns Acqiris data object of type pypdsdata.acqiris.DataDescV* for specific device and channel. If address given is not very specific then the first matching object is returned.

Parameters:

• address – xtc.DetInfo object or an address string (see User Manual)
• channel – channel number from 0 to max number of channels
• env – environment object containing Acqiris configuration object

Channel number is an integer number, total number of channels can be extracted from the Acqiris configuration object.

Method getPnCcdValue()

Usage: frame = evt.getPnCcdValue(address, env)

returns pnCCD data object of type pypdsdata.pnccd.FrameV* for specific device. If address given is not very specific then the first matching object is returned.

Parameters:

• address – xtc.DetInfo object or an address string (see User Manual)
• env – environment object containing pnCCD configuration object

Method getFeeGasDet()

Usage: array = evt.getFeeGasDet()

Returns the list of 4 numbers {{\[f_11_ENRC, f_12_ENRC, f_21_ENRC, f_22_ENRC\]}} obtained from [{{bld.BldDataFEEGasDetEnergy}}|#_pdsdata.bld.BldDataFEEGasDetEnergy] object.

Method getPhaseCavity()

Usage: obj = evt.getPhaseCavity()

Returns data object of type bld.BldDataPhaseCavity.

Method getEBeam()

Usage: obj = evt.getEBeam()

Returns data object of type bld.BldDataEBeam or bld.BldDataEBeamV0 whichever is present in the event.

Class Env

Instance of this class is a container for all sorts of environment data.

Construction

Usage: env = pyana.event.Env(jobName="pyana", hmgr=None, subproc=False)

Creates environment object.

Parameters:

• jobName – analysis job name, arbitrary string
• hmgr – histogram manager object
• subproc – flag which must be set to true when running in pyana sub-process

Objects of this type are created by pyana itself and end users do not need to create new instances.

Method jobName()

Usage: jobName = env.jobName()

Returns analysis job name string.

Method hmgr()

Usage: hmgr = env.hmgr()

Returns histogram manager object of type pyana.histo.HistoManager*.

Method mkfile()

Usage: file = env.mkfile(filename, mode='w', bufsize=-1)

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:

• filename – output file name
• mode – open mode, currently any "w*" modes are supported
• bufsize – output buffer size, default is to use Python's default

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: store = env.epicsStore()

This is the primary method for user code to access EPICS data. It returns event.EpicsStore object which can be used to retrieve the state of the individual EPICS channels.

Method update()

Usage: env.update(evt)

This method updates environment contents with selected data from event object. This is equivalent to calling env.updateEpics() and env.updateConfig().

Parameters:

• evt – event object of type event.Event

This method is not supposed to be called from user code, pyana takes care of all updates itself.

Method updateEpics()

Usage: env.updateEpics(evt)

This method updates environment EPICS data from event object.

Parameters:

• evt – event object of type event.Event

This method is not supposed to be called from user code, pyana takes care of all updates itself.

Method updateConfig()

Usage: env.updateConfig(evt)

This method copies configuration objects from event object into environment.

Parameters:

• evt – event object of type event.Event

This method is not supposed to be called from user code, pyana takes care of all updates itself.

Method getAcqConfig()

Usage: acqConfig = env.getAcqConfig(...)

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:

• detector – accepts enum xtc.DetInfo.Detector values, only returns objects produced by this detector
• detId – accepts number, only returns objects produced by this detector ID
• device – accepts enum xtc.DetInfo.Device values, only returns objects produced by this device
• devId – accepts number, only returns objects produced by this device ID
• address – xtc.DetInfo object or an address string (see User Manual)

Method getPnCCDConfig()

Usage: pnccdConfig = env.getPnCCDConfig(...)

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: opalConfig = env.getOpal1kConfig(...)

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: data = env.result()

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.

Class EpicsStore

Instance of this class contains current status of all EPICS channels. It is updated from event data on every new event.

Construction

Usage: store = pyana.event.EpicsStore()

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: store.update(evt)

This method updates environment EPICS data from event object.

Parameters:

• evt – event object of type event.Event

This method is not supposed to be called from user code, pyana takes care of all updates itself.

Method value()

Usage epics = store.value(name)

Returns current value of the EPICS channel with the given name. The type of returned data is either epics.EpicsPvCtrl or epics.EpicsPvTime.

Parameters:

• name – name of the EPICS channel

This is the primary method to access EPICS information in pyana jobs.

Class HistoMgrRoot

This 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.

Construction

Usage: hmgr = pyana.histo.HistoMgrRoot(...)

Creates new histogram manager object. Users should not instantiate new objects, instead the environment method hmgr() should be used to obtain existing manager object.

Keyword arguments:

• file – name of the ROOT file to store histograms, if missing then histograms will be memory-resident

Method h1d()

Usage: hist = hmgr.h1d(...)

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: hist = hmgr.h1f(...)

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: hist = hmgr.h1i(...)

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: hist = hmgr.h2d(...)

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: hist = hmgr.h2f(...)

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: hist = hmgr.h2i(...)

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: hist = hmgr.prof(...)

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: hist = hmgr.prof2d(...)

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.

Function HistoMgr()

Usage: hmgr = HistoMgr(...)

Do not call it, it's for pyana internal use.

Class Error

This is the type for the exception generated by few methods in _pdsdata package.

Construction

Usage: raise Error(message)

Arguments:

• message – string describing the error

Class XtcIterator

This class is not like its C++ counterpart pdsdata/xtc/XtcIterator. It implements true Python iterator interface, the return type for the iterator is xtc.Xtc. Typical use of this class is like this:

    if xtcObj.contains == xtc.TypeId.Type.Id_Xtc:
        for subXtc in xtc.XtcIterator(xtcObj):
            ..................

    # which is identical to this
    if xtcObj.contains == xtc.TypeId.Type.Id_Xtc:
        for subXtc in xtcObj.payload():
            ..................

    # and also identical to this
    if xtcObj.contains == xtc.TypeId.Type.Id_Xtc:
        for subXtc in xtcObj:
            ..................

Construction

Usage: iter = xtc.XtcIterator(xtcObj)

Arguments:

• xtcObj – XTC object whose contains type is Id_Xtc, otherwise an exception will be thrown.

Class TrigV1

Python wrapper for pdsdata/acqiris/TrigV1 class.

Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.

Enum Coupling

This enum is an embedded type of TrigV1 class. Following enum members are defined currently:

• TrigV1.Coupling.DC
• TrigV1.Coupling.AC
• TrigV1.Coupling.HFreject
• TrigV1.Coupling.DC50ohm
• TrigV1.Coupling.AC50ohm

Enum Slope

This enum is an embedded type of TrigV1 class. Following enum members are defined currently:

• TrigV1.Slope.Positive
• TrigV1.Slope.Negative
• TrigV1.Slope.OutOfWindow
• TrigV1.Slope.IntoWindow
• TrigV1.Slope.HFDivide
• TrigV1.Slope.SpikeStretcher

Enum Source

This enum is an embedded type of TrigV1 class. Following enum members are defined currently:

• TrigV1.Source.Internal
• TrigV1.Source.External

Method coupling()

Usage: coupling = trig.coupling()

Returns enum of TrigV1.Coupling type.

Method input()

Usage: input = trig.input()

Returns enum of TrigV1.Source type.

Method slope()

Usage: slope = trig.slope()

Returns enum of TrigV1.Slope type.

Method level()

Usage: level = trig.level()

Returns floating number.

Class BldDataPhaseCavity

Python wrapper for pdsdata/bld/BldDataPhaseCavity class.

Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.

Property fFitTime1

Usage: val = phase.fFitTime1

Returns floating number.

Property fFitTime2

Usage: val = phase.fFitTime2

Returns floating number.

Property fCharge1

Usage: val = phase.fCharge1

Returns floating number.

Property fCharge2

Usage: val = phase.fCharge2

Returns floating number.

Class TwoDGaussianV1

Python wrapper for pdsdata/camera/TwoDGaussianV1 class.

Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.

Method integral()

Usage: val = gauss.integral()

Returns integral statistics as integer number.

Method xmean()

Usage: val = gauss.xmean()

Returns mean X value as floating number.

Method ymean()

Usage: val = gauss.ymean()

Returns mean Y value as floating number.

Method major_axis_width()

Usage: val = gauss.major_axis_width()

Returns width of major axis as floating number.

Method minor_axis_width()

Usage: val = gauss.minor_axis_width()

Returns width of minor axis as floating number.

Method major_axis_tilt()

Usage: val = gauss.major_axis_tilt()

Returns tilt of major axis as floating number.

Class PVMonitor

Python wrapper for pdsdata/control/PVMonitor class.

Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.

Method name()

Usage: val = control.name()

Returns name of the monitoring channel.

Method array()

Usage: val = control.array()

Returns true for array.

Method index()

Usage: val = control.index()

Returns index in the array.

Method loValue()

Usage: val = control.loValue()

Returns low value as floating number.

Method hiValue()

Usage: val = control.hiValue()

Returns high value as floating number.

Class epicsTimeStamp

Python wrapper for pdsdata/epics/epicsTimeStamp class. In addition to methods described here the class also defines __hash__ and __cmp__ methods based on the content of the object and can be used as a key in the dictionaries.

Construction

Usage: {{ts = epics.epicsTimeStamp(\[_sec_, \[_nsec_\]\])}}

Arguments:

• sec – number of seconds since Jan 1, 1990 00:00
• nsec – nanoseconds within second

Property secPastEpoch

Usage: val = ts.secPastEpoch

Returns number of seconds since Jan 1, 1990 00:00.

Property nsec

Usage: val = ts.nsec

Returns nanoseconds within second.

Class PulseConfig

Python wrapper for pdsdata/evr/PulseConfig class.

Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.

Method pulse()

Usage: val = config.pulse()

Returns internal pulse generation channel as integer number.

Method trigger()

Usage: val = config.trigger()

Returns integer number.

Method set()

Usage: val = config.set()

Returns integer number.

Method clear()

Usage: val = config.clear()

Returns integer number.

Method polarity()

Usage: val = config.polarity()

Returns Boolean value.

Method map_set_enable()

Usage: val = config.map_set_enable()

Returns Boolean value.

Method map_reset_enable()

Usage: val = config.map_reset_enable()

Returns Boolean value.

Method map_trigger_enable()

Usage: val = config.map_trigger_enable()

Returns Boolean value.

Method prescale()

Usage: val = config.prescale()

Returns integer number.

Method delay()

Usage: val = config.delay()

Returns integer number.

Method width()

Usage: val = config.width()

Returns integer number.

Class ConfigV1

Python wrapper for pdsdata/opal1k/ConfigV1 class.

Constants

• LUT_Size
• Row_Pixels
• Column_Pixels

Enum Depth

This enum is an embedded type of ConfigV1 class. Following enum members are defined currently:

• ConfigV1.Depth.Eight_bit
• ConfigV1.Depth.Ten_bit
• ConfigV1.Depth.Twelve_bit

Enum Binning

This enum is an embedded type of ConfigV1 class. Following enum members are defined currently:

• ConfigV1.Binning.x1
• ConfigV1.Binning.x2
• ConfigV1.Binning.x4
• ConfigV1.Binning.x8

Enum Mirroring

This enum is an embedded type of ConfigV1 class. Following enum members are defined currently:

• ConfigV1.Mirroring.None
• ConfigV1.Mirroring.HFlip
• ConfigV1.Mirroring.VFlip
• ConfigV1.Mirroring.HVFlip

Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.

Method black_level()

Usage: val = config.black_level()

Returns offset/pedestal setting for camera (before gain) as integer number.

Method gain_percent()

Usage: val = config.gain_percent()

Returns camera gain setting in percentile (\[100-3200\] = \[1x-32x\]) as integer number.

Method output_offset()

Usage: val = config.output_offset()

Returns offset/pedestal value in pixel counts as integer number.

Method output_resolution()

Usage: val = config.output_resolution()

Returns bit-depth of pixel counts as enum ConfigV1.Depth.

Method output_resolution_bits()

Usage: val = config.output_resolution_bits()

Returns bit-depth of pixel counts (in actual bits).

Method vertical_binning()

Usage: val = config.vertical_binning()

Returns vertical re-binning of output (consecutive rows summed) as enum ConfigV1.Binning.

Method output_mirroring()

Usage: val = config.output_mirroring()

Returns geometric transformation of the image as enum ConfigV1.Mirroring.

Method vertical_remapping()

Usage: val = config.vertical_remapping()

Returns Boolean, true: remap the pixels to appear in natural geometric order (left->right, top->bottom), false: pixels appear on dual taps from different rows (left->right, top->bottom) alternated with (left->right, bottom->top) pixel by pixel.

Method defect_pixel_correction_enabled()

Usage: val = config.defect_pixel_correction_enabled()

Returns Boolean value.

Method output_lookup_table_enabled()

Usage: val = config.output_lookup_table_enabled()

Returns Boolean value.

Method output_lookup_table()

Usage: val = config.output_lookup_table()

Returns output lookup table as NumPy array, elements of array are unsigned numbers.

Method number_of_defect_pixels()

Usage: val = config.number_of_defect_pixels()

Returns defective pixel count.

Method defect_pixel_coordinates()

Usage: val = config.defect_pixel_coordinates()

Returns list of defective pixel coordinates, elements of the list have type camera.FrameCoord.

Method size()

Usage: val = config.size()

Returns total size of this structure.

Class FrameV1

Python wrapper for pdsdata/pnCCD/FrameV1 class.

Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.

Method specialWord()

Usage: val = frame.specialWord()

Returns integer number.

Method frameNumber()

Usage: val = frame.frameNumber()

Returns integer number.

Method timeStampHi()

Usage: val = frame.timeStampHi()

Returns integer number.

Method timeStampLo()

Usage: val = frame.timeStampLo()

Returns integer number.

Method next()

Usage: val = frame.next(config)

Returns next frame object or None.

Arguments:

• config - object of type pnccd.ConfigV1.

Method data()

Usage: val = frame.data(config)

Returns frame data as NumPy 2-dimensional array of integers of size 512x512.

Arguments:

• config - object of type pnccd.ConfigV1.

Method sizeofData()

Usage: val = frame.sizeofData(config)

Returns integer number.

Arguments:

• config - object of type pnccd.ConfigV1.

Class TM6740ConfigV1

Python wrapper for pdsdata/pulnix/TM6740ConfigV1 class.

Constants

• Row_Pixels
• Column_Pixels

Enum Depth

This enum is an embedded type of TM6740ConfigV1 class. Following enum members are defined currently:

• TM6740ConfigV1.Depth.Eight_bit
• TM6740ConfigV1.Depth.Ten_bit

Enum Binning

This enum is an embedded type of TM6740ConfigV1 class. Following enum members are defined currently:

• TM6740ConfigV1.Binning.x1
• TM6740ConfigV1.Binning.x2
• TM6740ConfigV1.Binning.x4

Enum LookupTable

This enum is an embedded type of TM6740ConfigV1 class. Following enum members are defined currently:

• TM6740ConfigV1.LookupTable.Gamma
• TM6740ConfigV1.LookupTable.Linear

Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.

Method vref()

Usage: val = config.vref()

Returns integer number.

Method gain_a()

Usage: val = config.gain_a()

Returns integer number.

Method gain_b()

Usage: val = config.gain_b()

Returns integer number.

Method gain_balance()

Usage: val = config.gain_balance()

Returns Boolean value.

Method shutter_width()

Usage: val = config.shutter_width()

Returns integer number.

Method output_resolution()

Usage: val = config.output_resolution()

Returns bit-depth of pixel counts as enum TM6740ConfigV1.Depth.

Method output_resolution_bits()

Usage: val = config.output_resolution_bits()

Returns bit-depth of pixel counts (in actual bits).

Method horizontal_binning()

Usage: val = config.horizontal_binning()

Returns horizontal re-binning of output (consecutive columns summed) as enum TM6740ConfigV1.Binning.

Method vertical_binning()

Usage: val = config.vertical_binning()

Returns vertical re-binning of output (consecutive rows summed) as enum TM6740ConfigV1.Binning.

Method lookuptable_mode()

Usage: val = config.lookuptable_mode()

Returns output lookup table corrections as enum TM6740ConfigV1.LookupTable.