NucleotideLocation

Full name SMRUCC.genomics.ComponentModel.Loci.NucleotideLocation Assembly SMRUCC.genomics.Core Members 22

Loci segment location information on an nucleotide sequence, this object added an NucleotideLocation.Strand information on Location data.

00 Remarks

(会自动根据LEFT和RIGHT的值来修正属性值)

01 Syntax

SMRUCC.genomics.ComponentModel.Loci.NucleotideLocation

02 Methods

Name	Overloads	Summary
GetUpStreamLoci	2	请放心，这个函数所得到的具体的位点是和链的方向相关的
.ctor	7	Create location model from the exists loci data, and then assign a new Strands value for it.
Normalization	1	Location.Normalization()
CreateObject	2	Create a nucleotide sequence loci location based on start position, segment length and segment strand.
Equals	1	和当前的这个位点位置进行允许在一定的误差范围之内的模糊匹配
GetRelationship	1	Gets the location relationship of two loci segments.(获取两个位点片段之间的位置关系，请注意，这个函数只依靠左右位置来判断关系，假若对核酸链的方向有要求在调用本函数之前请确保二者在同一条链之上)
LociIsContact	1	判断目标位点片段是否与本位点片段具有相互关系，这个函数是忽略掉了链的方向了的
ToString	1	这个函数的输出的字符串可以使用LocusExtensions.TryParse())方法进行解析
Parse	1	解析NucleotideLocation.ToString()的结果数据

03 Properties

Name	Overloads	Summary
Strand	1	这个位点在哪一条DNA核酸链 Forward = 1; Reverse = -1; Unknown = 0
tagStr	1	用户对这个位点的自定义标注信息
Start	1	NucleotideLocation: 实际的物理上面的位置，与核酸链的方向相关， (假若需要使用原始的位置数据，则请使用Location.left或者Location.right属性，这两个属性值是和具体的链的方向无关的)
Ends	1	NucleotideLocation: 实际的物理上面的位置，与核酸链的方向相关， (假若需要使用原始的位置数据，则请使用Location.left或者Location.right属性，这两个属性值是和具体的链的方向无关的)
IsValid	1	当任意一个断点为0的时候就无效

04 Members

method GetUpStreamLoci overload 2 #

GetUpStreamLoci(UInt32)

获取当前的这个核酸片段位点的上游的指定距离的位点的位置

Parameters

Name	Type	Description
`distance`	`UInt32`	-

method GetUpStreamLoci #

GetUpStreamLoci(Int32)

请放心，这个函数所得到的具体的位点是和链的方向相关的

Parameters

Name	Type	Description
`Distance`	`Int32`	-

method .ctor #

#ctor(Location, Strands)

Create location model from the exists loci data, and then assign a new Strands value for it.

Parameters

Name	Type	Description
`loci`	Location	-
`strand`	Strands	The new Strands value for the target loci.

method .ctor overload 4 #

#ctor(Int32, Int32, String)

使用片段的位置进行初始化本位点对象

Parameters

Name	Type	Description
`LociStart`	`Int32`	-
`LociEnds`	`Int32`	-
`Strand`	`String`	一般性的链的方向的描述性的字符串

method .ctor overload 7 #

#ctor(Int64, Int64, String)

Parameters

Name	Type	Description
`LociStart`	`Int64`	-
`LociEnds`	`Int64`	-
`Strand`	`String`	会自动通过LocusExtensions.GetStrand()函数来进行数据类型的转换的

method .ctor overload 2 #

#ctor(Int32, Int32, Strands)

Creates loci object from raw location data.

Parameters

Name	Type	Description
`start`	`Int32`	Location: Gets or set the left start value of the segment on the target sequence.(目标片段的左端起始区域，与链的方向无关)
`[end]`	`Int32`	Location: Gets or set the right stop value of the segment on the target sequence.(目标片段的右端终止区域，与链的方向无关)
`Strand`	Strands	链的方向

method .ctor overload 3 #

#ctor(Int32, Int32, Boolean)

使用片段的位置进行初始化本位点对象

Parameters

Name	Type	Description
`_start`	`Int32`	-
`_ends`	`Int32`	-
`ComplementStrand`	`Boolean`	这个片段是否位于DNA上面的互补链或者是否为反向序列

method .ctor overload 5 #

#ctor(Int32, Int32)

自动判断链的方向，假若开始小于结束，则是正链，反之为负义链

Parameters

Name	Type	Description
`start`	`Int32`	-
`ends`	`Int32`	-

method .ctor overload 6 #

#ctor(Int64, Int64, Boolean)

使用片段的位置进行初始化本位点对象

Parameters

Name	Type	Description
`_start`	`Int64`	-
`_ends`	`Int64`	-
`complementStrand`	`Boolean`	这个片段是否位于DNA上面的互补链或者是否为反向序列

method Normalization #

Normalization

Location.Normalization()

method CreateObject #

CreateObject(Int64, Int32, Strands)

Create a nucleotide sequence loci location based on start position, segment length and segment strand.

Parameters

Name	Type	Description
`Start`	`Int64`	-
`Length`	`Int32`	-
`Strand`	Strands	-

method CreateObject overload 2 #

CreateObject(Int64, Int64)

会自动比较start和ends这两个参数的大小来确定链的方向

Parameters

Name	Type	Description
`Start`	`Int64`	-
`Ends`	`Int64`	-

method Equals #

Equals(NucleotideLocation, Int32)

和当前的这个位点位置进行允许在一定的误差范围之内的模糊匹配

Parameters

Name	Type	Description
`Loci`	NucleotideLocation	-
`AllowedOffset`	`Int32`	当这个值为0的时候就是绝对相等

method GetRelationship #

GetRelationship(NucleotideLocation)

Gets the location relationship of two loci segments.(获取两个位点片段之间的位置关系，请注意，这个函数只依靠左右位置来判断关系，假若对核酸链的方向有要求在调用本函数之前请确保二者在同一条链之上)

Parameters

Name	Type	Description
`lcl`	NucleotideLocation	在计算之前请先调用Location.Normalization()方法来修正

method LociIsContact #

LociIsContact(NucleotideLocation)

判断目标位点片段是否与本位点片段具有相互关系，这个函数是忽略掉了链的方向了的

Parameters

Name	Type	Description
`Loci`	NucleotideLocation	-

method ToString #

ToString

这个函数的输出的字符串可以使用LocusExtensions.TryParse()方法进行解析

method Parse #

Parse(String)

解析NucleotideLocation.ToString()的结果数据

Parameters

Name	Type	Description
`loci$`	`String`	-

property Strand #

Strand

这个位点在哪一条DNA核酸链

 Forward =  1; 
 Reverse = -1; 
 Unknown =  0

property tagStr #

tagStr

用户对这个位点的自定义标注信息

property Start #

Start

NucleotideLocation: 实际的物理上面的位置，与核酸链的方向相关， (假若需要使用原始的位置数据，则请使用Location.left或者Location.right属性，这两个属性值是和具体的链的方向无关的)

property Ends #

Ends

property IsValid #

IsValid

当任意一个断点为0的时候就无效