Feature/model attr access

CHANGELOG.md

@@ -4,6 +4,9 @@ Project Changelog
 Release 1.6.0 (TBD)
 -------------------
 
+API changes:
+* Add emission model attribute access to line and lineshape . (#294)
+
 New:
 * Add Function6D framework. (#478)
 * Add e_field attribute to Plasma object for electric field vector. (#465)

cherab/core/atomic/line.pyx

@@ -33,6 +33,14 @@ cdef class Line:
       specify the n-levels with integers (e.g. (3,2)). For all other ions the full spectroscopic
       configuration string should be specified for both states. It is up to the atomic data
       provider package to define the exact notation.
+
+    :ivar Element element: The atomic element/isotope to which this emission line belongs.
+    :ivar int charge: The charge state of the element/isotope that emits this line.
+    :ivar tuple transition: A two element tuple that defines the upper and lower electron
+      configuration states of the transition. For hydrogen-like ions it may be enough to
+      specify the n-levels with integers (e.g. (3,2)). For all other ions the full spectroscopic
+      configuration string should be specified for both states. It is up to the atomic data
+      provider package to define the exact notation.
 
     .. code-block:: pycon
 

cherab/core/model/plasma/impact_excitation.pyx

@@ -47,6 +47,8 @@ cdef class ExcitationLine(PlasmaModel):
 
     :ivar Plasma plasma: The plasma to which this emission model is attached.
     :ivar AtomicData atomic_data: The atomic data provider for this model.
+    :ivar Line line: The emission line object.
+    :ivar LineShapeModel lineshape: The line shape model.
     """
 
     def __init__(self, Line line, Plasma plasma=None, AtomicData atomic_data=None, object lineshape=None,
@@ -75,6 +77,14 @@ cdef class ExcitationLine(PlasmaModel):
     def __repr__(self):
         return '<ExcitationLine: element={}, charge={}, transition={}>'.format(self._line.element.name, self._line.charge, self._line.transition)
 
+    @property
+    def line(self):
+        return self._line
+
+    @property
+    def lineshape(self):
+        return self._lineshape
+
     cpdef Spectrum emission(self, Point3D point, Vector3D direction, Spectrum spectrum):
 
         cdef double ne, ni, te, radiance

cherab/core/model/plasma/recombination.pyx

@@ -47,6 +47,8 @@ cdef class RecombinationLine(PlasmaModel):
 
     :ivar Plasma plasma: The plasma to which this emission model is attached.
     :ivar AtomicData atomic_data: The atomic data provider for this model.
+    :ivar Line line: The emission line object.
+    :ivar LineShapeModel lineshape: The line shape model.
     """
 
     def __init__(self, Line line, Plasma plasma=None, AtomicData atomic_data=None, object lineshape=None,
@@ -75,6 +77,14 @@ cdef class RecombinationLine(PlasmaModel):
     def __repr__(self):
         return '<RecombinationLine: element={}, charge={}, transition={}>'.format(self._line.element.name, self._line.charge, self._line.transition)
 
+    @property
+    def line(self):
+        return self._line
+
+    @property
+    def lineshape(self):
+        return self._lineshape
+
     cpdef Spectrum emission(self, Point3D point, Vector3D direction, Spectrum spectrum):
 
         cdef double ne, ni, te, radiance

cherab/core/model/plasma/thermal_cx.pyx

@@ -49,6 +49,8 @@ cdef class ThermalCXLine(PlasmaModel):
 
     :ivar Plasma plasma: The plasma to which this emission model is attached.
     :ivar AtomicData atomic_data: The atomic data provider for this model.
+    :ivar Line line: The emission line object.
+    :ivar LineShapeModel lineshape: The line shape model.
     """
 
     def __init__(self, Line line, Plasma plasma=None, AtomicData atomic_data=None, object lineshape=None,
@@ -77,6 +79,14 @@ cdef class ThermalCXLine(PlasmaModel):
     def __repr__(self):
         return '<ThermalCXLine: element={}, charge={}, transition={}>'.format(self._line.element.name, self._line.charge, self._line.transition)
 
+    @property
+    def line(self):
+        return self._line
+
+    @property
+    def lineshape(self):
+        return self._lineshape
+
     cpdef Spectrum emission(self, Point3D point, Vector3D direction, Spectrum spectrum):
 
         cdef:

cherab/core/model/plasma/total_radiated_power.pyx

@@ -53,6 +53,9 @@ cdef class TotalRadiatedPower(PlasmaModel):
     :param int charge: The charge state of the element/isotope.
     :param Plasma plasma: The plasma to which this emission model is attached. Default is None.
     :param AtomicData atomic_data: The atomic data provider for this model. Default is None.
+
+    :ivar Element element: The atomic element/isotope.
+    :ivar int charge: The charge state of the element/isotope.
     """
 
     def __init__(self, Element element, int charge, Plasma plasma=None, AtomicData atomic_data=None):
@@ -68,6 +71,14 @@ cdef class TotalRadiatedPower(PlasmaModel):
 
         # ensure that cache is initialised
         self._change()
+
+    @property
+    def element(self):
+        return self._element
+
+    @property
+    def charge(self):
+        return self._charge
 
     cpdef Spectrum emission(self, Point3D point, Vector3D direction, Spectrum spectrum):