CandidateSearch.util.Result Class Reference

Result class to transform and store the returned integer array of VectorSearch. More...

Public Member Functions
	Result (ref int[] SearchResult, ref List< Peptide > Peptides, ref List< Spectrum > Spectra, int TopN)
	Constructor creating a result item that stores the processed VectorSearch result.
int	export (string filename)
	Exports the results to csv format into a file with the given filename.

Properties
Dictionary< int, List< Peptide > >	result [get]
	Dictionary that maps scan numbers to lists of peptide candidates.

Detailed Description

Result class to transform and store the returned integer array of VectorSearch.

Definition at line 6 of file Result.cs.

Constructor & Destructor Documentation

Result()

CandidateSearch.util.Result.Result	(	ref int[]	SearchResult,
		ref List< Peptide >	Peptides,
		ref List< Spectrum >	Spectra,
		int	TopN
	)

Constructor creating a result item that stores the processed VectorSearch result.

Parameters

SearchResult	The search result of the VectorSearch.
Peptides	The complete list of considered peptides/peptidoforms.
Spectra	The complete list of searched spectra.
TopN	The number of top candidates reported for each spectrum.

Definition at line 20 of file Result.cs.

Member Function Documentation

export()

int CandidateSearch.util.Result.export

(

string

filename

)

Exports the results to csv format into a file with the given filename.

Parameters

filename

The output filename.

Returns

0 if the export was successful, 1 if it was unsuccessful.

Definition at line 49 of file Result.cs.

Property Documentation

result

Dictionary<int, List<Peptide> > CandidateSearch.util.Result.result

get

Dictionary that maps scan numbers to lists of peptide candidates.

Definition at line 11 of file Result.cs.

---

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

• C:/Users/P42587/Documents/GitHub/CandidateSearch/util/Result.cs