eb_tests.iaea.IAEAPhaseSpace Class Reference

Inheritance diagram for eb_tests.iaea.IAEAPhaseSpace:

Collaboration diagram for eb_tests.iaea.IAEAPhaseSpace:

Public Member Functions
	__init__ (self, path, mode='r')
	num_particles (self, particle_type='all')
	num_orig_particles (self)
	maximum_energy (self)
	source_id (self)

Public Attributes
	access = iaea_types.iaea_file_modes[mode]
	path = os.path.realpath(path)

Static Public Attributes
str	header_ext = '.IAEAheader'
str	phsp_ext = '.IAEAphsp'

Protected Member Functions
	_create_source (self)
	_set_path (self, path)

Protected Attributes
	_source_id = iaea_types.IAEA_I32(-1)

Detailed Description

Definition at line 25 of file iaea.py.

Constructor & Destructor Documentation

__init__()

eb_tests.iaea.IAEAPhaseSpace.__init__	(		self,
			path,
			mode = 'r' )

Set up access to an IAEA phase space file

Arguments:
path -- The path to the iaea phase space file

Keyword arguments:
mode -- 'r' for read, 'w' for read/write or 'a' for 'append' (default 'r')

Definition at line 31 of file iaea.py.

Member Function Documentation

_create_source()

eb_tests.iaea.IAEAPhaseSpace._create_source ( self )

protected

Definition at line 52 of file iaea.py.

_set_path()

eb_tests.iaea.IAEAPhaseSpace._set_path ( self, path )

protected

Definition at line 122 of file iaea.py.

maximum_energy()

eb_tests.iaea.IAEAPhaseSpace.maximum_energy

(

self

)

Return maximum energy in this source in (MeV)

Definition at line 108 of file iaea.py.

num_orig_particles()

eb_tests.iaea.IAEAPhaseSpace.num_orig_particles

(

self

)

Return max number of particles of type particle_type

Keyword arguments:
particle_type -- type or category of particle to check (default 'all')

Definition at line 88 of file iaea.py.

num_particles()

eb_tests.iaea.IAEAPhaseSpace.num_particles	(		self,
			particle_type = 'all' )

Return max number of particles of type particle_type

Keyword arguments:
particle_type -- type or category of particle to check (default 'all')

Definition at line 61 of file iaea.py.

source_id()

eb_tests.iaea.IAEAPhaseSpace.source_id

(

self

)

Definition at line 119 of file iaea.py.

Member Data Documentation

_source_id

eb_tests.iaea.IAEAPhaseSpace._source_id = iaea_types.IAEA_I32(-1)

protected

Definition at line 42 of file iaea.py.

access

eb_tests.iaea.IAEAPhaseSpace.access = iaea_types.iaea_file_modes[mode]

Definition at line 45 of file iaea.py.

header_ext

str eb_tests.iaea.IAEAPhaseSpace.header_ext = '.IAEAheader'

static

Definition at line 27 of file iaea.py.

path

eb_tests.iaea.IAEAPhaseSpace.path = os.path.realpath(path)

Definition at line 123 of file iaea.py.

phsp_ext

str eb_tests.iaea.IAEAPhaseSpace.phsp_ext = '.IAEAphsp'

static

Definition at line 28 of file iaea.py.

---

The documentation for this class was generated from the following file:

• /Users/marc/Developer/clrp/EGSnrc-eb/HEN_HOUSE/user_codes/egs_brachy/egs_brachy/eb_tests/iaea.py