Page History
...
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
Class pyana.event.EventInstance of this class contains all event data. ConstructionUsage: Creates event object from the corresponding XTC datagram object. Parameters:
Method damage()Usage: Returns object of type PSDM: 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 get()
This is a generic method for finding an object of given type. If address is not given or is not very specific then the first matching object is returned. Note that this method returns original data types defined in Parameters:
Method getAcqValue()Usage: Returns Acqiris data object of type PSDM: Parameters:
Channel number is an integer number, total number of channels can be extracted from the Acqiris configuration object. Method getCsPadQuads()Usage: Returns list of objects of type PSDM: Parameters:
The size of the list is determined by the CsPad configuration ( Method getEBeam()Usage: Returns data object of type PSDM: Method getEvrData()Usage: Returns data object of type PSDM: Parameters:
This method is equivalent to Method getFeeGasDet()Usage:
Method getFrameValue()Usage: Returns frame data object of type PSDM: Parameters:
This method is equivalent to Method getIpimbValue()Usage: Returns frame data object of type PSDM: Parameters:
This method is equivalent to Method getOpal1kValue()Usage: This methods is an alias for Method getPhaseCavity()Usage: Returns data object of type PSDM: Method getPnCcdValue()Usage: returns pnCCD data object of type PSDM: Parameters:
Method getPrincetonValue()Usage: Returns Princeton frame object of type PSDM: Parameters:
Method getTime()Usage: Returns PSDM: Method run()Usage: Returns run number as integer value. Run number is extracted from the file names being processed. When the file name cannot be determined or has unknown format the above method will return negative number. Method seq()Usage: Returns PSDM: |
...
| 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 epicsStore()Usage: This is the primary method for user code to access EPICS data. It returns PSDM: Method getConfig()
This is a generic method for finding a configuration object of given type. If address is not given or is not very specific then the first matching object is returned. Parameters:
Method getAcqConfig()Usage: Returns PSDM: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:
This method is equivalent to Method getOpal1kConfig()Usage: Returns PSDM: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:
This method is equivalent to Method getPnCCDConfig()Usage: Returns PSDM: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:
This method is equivalent to Method getPrincetonConfig()Usage: Returns PSDM:Princeton configuration object for a given device address. If more than one object is matched by the parameters then first arbitrary object is returned. Parameters:
This method is equivalent to Method hmgr()Usage: Returns histogram manager object of type Method jobName()Usage: Returns analysis job name string. 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 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 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 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. 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 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 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. |
...
| 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 PSDM: Parameters:
This is the primary method to access EPICS information in pyana jobs. |
...
| 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 PSDM: 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 PSDM: |
...
| 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:
Method bits()Usage: Returns damage mask excluding user bits as integer number. Method userBits()Usage: Returns user bits of the damage mask as integer number. |
...
| 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 PSDM: 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 PSDM: Method device()Usage: Returns device enum which is a value of PSDM: 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 PSDM: Property xtcUsage: Returns top-level Xtc as object of type PSDM: |
...
| 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 PSDM: 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 PSDM: Method service()Usage: Returns the transition type as object of PSDM: 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 PSDM: Method stamp()Usage: Returns timestamp value for sequence as an object of PSDM: |
...
| 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.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 PSDM: Property srcUsage: Returns data source object. Depending on the source level the type of the returned object will be one of PSDM: Property containsUsage: Returns the type of the object contained in XTC as object od PSDM: 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.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 PSDM: Method vert()Usage: Returns object of PSDM: 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 PSDM: Arguments:
Method waveform()Usage: Returns waveform array of Arguments:
Method nextChannel()Usage: Returns data object of PSDM: 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.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 PSDM: Method roiEnd()Usage: Returns coordinates of finish of rectangular region of interest (exclusive) as PSDM: 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 PSDM: 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.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 PSDM: 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 PSDM: Method pvMonitor()Usage: Returns PSDM: |
...
| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
Class _pdsdata.cspad.ConfigV1Python wrapper for pdsdata/cspad/ConfigV1 class.
Enum RunModesThis enum is an embedded type of
Class constants
ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method quads()Usage: Returns list of the objects of type PSDM:_pdsdata.cspad.ConfigV1QuadReg. Method numQuads()Usage: Returns number of quadrants as integer number. Method tdi()Usage: Returns integer number. Method quadMask()Usage: Returns integer number. Method runDelay()Usage: Returns integer number. Method eventCode()Usage: Returns integer number. Method inactiveRunMode()Usage: Returns PSDM:RunModes enum value. Method activeRunMode()Usage: Returns PSDM:RunModes enum value. Method payloadSize()Usage: Returns integer number. Method badAsicMask0()Usage: Returns integer number. Method badAsicMask1()Usage: Returns integer number. Method asicMask()Usage: Returns integer number. Method numAsicsRead()Usage: Returns integer number. Method concentratorVersion()Usage: Returns integer number. |
...
| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
Class _pdsdata.cspad.ConfigV1QuadRegPython wrapper for pdsdata/cspad/ConfigV1QuadReg class.
Enum DataModesThis enum is an embedded type of
Class constants
ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method shiftSelect()Usage: Returns list of integer numbers. Method edgeSelect()Usage: Returns list of integer numbers. Method readClkSet()Usage: Returns integer number. Method readClkHold()Usage: Returns integer number. Method dataMode()Usage: Returns PSDM:DataModes enum value. Method prstSel()Usage: Returns integer number. Method acqDelay()Usage: Returns integer number. Method intTime()Usage: Returns integer number. Method digDelay()Usage: Returns integer number. Method ampIdle()Usage: Returns integer number. Method injTotal()Usage: Returns integer number. Method rowColShiftPer()Usage: Returns integer number. Method readOnly()Usage: Returns object of type PSDM:_pdsdata.cspad.CsPadReadOnlyCfg. Method ro()Usage: Equivalent to Method dp()Usage: Returns object of type PSDM:_pdsdata.cspad.CsPadDigitalPotsCfg. Method gm()Usage: Returns object of type PSDM:_pdsdata.cspad.CsPadGainMapCfg. |
...
| Panel | ||||||
|---|---|---|---|---|---|---|
Class _pdsdata.cspad.CsPadGainMapCfgPython wrapper for pdsdata/cspad/CsPadGainMapCfg class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method map()Usage: Returns 2-dimensional array of size Property gainMapUsage: Returns the same array as |
...
| Panel | ||||||
|---|---|---|---|---|---|---|
Class _pdsdata.cspad.ElementV1Python wrapper for pdsdata/cspad/ElementV1 class. Class constants
ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method virtual_channel()Usage: Returns integer number. Method lane()Usage: Returns integer number. Method tid()Usage: Returns integer number. Method acq_count()Usage: Returns integer number. Method op_code()Usage: Returns integer number. Method quad()Usage: Returns integer number. Method seq_count()Usage: Returns integer number. Method ticks()Usage: Returns integer number. Method fiducials()Usage: Returns integer number. Method frame_type()Usage: Returns integer number. Method sb_temp()Usage: Returns integer number, index is a number from 0 to 3. Method next()Usage: Returns next element, config is an object of type Method data()Usage: Returns data array, config is an object of type PSDM:_pdsdata.cspad.ConfigV1 type. Dimensions of array are Method pixel()Usage: Returns value of a given pixel. |
...
| 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.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 PSDM: 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 PSDM: Method noutputs()Usage: Returns integer number. Method output_map()Usage: Returns object of PSDM: 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 PSDM: Method noutputs()Usage: Returns integer number. Method output_map()Usage: Returns object of PSDM: Method size()Usage: Returns total size of the object. |
...
| Panel | ||||||
|---|---|---|---|---|---|---|
Class _pdsdata.evr.ConfigV3Python wrapper for pdsdata/evr/ConfigV3 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method neventcodes()Usage: Returns integer number. Method eventcode()Usage: Returns object of PSDM: Method npulses()Usage: Returns integer number. Method pulse()Usage: Returns object of PSDM: Method noutputs()Usage: Returns integer number. Method output_map()Usage: Returns object of PSDM: Method size()Usage: Returns total size of the object. |
...
| Panel | ||||||
|---|---|---|---|---|---|---|
Class _pdsdata.evr.ConfigV4Python wrapper for pdsdata/evr/ConfigV4 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method neventcodes()Usage: Returns integer number. Method eventcode()Usage: Returns object of PSDM: Method npulses()Usage: Returns integer number. Method pulse()Usage: Returns object of PSDM: Method noutputs()Usage: Returns integer number. Method output_map()Usage: Returns object of PSDM: Method size()Usage: Returns total size of the object. |
...
| Panel | ||||||
|---|---|---|---|---|---|---|
Class _pdsdata.evr.DataV3Python wrapper for pdsdata/evr/DataV3 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method numFifoEvents()Usage: Returns integer number. Method fifoEvent()Usage: Returns object of PSDM: |
...
| Panel | ||||||
|---|---|---|---|---|---|---|
Class _pdsdata.evr.IOChannelPython wrapper for pdsdata/evr/IOChannel class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method name()Usage: Returns string value. Method ninfo()Usage: Returns integer value representing the number of info objects. Method info()Usage: Returns PSDM:xtc.DetInfo object. Arguments:
|
...
| Panel | ||||||
|---|---|---|---|---|---|---|
Class _pdsdata.evr.IOConfigV1Python wrapper for pdsdata/evr/IOConfigV1 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method conn()Usage: Returns PSDM:evr.OutputMap.Conn enumeration value. Method nchannels()Usage: Returns integer value representing number of channels. Method channel()Usage: Returns PSDM:evr.IOChannel object for given index. Arguments:
|
...
| Panel | ||||||
|---|---|---|---|---|---|---|
Class _pdsdata.lusi.IpmFexConfigV1Python wrapper for pdsdata/lusi/IpmFexConfigV1 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Property diodeUsage: Returns list of PSDM:_pdsdata.lusi.DiodeFexConfigV1 objects. Property xscaleUsage: Returns floating number. Property yscaleUsage: Returns floating 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 PSDM: Method size()Usage: Returns total size of this structure. |
...
| 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:
|
...
| Anchor | ||||
|---|---|---|---|---|
|
...
| Panel | ||||||
|---|---|---|---|---|---|---|
Class _pdsdata.princeton.FrameV1Python wrapper for pdsdata/princeton/FrameV1 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method shotIdStart()Usage: Returns integer number. Method readoutTime()Usage: Returns floating number. Method data()Usage: Returns frame data as NumPy 2-dimensional array of integers, size is determined by the configuration object. Arguments:
|
...
| Panel | ||||||
|---|---|---|---|---|---|---|
Class _pdsdata.princeton.InfoV1Python wrapper for pdsdata/princeton/InfoV1 class. ConstructionThis class cannot be instantiated directly, methods of other classes return instances of this type. Method temperature()Usage: Returns floating number. |
...
This package is a user-level interface to lower-level PSDM:_pdsdata package. It repeats the module structure of _pdsdata and defines the same classes but shields user from unnecessary details present in _pdsdata. In many cases pypdsdata imports the class from _pdsdata without any changes. Documentation below only describes cases when pypdsdata changes or extends the corresponding _pdsdata types, for unchanged types consult corresponding _pdsdata documentation.
...
| Panel | ||||||
|---|---|---|---|---|---|---|
Class pypdsdata.acqiris.DataDescV1This class overrides several methods in the corresponding PSDM: ConstructionUsage: Arguments:
Method nbrSamplesInSeg()Usage: Returns integer number. Method nbrSegments()Usage: Returns integer number. Method timestamp()Usage: Returns object of PSDM: 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 PSDM: |
...
| Anchor | ||||
|---|---|---|---|---|
|
...
| Panel | ||||||
|---|---|---|---|---|---|---|
Class pypdsdata.cspad.ElementV1This class overrides several methods in the corresponding PSDM: Class constants
ConstructionUsage: Arguments:
Method virtual_channel()Usage: Returns integer number. Method lane()Usage: Returns integer number. Method tid()Usage: Returns integer number. Method acq_count()Usage: Returns integer number. Method op_code()Usage: Returns integer number. Method quad()Usage: Returns integer number. Method seq_count()Usage: Returns integer number. Method ticks()Usage: Returns integer number. Method fiducials()Usage: Returns integer number. Method frame_type()Usage: Returns integer number. Method sb_temp()Usage: Returns integer number, index is a number from 0 to 3. Method data()Usage: Returns data array. Dimensions of array are Method pixel()Usage: Returns value of a given pixel. |
...
| Panel | ||||||
|---|---|---|---|---|---|---|
Class pypdsdata.pnccd.FrameV1This class overrides several methods in the corresponding PSDM: 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. |
...
| Panel | ||||||
|---|---|---|---|---|---|---|
Class pypdsdata.princeton.FrameV1This class overrides several methods in the corresponding PSDM: ConstructionUsage: Arguments:
Method shotIdStart()Usage: Returns integer number. Method readoutTime()Usage: Returns floating number. Method data()Usage: Returns frame data as NumPy 2-dimensional array of integers. |
Overview
Content Tools