Enum PsmScore
- All Implemented Interfaces:
Serializable
,Comparable<PsmScore>
,java.lang.constant.Constable
public enum PsmScore extends Enum<PsmScore>
Enum listing the PSM scores implemented in compomics utilities.
- Author:
- Marc Vaudel
-
Nested Class Summary
-
Enum Constant Summary
Enum Constants Enum Constant Description hyperScore
Hyperscore as variation of the score implemented in X!Tandem www.thegpm.org/tandem.native_score
The native score of the search engine.precursor_accuracy
The precursor accuracy.snrScore
Signal to noise ratio score. -
Field Summary
Fields Modifier and Type Field Description String
description
Short description of the score.boolean
increasing
Indicates whether the score increases with the quality of the match.Integer
index
The index of the score of interest.String
name
The name of the score. -
Method Summary
Modifier and Type Method Description static PsmScore
getScore(int scoreIndex)
Returns the PSM score of the given index.static PsmScore
getScore(String scoreName)
Returns the PSM score of the given name.static PsmScore
valueOf(String name)
Returns the enum constant of this type with the specified name.static PsmScore[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
native_score
The native score of the search engine. -
precursor_accuracy
The precursor accuracy. -
hyperScore
Hyperscore as variation of the score implemented in X!Tandem www.thegpm.org/tandem. See com.compomics.util.experiment.identification.psm_scoring.psm_scores.HyperScore for details. -
snrScore
Signal to noise ratio score.
-
-
Field Details
-
index
The index of the score of interest. -
name
The name of the score. -
increasing
public final boolean increasingIndicates whether the score increases with the quality of the match. -
description
Short description of the score.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getScore
Returns the PSM score of the given index. Null if not found.- Parameters:
scoreIndex
- the index of the desired score- Returns:
- the score of given index
-
getScore
Returns the PSM score of the given name. Null if not found.- Parameters:
scoreName
- the name of the desired score- Returns:
- the score of given name
-