DCUtils Namespace Reference

Classes
class	h5py_proxy
class	Storage
Functions
def	str_tstamp
def	get_enviroment
def	get_login
def	get_hostname
def	get_cwd
def	create_directory_v0
def	create_directory
def	create_path
def	save_string_as_dset
def	source_full_name
def	dettype_from_str_source
def	string_from_source
def	detector_full_name
def	psana_source
	------------------------------
def	get_subgroup
def	delete_object
def	save_object_as_dset
def	evt_time
def	evt_fiducials
def	test_source_full_name
def	test_string_from_source
def	test_psana_source
def	test_detector_full_name
def	test_evt_time
def	test_misc
def	do_test
Variables
string	__version__ = "$Revision: 12777 $"
tuple	sp = Storage()

---

Function Documentation

def DCUtils::str_tstamp	(		fmt = '%Y-%m-%dT%H:%M:%S',
			time_sec = None
	)

Returns string timestamp for specified format and time in sec or current time by default

Definition at line 111 of file DCUtils.py.

def DCUtils::get_enviroment

(

env = 'USER'

)

Returns the value of specified by string name environment variable

Definition at line 118 of file DCUtils.py.

def DCUtils::get_login

(

)

Returns login name

Definition at line 125 of file DCUtils.py.

def DCUtils::get_hostname

(

)

Returns login name

Definition at line 133 of file DCUtils.py.

def DCUtils::get_cwd

(

)

Returns current working directory

Definition at line 141 of file DCUtils.py.

def DCUtils::create_directory_v0	(		dir,
			verb = False
	)

Definition at line 148 of file DCUtils.py.

def DCUtils::create_directory	(		dir,
			mode = 0775
	)

Definition at line 157 of file DCUtils.py.

def DCUtils::create_path	(		path,
			depth = 2,
			mode = 0775
	)

Definition at line 169 of file DCUtils.py.

def DCUtils::save_string_as_dset	(		grp,
			name,
			s
	)

Creates and returns the h5py dataset object with name for single string s

Definition at line 185 of file DCUtils.py.

def DCUtils::source_full_name	(		env,
			src
	)

Returns full name like 'DetInfo(XppGon.0:Cspad2x2.0)' of the brief source or its alias
   using env.configStore().keys()

Definition at line 197 of file DCUtils.py.

def DCUtils::dettype_from_str_source

(

src

)

Returns the detector type from full psana source name (Ex.: Cspad2x2 from DetInfo(XppGon.0:Cspad2x2.0) 

Definition at line 209 of file DCUtils.py.

def DCUtils::string_from_source

(

source

)

Returns string like 'CxiDs2.0:Cspad.0' from 'DetInfo(CxiDs2.0:Cspad.0)'
   or 'DsaCsPad' from 'Source('DsaCsPad')' form input string or psana.Source object

Definition at line 219 of file DCUtils.py.

def DCUtils::detector_full_name	(		env,
			src
	)

Returns full detector name like 'XppGon.0:Cspad2x2.0' for short src, alias src, or psana.Source.

Definition at line 230 of file DCUtils.py.

def DCUtils::psana_source	(		env,
			srcpar
	)

------------------------------

returns psana.Source(src) from other psana.Source brief src or alias.

   Parameters

   srcpar  : str  - regular source or its alias, ex.: 'XppEndstation.0:Rayonix.0' or 'rayonix'
   set_sub : bool - default=True - propagates source parameter to low level package  

Definition at line 242 of file DCUtils.py.

def DCUtils::get_subgroup	(		grp,
			subgr_name
	)

For hdf5:
   returns subgroup of the group if it exists or creates and returns new subgroup

Definition at line 264 of file DCUtils.py.

def DCUtils::delete_object	(		grp,
			oname
	)

Definition at line 274 of file DCUtils.py.

def DCUtils::save_object_as_dset	(		grp,
			name,
			shape = None,
			dtype = None,
			data = 0
	)

Saves object as h5py dataset

   Currently supports scalar int, double, string and numpy.array

Definition at line 284 of file DCUtils.py.

def DCUtils::evt_time

(

evt

)

Returns event (double) time.

Definition at line 314 of file DCUtils.py.

def DCUtils::evt_fiducials

(

evt

)

Returns event fiducials.

Definition at line 324 of file DCUtils.py.

def DCUtils::test_source_full_name

(

)

Definition at line 336 of file DCUtils.py.

def DCUtils::test_string_from_source

(

)

Definition at line 347 of file DCUtils.py.

def DCUtils::test_psana_source

(

)

Definition at line 357 of file DCUtils.py.

def DCUtils::test_detector_full_name

(

)

Definition at line 368 of file DCUtils.py.

def DCUtils::test_evt_time

(

)

Definition at line 379 of file DCUtils.py.

def DCUtils::test_misc

(

)

Definition at line 388 of file DCUtils.py.

def DCUtils::do_test

(

)

Definition at line 397 of file DCUtils.py.

---

Variable Documentation

string DCUtils::__version__ = "$Revision: 12777 $" [static]

Definition at line 67 of file DCUtils.py.

tuple DCUtils::sp = Storage() [static]

Definition at line 107 of file DCUtils.py.

---