SequenceRangeGroupingIntersect Method |
Returns overlapping sequence ranges from this and specified SequenceRangeGroup for each group in this grouping.
For instance if you had in group 'Chr1' the following ranges:
Ranges in this instance Ranges in the query
0 to 10 20 to 40
30 to 50 70 to 100
60 to 80 400 to 800
300 to 500 850 to 900
600 to 700 900 to 1200
800 to 1000
Result for minOverlap set to 1
1. If outputType is OverlappingPiecesOfIntervals.
30 to 40
70 to 80
400 to 500
600 o 700
850 to 900
900 to 1000
2. If outputType is OverlappingIntervals
30 to 50
60 to 80
300 to 500
600 to 700
800 to 1000
Running this method creates all new ISequenceRange objects and adds them
to the newly created SequenceRangeGrouping returned here.
Namespace: BioAssembly: Bio.Core (in Bio.Core.dll) Version: 2.0.0.1 (2.0.0.1)
Syntax public SequenceRangeGrouping Intersect(
SequenceRangeGrouping query,
long minOverlap = 1,
IntersectOutputType outputType = IntersectOutputType.OverlappingPiecesOfIntervals,
bool isParentSeqRangesRequired = false
)
Public Function Intersect (
query As SequenceRangeGrouping,
Optional minOverlap As Long = 1,
Optional outputType As IntersectOutputType = IntersectOutputType.OverlappingPiecesOfIntervals,
Optional isParentSeqRangesRequired As Boolean = false
) As SequenceRangeGrouping
public:
SequenceRangeGrouping^ Intersect(
SequenceRangeGrouping^ query,
long long minOverlap = 1,
IntersectOutputType outputType = IntersectOutputType::OverlappingPiecesOfIntervals,
bool isParentSeqRangesRequired = false
)
member Intersect :
query : SequenceRangeGrouping *
?minOverlap : int64 *
?outputType : IntersectOutputType *
?isParentSeqRangesRequired : bool
(* Defaults:
let _minOverlap = defaultArg minOverlap 1
let _outputType = defaultArg outputType IntersectOutputType.OverlappingPiecesOfIntervals
let _isParentSeqRangesRequired = defaultArg isParentSeqRangesRequired false
*)
-> SequenceRangeGrouping
Parameters
- query
- Type: BioSequenceRangeGrouping
Query grouping. - minOverlap (Optional)
- Type: SystemInt64
Minmum length of bases pairs should be overlapped.
By default this will be set to 1. - outputType (Optional)
- Type: BioIntersectOutputType
Type of output required, OverlappingPiecesOfIntervals or OverlappingIntervals.
By default this will be set to OverlappingPiecesOfIntervals that is only the base pairs that overlaps with
query ranges will be returned. - isParentSeqRangesRequired (Optional)
- Type: SystemBoolean
If this flag is set to true then the sequence ranges from
which the new sequence range is created are added to the ParentSeqRanges property of the
new sequence ranges.
Return Value
Type:
SequenceRangeGroupingThe intersected result.
See Also