CoreMS 2.0.8__tar.gz → 2.0.9__tar.gz

{CoreMS-2.0.8 → CoreMS-2.0.9}/CoreMS.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: CoreMS
-Version: 2.0.8
+Version: 2.0.9
 Summary: Mass Spectrometry Framework for Small Molecules Analysis
 Home-page: https://github.com/EMSL-Computing/CoreMS
 Author: Corilo, Yuri
@@ -14,7 +14,7 @@ Classifier: Development Status :: 4 - Beta
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
-![CoreMS Logo](https://github.com/EMSL-Computing/CoreMS/tree/master/docs/CoreMS.COLOR_small.png?raw=true)  
+![CoreMS Logo](docs/CoreMS.COLOR_small.png?raw=true)  
 
 <div align="left">
 
@@ -66,7 +66,7 @@ CoreMS aims to provide
 
 ## Current Version
 
- `2.0.8`
+ `2.0.9`
 
 ***
 
@@ -339,7 +339,7 @@ UML (unified modeling language) diagrams for Direct Infusion FT-MS and GC-MS cla
 
 If you use CoreMS in your work, please use the following citation:
 
-Version [2.0.8 Release on GitHub](https://github.com/EMSL-Computing/CoreMS/releases/tag/v2.0.8), archived on Zenodo:  
+Version [2.0.9 Release on GitHub](https://github.com/EMSL-Computing/CoreMS/releases/tag/v2.0.9), archived on Zenodo:  
 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4641552.svg)](https://doi.org/10.5281/zenodo.4641552)
 

{CoreMS-2.0.8 → CoreMS-2.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: CoreMS
-Version: 2.0.8
+Version: 2.0.9
 Summary: Mass Spectrometry Framework for Small Molecules Analysis
 Home-page: https://github.com/EMSL-Computing/CoreMS
 Author: Corilo, Yuri
@@ -14,7 +14,7 @@ Classifier: Development Status :: 4 - Beta
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
-![CoreMS Logo](https://github.com/EMSL-Computing/CoreMS/tree/master/docs/CoreMS.COLOR_small.png?raw=true)  
+![CoreMS Logo](docs/CoreMS.COLOR_small.png?raw=true)  
 
 <div align="left">
 
@@ -66,7 +66,7 @@ CoreMS aims to provide
 
 ## Current Version
 
- `2.0.8`
+ `2.0.9`
 
 ***
 
@@ -339,7 +339,7 @@ UML (unified modeling language) diagrams for Direct Infusion FT-MS and GC-MS cla
 
 If you use CoreMS in your work, please use the following citation:
 
-Version [2.0.8 Release on GitHub](https://github.com/EMSL-Computing/CoreMS/releases/tag/v2.0.8), archived on Zenodo:  
+Version [2.0.9 Release on GitHub](https://github.com/EMSL-Computing/CoreMS/releases/tag/v2.0.9), archived on Zenodo:  
 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4641552.svg)](https://doi.org/10.5281/zenodo.4641552)
 

{CoreMS-2.0.8 → CoreMS-2.0.9}/README.md

@@ -1,4 +1,4 @@
-![CoreMS Logo](https://github.com/EMSL-Computing/CoreMS/tree/master/docs/CoreMS.COLOR_small.png?raw=true)  
+![CoreMS Logo](docs/CoreMS.COLOR_small.png?raw=true)  
 
 <div align="left">
 
@@ -50,7 +50,7 @@ CoreMS aims to provide
 
 ## Current Version
 
- `2.0.8`
+ `2.0.9`
 
 ***
 
@@ -323,7 +323,7 @@ UML (unified modeling language) diagrams for Direct Infusion FT-MS and GC-MS cla
 
 If you use CoreMS in your work, please use the following citation:
 
-Version [2.0.8 Release on GitHub](https://github.com/EMSL-Computing/CoreMS/releases/tag/v2.0.8), archived on Zenodo:  
+Version [2.0.9 Release on GitHub](https://github.com/EMSL-Computing/CoreMS/releases/tag/v2.0.9), archived on Zenodo:  
 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4641552.svg)](https://doi.org/10.5281/zenodo.4641552)
 

{CoreMS-2.0.8 → CoreMS-2.0.9}/corems/__init__.py

@@ -1,5 +1,5 @@
 __author__ = 'Yuri E. Corilo'
-__version__ = '2.0.8'
+__version__ = '2.0.9'
 __doc__ = '''
 <div align="left">
 

{CoreMS-2.0.8 → CoreMS-2.0.9}/corems/encapsulation/factory/processingSetting.py

@@ -63,16 +63,16 @@ class DataInputSetting:
         self.header_translate = {'m/z': Labels.mz, 
                                  'mOz': Labels.mz,
                                  'Mass': Labels.mz,
-                                 'Resolving Power': 'Resolving Power',
+                                 'Resolving Power': Labels.rp,
                                  'Res.': Labels.rp,
+                                 'resolution': Labels.rp,
                                  'Intensity': Labels.abundance,
                                  'I': Labels.abundance,
                                  'Abundance': Labels.abundance,
+                                 'abs_abu': Labels.abundance,
                                  'Signal/Noise': Labels.s2n,
                                  'S/N': Labels.s2n,
-                                 'abs_abu': Labels.abundance,
-                                 'sn': Labels.s2n,
-                                 'resolution': Labels.rp}
+                                 'sn': Labels.s2n}
 
     def add_mz_label(self, label):
         """Add a label to the header_translate dictionary to be translated to the corems label for mz."""

{CoreMS-2.0.8 → CoreMS-2.0.9}/corems/mass_spectra/factory/LC_Temp.py

@@ -10,7 +10,9 @@ class TIC_Data:
     Time: [floats]
         list of retention times
     TIC: [floats]
-        total ion chromatogram
+        total ion current [chromatogram]
+    BPC: [floats]
+        base peak [chromatogram]
     Apexes: [int]    
         original thermo apex scan number after peak picking 
      '''
@@ -18,6 +20,7 @@ class TIC_Data:
      scans : List[int] = field(default_factory=list)
      time : List[float] = field(default_factory=list)
      tic : List[float] = field(default_factory=list)
+     bpc : List[float] = field(default_factory=list)
      apexes : List[int] = field(default_factory=list)
 
 @dataclass

{CoreMS-2.0.8 → CoreMS-2.0.9}/corems/mass_spectra/input/rawFileReader.py

@@ -503,9 +503,15 @@ class ThermoBaseClass:
             # plt.show()
 
     def get_tic(
-        self, ms_type="MS !d", peak_detection=True, smooth=True, plot=False, ax=None
+        self, ms_type="MS !d", peak_detection=True, smooth=True, plot=False, ax=None,trace_type='TIC',
     ) -> Tuple[TIC_Data, axes.Axes]:
-        """ms_type: str ('MS', MS2')
+        """ms_type: str ('MS !d', 'MS2', None)
+            if you use None you get all scans.
+        peak_detection: bool
+        smooth: bool
+        plot: bool
+        ax: matplotlib axis object
+        trace_type: str ('TIC','BPC')
 
         returns:
             chroma: dict
@@ -520,9 +526,16 @@ class ThermoBaseClass:
                 original thermo apex scan number after peak picking
             }
         """
-
-        settings = ChromatogramTraceSettings(TraceType.TIC)
-        settings.Filter = ms_type
+        if trace_type == 'TIC':
+            settings = ChromatogramTraceSettings(TraceType.TIC)
+        elif trace_type == 'BPC':
+            settings = ChromatogramTraceSettings(TraceType.BasePeak)
+        else:
+            print(f'{trace_type} undefined')
+        if ms_type == "all":
+            settings.Filter = None
+        else:
+            settings.Filter = ms_type
 
         chroma_settings = IChromatogramSettings(settings)
 
@@ -532,7 +545,7 @@ class ThermoBaseClass:
 
         trace = ChromatogramSignal.FromChromatogramData(data)
 
-        data = TIC_Data(time=[], scans=[], tic=[], apexes=[])
+        data = TIC_Data(time=[], scans=[], tic=[], bpc=[], apexes=[])
 
         if trace[0].Length > 0:
             for i in range(trace[0].Length):
@@ -564,7 +577,7 @@ class ThermoBaseClass:
                     ax = plt.gca()
                     # fig, ax = plt.subplots(figsize=(6, 3))
 
-                ax.plot(data.time, data.tic, label=" TIC")
+                ax.plot(data.time, data.tic, label=trace_type)
                 ax.set_xlabel("Time (min)")
                 ax.set_ylabel("a.u.")
                 if peak_detection:
@@ -578,8 +591,13 @@ class ThermoBaseClass:
                         )
 
                 # plt.show()
+                if trace_type == 'BPC':
+                    data.bpc = data.tic
+                    data.tic = []
                 return data, ax
-
+            if trace_type == 'BPC':
+                data.bpc = data.tic
+                data.tic = []
             return data, None
 
         else:

{CoreMS-2.0.8 → CoreMS-2.0.9}/corems/mass_spectrum/calc/Calibration.py

@@ -381,13 +381,15 @@ class MzDomainCalibration:
             if self.mzsegment:
                 # Recombine the mass domains
                 mz_domain = np.concatenate([mz_domain,mz_exp_peaks_unchanged])
-                mz_profile_calc = np.concatenate([mz_profile_calc,mz_exp_profile_unchanged])
-                # Sort them 
                 mz_domain.sort()
-                mz_profile_calc.sort()
+                if not self.mass_spectrum.is_centroid:
+                    mz_profile_calc = np.concatenate([mz_profile_calc,mz_exp_profile_unchanged])
+                    mz_profile_calc.sort()
+                # Sort them 
                 if mz_exp_peaks[0] > mz_exp_peaks[1]: #If originally descending mass order
                     mz_domain = mz_domain[::-1]
-                    mz_profile_calc = mz_profile_calc[::-1]
+                    if not self.mass_spectrum.is_centroid:
+                        mz_profile_calc = mz_profile_calc[::-1]
 
             self.mass_spectrum.mz_cal = mz_domain
             if not self.mass_spectrum.is_centroid:

{CoreMS-2.0.8 → CoreMS-2.0.9}/corems/mass_spectrum/calc/PeakPicking.py

@@ -453,7 +453,10 @@ class PeakPicking:
         elif noise_threshold_method == 'signal_noise':
 
             abundance_threshold = self.settings.noise_threshold_min_s2n
-            factor = self.baseline_noise_std
+            if self.is_centroid:
+                factor = 1
+            else:
+                factor = self.baseline_noise_std
 
         elif noise_threshold_method == "relative_abundance":
 

{CoreMS-2.0.8 → CoreMS-2.0.9}/corems/ms_peak/calc/MSPeakCalc.py

@@ -27,9 +27,9 @@ class MSPeakCalculation:
         The parent MSParent object associated with the MSPeakCalculation object.
     mz_exp : float
         The experimental m/z value of the peak.
-    start_scan : int
+    peak_left_index : int
         The start scan index of the peak.
-    final_scan : int
+    peak_right_index : int
         The final scan index of the peak.
     resolving_power : float
         The resolving power of the peak.
@@ -136,11 +136,10 @@ class MSPeakCalculation:
         float
             peak area
         """
-        #TODO throughout change final_scan and start_scan when the MSPeakClasses 
-        if self.final_scan > self.start_scan:
+        if self.peak_right_index > self.peak_left_index:
 
-            yy = self._ms_parent.abundance_profile[self.start_scan:self.final_scan]
-            xx = self._ms_parent.mz_exp_profile[self.start_scan:self.final_scan]
+            yy = self._ms_parent.abundance_profile[self.peak_left_index:self.peak_right_index]
+            xx = self._ms_parent.mz_exp_profile[self.peak_left_index:self.peak_right_index]
             # check if the axis is high to low m/z or not. if its MSFromFreq its high mz first, if its from Profile, its low mz first
             if xx[0] > xx[-1]:
                 xx = flip(xx)    
@@ -182,8 +181,8 @@ class MSPeakCalculation:
         mz_extend here extends the x-axis domain so that we have sufficient points either side of the apex to fit.
         Takes about 10ms per peak
         """
-        start_index = self.start_scan - mz_extend  if not self.start_scan == 0 else 0
-        final_index = self.final_scan + mz_extend  if not self.final_scan == len(self._ms_parent.mz_exp_profile) else self.final_scan
+        start_index = self.peak_left_index - mz_extend  if not self.peak_left_index == 0 else 0
+        final_index = self.peak_right_index + mz_extend  if not self.peak_right_index == len(self._ms_parent.mz_exp_profile) else self.peak_right_index
 
         # check if MSPeak contains the resolving power info
         if self.resolving_power:
@@ -385,8 +384,8 @@ class MSPeakCalculation:
             # Thermo data is noise reduced by also noise subtracted, so starts at 0
             # Absorption mode/phased data will have positive and negative components and may not be baseline corrected
 
-        start_index = self.start_scan - mz_extend  if not self.start_scan == 0 else 0
-        final_index = self.final_scan + mz_extend  if not self.final_scan == len(self._ms_parent.mz_exp_profile) else self.final_scan
+        start_index = self.peak_left_index - mz_extend  if not self.peak_left_index == 0 else 0
+        final_index = self.peak_right_index + mz_extend  if not self.peak_right_index == len(self._ms_parent.mz_exp_profile) else self.peak_right_index
 
         # check if MSPeak contains the resolving power info
         if self.resolving_power:
@@ -649,8 +648,8 @@ class MSPeakCalculation:
             x-axis domain for fit
         
         """
-        start_index = self.start_scan - mz_overlay  if not self.start_scan == 0 else 0
-        final_index = self.final_scan + mz_overlay  if not self.final_scan == len(self._ms_parent.mz_exp_profile) else self.final_scan
+        start_index = self.peak_left_index - mz_overlay  if not self.peak_left_index == 0 else 0
+        final_index = self.peak_right_index + mz_overlay  if not self.peak_right_index == len(self._ms_parent.mz_exp_profile) else self.peak_right_index
 
         if oversample_multiplier == 1:
 

{CoreMS-2.0.8 → CoreMS-2.0.9}/corems/ms_peak/factory/MSPeakClasses.py

@@ -79,10 +79,9 @@ class _MSPeak(MSPeakCalculation):
         self.resolving_power = float(resolving_power)
         self.signal_to_noise = float(signal_to_noise)
         # profile indexes
-        #TODO fix these names from 'scan' to be more logical about peak indexes.
-        self.start_scan = int(indexes[0])
-        self.apex_scan = int(indexes[1])
-        self.final_scan = int(indexes[2])
+        self.peak_left_index = int(indexes[0])
+        self.peak_apex_index = int(indexes[1])
+        self.peak_right_index = int(indexes[2])
 
         # mass spec obj index
         self.index = int(index)
@@ -318,15 +317,15 @@ class _MSPeak(MSPeakCalculation):
 
             if ax is None:
                 ax = plt.gca()
-            x = self._ms_parent.mz_exp_profile[self.start_scan : self.final_scan]
-            y = self._ms_parent.abundance_profile[self.start_scan : self.final_scan]
+            x = self._ms_parent.mz_exp_profile[self.peak_left_index : self.peak_right_index]
+            y = self._ms_parent.abundance_profile[self.peak_left_index : self.peak_right_index]
 
             ax.plot(x, y, color=color, label="Data")
             ax.set(xlabel="m/z", ylabel="abundance")
             if derivative and not self._ms_parent.is_centroid:
                 dy = sp.derivate(
                     self._ms_parent.abundance_profile[
-                        self.start_index : self.final_index + 1
+                        self.peak_left_index : self.peak_right_index + 1
                     ]
                 )
                 ax.plot(x, dy, c=deriv_color)

{CoreMS-2.0.8 → CoreMS-2.0.9}/setup.py

@@ -14,7 +14,7 @@ with open('requirements.txt') as f:
 # This call to setup() does all the work
 setup(
     name="CoreMS",
-    version="2.0.8",
+    version="2.0.9",
     description="Mass Spectrometry Framework for Small Molecules Analysis",
     long_description=long_description,
     long_description_content_type="text/markdown",

{CoreMS-2.0.8 → CoreMS-2.0.9}/tests/test_calibration.py

@@ -16,11 +16,13 @@ from corems.molecular_id.search.findOxygenPeaks import FindOxygenPeaks
 from corems.transient.input.brukerSolarix import ReadBrukerSolarix
 from corems.molecular_id.search.molecularFormulaSearch import SearchMolecularFormulas
 from corems.molecular_id.calc.ClusterFilter import ClusteringFilter
-from corems.mass_spectrum.input.massList import ReadMassList
+from corems.mass_spectrum.input.massList import ReadCoremsMasslist, ReadMassList
 from corems.mass_spectrum.calc.AutoRecalibration import HighResRecalibration
 from corems import get_filename
+
+
 def create_mass_spectrum():
-    
+    # Creates a profile mode mass spectrum object
     '''parse transient data from Bruker into a mass spectrum class object
 
         Parameters
@@ -49,14 +51,27 @@ def create_mass_spectrum():
     
     return mass_spectrum
 
+def create_centroid_mass_spectrum():
+    # Creates a centroid mass spectrum object
+    file_location = Path.cwd() / "tests/tests_data/ftms/ESI_NEG_SRFA_UnCal_Unassign.csv"
+    
+    MSParameters.mass_spectrum.noise_threshold_method = 'relative_abundance'
+    MSParameters.mass_spectrum.noise_threshold_min_relative_abundance = 0.1
+    
+    #load any type of mass list file, change the delimeter to read another type of file, i.e : "," for csv, "\t" for tabulated mass list, etc
+    mass_list_reader = ReadCoremsMasslist(file_location,  analyzer='ICR', instrument_label='12T')
+
+    mass_spectrum = mass_list_reader.get_mass_spectrum(loadSettings=False)
+
+    return mass_spectrum
+ 
+
 
 def test_mz_domain_calibration():
 
     MSParameters.mass_spectrum.min_calib_ppm_error = -10
     MSParameters.mass_spectrum.max_calib_ppm_error = 10
 
-    file_location = Path.cwd() / "tests/tests_data/ftms/ESI_NEG_SRFA.d/"
-
     ref_file_location = Path.cwd() / "tests/tests_data/ftms/SRFA.ref"
 
     mass_spectrum = create_mass_spectrum()
@@ -65,15 +80,52 @@ def test_mz_domain_calibration():
 
     MzDomainCalibration(mass_spectrum, ref_file_location).run()
 
+def test_mz_domain_calibration_centroid():
+
+    MSParameters.mass_spectrum.min_calib_ppm_error = -10
+    MSParameters.mass_spectrum.max_calib_ppm_error = 10
+    MSParameters.mass_spectrum.calib_pol_order = 1
+
+    ref_file_location = Path.cwd() / "tests/tests_data/ftms/SRFA.ref"
+
+    mass_spectrum = create_centroid_mass_spectrum()
+
+    mass_spectrum.filter_by_noise_threshold()
+
+    MzDomainCalibration(mass_spectrum, ref_file_location).run()
+
+    # check there is an output
+    assert mass_spectrum.calibration_order == 1
+    assert(mass_spectrum.calibration_points == 25)
+    assert(round(mass_spectrum.calibration_RMS, 4) == round(0.8690388563830891, 4))
+
 def test_autorecalibration():
 
     mass_spectrum = create_mass_spectrum()
 
     mass_spectrum.filter_by_noise_threshold()
 
+    auto_error_bounds = HighResRecalibration(mass_spectrum,plot=False,docker=False).determine_error_boundaries()
+
+    MSParameters.mass_spectrum.min_calib_ppm_error = auto_error_bounds[-1][0]
+    MSParameters.mass_spectrum.max_calib_ppm_error =  auto_error_bounds[-1][1]
+
+    ref_file_location = Path.cwd() / "tests/tests_data/ftms/SRFA.ref"
+
+    MzDomainCalibration(mass_spectrum, ref_file_location).run()
+
+
+def test_autorecalibration_centroid():
+
+    mass_spectrum = create_centroid_mass_spectrum()
+
+    mass_spectrum.filter_by_noise_threshold()
+
     HighResRecalibration(mass_spectrum,plot=False,docker=False).determine_error_boundaries()
 
+
 def test_segmentedmzcalibration():
+    # Tests profile mode recalibration
     mass_spectrum = create_mass_spectrum()
 
     mass_spectrum.filter_by_noise_threshold()
@@ -83,6 +135,17 @@ def test_segmentedmzcalibration():
     MzDomainCalibration(mass_spectrum, ref_file_location, mzsegment=(0,300)).run()
 
 
+def test_segmentedmzcalibration_centroid():
+    # Tests centroided mode recalibration
+    mass_spectrum = create_centroid_mass_spectrum()
+
+    mass_spectrum.filter_by_noise_threshold()
+
+    ref_file_location = Path.cwd() / "tests/tests_data/ftms/SRFA.ref"
+
+    MzDomainCalibration(mass_spectrum, ref_file_location, mzsegment=(0,300)).run()
+
+
 def test_old_calibration():
     
     ''' Mass calibration test module: