Page History
...
Panel | ||||||
---|---|---|---|---|---|---|
Class EnvInstance of this class is a container for all sorts of environment data. ConstructionUsage: Creates environment object. Parameters:
Objects of this type are created by pyana itself and end users do not need to create new instances. Method jobName()Usage: Returns analysis job name string. Method 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. Keyword arguments: detector – accepts enum xtc.DetInfo.Detector values, only returns objects produced by this detectordetId – accepts number, only returns objects produced by this detector IDdevice – accepts enum xtc.DetInfo.Device values, only returns objects produced by this device Parameters: devId – accepts number, only returns objects produced by this device ID
Method getPnCCDConfig()Usage: Returns pnCCD configuration object for a given device address. If more than one object is matched by the parameters then first arbitrary object is returned. Accepts the same keyword arguments as the getAcqConfig() method. 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. |
...