rectangleGate-class(flowCore)
rectangleGate-class()所属R语言包：flowCore
Class "rectangleGate"
类“rectangleGate”
译者：生物统计家园网 机器人LoveR
描述----------Description----------
Class and constructor for n-dimensional rectangular filter objects.
n维矩形filter对象的类和构造。
用法----------Usage----------
rectangleGate(..., .gate, filterId="defaultRectangleGate")
参数----------Arguments----------
参数：filterId
An optional parameter that sets the filterId of this gate. The object can later be identified by this name.
一个可选的参数，设置了这个门filterId。对象可以在以后确定了这个名字。
参数：.gate
A definition of the gate. This can be either a list, or a matrix, as described below.
门的定义。这可以是一个列表，或矩阵，如下所述。
参数：...
You can also directly provide the boundaries of a rectangleGate as additional named arguments, as described below.
您也可以直接提供一个rectangleGate边界额外的命名参数，如下所述。
Details
详情----------Details----------
This class describes a rectangular region in n dimensions, which is a Cartesian product of n orthogonal intervals in these dimensions. n=1 corresponds to a range gate, n=2 to a rectangle gate, n=3 corresponds to a box region and n>3 to a hyper-rectangular regions. Intervals may be open on one side, in which case the value for the boundary is supposed to be Inf or -Inf, respectively. rectangleGates are inclusive, that means that events on the boundaries are considered to be in the gate.
这个类描述了一个n维的矩形区域，这是一个笛卡尔积n在这些方面的正交间隔。 n=1对应一个距离门，n=2矩形门，n=3对应一个盒子区域和n>3一个超矩形区域。间隔可能是开放的一面，在这种情况下，边界值应该是Inf或-Inf，分别。 rectangleGates包容性，这意味着边界上的事件被认为是在门。
The constructor is designed to be useful in both direct and programmatic usage. To use it programmatically, you may either construct a named list or you may construct a matrix with n columns and 2 rows. The first row corresponds to the minimal value for each parameter while the second row corresponds to the maximal value for each parameter. The names of the parameters are taken from the column names or from the list names, respectively. Alternatively, the boundaries of the rectangleGate can be given as additional named arguments, where each of these arguments should be a numeric vector of length 2; the function tries to collapse these boundary values into a matrix.
构造设计，直接和纲领性的使用是有用的。编程使用它，你可能会建立一个名为列表，或者您可能会n列2行构建一个矩阵。第一行对应每个参数的最小值，而第二行对应每个参数的最大值。参数的名称，分别采取列名或从列表名称。另外，界限rectangleGate可以得到额外的命名参数，这些参数的每个人都应该是一个长度为数字向量2函数试图倍数成一个矩阵这些边界值。
Note that boundaries of rectangleGates where min > max are syntactically valid, however when evaluated they will always be empty.
注意rectangleGates其中min > max语法有效，但计算时，他们将永远是空的，边界。
rectangleGate objects can also be multiplied using the * operator, provided that both gates have orthogonal axes. This results in higher-dimensional rectangleGates. The inverse operation of subsetting by parameter name(s) is also available.
rectangleGate对象也可以使用*运营商，提供两个门轴正交相乘。在高维rectangleGates这个结果。也可以逆运算的参数名称（S）的子集。
Evaluating a rectangleGate generates an object of class logicalFilterResult. Accordingly, rectangleGates can be used to subset and to split flow cytometry data sets.
rectangleGate评价类logicalFilterResult生成一个对象。因此，rectangleGates可以使用子集和分裂流式单元仪的数据集。
值----------Value----------
Returns a rectangleGate object for use in filtering flowFrames or other flow cytometry objects.
使用过滤rectangleGates或其他流式单元仪检测对象返回一个flowFrame对象。
延伸----------Extends----------
Class "parameterFilter", directly.
类"parameterFilter"，直接。
Class "concreteFilter", by class parameterFilter, distance 2.
类"concreteFilter"类parameterFilter，距离2。
Class "filter", by class parameterFilter, distance 3.
类"filter"类parameterFilter，距离3。
插槽----------Slots----------
min,max: Objects of class "numeric". The minimum and maximum values of the n-dimensional rectangular
min,max类"numeric"：对象。 n维矩形的最低和最高值
parameters: Object of class "character", indicating the parameters for which the rectangleGate is
parameters：Object类的"character"，表示参数为rectangleGate是
filterId: Object of class "character",
filterId：Object类的"character"，
类的对象----------Objects from the Class----------
Objects can be created by calls of the form new("rectangleGate", ...), by using the constructor rectangleGate or by combining existing rectangleGates using the * method. Using the constructor is the recommended way of object instantiation:
可以创建对象的形式new("rectangleGate", ...)的呼声，通过使用构造rectangleGate或结合现有的rectangleGates用*方法。使用构造对象实例的推荐方式：
方法----------Methods----------
%in% signature(x = "flowFrame", table = "rectangleGate"): The workhorse used to evaluate the filter on data. This is usually not called directly by the user, but
在％signature(x = "flowFrame", table = "rectangleGate")：主力用来评估对数据的过滤器。这通常不是直接调用的用户，但
show signature(object = "rectangleGate"): Print
显示signature(object = "rectangleGate")：打印
* signature(e1 = "rectangleGate", e2 = "rectangleGate"): combining two rectangleGates into one
*signature(e1 = "rectangleGate", e2 = "rectangleGate")：结合两个rectangleGates成一个
\[ signature(x = "rectangleGate", i = "character"): Subsetting of a rectangleGate by parameter name(s). This
\ [signature(x = "rectangleGate", i = "character")：rectangleGate通过参数名称（S）的子集。这
注意----------Note----------
See the documentation in the flowViz package for details on plotting of rectangleGates.
详情在flowViz包rectangleGates图看到的文档。
作者（S）----------Author(s)----------
F.Hahne, B. Ellis N. Le Meur
参见----------See Also----------
flowFrame, polygonGate, ellipsoidGate, polytopeGate, filter for evaluation of rectangleGates and split and Subsetfor splitting and subsetting of flow cytometry data sets based on that.
flowFrame，polygonGate，ellipsoidGate，polytopeGate，filterrectangleGates和split和Subset评价设置基础上，分裂和流式单元仪数据的子集。
举例----------Examples----------
## Loading example data[＃载入数据为例]
dat <- read.FCS(system.file("extdata","0877408774.B08",
package="flowCore"))
#Create directly. Most likely from a command line[直接创建。最有可能从一个命令行]
rectangleGate(filterId="myRectGate", "FSC-H"=c(200, 600), "SSC-H"=c(0, 400))
#To facilitate programmatic construction we also have the following[为了方便纲领性建设，我们也有以下]
rg <- rectangleGate(filterId="myRectGate", list("FSC-H"=c(200, 600),
"SSC-H"=c(0, 400)))
mat <- matrix(c(200, 600, 0, 400), ncol=2, dimnames=list(c("min", "max"),
c("FSC-H", "SSC-H")))
rg <- rectangleGate(filterId="myRectGate", .gate=mat)
## Filtering using rectangleGates[＃过滤使用rectangleGates]
fres <- filter(dat, rg)
fres
summary(fres)
## The result of rectangle filtering is a logical subset[＃矩形过滤的结果是一个逻辑的子集]
Subset(dat, fres)
## We can also split, in which case we get those events in and those[＃我们也可以分裂，在这种情况下，我们得到这些事件和那些]
## not in the gate as separate populations[＃而不是作为单独的种群门]
split(dat, fres)
## Multiply rectangle gates[＃乘以矩形闸门]
rg1 <- rectangleGate(filterId="FSC-", "FSC-H"=c(-Inf, 50))
rg2 <- rectangleGate(filterId="SSC+", "SSC-H"=c(50, Inf))
rg1 * rg2
## Subset rectangle gates[＃子集矩形门]
rg["FSC-H"]
转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。
注：
注1：为了方便大家学习，本文档为生物统计家园网机器人LoveR翻译而成，仅供个人R语言学习参考使用，生物统计家园保留版权。
注2：由于是机器人自动翻译，难免有不准确之处，使用时仔细对照中、英文内容进行反复理解，可以帮助R语言的学习。
注3：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。
|
发表于 2012-2-25 17:47:42
