dotnetrawfilereader-sys 0.7.0

A low-level interface to a in-process dotnet runtime for Thermo Fisher's RawFileReader library
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>ThermoFisher.CommonCore.MassPrecisionEstimator</name>
    </assembly>
    <members>
        <member name="T:ThermoFisher.CommonCore.MassPrecisionEstimator.EstimatorResults">
            <summary>  
            Class to hold mass precision estimator results for individual mass/intensity points 
            in a scan. 
            </summary>
        </member>
        <member name="P:ThermoFisher.CommonCore.MassPrecisionEstimator.EstimatorResults.Intensity">
            <summary>
            Gets or sets the intensity value
            </summary>
        </member>
        <member name="P:ThermoFisher.CommonCore.MassPrecisionEstimator.EstimatorResults.Mass">
            <summary>
            Gets or sets the mass value
            </summary>
        </member>
        <member name="P:ThermoFisher.CommonCore.MassPrecisionEstimator.EstimatorResults.MassAccuracyInMmu">
            <summary>
            Gets or sets the mass accuracy in MMU value
            </summary>
        </member>
        <member name="P:ThermoFisher.CommonCore.MassPrecisionEstimator.EstimatorResults.MassAccuracyInPpm">
            <summary>
            Gets or sets the mass accuracy in PPM value
            </summary>
        </member>
        <member name="P:ThermoFisher.CommonCore.MassPrecisionEstimator.EstimatorResults.Resolution">
            <summary>
            Gets or sets the resolution value
            </summary>
        </member>
        <member name="T:ThermoFisher.CommonCore.MassPrecisionEstimator.IPrecisionEstimate">
            <summary>
            The interface class for the Mass Precision Estimate (MPE) code
            </summary>
        </member>
        <member name="P:ThermoFisher.CommonCore.MassPrecisionEstimator.IPrecisionEstimate.Rawfile">
            <summary> 
            Sets the RAW file. 
            </summary>
        </member>
        <member name="P:ThermoFisher.CommonCore.MassPrecisionEstimator.IPrecisionEstimate.ScanNumber">
            <summary> 
            Sets the scan number. 
            </summary>
            <value> The scan number. </value>
        </member>
        <member name="M:ThermoFisher.CommonCore.MassPrecisionEstimator.IPrecisionEstimate.GetIonTime(ThermoFisher.CommonCore.Data.FilterEnums.MassAnalyzerType,ThermoFisher.CommonCore.Data.Business.Scan,System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String})">
            <summary>
            Calculate the ion time - fill (traps and FT) or dwell time (quads)
            based upon the type of instrument.
            </summary>
            <param name="analyzerType">The analyzer type</param>
            <param name="scan">The scan to process</param>
            <param name="trailerHeadings">The trailer headings.</param>
            <param name="trailerValues">The trailer values.</param>
            <returns>The calculated ion time</returns>
        </member>
        <member name="M:ThermoFisher.CommonCore.MassPrecisionEstimator.IPrecisionEstimate.GetMassPrecisionEstimate(ThermoFisher.CommonCore.Data.Business.Scan,ThermoFisher.CommonCore.Data.FilterEnums.MassAnalyzerType,System.Double,System.Double)">
            <summary> 
            Gets the mass precision estimate for the data in the provided scan. The information is passed through the
            arguments in this method.
            </summary>
            <param name="scan">The scan to process</param>
            <param name="analyzerType">The analyzer type for the provided scan</param>
            <param name="ionTime">The ion time for the provided scan</param>
            <param name="resolution">the resolution for the provided scan</param>
            <returns>The list of EstimatorResults objects</returns>
        </member>
        <member name="M:ThermoFisher.CommonCore.MassPrecisionEstimator.IPrecisionEstimate.GetMassPrecisionEstimate">
            <summary> 
            Gets mass precision estimate for the provided scan number.  The information needed to process the scan is passed through
            the properties in the class when using this method. 
            </summary>
            <returns>The list of EstimatorResults objects</returns>
        </member>
        <member name="T:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate">
            <summary>
            Class to calculate the mass precision estimates (MPE) for a specific scan
            </summary>
        </member>
        <member name="T:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.TrapScanType">
            <summary>
            Values that represent the ion trap scan types.
            </summary>
        </member>
        <member name="F:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.TrapScanType.Normal">
            <summary>
            The type for a normal scan
            </summary>
        </member>
        <member name="F:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.TrapScanType.Enhanced">
            <summary>
            The type for an enhanced scan
            </summary>
        </member>
        <member name="F:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.TrapScanType.Zoom">
            <summary>
            The type for a zoom scan
            </summary>
        </member>
        <member name="F:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.TrapScanType.UltraZoom">
            <summary>
            The type for an ultra zoom scan
            </summary>
        </member>
        <member name="F:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate._estimatorResults">
            <summary>
            List containing the results from the mass precision estimate calculation.
            </summary>
        </member>
        <member name="F:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate._rawFile">
            <summary>
            The RAW file object.
            </summary>
        </member>
        <member name="F:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate._scanResolution">
            <summary>
            The scan resolution.
            </summary>
        </member>
        <member name="F:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate._ionTime">
            <summary>
            The ion time.
            </summary>
        </member>
        <member name="F:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate._scanNumber">
            <summary>
            The scan number.
            </summary>
        </member>
        <member name="P:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.Rawfile">
            <summary>
            Sets the raw file as an open IRawData objects.
            </summary>
        </member>
        <member name="P:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.ScanNumber">
            <summary>
            Sets the scan number of the scan to be analyzed
            </summary>
            <value> The scan number. </value>
        </member>
        <member name="M:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.GetIonTrapScanType(System.String)">
            <summary>
            Gets the ion trap scan type.
            </summary>
            <param name="scanFilter">
            The scan filter to process
            </param>
            <returns>
            The ion trap scan type as an enumerated value.
            </returns>
        </member>
        <member name="M:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate"/> class. 
            </summary>
        </member>
        <member name="M:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.Dispose">
            <summary>
            Performs application-defined tasks associated with freeing, releasing, or resetting
            unmanaged resources.
            </summary>
        </member>
        <member name="M:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.GetIonTime(ThermoFisher.CommonCore.Data.FilterEnums.MassAnalyzerType,ThermoFisher.CommonCore.Data.Business.Scan,System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String})">
            <summary>
            Calculate the ion time (fill (traps and FT) or dwell time (quads))
            </summary>
            <param name="analyzerType">The analyzer type</param>
            <param name="scan">The scan to process</param>
            <param name="trailerHeadings">The trailer extra data headings</param>
            <param name="trailerValues">The trailer extra data values</param>
            <returns> The calculated ion time</returns>
        </member>
        <member name="M:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.GetMassPrecisionEstimate(ThermoFisher.CommonCore.Data.Business.Scan,ThermoFisher.CommonCore.Data.FilterEnums.MassAnalyzerType,System.Double,System.Double)">
            <summary>
            Gets mass precision estimate and stores them in a class property list of classes
            This method will throw an Exception or ArgumentException if a problem occurs
            during processing.
            </summary>
            <param name="scan">
            The scan to process
            </param>
            <param name="analyzerType">
            The analyzer type for the scan
            </param>
            <param name="ionTime">
            The ion time for the scan
            </param>
            <param name="resolution">
            The resolution for the scan
            </param>
            <returns>
            Returns the list of Mass Precision Estimation results
            </returns>
        </member>
        <member name="M:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.GetMassPrecisionEstimate">
            <summary>
            Gets mass precision estimate and stores them in a class property list of classes
            This method will throw an Exception or ArgumentException if a problem occurs
            during processing.
            </summary>
            <returns>
            Returns the list of Mass Precision Estimation results
            </returns>
        </member>
        <member name="M:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.PopulateScanData(ThermoFisher.CommonCore.Data.Business.Scan,ThermoFisher.CommonCore.Data.FilterEnums.MassAnalyzerType)">
            <summary>
            Populate the mass precision estimator data list from raw or label data 
            as appropriate for the scan data.
            </summary>
            <param name="scan">The scan</param>
            <param name="analyzerType"> The analyzer type </param>
            <returns>Returns true or false based upon if the scan could be filled in</returns>
        </member>
        <member name="M:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.CalculateMassPrecisionEstimateFromFormula">
            <summary>
            Calculate the MPE for the scan from formula.
            </summary>
        </member>
        <member name="M:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.CompareMassAccuracyToTables(ThermoFisher.CommonCore.Data.FilterEnums.MassAnalyzerType,System.String)">
            <summary>
            Compare the calculated MPE to tables of information from Alexander and Jae
            </summary>
            <param name="analyzerType"> the analyzer type. </param>
            <param name="scanFilter"> the scan filter. </param>
        </member>
        <member name="M:ThermoFisher.CommonCore.MassPrecisionEstimator.PrecisionEstimate.GetScanResolution">
            <summary>
            Gets the scan resolution from the file header 
            </summary>
            <returns>The resolution from the run header.</returns>
        </member>
    </members>
</doc>