Click or drag to resize
QualitativeSequence Class
This class holds quality scores along with the sequence data.
Inheritance Hierarchy
SystemObject
  BioQualitativeSequence

Namespace: Bio
Assembly: Bio.Core (in Bio.Core.dll) Version: 2.0.0.1 (2.0.0.1)
Syntax
public class QualitativeSequence : IQualitativeSequence, 
	ISequence, IEnumerable<byte>, IEnumerable

The QualitativeSequence type exposes the following members.

Constructors
  NameDescription
Public methodQualitativeSequence(IAlphabet, FastQFormatType, Byte, Byte)
Initializes a new instance of the QualitativeSequence class with specified alphabet, quality score type, byte array representing symbols and encoded quality scores. Sequence and quality scores are validated with the specified alphabet and specified fastq format respectively.
Public methodQualitativeSequence(IAlphabet, FastQFormatType, String, String)
Initializes a new instance of the QualitativeSequence class with specified alphabet, quality score type, string representing symbols and encoded quality scores. Sequence and quality scores are validated with the specified alphabet and specified fastq format respectively.
Public methodQualitativeSequence(IAlphabet, FastQFormatType, Byte, Byte, Boolean)
Initializes a new instance of the QualitativeSequence class with specified alphabet, quality score type, byte array representing symbols and encoded quality scores.
Public methodQualitativeSequence(IAlphabet, FastQFormatType, Byte, Int32, Boolean)
Initializes a new instance of the QualitativeSequence class with specified alphabet, quality score type, byte array representing symbols and integer array representing base quality scores (Phred or Solexa base according to the FastQ format type).
Public methodQualitativeSequence(IAlphabet, FastQFormatType, Byte, SByte, Boolean)
Initializes a new instance of the QualitativeSequence class with specified alphabet, quality score type, byte array representing symbols and signed byte array representing base quality scores (Phred or Solexa base according to the FastQ format type).
Public methodQualitativeSequence(IAlphabet, FastQFormatType, String, String, Boolean)
Initializes a new instance of the QualitativeSequence class with specified alphabet, quality score type, string representing symbols and encoded quality scores.
Top
Properties
  NameDescription
Public propertyAlphabet
Gets the alphabet to which symbols in this sequence belongs to.
Public propertyCount
Gets the number of bytes contained in the Sequence.
Public propertyFormatType
Gets the quality scores format type. Ex: Illumina/Solexa/Sanger.
Public propertyID
Gets or sets the Identifier.
Public propertyItem
Returns the byte which represents the symbol found at the specified index if within bounds. Note that the index value starts at 0.
Public propertyMetadata

Gets or sets the metadata for this qualitative sequence.

Many sequence representations when saved to file also contain information about that sequence. Unfortunately there is no standard around what that data may be from format to format. This property allows a place to put structured metadata that can be accessed by a particular key.

For example, if species information is stored in a particular Species class, you could add it to the dictionary by:

mySequence.Metadata["SpeciesInfo"] = mySpeciesInfo;

To fetch the data you would use:

Species mySpeciesInfo = mySequence.Metadata["SpeciesInfo"];

Particular formats may create their own data model class for information unique to their format as well. Such as:

GenBankMetadata genBankData = new GenBankMetadata();

// ... add population code

mySequence.MetaData["GenBank"] = genBankData;.

Top
Methods
  NameDescription
Public methodStatic memberConvertEncodedQualityScore(FastQFormatType, FastQFormatType, Byte)
Converts Encoded quality score from to specified format.
Public methodStatic memberConvertEncodedQualityScore(FastQFormatType, FastQFormatType, Byte)
Converts Encoded quality scores from to specified format.
Public methodStatic memberConvertQualityScore
Converts Quality score from to specified format.
Public methodStatic memberConvertQualityScores(FastQFormatType, FastQFormatType, Int32)
Converts Quality scores from to specified format.
Public methodStatic memberConvertQualityScores(FastQFormatType, FastQFormatType, SByte)
Converts Quality scores from to specified format.
Public methodConvertTo
Converts the current instance to the specified FastQ format type and returns a new instance of QualitativeSequence.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetComplementedSequence
Return a new QualitativeSequence representing the complement of this QualitativeSequence.
Public methodStatic memberGetDefaultQualScore
Gets the default quality score for the specified FastQFormatType.
Public methodGetEncodedQualityScore
Gets the encoded quality score found at the specified index if within bounds. Note that the index value start at 0.
Public methodGetEncodedQualityScores
Gets the encoded quality scores.
Public methodGetEnumerator
Gets an enumerator to the bytes present symbols in this sequence.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodStatic memberGetMaxEncodedQualScore
Gets the maximum encoded quality score for the specified FastQFormatType.
Public methodStatic memberGetMinEncodedQualScore
Gets the minimum encoded quality score for the specified FastQFormatType.
Public methodGetPhredQualityScore
Gets the Phred base quality score.
Public methodGetPhredQualityScores
Gets the Phred base quality scores.
Public methodGetQualityScore
Returns base quality scores at specified index. Returns Solexa quality scores if the FastQFormat type of this instance is Solexa Illumina v1.0, else returns Phred quality scores.
Public methodGetQualityScores
Returns base quality scores. Returns Solexa quality scores if the FastQFormat type of this instance is Solexa Illumina v1.0, else returns Phred quality scores.
Public methodGetReverseComplementedSequence
Return a new QualitativeSequence representing the reverse complement of this QualitativeSequence.
Public methodGetReversedSequence
Return a new QualitativeSequence representing this QualitativeSequence with the orientation reversed.
Public methodGetSolexaQualityScore
Gets the Solexa base quality score.
Public methodGetSolexaQualityScores
Gets the solexa base quality scores.
Public methodGetSubSequence
Return a new QualitativeSequence representing a range (subsequence) of this QualitativeSequence.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOfNonGap
Gets the index of first non-gap symbol.
Public methodIndexOfNonGap(Int64)
Returns the position of the first symbol beyond startPos that does not have a Gap symbol.
Public methodLastIndexOfNonGap
Gets the index of last non-gap symbol.
Public methodLastIndexOfNonGap(Int64)
Returns the index of last non-gap symbol before the specified end position.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string representation of the Qualitative sequence data. This representation will come from the symbols in the alphabet defined for the sequence. Also their Quality scores.
(Overrides ObjectToString.)
Public methodStatic memberValidateQualScores
Validates whether the specified encoded quality scores are within the FastQFormatType limit or not.
Top
Fields
  NameDescription
Public fieldStatic memberIllumina_v1_3_MaxEncodedQualScore
Maximum encoded quality score for Illumina v1.3 format: 126
Public fieldStatic memberIllumina_v1_3_MinEncodedQualScore
Minimum encoded quality score for Illumina v1.3 format: 64
Public fieldStatic memberIllumina_v1_5_MaxEncodedQualScore
Maximum encoded quality score for Illumina v1.5 format: 126
Public fieldStatic memberIllumina_v1_5_MinEncodedQualScore
Minimum encoded quality score for Illumina v1.5 format: 64
Public fieldStatic memberIllumina_v1_8_MaxEncodedQualScore
Maximum encoded quality score for Illumina v1.8 format: 126
Public fieldStatic memberIllumina_v1_8_MinEncodedQualScore
Minimum encoded quality score for Illumina v1.8 format: 33
Public fieldStatic memberPhred_MaxQualityScore
Phred maximum quality score: 93
Public fieldStatic memberPhred_MinQualityScore
Phred minimum quality score: 0
Public fieldStatic memberSanger_MaxEncodedQualScore
Maximum encoded quality score for Sanger format: 126
Public fieldStatic memberSanger_MinEncodedQualScore
Minimum encoded quality score for Sanger format: 33
Public fieldStatic memberSolexa_Illumina_v1_0_MaxEncodedQualScore
Maximum encoded quality score for Solexa/Illumina v1.0 format: 126
Public fieldStatic memberSolexa_Illumina_v1_0_MinEncodedQualScore
Minimum encoded quality score for Solexa/Illumina v1.0 format: 59
Public fieldStatic memberSolexa_MaxQualityScore
Solexa maximum quality score: 62
Public fieldStatic memberSolexa_MinQualityScore
Solexa minimum quality score: -5
Top
Extension Methods
  NameDescription
Public Extension MethodAppendByte(Byte)Overloaded.
Yield an Enumeration of the list with the item appended to the end
(Defined by IEnumerableExtensions.)
Public Extension MethodAppendByte(IEnumerableByte)Overloaded.
Yield a concatenation of the two Enumerable lists
(Defined by IEnumerableExtensions.)
Public Extension MethodConvertToString
Converts the sequence to a string.
(Defined by SequenceExtensions.)
Public Extension MethodElementAtByte
Returns the element at a specified index in a sequence.
(Defined by IEnumerableExtensions.)
Public Extension MethodForEachByte(ActionByte)Overloaded.
Calls an action on each element of a sequence. The action takes one argument: an element. It has no return value.
(Defined by IEnumerableExtensions.)
Public Extension MethodForEachByte(ActionByte, Int32)Overloaded.
Calls an action on each element of a sequence. The action takes two arguments: an element and the index of the element. It has no return value.
(Defined by IEnumerableExtensions.)
Public Extension MethodIsMarkedAsReverseComplement
This checks for a sequence marker to determine if the given ISequence was generated from a reverse complement.
(Defined by SequenceExtensions.)
Public Extension MethodMarkAsReverseComplement
This adds a key to the Metadata to indicate this is a reversed sequence
(Defined by SequenceExtensions.)
Public Extension MethodShuffleByte
Shuffles the elements of a sequence.
(Defined by IEnumerableExtensions.)
Public Extension MethodStringJoinOverloaded.
Creates a string from a sequence of elements. No delimiter is used.
(Defined by IEnumerableExtensions.)
Public Extension MethodStringJoin(String)Overloaded.
Creates a delimited string from a sequence of elements.
(Defined by IEnumerableExtensions.)
Public Extension MethodStringJoin(String, Int32, String)Overloaded.
Creates a delimited string from a sequence of elements. At most maxLength elements will be used and "..." shows that more elements were in the list.
(Defined by IEnumerableExtensions.)
Public Extension MethodSubSequenceByte
Take the items from a sequence starting with item # start (index 0) and contining for count items.
(Defined by IEnumerableExtensions.)
Public Extension MethodToHashSetByteOverloaded.
Creates a HashSet from a sequence. If the sequence is already a HashSet, a new HashSet is still created.
(Defined by IEnumerableExtensions.)
Public Extension MethodToHashSetByte(IEqualityComparerByte)Overloaded.
Creates a HashSet from a sequence. If the sequence is already a HashSet, a new HashSet is still created.
(Defined by IEnumerableExtensions.)
Public Extension MethodToQueueByte
Creates a Queue from a sequence. If the sequence is already a Queue, a new Queue is still created.
(Defined by IEnumerableExtensions.)
Top
See Also

Reference