Page History
...
Anchor | ||||
---|---|---|---|---|
|
Module pyana.event
This module is a collection of classes and methods to deal with the event data and everything related to it.
...
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
Class pyana.event.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 getOpal1kValue()Usage: Returns Acqiris data object of type Parameters:
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 pyana.event.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 subprocess()Usage: Returns sub-process number. In case of multi-processing job it will be a non-negative number ranging from 0 to a total number of sub-processes. In case of single-process job it will return -1. Method jobNameSub()Usage: Returns process-specific analysis job name string. In case of multi-processing job it will a string in format "jobName-procNum" where procNum is a number returned by 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. Parameters:
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. Parameters:
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. Parameters:
Method getControlConfig()Usage: Returns control.Config configuration object or 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 pyana.event.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. |
...
Anchor | ||||
---|---|---|---|---|
|
Module pyana.histo
This module is a collection classes and methods to create and manage histograms from user analysis modules.
...
Panel | ||||||
---|---|---|---|---|---|---|
Class pyana.histo.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 pyana.histo.HistoMgr()Usage: Do not call it, it's for pyana internal use. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.ErrorThis is the type for the exception generated by few methods in _pdsdata package. ConstructionUsage: Arguments:
|
...
Panel | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Class _pdsdata.xtc.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 _pdsdata.xtc.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 _pdsdata.xtc.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 _pdsdata.xtc.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 _pdsdata.xtc.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 _pdsdata.xtc.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 _pdsdata.xtc.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 _pdsdata.xtc.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 _pdsdata.xtc.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 _pdsdata.xtc.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 _pdsdata.xtc.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 _pdsdata.xtc.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 _pdsdata.xtc.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 _pdsdata.xtc.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:
|
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.acqiris.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 _pdsdata.acqiris.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 _pdsdata.acqiris.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 _pdsdata.acqiris.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 _pdsdata.acqiris.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. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.bld.BldDataEBeamPython wrapper for pdsdata/bld/BldDataEBeam class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Property uDamageMaskUsage: Returns integer number. Property fEbeamChargeUsage: Returns floating number. Property fEbeamL3EnergyUsage: Returns floating number. Property fEbeamLTUPosXUsage: Returns floating number. Property fEbeamLTUPosYUsage: Returns floating number. Property fEbeamLTUAngXUsage: Returns floating number. Property fEbeamLTUAngYUsage: Returns floating number. Property fEbeamPkCurrBC2Usage: Returns floating number. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.bld.BldDataEBeamV0Python wrapper for pdsdata/bld/BldDataEBeamV0 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Property uDamageMaskUsage: Returns integer number. Property fEbeamChargeUsage: Returns floating number. Property fEbeamL3EnergyUsage: Returns floating number. Property fEbeamLTUPosXUsage: Returns floating number. Property fEbeamLTUPosYUsage: Returns floating number. Property fEbeamLTUAngXUsage: Returns floating number. Property fEbeamLTUAngYUsage: Returns floating number. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.bld.BldDataFEEGasDetEnergyPython wrapper for pdsdata/bld/BldDataFEEGasDetEnergy class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Property f_11_ENRCUsage: Returns floating number. Property f_12_ENRCUsage: Returns floating number. Property f_21_ENRCUsage: Returns floating number. Property f_22_ENRCUsage: Returns floating number. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.bld.BldDataPhaseCavityPython wrapper for pdsdata/bld/BldDataPhaseCavity class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Property fFitTime1Usage: Returns floating number. Property fFitTime2Usage: Returns floating number. Property fCharge1Usage: Returns floating number. Property fCharge2Usage: Returns floating number. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.camera.FrameCoordPython wrapper for pdsdata/camera/FrameCoord class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Property columnUsage: Returns integer number. Property columnUsage: Returns integer number. Property xUsage: Returns integer number, this is equivalent to Property yUsage: Returns integer number, this is equivalent to |
...
Panel | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Class _pdsdata.camera.FrameFexConfigV1Python wrapper for pdsdata/camera/FrameFexConfigV1 class.
Enum ForwardingThis enum is an embedded type of
Enum ProcessingThis enum is an embedded type of
ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method forwarding()Usage: Returns forwarding policy for frame data as enum Method forward_prescale()Usage: Returns prescale of events with forwarded frames as integer number. Method processing()Usage: Returns algorithm to apply to frames to produce processed output as enum Method roiBegin()Usage: Returns coordinates of start of rectangular region of interest (inclusive) as Method roiEnd()Usage: Returns coordinates of finish of rectangular region of interest (exclusive) as Method threshold()Usage: Returns pixel data threshold value to apply in processing as integer number. Method number_of_masked_pixels()Usage: Returns count of masked pixels to exclude from processing as integer number. Method masked_pixel_coordinates()Usage: Returns Python list of masked pixel coordinates, items in the list have type Method size()Usage: Returns size of this structure (including appended masked pixel coordinates). |
...
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
Class _pdsdata.camera.FrameV1Python wrapper for pdsdata/camera/FrameV1 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method width()Usage: Returns number of pixels in a row. Method height()Usage: Returns number of pixels in a column. Method depth()Usage: Returns number of bits per pixel. Method depth_bytes()Usage: Returns number of bytes per pixel. Method offset()Usage: Returns fixed offset/pedestal value of pixel data. Method data_size()Usage: Returns fixed offset/pedestal value of pixel data. Method data()
Returns pixel data as NumPy array, if optional argument is True then array is writable. Arguments:
Method pixel()Usage: Returns individual pixel datum given coordinates (x, y). |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.camera.TwoDGaussianV1Python wrapper for pdsdata/camera/TwoDGaussianV1 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method integral()Usage: Returns integral statistics as integer number. Method xmean()Usage: Returns mean X value as floating number. Method ymean()Usage: Returns mean Y value as floating number. Method major_axis_width()Usage: Returns width of major axis as floating number. Method minor_axis_width()Usage: Returns width of minor axis as floating number. Method major_axis_tilt()Usage: Returns tilt of major axis as floating number. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.control.ConfigV1Python wrapper for pdsdata/control/ConfigV1 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method uses_duration()Usage: Returns Boolean value. Method uses_events()Usage: Returns Boolean value. Method duration()Usage: Returns value of Method events()Usage: Returns number of events. Method npvControls()Usage: Returns number of PVControls. Method npvMonitors()Usage: Returns number of PVMonitors. Method size()Usage: Returns total data size. Method pvControl()Usage: Returns Method pvMonitor()Usage: Returns |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.control.PVControlPython wrapper for pdsdata/control/PVControl class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method name()Usage: Returns name of the monitoring channel. Method array()Usage: Returns true if the channel is an array. Method index()Usage: Returns index in the array. Method value()Usage: Returns value as floating number. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.control.PVMonitorPython wrapper for pdsdata/control/PVMonitor class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method name()Usage: Returns name of the monitoring channel. Method array()Usage: Returns true for array. Method index()Usage: Returns index in the array. Method loValue()Usage: Returns low value as floating number. Method hiValue()Usage: Returns high value as floating number. |
...
Panel | ||||||
---|---|---|---|---|---|---|
_pdsdata.epics ConstantsModule defines a number of constants which determine the type of the EPICS data. This constants are:
where the
Currently the data EPICS stored in XTC files is either of |
...
Panel | ||||||
---|---|---|---|---|---|---|
Function _pdsdata.epics.dbr_type_is_CTRL()Usage: Returns true if the EPICS type constant of the data object is one of |
...
Panel | ||||||
---|---|---|---|---|---|---|
Function _pdsdata.epics.dbr_type_is_TIME()Usage: Returns true if the EPICS type constant of the data object is one of |
...
Panel | ||
---|---|---|
Array _pdsdata.epics.epicsAlarmConditionStrings
Stores string representation of the EPICS status codes. |
...
Panel | ||
---|---|---|
Array _pdsdata.epics.epicsAlarmSeverityStrings
Stores string representation of the EPICS severity codes. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.epics.EpicsPvCtrlPython wrapper for pdsdata/epics/EpicsPvCtrl<T> classes. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Property iPvIdUsage: Returns PV ID as integer number. Property iDbrTypeUsage: Returns one of the Property iNumElementsUsage: Returns size of PV array. Property sPvNameUsage: Returns PV name. Property statusUsage: Returns status as integer number. Value can be used as an index into Property severityUsage: Returns severity as integer number. Value can be used as an index into Property precisionUsage: Returns precision of the floating point data as number of decimal digits. For non-floating types precision is None. Property unitsUsage: String describing physical units, None for Property upper_disp_limitUsage: One of the EPICS data data limits, type is determined by PV type, None returned for Property lower_disp_limitUsage: One of the EPICS data data limits, type is determined by PV type, None returned for Property upper_alarm_limitUsage: One of the EPICS data data limits, type is determined by PV type, None returned for Property upper_warning_limitUsage: One of the EPICS data data limits, type is determined by PV type, None returned for Property lower_warning_limitUsage: One of the EPICS data data limits, type is determined by PV type, None returned for Property lower_alarm_limitUsage: One of the EPICS data data limits, type is determined by PV type, None returned for Property upper_ctrl_limitUsage: One of the EPICS data data limits, type is determined by PV type, None returned for Property lower_ctrl_limitUsage: One of the EPICS data data limits, type is determined by PV type, None returned for Property no_strUsage: Number of ENUM states, None for non-enum PV types. Property strsUsage: List of ENUM states, None for non-enum PV types. Property valueUsage: PV value, always a single value, for arrays it is first element. Type of the value is determined by PV type. Property valuesUsage: List of PV values of size |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.epics.EpicsPvTimePython wrapper for pdsdata/epics/EpicsPvTime<T> classes. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Property iPvIdUsage: Returns PV ID as integer number. Property iDbrTypeUsage: Returns one of the Property iNumElementsUsage: Returns size of PV array. Property statusUsage: Returns status as integer number. Value can be used as an index into Property severityUsage: Returns severity as integer number. Value can be used as an index into Property stampUsage: EPICS timestamp value of type Property valueUsage: PV value, always a single value, for arrays it is first element. Type of the value is determined by PV type. Property valuesUsage: List of PV values of size |
...
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
Class _pdsdata.epics.epicsTimeStampPython wrapper for pdsdata/epics/epicsTimeStamp class. In addition to methods described here the class also defines Construction
Arguments:
Property secPastEpochUsage: Returns number of seconds since Jan 1, 1990 00:00. Property nsecUsage: Returns nanoseconds within second. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.evr.ConfigV1Python wrapper for pdsdata/evr/ConfigV1 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method npulses()Usage: Returns integer number. Method pulse()Usage: Returns object of Method noutputs()Usage: Returns integer number. Method output_map()Usage: Returns object of Method size()Usage: Returns total size of the object. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.evr.ConfigV2Python wrapper for pdsdata/evr/ConfigV2 class. Enum RateCodeThis enum is an embedded type of
Enum BeamCodeThis enum is an embedded type of
ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method beam()Usage: Returns value of enum Method rate()Usage: Returns value of enum Method opcode()Usage: Returns integer number. Method npulses()Usage: Returns integer number. Method pulse()Usage: Returns object of Method noutputs()Usage: Returns integer number. Method output_map()Usage: Returns object of Method size()Usage: Returns total size of the object. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.evr.OutputMapPython wrapper for pdsdata/evr/OutputMap class. Enum SourceThis enum is an embedded type of
Enum ConnThis enum is an embedded type of
ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method source()Usage: Returns value of enum Method source_id()Usage: Returns integer number. Method conn()Usage: Returns value of enum Method conn_id()Usage: Returns integer number. Method map()Usage: Returns encoded source value as integer number. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.evr.PulseConfigPython wrapper for pdsdata/evr/PulseConfig class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method pulse()Usage: Returns internal pulse generation channel as integer number. Method trigger()Usage: Returns integer number. Method set()Usage: Returns integer number. Method clear()Usage: Returns integer number. Method polarity()Usage: Returns Boolean value. Method map_set_enable()Usage: Returns Boolean value. Method map_reset_enable()Usage: Returns Boolean value. Method map_trigger_enable()Usage: Returns Boolean value. Method prescale()Usage: Returns integer number. Method delay()Usage: Returns integer number. Method width()Usage: Returns integer number. |
...
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
Class _pdsdata.opal1k.ConfigV1Python wrapper for pdsdata/opal1k/ConfigV1 class. Constants
Enum DepthThis enum is an embedded type of
Enum BinningThis enum is an embedded type of
Enum MirroringThis enum is an embedded type of
ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method black_level()Usage: Returns offset/pedestal setting for camera (before gain) as integer number. Method gain_percent()Usage:
Method output_offset()Usage: Returns offset/pedestal value in pixel counts as integer number. Method output_resolution()Usage: Returns bit-depth of pixel counts as enum Method output_resolution_bits()Usage: Returns bit-depth of pixel counts (in actual bits). Method vertical_binning()Usage: Returns vertical re-binning of output (consecutive rows summed) as enum Method output_mirroring()Usage: Returns geometric transformation of the image as enum Method vertical_remapping()Usage: 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: Returns Boolean value. Method output_lookup_table_enabled()Usage: Returns Boolean value. Method output_lookup_table()Usage: Returns output lookup table as NumPy array, elements of array are unsigned numbers. Method number_of_defect_pixels()Usage: Returns defective pixel count. Method defect_pixel_coordinates()Usage: Returns list of defective pixel coordinates, elements of the list have type Method size()Usage: Returns total size of this structure. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.pnccd.ConfigV1Python wrapper for pdsdata/pnCCD/ConfigV1 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method numLinks()Usage: Returns number of links. Method payloadSizePerLink()Usage: Returns data size per link. |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.pnccd.FrameV1Python wrapper for pdsdata/pnCCD/FrameV1 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method specialWord()Usage: Returns integer number. Method frameNumber()Usage: Returns integer number. Method timeStampHi()Usage: Returns integer number. Method timeStampLo()Usage: Returns integer number. Method next()Usage: Returns next frame object or None. Arguments:
Method data()Usage: Returns frame data as NumPy 2-dimensional array of integers of size 512x512. Arguments:
Method sizeofData()Usage: Returns integer number. Arguments:
|
...
Panel | ||||||
---|---|---|---|---|---|---|
Class _pdsdata.pulnix.TM6740ConfigV1Python wrapper for pdsdata/pulnix/TM6740ConfigV1 class. Constants
Enum DepthThis enum is an embedded type of
Enum BinningThis enum is an embedded type of
Enum LookupTableThis enum is an embedded type of
ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method vref()Usage: Returns integer number. Method gain_a()Usage: Returns integer number. Method gain_b()Usage: Returns integer number. Method gain_balance()Usage: Returns Boolean value. Method shutter_width()Usage: Returns integer number. Method output_resolution()Usage: Returns bit-depth of pixel counts as enum Method output_resolution_bits()Usage: Returns bit-depth of pixel counts (in actual bits). Method horizontal_binning()Usage: Returns horizontal re-binning of output (consecutive columns summed) as enum Method vertical_binning()Usage: Returns vertical re-binning of output (consecutive rows summed) as enum Method lookuptable_mode()Usage: Returns output lookup table corrections as enum |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class pypdsdata.acqiris.DataDescV1This class overrides several methods in the corresponding ConstructionUsage: Arguments:
Method nbrSamplesInSeg()Usage: Returns integer number. Method nbrSegments()Usage: Returns integer number. Method timestamp()Usage: Returns object of Arguments:
Method waveform()Usage: Returns waveform array of Method timestamps()Usage: Returns NumPy array of timestamps (floating numbers). First element of array is always 0, other elements are equidistant with the distance and number of intervals determined by |
...
Panel | ||||||
---|---|---|---|---|---|---|
Class pypdsdata.pnccd.FrameV1This class overrides several methods in the corresponding ConstructionUsage: Arguments:
Method specialWord()Usage: Returns integer number. Method frameNumber()Usage: Returns integer number. Method timeStampHi()Usage: Returns integer number. Method timeStampLo()Usage: Returns integer number. Method data()Usage: Returns frame data as NumPy 2-dimensional array of integers of size 1024x1024. Method sizeofData()Usage: Returns integer number. |