tkdataset Class Reference

Represents a dataset of nuclear levels and decays for a given nucleus. More...

#include <physics/tklevel_scheme.h>

Public Member Functions
	tkdataset ()=default
	tkdataset (const tkstring &_nuc, int _zz, int _aa, const tkstring &_name, int _id)
virtual	~tkdataset ()=default
shared_ptr< tkgammadecay >	add_gamma_decay (shared_ptr< tklevel > _lvlfrom, shared_ptr< tklevel > _lvlto, double _ener=0., double _unc=0.)
	add a new decay between two levels to the dataset
shared_ptr< tklevel >	add_level (double _ener, double _unc, tkstring _unit, tkstring _jpistr)
	manually add a new level to the dataset
const tkstring &	get_comment () const
	returns the dataset comment
const tkstring &	get_date () const
	returns the dataset date (YYYY-MM format)
int	get_id () const
	returns the dataset ID
const tkstring &	get_name () const
	returns the dataset name
const tkstring &	get_nucleus_name () const
	returns the nucleus name associated to this dataset
const tkstring &	get_source () const
	returns the dataset source ("ENSDF" or "XUNDL")
bool	has_comment () const
	returns true if the dataset has a comment
bool	has_date () const
	returns true if the dataset has a date
bool	is_xundl () const
	returns true if the dataset comes from XUNDL

Friends
class	tklevel
class	tklevel_scheme

Detailed Description

Represents a dataset of nuclear levels and decays for a given nucleus.

Stores information on a specific dataset.

A tkdataset corresponds to a single ENSDF or XUNDL dataset entry. It holds the list of levels and gamma decays loaded from the database for that dataset. It is accessed via tklevel_scheme::get_dataset() or by iterating over tklevel_scheme::get_datasets().

See also

tklevel_scheme, tklevel, tkdecay

See the datasets user guide.

Definition at line 43 of file tklevel_scheme.h.

Constructor & Destructor Documentation

tkdataset() [1/2]

tkdataset ( const tkstring & _nuc, int _zz, int _aa, const tkstring & _name, int _id )

inline

Definition at line 68 of file tklevel_scheme.h.

tkdataset() [2/2]

tkdataset ( )

default

~tkdataset()

virtual ~tkdataset ( )

virtualdefault

Member Function Documentation

add_gamma_decay()

shared_ptr< tkgammadecay > add_gamma_decay	(	shared_ptr< tklevel >	_lvlfrom,
		shared_ptr< tklevel >	_lvlto,
		double	_ener = 0.,
		double	_unc = 0. )

add a new decay between two levels to the dataset

Manually adds a gamma decay between two levels.

Parameters

_lvlfrom	parent level (decaying level)
_lvlto	daughter level (populated level)
_ener	gamma energy in keV (default 0: computed as the energy difference between the two levels)
_unc	uncertainty on the gamma energy in keV

Returns

shared pointer to the newly created tkgammadecay.

Example:

tknucleus nuc("132Sn");
auto ds = nuc.get_level_scheme()->get_dataset();
auto lvl0 = ds->add_level(0.,    0., "keV", "0+");
auto lvl1 = ds->add_level(4041., 0., "keV", "2+");
auto dec  = ds->add_gamma_decay(lvl1, lvl0);

See also

add_level()

Definition at line 622 of file tklevel_scheme.cpp.

add_level()

shared_ptr< tklevel > add_level	(	double	_ener,
		double	_unc,
		tkstring	_unit,
		tkstring	_jpistr )

manually add a new level to the dataset

Manually adds a new level to the dataset.

Parameters

_ener	energy of the level
_unc	uncertainty on the energy
_unit	unit of the energy (e.g. "keV")
_jpistr	spin-parity string (e.g. "2+")

Returns

shared pointer to the newly created tklevel, inserted at the correct position by energy.

This method allows building a custom dataset programmatically, for example to compute transition probabilities for artificially constructed level schemes. The new level is inserted in the level list sorted by increasing energy and yrast status is updated accordingly.

See also

add_gamma_decay()

Definition at line 572 of file tklevel_scheme.cpp.

get_comment()

const tkstring & get_comment ( ) const

inline

returns the dataset comment

Definition at line 79 of file tklevel_scheme.h.

get_date()

const tkstring & get_date ( ) const

inline

returns the dataset date (YYYY-MM format)

Definition at line 83 of file tklevel_scheme.h.

get_id()

int get_id ( ) const

inline

returns the dataset ID

Definition at line 73 of file tklevel_scheme.h.

get_name()

const tkstring & get_name ( ) const

inline

returns the dataset name

Definition at line 75 of file tklevel_scheme.h.

get_nucleus_name()

const tkstring & get_nucleus_name ( ) const

inline

returns the nucleus name associated to this dataset

Definition at line 77 of file tklevel_scheme.h.

get_source()

const tkstring & get_source ( ) const

inline

returns the dataset source ("ENSDF" or "XUNDL")

Definition at line 87 of file tklevel_scheme.h.

has_comment()

bool has_comment ( ) const

inline

returns true if the dataset has a comment

Definition at line 81 of file tklevel_scheme.h.

has_date()

bool has_date ( ) const

inline

returns true if the dataset has a date

Definition at line 85 of file tklevel_scheme.h.

is_xundl()

bool is_xundl ( ) const

inline

returns true if the dataset comes from XUNDL

Definition at line 89 of file tklevel_scheme.h.

Friends And Related Symbol Documentation

tklevel

friend class tklevel

friend

Definition at line 45 of file tklevel_scheme.h.

tklevel_scheme

friend class tklevel_scheme

friend

Definition at line 46 of file tklevel_scheme.h.

---

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

• src/physics/tklevel_scheme.h
• src/physics/tklevel_scheme.cpp