public static class AssemblerInput.Read extends Object
getReads().getNextReadPair()
Since different sequencing technologies orientate paired data in different relative orientations, paired data can be obtained in 2 different ways:
getReadNormalized(), getMateNormalized() and getExpectedMateDistanceNormalized()getReadNormalized() and getMateNormalizedReversed() to get the reads as forward/reverse (e.g. Illumina data style)
getRead(), getMate(), getExpectedMateDistanceForRead(), getExpectedMateDistanceForMate(). For a full discussion of
what data means in this case, see PairedReads
PairedReads for a full discussion of what unnormalized expected distances mean.
If the assembly algorithm specified that it supports input contigs (see Assembler.supportsInputContigs()
then instead of a read representing a sequence or paired of sequences, it may be a contig, in which case it will
return null from getRead() and instead return a non-null value from getContig().| Constructor and Description |
|---|
AssemblerInput.Read(NucleotideSequenceDocument read,
AnnotatedPluginDocument referencedAnnotatedDocument,
int indexInReferencedDocument)
Constructs a new read consisting of a single unpaired sequence.
|
AssemblerInput.Read(NucleotideSequenceDocument read,
NucleotideSequenceDocument mate,
int expectedMateDistanceForRead,
int expectedMateDistanceForMate,
AnnotatedPluginDocument referencedAnnotatedDocument,
int indexOfReadInReferencedAnnotatedDocument,
AnnotatedPluginDocument mateReferencedAnnotatedDocument,
int indexOfMateInReferencedAnnotatedDocument)
Constructs a read consisting of a pair of sequences.
|
AssemblerInput.Read(NucleotideSequenceDocument read,
NucleotideSequenceDocument mate,
int expectedMateDistanceForRead,
int expectedMateDistanceForMate,
SequenceAlignmentDocument.ReferencedSequence referencedSequence,
SequenceAlignmentDocument.ReferencedSequence mateReferencedSequence)
Constructs a read consisting of a pair of sequences.
|
AssemblerInput.Read(NucleotideSequenceDocument read,
SequenceAlignmentDocument.ReferencedSequence referencedDocument)
Constructs a new read consisting of a single unpaired sequence.
|
AssemblerInput.Read(SequenceAlignmentDocument contig,
int indexOfAssemblyReferenceSequenceForContig)
Constructs a new read consisting of a single contig.
|
| Modifier and Type | Method and Description |
|---|---|
SequenceAlignmentDocument |
getContig()
If this read represents a contig as input to the assembler, returns that contig.
|
int |
getExpectedMateDistanceForMate()
Get the expected distance (which may be positive or negative) to find the mate of
getMate(). |
int |
getExpectedMateDistanceForRead()
Get the expected distance (which may be positive or negative) to find the mate of
getRead(). |
int |
getExpectedMateDistanceNormalized()
Gets the expected distance normalized to be positive.
|
int |
getIndexOfAssemblyReferenceSequenceForContig()
If this read represents a contig (i.e.
|
NucleotideSequenceDocument |
getMate()
Gets the second read in the pair or null if the read in unpaired.
|
NucleotideSequenceDocument |
getMateNormalized()
Gets the second read in the pair or null if the read is unpaired.
|
NucleotideSequenceDocument |
getMateNormalizedReversed()
Gets the second read in the pair or null if the read is unpaired normalized such that
the 2 reads are forward-reverse orientated.
|
SequenceAlignmentDocument.ReferencedSequence |
getMateReferencedDocument()
Gets the referenced document (not the same thing as a reference sequence) for the read returned from
getMate(). |
SequenceAlignmentDocument.ReferencedSequence |
getMateReferencedDocumentNormalized()
Gets the referenced document (not the same thing as a reference sequence) for the read returned from
getMateNormalized(). |
AssemblerInput.DataType |
getProbableDataType() |
NucleotideSequenceDocument |
getRead()
Gets the first read in the pair or the single read if the read is unpaired.
|
NucleotideSequenceDocument |
getReadNormalized()
Gets the first read in the pair or the single read if the read is unpaired.
|
SequenceAlignmentDocument.ReferencedSequence |
getReadReferencedDocument()
Gets the referenced document (not the same thing as a reference sequence) for the read returned from
getRead(). |
SequenceAlignmentDocument.ReferencedSequence |
getReadReferencedDocumentNormalized()
Gets the referenced document (not the same thing as a reference sequence) for the read returned from
getReadNormalized(). |
public AssemblerInput.Read(SequenceAlignmentDocument contig, int indexOfAssemblyReferenceSequenceForContig)
contig - the contig.indexOfAssemblyReferenceSequenceForContig - the value to be returned from getIndexOfAssemblyReferenceSequenceForContig()public AssemblerInput.Read(NucleotideSequenceDocument read, SequenceAlignmentDocument.ReferencedSequence referencedDocument)
read - the sequencereferencedDocument - an optional referenced document. A referenced document is what Geneious goes to if you click on the little "Go to referenced document" icon to the left of the sequence names in the alignment/contig viewer.public AssemblerInput.Read(NucleotideSequenceDocument read, AnnotatedPluginDocument referencedAnnotatedDocument, int indexInReferencedDocument)
read - the sequencereferencedAnnotatedDocument - an optional referenced document. A referenced document is what Geneious goes to if you click on the little "Go to referenced document" icon to the left of the sequence names in the alignment/contig viewer.indexInReferencedDocument - the index of the sequence in the referenced documentpublic AssemblerInput.Read(NucleotideSequenceDocument read, NucleotideSequenceDocument mate, int expectedMateDistanceForRead, int expectedMateDistanceForMate, SequenceAlignmentDocument.ReferencedSequence referencedSequence, SequenceAlignmentDocument.ReferencedSequence mateReferencedSequence)
read - the first sequence in the pairmate - the second sequence in the pairexpectedMateDistanceForRead - the expected distance of the mate from read which may be positive or negative See PairedReads for more information.expectedMateDistanceForMate - the expected distance of the read from mate which may be positive or negative See PairedReads for more information.referencedSequence - an optional referenced document corresponding to 'read'. A referenced document is what Geneious goes to if you click on the little "Go to referenced document" icon to the left of the sequence names in the alignment/contig viewer.mateReferencedSequence - an optional referenced document corresponding to 'mate'. A referenced document is what Geneious goes to if you click on the little "Go to referenced document" icon to the left of the sequence names in the alignment/contig viewer.public AssemblerInput.Read(NucleotideSequenceDocument read, NucleotideSequenceDocument mate, int expectedMateDistanceForRead, int expectedMateDistanceForMate, AnnotatedPluginDocument referencedAnnotatedDocument, int indexOfReadInReferencedAnnotatedDocument, AnnotatedPluginDocument mateReferencedAnnotatedDocument, int indexOfMateInReferencedAnnotatedDocument)
read - the first sequence in the pairmate - the second sequence in the pairexpectedMateDistanceForRead - the expected distance of the mate from read which may be positive or negative See PairedReads for more information.expectedMateDistanceForMate - the expected distance of the read from mate which may be positive or negative See PairedReads for more information.referencedAnnotatedDocument - an optional referenced document for 'read'. A referenced document is what Geneious goes to if you click on the little "Go to referenced document" icon to the left of the sequence names in the alignment/contig viewer.indexOfReadInReferencedAnnotatedDocument - the index of 'read' in the referenced documentmateReferencedAnnotatedDocument - an optional referenced document for 'mate'. A referenced document is what Geneious goes to if you click on the little "Go to referenced document" icon to the left of the sequence names in the alignment/contig viewer.indexOfMateInReferencedAnnotatedDocument - the index of 'mate' in the referenced documentpublic AssemblerInput.DataType getProbableDataType()
public SequenceAlignmentDocument getContig()
getRead() will return a non-null value. getContig will only return non-null values if
Assembler.supportsInputContigs() returned true.public int getIndexOfAssemblyReferenceSequenceForContig()
getContig() returned non-null) which has a reference
sequence (i.e. getContig().getContigReferenceSequenceIndex() returns a non-negative value)
and that reference sequence is being treated as a reference sequence for this assembly, then
this method returns the index of the reference sequence in the assembly input.
(that could be retrieved using AssemblerInput.getReferenceSequence(int, jebl.util.ProgressListener)
or -1 if this contig does not contain a reference sequence that is being treated as an input reference sequence to the assembler.public NucleotideSequenceDocument getRead()
AssemblerInput.Read for a discussion of the various get methods.Assembler.supportsInputContigs() return false. If Assembler.supportsInputContigs() returns true then getRead() may return null in which case getContig() will return a non-null valuepublic NucleotideSequenceDocument getMate()
AssemblerInput.Read for a discussion of the various get methods.public SequenceAlignmentDocument.ReferencedSequence getReadReferencedDocument()
getRead().
A referenced document is what Geneious goes to if you click on the little "Go to referenced document" icon to the left of the sequence names in the alignment/contig viewer.getRead() or null if this read has no referenced document.public SequenceAlignmentDocument.ReferencedSequence getMateReferencedDocument()
getMate().
A referenced document is what Geneious goes to if you click on the little "Go to referenced document" icon to the left of the sequence names in the alignment/contig viewer.getMate() or null if this read has no referenced document.public SequenceAlignmentDocument.ReferencedSequence getReadReferencedDocumentNormalized()
getReadNormalized().
A referenced document is what Geneious goes to if you click on the little "Go to referenced document" icon to the left of the sequence names in the alignment/contig viewer.getReadNormalized() or null if this read has no referenced document.public SequenceAlignmentDocument.ReferencedSequence getMateReferencedDocumentNormalized()
getMateNormalized().
A referenced document is what Geneious goes to if you click on the little "Go to referenced document" icon to the left of the sequence names in the alignment/contig viewer.getMateNormalized() or null if this read has no referenced document.public int getExpectedMateDistanceForRead()
getRead().
See AssemblerInput.Read for a discussion of the various get methods.getRead().getExpectedMateDistanceForMate()public int getExpectedMateDistanceForMate()
getMate().
See AssemblerInput.Read for a discussion of the various get methods.getMate().getExpectedMateDistanceForRead()public int getExpectedMateDistanceNormalized()
getReadNormalized() and getMateNormalized()
See AssemblerInput.Read for a discussion of the various get methods.public NucleotideSequenceDocument getReadNormalized()
getExpectedMateDistanceNormalized() and either getMateNormalized() or getMateNormalizedReversed().
See AssemblerInput.Read for a discussion of the various get methods.public NucleotideSequenceDocument getMateNormalized()
getReadNormalized() and getExpectedMateDistanceNormalized()
See AssemblerInput.Read for a discussion of the various get methods.public NucleotideSequenceDocument getMateNormalizedReversed()
getReadNormalized() and getExpectedMateDistanceNormalized() where
getReadNormalized() returns the forward read, getMateNormalizedReversed() returns the reverse read and getExpectedMateDistanceNormalized() returns the distance between them.
See AssemblerInput.Read for a discussion of the various get methods.