R语言 RSAGA包 rsaga.esri.wrapper()函数中文帮助文档(中英文对照)

loveR

rsaga.esri.wrapper(RSAGA)
rsaga.esri.wrapper()所属R语言包：RSAGA

                                        Use RSAGA functions for ESRI grids
                                         使用ESRI电网的RSAGA功能

                                         译者：生物统计家园网 机器人LoveR

描述----------Description----------

This wrapper converts input grid files provided in ESRI binary (.flt) or ASCII (.asc) formats to SAGA's (version 2) grid format, calls the RSAGA geoprocessing function, and converts the output grids back to the ESRI grid format. Conversion can also be limited to either input or
此包装将在ESRI二进制（FLT），或ASCII格式（ASC）SAGA（第2版）网格格式输入电网提供的文件，要求RSAGAGEO处理功能，并转换输出电网的ESRI网格格式。也可以转换为输入或


用法----------Usage----------


rsaga.esri.wrapper(fun, in.esri = TRUE, out.esri = TRUE, env = rsaga.env(),
    esri.workspace = env$workspace, format = "ascii", georef = "corner",
    prec = 5, esri.extension, condensed.res = TRUE, clean.up = TRUE,
    intern = TRUE, ...)



参数----------Arguments----------

参数：fun
function: one of the RSAGA geoprocessing functions, such as rsaga.close.gaps or rsaga.hillshade etc.  
功能：一RSAGAGEO处理功能，如rsaga.close.gaps或rsaga.hillshade等


参数：in.esri
logical: are input grids provided as ESRI grids (in.esri=TRUE) or as SAGA grids?
逻辑：输入电网，作为ESRI网格（in.esri=TRUE）或SAGA电网提供吗？


参数：out.esri
logical: should output grids be converted to ESRI grids?
逻辑：应输出电网转换为ESRI电网的吗？


参数：env
RSAGA environment as returned by rsaga.env  
RSAGA环境返回rsaga.env


参数：esri.workspace
directory for the input and output ESRI ASCII/binary grids
目录的输入和输出ESRI ASCII /二进制网格


参数：format
output file format, either "ascii" (default; equivalent: format=1) for ASCII grids or "binary" (equivalent: 0) for binary ESRI grids (.flt).  
输出文件格式，是"ascii"（默认情况下，相当于format=1）为ASCII电网或"binary"（相当于：0）二进制ESRI网格（.flt中） 。


参数：georef
character: "corner" (equivalent numeric code: 0) or "center" (default; equivalent: 1). Determines whether the georeference will be related to the center or corner of its extreme lower left grid cell.
字符："corner"（相当于数字代码：0）或"center"（默认情况下，相当于：1）。确定的GEO坐标定位是否会涉及到它的极端左下角的网格单元格的中心或角落。


参数：prec
number of digits when writing floating point values to ASCII grid files (only relevant if out.esri=TRUE)  
数位ASCII网格文件（只写浮点值时，如果out.esri=TRUE）


参数：esri.extension
extension for input/output ESRI grids: defaults to .asc for format="ascii", and to .flt for format="binary"
扩展对输入/输出ESRI电网的：默认为.ascformat="ascii"，并.fltformat="binary"


参数：condensed.res
logical: return only results of the RSAGA geoprocessing function fun (condensed.res=TRUE), or include the results of the import and export operations, i.e. the calls to rsaga.esri.to.sgrd and rsaga.sgrd.to.esri? (see Value)
逻辑：只返回结果的RSAGAGEO处理功能fun（condensed.res=TRUE），包括进口和出口业务的结果，即的检测rsaga.esri.to.sgrd和rsaga.sgrd.to.esri？ （请参见值）


参数：clean.up
logical: delete intermediate SAGA grid files?
逻辑：删除中间SAGA的格档？


参数：intern
intern argument to be passed to rsaga.geoprocessor; see Value
的intern参数传递给rsaga.geoprocessor的，请参见值


参数：...
additional arguments for fun; NOTE: ESRI ASCII/float raster file names should NOT include the file extension (.asc, .flt); the file extension is defined by the esri.extension and format arguments!
额外的参数fun;注意：ESRI的ASCII /浮法栅格文件名不应该包括的文件扩展名（。递增。FLT）是定义的esri.extension，的文件扩展名和format参数！


Details

详细信息----------Details----------

ESRI ASCII/float raster file names should NOT include  the file extension (.asc, .flt); the file extension is defined
ESRI ASCII /浮点光栅文件名，不包括文件扩展名（。递增。FLT）的文件扩展名定义


值----------Value----------

The object returned depends on the condensed.res arguments and the intern argument passed to the rsaga.geoprocessor.
返回的对象取决于condensed.res参数和intern的rsaga.geoprocessor参数传递。

If condensed.res=TRUE and intern=FALSE, a single numerical  error code (0: success) is returned. If condensed.res=TRUE and intern=TRUE (default), a character vector with the module's console  output is returned (invisibly).
如果condensed.res=TRUE和intern=FALSE，一个单一的数字错误代码（0：成功），则返回。如果condensed.res=TRUE和intern=TRUE（默认）模块的控制台输出，字符向量，则返回（不可见）。

If condensed.res=FALSE the result is a list with components in.res, geoproc.res and out.res. Each of these components is either an error code (for intern=FALSE) or  (for intern=TRUE) a character vector with the console output of the input (rsaga.esri.to.sgrd), the geoprocessing (fun), and the output conversion (rsaga.sgrd.to.esri) step, respectively. For in.esri=FALSE or out.esri=FALSE, the corresponding component is NULL.
如果condensed.res=FALSE的结果是组件的列表in.res，geoproc.res和out.res。这些组件中的每一个都可以是一个错误代码（intern=FALSE）或（intern=TRUE）与控制台的输入输出（rsaga.esri.to.sgrd），空间处理（字符向量<X >），并输出转换（fun）步骤中，分别。对于rsaga.sgrd.to.esri或in.esri=FALSE，相应的组件是out.esri=FALSE。


注意----------Note----------

Note that the intermediate grids as well as the output grids may overwrite existing files with the same file names without prompting
需要注意的是中间网格，以及输出网格不提示的情况下，可能会覆盖现有的文件相同的文件名


（作者）----------Author(s)----------


Alexander Brenning



参见----------See Also----------

rsaga.esri.to.sgrd, rsaga.sgrd.to.esri,
rsaga.esri.to.sgrd，rsaga.sgrd.to.esri，


实例----------Examples----------


## Not run: [＃不运行：]
rsaga.esri.wrapper(rsaga.hillshade,in.dem="dem",out.grid="hshd",condensed.res=FALSE,intern=FALSE)
# if successful, returns list(in.res=0,geoproc.res=0,out.res=0),[如果成功，则返回列表（in.res = 0，geoproc.res = 0，out.res = 0），]
# and writes hshd.asc; intermediate files dem.sgrd, dem.hgrd, dem.sdat,[和写入hshd.asc的中间的的文件dem.sgrd，dem.hgrd，dem.sdat，]
# hshd.sgrd, hshd.hgrd, and hshd.sdat are deleted.[hshd.sgrd，hshd.hgrd，并hshd.sdat被删除。]
# hshd.asc is overwritten if it already existed.[hshd.asc覆盖，如果它已经存在。]

## End(Not run)[＃（不执行）]

转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。


注：
注1：为了方便大家学习，本文档为生物统计家园网机器人LoveR翻译而成，仅供个人R语言学习参考使用，生物统计家园保留版权。
注2：由于是机器人自动翻译，难免有不准确之处，使用时仔细对照中、英文内容进行反复理解，可以帮助R语言的学习。
注3：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。