pinspec.process.RITrue Class Reference

A true resonance integral. More...

#include "pinspec/process.py"

Inheritance diagram for pinspec.process.RITrue:

Public Member Functions
def	__init__
	RITrue constructor. More...
def	setName
	Sets the name of the true resonance integral. More...
def	computeRIs
	Computes the true resonance integrals for an isotopic reaction rate. More...
def	getName
	Returns the name of the RITrue object. More...
def	getNumIntegrals
	Returns the number of resonance integral energy bands. More...
def	getIntegrals
	Returns an array of the resonance integrals for each energy band. More...
def	getEnergyBandsCenters
	Returns an array of the centers of each energy band. More...
def	getEnergyBands
	Returns an array of the energy bands. More...
def	printRIs
	Prints a formatted table of the true resonance integrals to the screen. More...

Private Attributes
	_name
	The name of the effective resonance integral.
	_isotope
	The isotope for this resonance integral.
	_reaction
	The reaction rate for this resonance integral (ie, 'capture') More...
	_num_RIs
	The number of resonance integrals.
	_RIs
	The numpy array of resonance integral values.
	_energy_bands
	The numpy array of energy band values.

Detailed Description

A true resonance integral.

This class represents the true resonance integral computed from a spectrum.

Constructor & Destructor Documentation

def pinspec.process.RITrue.__init__	(		self,
			isotope,
			bands,
			reaction = 'capture',
			name = ''
	)

RITrue constructor.

Parameters

self	the RITrue object pointer
isotope	a pointer to the isotope of interest
bands	an array of the energy bands for each resonance integral
reaction	an optional argument string with the reaction rate type
name	an optional argument string for the resonance integral name

Member Function Documentation

def pinspec.process.RITrue.computeRIs	(		self,
			bands,
			reaction
	)

Computes the true resonance integrals for an isotopic reaction rate.

This method computes an infinite dilute resonance integral for each of the user-defined energy bands for some isotopic reaction rate using numerical integration as follows:

Parameters

self	the RITrue object pointer
bands	an array of the energy bands for each resonance integral
reaction	an optional argument string with the reaction rate type

def pinspec.process.RITrue.getEnergyBands

(

self

)

Returns an array of the energy bands.

Parameters

self	the RITrue object pointer

Returns

a numpy array of the values defining the energy bands (eV)

def pinspec.process.RITrue.getEnergyBandsCenters

(

self

)

Returns an array of the centers of each energy band.

Parameters

self	the RITrue object pointer

Returns

a numpy array of the energy band centers (eV)

def pinspec.process.RITrue.getIntegrals

(

self

)

Returns an array of the resonance integrals for each energy band.

Parameters

self	the RITrue object pointer

Returns

a numpy array of the resonance integrals

def pinspec.process.RITrue.getName

(

self

)

Returns the name of the RITrue object.

Returns an empty string if no name has been specified by the user.

Parameters

self	the RITrue object pointer

Returns

a string with the name of the RITrue

def pinspec.process.RITrue.getNumIntegrals

(

self

)

Returns the number of resonance integral energy bands.

Parameters

self	the RITrue object pointer

Returns

the number of resonance integrals

def pinspec.process.RITrue.printRIs

(

self

)

Prints a formatted table of the true resonance integrals to the screen.

Parameters

self	the RITrue object pointer

Returns

a reference to the RITrue object

def pinspec.process.RITrue.setName	(		self,
			name = ''
	)

Sets the name of the true resonance integral.

This is useful when one wishes to print the resonance integral values to the screen or a file since it will be identifiable by the user-defined name.

Parameters

self	the RITrue object pointer
name	the name of the RITrue object

Member Data Documentation

pinspec.process.RITrue._reaction

private

The reaction rate for this resonance integral (ie, 'capture')

The reaction rate type (ie, 'capture')

---

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

• pinspec/process.py