Stores information on a gamma-ray decay. More...

Detailed Description

Stores information on a gamma-ray decay.

See the tkn::tkdecay documentation

Definition at line 131 of file tkdecay.h.

Inheritance diagram for tkgammadecay:

#include <tkdecay.h>

Public Member Functions
	tkgammadecay (int _id, int _from_id, int _to_id, const tkdb_table::measure_data_struct &_struc)

virtual	~tkgammadecay () override=default

double	get_conv_coeff ()
	returns the gamma conversion coefficient value

shared_ptr< tkmeasure >	get_conv_coeff_measure ()
	returns the gamma conversion coefficient tkmeasure object

double	get_mixing_ratio ()
	returns the gamma mixing ratio value

shared_ptr< tkmeasure >	get_mixing_ratio_measure ()
	returns the gamma mixing ratio tkmeasure object

tkstring	get_multipolarity ()
	get the transition multipolarity

double	get_relative_intensity ()
	returns the gamma relative intensity (100% correspond the the more intence gamma-ray)

shared_ptr< tkmeasure >	get_relative_intensity_measure ()
	returns the gamma relative intensity tkmeasure object (100% correspond the the more intence gamma-ray)

double	get_trans_prob (bool _elec, int _L, bool _WU)
	returns the gamma gamma transition probability value (ex: BE2 in Weiksopf units, get_trans_prob(1,2,1))

shared_ptr< tkmeasure >	get_trans_prob_measure (bool _elec, int _L, bool _WU)
	returns the gamma transition probability tkmeasure object (ex: BE2 in Weiksopf units, get_trans_prob(1,2,1))

void	set_conv_coeff (tkdb_table::measure_data_struct &_struc)
	set the conversion coeff

void	set_mixing_ratio (tkdb_table::measure_data_struct &_struc)
	set the mixing ratio info

void	set_multipolarity (const tkstring &_mul)
	set the relative intensity info

void	set_relative_intensity (double _val, double _unc)

void	set_relative_intensity (tkdb_table::measure_data_struct &_struc)
	set the relative intensity info

void	set_transition_probability (tkdb_table::measure_data_struct &_struc)
	set the transition probability

Public Member Functions inherited from tkdecay
	tkdecay (int _id, int _from_id, int _to_id, const tkdb_table::measure_data_struct &_struc, decay_type _type)

virtual	~tkdecay () override=default

const tkstring &	get_comment () const
	get the level comment string

decay_type	get_decay_type ()
	get the decay type

double	get_energy (const tkunit_manager::units_keys _unit=tkunit_manager::units_keys::keV)
	returns the energy in keV by default

shared_ptr< tkmeasure >	get_energy_meas () const
	returns the energy tkmeasure object

shared_ptr< tklevel >	get_level_from ()
	get the parent level

shared_ptr< tklevel >	get_level_to ()
	get the daughter level

bool	has_comment () const
	check if a comment exists

bool	is_uncertain () const
	check if the decay is uncertain

void	print (const tkstring &_option="") const
	print the decay properties

Public Member Functions inherited from tkproperty_list
	tkproperty_list (tkstring _name)

virtual	~tkproperty_list ()=default

shared_ptr< tkmeasure >	get (const tkstring &_property) const
	get the property as tkmeasure

vector< shared_ptr< tkmeasure > >	get_data_properties (const tkstring &_opt="*")
	get a vector of data properties according to a regular expression

const auto &	get_properties () const
	get the properties map

tkstring	get_property (const tkstring &_property) const
	get the property value as a string

tkstring	get_property_type (const tkstring &_property) const
	get the property type as a string

tkstring	get_property_unit (const tkstring &_property) const
	get the property unnit as a string

bool	has_property (const tkstring &_property) const
	to check if the property is available

void	list_data_properties (const tkstring &_opt="*") const
	list the available tkmeasure properties

void	list_properties (const tkstring &_opt="*") const
	list the available properties

Friends
class	tkdataset

class	tklevel_scheme

Additional Inherited Members
Public Types inherited from tkdecay
enum	decay_type { kundef , kbeta , kec , kalpha , kparticle , kgamma }

Static Public Attributes inherited from tkdecay
static array< tkstring, 6 >	decay_type_str = {"undefined", "beta", "ec", "alpha", "particle", "gamma"}

Constructor & Destructor Documentation

◆ tkgammadecay()

tkgammadecay	(	int	_id,
		int	_from_id,
		int	_to_id,
		const tkdb_table::measure_data_struct &	_struc )

inline

Definition at line 137 of file tkdecay.h.

◆ ~tkgammadecay()

virtual ~tkgammadecay ( )

overridevirtualdefault

Member Function Documentation

◆ get_conv_coeff()

double get_conv_coeff ( )

returns the gamma conversion coefficient value

This method returns the gamma conversion coefficient. A std::nan(1) is returned in case no lifetime is known for this nucleus. It can be tested using tknucleus::has_property("conv") prior to call this method or std::is_nan() on the returned value.

Definition at line 342 of file tkdecay.cpp.

◆ get_conv_coeff_measure()

shared_ptr< tkmeasure > get_conv_coeff_measure ( )

inline

returns the gamma conversion coefficient tkmeasure object

Definition at line 151 of file tkdecay.h.

◆ get_mixing_ratio()

double get_mixing_ratio ( )

returns the gamma mixing ratio value

This method returns the gamma mixing ratio. A std::nan(1) is returned in case no lifetime is known for this nucleus. It can be tested using tknucleus::has_property("mix ratio") prior to call this method or std::is_nan() on the returned value.

Definition at line 329 of file tkdecay.cpp.

◆ get_mixing_ratio_measure()

shared_ptr< tkmeasure > get_mixing_ratio_measure ( )

inline

returns the gamma mixing ratio tkmeasure object

Definition at line 146 of file tkdecay.h.

◆ get_multipolarity()

tkstring get_multipolarity ( )

inline

get the transition multipolarity

Definition at line 161 of file tkdecay.h.

◆ get_relative_intensity()

double get_relative_intensity ( )

returns the gamma relative intensity (100% correspond the the more intence gamma-ray)

This method returns the gamma relative intensity in %. An intensity of 100% correspond the the more intence gamma-ray decaying from its parent level A std::nan(1) is returned in case no lifetime is known for this nucleus. It can be tested using tknucleus::has_property("RI") prior to call this method or std::is_nan() on the returned value.

Definition at line 316 of file tkdecay.cpp.

◆ get_relative_intensity_measure()

shared_ptr< tkmeasure > get_relative_intensity_measure ( )

inline

returns the gamma relative intensity tkmeasure object (100% correspond the the more intence gamma-ray)

Definition at line 141 of file tkdecay.h.

◆ get_trans_prob()

double get_trans_prob	(	bool	_elec,
		int	_L,
		bool	_WU )

returns the gamma gamma transition probability value (ex: BE2 in Weiksopf units, get_trans_prob(1,2,1))

Parameters

_elec	true for electric transition, false for magnetic
_L	transfered momentum of the transiton (2 for a E2 transition)
_WU	true to obtain the result in Weisskopf units

This method returns the gamma transition probability value A std::nan(1) is returned in case no lifetime is known for this nucleus.

Definition at line 366 of file tkdecay.cpp.

◆ get_trans_prob_measure()

shared_ptr< tkmeasure > get_trans_prob_measure	(	bool	_elec,
		int	_L,
		bool	_WU )

returns the gamma transition probability tkmeasure object (ex: BE2 in Weiksopf units, get_trans_prob(1,2,1))

Definition at line 348 of file tkdecay.cpp.

◆ set_conv_coeff()

void set_conv_coeff ( tkdb_table::measure_data_struct & _struc )

set the conversion coeff

Definition at line 285 of file tkdecay.cpp.

◆ set_mixing_ratio()

void set_mixing_ratio ( tkdb_table::measure_data_struct & _struc )

set the mixing ratio info

Definition at line 273 of file tkdecay.cpp.

◆ set_multipolarity()

void set_multipolarity ( const tkstring & _mul )

set the relative intensity info

Definition at line 268 of file tkdecay.cpp.

◆ set_relative_intensity() [1/2]

void set_relative_intensity	(	double	_val,
		double	_unc )

Definition at line 251 of file tkdecay.cpp.

◆ set_relative_intensity() [2/2]

void set_relative_intensity ( tkdb_table::measure_data_struct & _struc )

set the relative intensity info

Definition at line 240 of file tkdecay.cpp.

◆ set_transition_probability()

void set_transition_probability ( tkdb_table::measure_data_struct & _struc )

set the transition probability

Definition at line 296 of file tkdecay.cpp.

Friends And Related Symbol Documentation

◆ tkdataset

friend class tkdataset

friend

Definition at line 133 of file tkdecay.h.

◆ tklevel_scheme

friend class tklevel_scheme

friend

Definition at line 134 of file tkdecay.h.

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

tkn.doxygen/src/physics/tkdecay.h
tkn.doxygen/src/physics/tkdecay.cpp

Detailed Description

Public Member Functions

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ tkgammadecay()

◆ ~tkgammadecay()

Member Function Documentation

◆ get_conv_coeff()

◆ get_conv_coeff_measure()

◆ get_mixing_ratio()

◆ get_mixing_ratio_measure()

◆ get_multipolarity()

◆ get_relative_intensity()

◆ get_relative_intensity_measure()

◆ get_trans_prob()

◆ get_trans_prob_measure()

◆ set_conv_coeff()

◆ set_mixing_ratio()

◆ set_multipolarity()

◆ set_relative_intensity() [1/2]

◆ set_relative_intensity() [2/2]

◆ set_transition_probability()

Friends And Related Symbol Documentation

◆ tkdataset

◆ tklevel_scheme