CandidateSearch 1.1.2
Proof-of-concept implementation of a search engine that uses sparse matrix multiplication to identify the best peptide candidates for a given mass spectrum.
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
CandidateSearch.util.Spectrum Class Reference

Simplified spectrum class implemention of a mass spectrum. More...

Public Member Functions

 Spectrum (double[] Mz, double[] Intensity, int ScanNumber)
 Constructor to create a new spectrum.
 
int[] getEncoding (int massRange=5000, int massMultiplier=100)
 Get the encoding vector of the spectrum.
 

Properties

double[] mz [get]
 Array containing m/z values of centroid peaks.
 
double[] intensity [get]
 Array containing intensities of centroid peaks.
 
int scanNumber [get]
 The scan number of the spectrum.
 

Detailed Description

Simplified spectrum class implemention of a mass spectrum.

Definition at line 6 of file Spectra.cs.

Constructor & Destructor Documentation

◆ Spectrum()

CandidateSearch.util.Spectrum.Spectrum ( double[]  Mz,
double[]  Intensity,
int  ScanNumber 
)

Constructor to create a new spectrum.

Parameters
MzArray containing m/z values of centroid peaks.
IntensityArray containing intensities of centroid peaks.
ScanNumberThe scan number of the spectrum.

Definition at line 27 of file Spectra.cs.

Member Function Documentation

◆ getEncoding()

int[] CandidateSearch.util.Spectrum.getEncoding ( int  massRange = 5000,
int  massMultiplier = 100 
)

Get the encoding vector of the spectrum.

Parameters
massRangeMaximum m/z that should be considered while encoding. Has to match the specifications of VectorSearch.
massMultiplierPrecision of the encoding. Has to match the specifications of VectorSearch.
Returns
The encoding vector as an integer array.

Definition at line 41 of file Spectra.cs.

Property Documentation

◆ intensity

double [] CandidateSearch.util.Spectrum.intensity
get

Array containing intensities of centroid peaks.

Definition at line 15 of file Spectra.cs.

◆ mz

double [] CandidateSearch.util.Spectrum.mz
get

Array containing m/z values of centroid peaks.

Definition at line 11 of file Spectra.cs.

◆ scanNumber

int CandidateSearch.util.Spectrum.scanNumber
get

The scan number of the spectrum.

Definition at line 19 of file Spectra.cs.

The documentation for this class was generated from the following file: