C# Class ImsInformed.Workflows.VoltageAccumulation.VoltageAccumulationWorkflow

Essentially just accumulate voltages of a UIMF file and split it.
显示文件 Open project: PNNL-Comp-Mass-Spec/IMS-Informed-Library Class Usage Examples

Public Properties

Property Type Description
NumberOfBins int
NumberOfFrames double
UimfReader DataReader

Public Methods

Method Description
ExportToMzML ( string MzMLPath ) : bool
RunVoltageAccumulationWorkflow ( FileFormatEnum exportFormat ) : bool

The run voltage accumulation workflow.
RunVoltageAccumulationWorkflow ( int startScan, int endScan, FileFormatEnum exportFormat ) : bool

The run voltage accumulation workflow.
RunVoltageAccumulationWorkflow ( int startScan, int endScan, int startBin, int endBin, FileFormatEnum exportFormat ) : bool

The run voltage accumulation workflow.
RunVoltageAccumulationWorkflow ( int startScan, int endScan, int startBin, int endBin, double xCompression, double yCompression, FileFormatEnum exportFormat ) : bool

The run voltage accumulation workflow.
VoltageAccumulationWorkflow ( bool averageNotSum, string uimfLocation, string outputDirectory ) : System

Private Methods

Method Description
RunVoltageAccumulationWorkflow ( int startScan, int endScan, bool fullScan, FileFormatEnum exportFormat ) : bool

The run voltage accumulation workflow.
RunVoltageAccumulationWorkflow ( int startScan, int endScan, int startBin, int endBin, bool fullScan, FileFormatEnum exportFormat ) : bool

The run voltage accumulation workflow.
RunVoltageAccumulationWorkflow ( int startScan, int endScan, int startBin, int endBin, double xCompression, double yCompression, bool fullScan, FileFormatEnum exportFormat ) : bool

The input UIMF file needs to be a UIMF file created by direct-injection IMS, with different drift tube voltages at different frames. This constructor intelligently group voltages together by observing sharp changes in running voltage standard deviation. The entire mobility and frame range would be accumulated.

Method Details

ExportToMzML() public method

public ExportToMzML ( string MzMLPath ) : bool
MzMLPath string
return bool

RunVoltageAccumulationWorkflow() public method

The run voltage accumulation workflow.
public RunVoltageAccumulationWorkflow ( FileFormatEnum exportFormat ) : bool
exportFormat FileFormatEnum
return bool

RunVoltageAccumulationWorkflow() public method

The run voltage accumulation workflow.
public RunVoltageAccumulationWorkflow ( int startScan, int endScan, FileFormatEnum exportFormat ) : bool
startScan int /// The start scan. ///
endScan int /// The end scan. ///
exportFormat FileFormatEnum
return bool

RunVoltageAccumulationWorkflow() public method

The run voltage accumulation workflow.
public RunVoltageAccumulationWorkflow ( int startScan, int endScan, int startBin, int endBin, FileFormatEnum exportFormat ) : bool
startScan int /// The start scan. ///
endScan int /// The end scan. ///
startBin int /// The start bin. ///
endBin int /// The end bin. ///
exportFormat FileFormatEnum
return bool

RunVoltageAccumulationWorkflow() public method

The run voltage accumulation workflow.
public RunVoltageAccumulationWorkflow ( int startScan, int endScan, int startBin, int endBin, double xCompression, double yCompression, FileFormatEnum exportFormat ) : bool
startScan int /// The start scan. ///
endScan int /// The end scan. ///
startBin int /// The start bin. ///
endBin int /// The end bin. ///
xCompression double /// The x compression. ///
yCompression double /// The y compression. ///
exportFormat FileFormatEnum
return bool

VoltageAccumulationWorkflow() public method

public VoltageAccumulationWorkflow ( bool averageNotSum, string uimfLocation, string outputDirectory ) : System
averageNotSum bool
uimfLocation string
outputDirectory string
return System

Property Details

NumberOfBins public_oe property

The number of scans.
public int NumberOfBins
return int

NumberOfFrames public_oe property

The number of frames.
public double NumberOfFrames
return double

UimfReader public_oe property

The UIMF reader.
public DataReader UimfReader
return DataReader