Enhances enums with descriptive methods

Author: AndrewSazonov

src/easydiffraction/experiments/experiment/enums.py

@@ -14,6 +14,12 @@ class SampleFormEnum(str, Enum):
     def default(cls) -> 'SampleFormEnum':
         return cls.POWDER
 
+    def description(self) -> str:
+        if self is SampleFormEnum.POWDER:
+            return 'Powdered or polycrystalline sample.'
+        elif self is SampleFormEnum.SINGLE_CRYSTAL:
+            return 'Single crystal sample.'
+
 
 class ScatteringTypeEnum(str, Enum):
     """Type of scattering modeled in an experiment."""
@@ -25,6 +31,12 @@ class ScatteringTypeEnum(str, Enum):
     def default(cls) -> 'ScatteringTypeEnum':
         return cls.BRAGG
 
+    def description(self) -> str:
+        if self is ScatteringTypeEnum.BRAGG:
+            return 'Bragg diffraction for conventional structure refinement.'
+        elif self is ScatteringTypeEnum.TOTAL:
+            return 'Total scattering for pair distribution function analysis (PDF).'
+
 
 class RadiationProbeEnum(str, Enum):
     """Incident radiation probe used in the experiment."""
@@ -36,6 +48,12 @@ class RadiationProbeEnum(str, Enum):
     def default(cls) -> 'RadiationProbeEnum':
         return cls.NEUTRON
 
+    def description(self) -> str:
+        if self is RadiationProbeEnum.NEUTRON:
+            return 'Neutron diffraction.'
+        elif self is RadiationProbeEnum.XRAY:
+            return 'X-ray diffraction.'
+
 
 class BeamModeEnum(str, Enum):
     """Beam delivery mode for the instrument."""
@@ -47,6 +65,12 @@ class BeamModeEnum(str, Enum):
     def default(cls) -> 'BeamModeEnum':
         return cls.CONSTANT_WAVELENGTH
 
+    def description(self) -> str:
+        if self is BeamModeEnum.CONSTANT_WAVELENGTH:
+            return 'Constant wavelength (CW) diffraction.'
+        elif self is BeamModeEnum.TIME_OF_FLIGHT:
+            return 'Time-of-flight (TOF) diffraction.'
+
 
 class PeakProfileTypeEnum(str, Enum):
     """Available peak profile types per scattering and beam mode."""
@@ -77,3 +101,17 @@ def default(
             (ScatteringTypeEnum.TOTAL, BeamModeEnum.CONSTANT_WAVELENGTH): cls.GAUSSIAN_DAMPED_SINC,
             (ScatteringTypeEnum.TOTAL, BeamModeEnum.TIME_OF_FLIGHT): cls.GAUSSIAN_DAMPED_SINC,
         }[(scattering_type, beam_mode)]
+
+    def description(self) -> str:
+        if self is PeakProfileTypeEnum.PSEUDO_VOIGT:
+            return 'Pseudo-Voigt profile'
+        elif self is PeakProfileTypeEnum.SPLIT_PSEUDO_VOIGT:
+            return 'Split pseudo-Voigt profile with empirical asymmetry correction.'
+        elif self is PeakProfileTypeEnum.THOMPSON_COX_HASTINGS:
+            return 'Thompson-Cox-Hastings profile with FCJ asymmetry correction.'
+        elif self is PeakProfileTypeEnum.PSEUDO_VOIGT_IKEDA_CARPENTER:
+            return 'Pseudo-Voigt profile with Ikeda-Carpenter asymmetry correction.'
+        elif self is PeakProfileTypeEnum.PSEUDO_VOIGT_BACK_TO_BACK:
+            return 'Pseudo-Voigt profile with Back-to-Back Exponential asymmetry correction.'
+        elif self is PeakProfileTypeEnum.GAUSSIAN_DAMPED_SINC:
+            return 'Gaussian-damped sinc profile for pair distribution function (PDF) analysis.'