自建 | gma库详细帮助

  目前，自建 | 地理与气象数据分析（geographic and meteorological data analysis）（gma）的说明与使用 已对gma的整体情况作了介绍、对目前包含的所有函数做了列举，并对其中的一些默认参数进行了说明。

  本文主要对gma每个函数进行详细的说明。当然，也可以通过help来获取对应函数的帮助。

1 index 指数运算（基于数组）

1.1 gma.index.EVI （增强植被指数）

EVI(Nir, Red, Blue)
	'''
	简介
	----------
	增强植被指数。

	参数
	----------
	Nir: 近红外
	
	Red: 红
	
	Blue:蓝
	
	'''

1.2 gma.index.NDBI （归一化建筑指数）

NDBI(Nir, Swir)
	'''
	简介
	----------
	归一化建筑指数。

	参数
	----------
	Nir: 近红外
	
	Swir: 短波红外
	
	'''

1.3 gma.index.NDWI （归一化水指数）

NDWI(Nir, Green)
	'''
	简介
	----------
	归一化水指数。

	参数
	----------
	Nir: 近红外
	
	Green: 绿
	
	'''

1.4 gma.index.NDVI （归一化植被指数）

NDVI(Nir, Red)
	'''
	简介
	----------
	归一化植被指数。

	参数
	----------
	Nir: 近红外
	
	Red: 红
	
	'''

1.5 gma.index.PM_ET0 （Penman-Monteith 法作物参考蒸散量）

 PM_ET0(Pres, Wind, MaxT, MinT, Rh, Shour, Lat, Day, Ele, AS=0.25, BS=0.5, A=0.23)
    '''
    简介
    ----------
    彭曼法（Penman Monteith）计算【日】【作物参考蒸散量（ET0）】。

    参数
    ----------
    Pres: number 或 array。日平均气压（hPa）。

    Wind: number 或 array。日平均10m风速（m/s）。

    MaxT: number 或 array。日最高气温（℃）。

    MaxT: number 或 array。日最低气温（℃）。

    Rh: number 或 array。日平均相对湿度（%）。

    Shour: number 或 array。日日照时数（hr）。

    Lat: number 或 array。纬度（°）。

    Day: int 或 array。以日序（儒略日）表示。1-365（平年）或366（闰年）。

    Ele: number 或 array。海拔高度（m）。

    **常量
    ----------
    AS = 0.25。

    BS = 0.5。

    A = 0.23。

    返回
    ----------
    类型: float 或 array。
    
    '''

1.6 gma.index.TVDI （温度植被干旱指数）

TVDI(VI, LST, ValidVIRange = [0.2, 0.8], ValidLSTRange = [200, 350], Delta = 0.01,
         VINoData = None, LSTNoData = None, OutNoData = -1):

    '''
    简介
    ----------
    【温度植被干旱指数】。

    参数
    ----------
    VI: array。植被指数。

    LST: array。陆表温度（K）。

    **可选参数
    ----------
    ValidVIRange = list。参与干湿边拟合植被指数的有效值范围，默认 0.2 ~ 0.8。

    ValidLSTRange = list。参与干湿边拟合陆表温度的有效值范围，默认 200 ~ 350（K）。

    Delta = number。干湿边拟合过程中植被指数采样的样本间距。默认为 0.01。

    VINoData = number。植被指数数据中的无效值。默认不设置（None）。

    LSTNoData = number。陆表温度数据中的无效值。默认不设置（None）。

    OutNoData = number。TVDI结果中的无效值，默认 VINoData， VINoData 的区域都将被改为 OutNoData。默认值为 -1。

    返回
    ----------
    返回值（类型）: TVDI（array）, 参与拟合的VI（array）, 参与拟合的湿边LST（array）, 参与拟合的干边LST（array）,

                    [湿边方程系数, 湿边方程常数]（list）, [干边方程系数, 干边方程常数]（list）。

    '''

2 math 数学运算

2.1 gma.math._DFToNumeric （强制转换为数字）

_DFToNumeric(DataFrame)
    
	'''
	简介
	----------
	强制转换 DataFrame 中非数字字符串为 NAN。

	参数
	----------
	DataFrame: pandas数据帧。

	'''

2.2 gma.math.FillNoData（填充缺失值）

FillNoData(Data, FillValue = None, Method = 'linear', **kwargs)
    '''
    简介
    ----------
    对缺失值或异常值值进行【插补】。

    参数
    ----------
    Data: list, tuple, Series, DataFrame。需要插补的数据。

    **可选参数
    ----------
    FillValue = number 或 list。标记需要进行插补的缺失值。可为数字（number）或数字列表（list）。默认不标记缺失值（None）。

        注：1.当 FillValue 为列表时，列表内所有值都将被插补。2.数据内原有的NAN、INF以及不能被转化为数字的字符串等异常值也将被插补。

    Method = str。插补方法。默认线性插值（'linear'）。其他的插补方法还包括：

        'time'（时间）, 'index'（索引）, 'values'（序列值）, 'pad'（前向填充）, 'nearest'（最邻近）, 
        'zero'（零值）, 'slinear'（滑动线性）, 'quadratic'（2次插值）, 'cubic'（3次插值）, 'spline'（样条函数）,
        'barycentric'（重心）, 'polynomial'（分段多项式）, 'from_derivatives'（衍生）, 'krogh'（克罗格）, 
        'piecewise_polynomial'（分段多项式）,'pchip'（分段三次Hermite多项式插值）, 'akima'（akima光滑插值）, 
        'cubicspline'（3次样条）。

    **kwargs。传递给插值函数的其他参数。例如： Method 为 'polynomial' 或 'spline' 需要设置 order(阶数)，默认阶数为 3。

    返回
    ----------
    类型: Series，DataFrame 返回输入类型；list, tuple 返回 array。

    '''

2.3 gma.math.Smooth 类（数据平滑）

Smooth(Data, WindowSize, Times = 1)
    '''
    类简介
    ----------
    数据平滑（滤波）。

    初始化
    ----------
    Data: 1D data。需要平滑的 1 维数据。

    WindowSize: int。平滑窗口大小。必须为正奇数。

    Times = int。平滑次数。默认平滑 1 次。

    '''

2.3.1 gma.math.Smooth.SavitzkyGolay（SavitzkyGolay平滑）

Smooth(Data, WindowSize, Times = 1).SavitzkyGolay(Polyorder = 2, Delta = 1, Mode = 'interp')
	'''
	简介
	----------
	【Savitzky-Golay】平滑。

	**可选参数
	----------
	Polyorder = int。平滑多项式阶数。默认为 2 。

	Delta = float。将应用过滤器的样本间距。默认为 1。

	Mode = str。边缘数据处理方法。默认为 插补（'interp'）。

		其他方法：'mirror', 'nearest', 'wrap'。

	返回
	----------
	类型: Array。
	
	'''

2.3.2 gma.math.Smooth.MovingAverage（滑动平均）

Smooth(Data, WindowSize, Times = 1).MovingAverage(Mode = 'nearest')
	'''
	简介
	----------
	【滑动平均】平滑。

	**可选参数
	----------
	Mode = str。边缘数据处理方法。默认为 采用最近数据填充（'nearest'）。

		其他方法：'mirror', 'interp', 'wrap'。

	返回
	----------
	类型: Array。

	'''

2.4 gma.math.Evaluation 类（数据评估）

Evaluation(Measure, Simulation)
    '''
    类简介
    ----------
    数据评估。

    初始化
    ----------
    Measure: list。实测数据。

    Simulation: list。模拟数据。

    '''

2.4.1 gma.math.Evaluation.RMSE（均方根误差）

Evaluation(Measure, Simulation).RMSE()
    '''均方根误差'''

2.4.2 gma.math.Evaluation.NRMSE（归一化均方根误差）

Evaluation(Measure, Simulation).NRMSE()
    '''归一化均方根误差'''

2.4.3 gma.math.Evaluation.D（D指标）

Evaluation(Measure, Simulation).D()
    '''D指标'''

2.4.4 gma.math.Evaluation.r（相关系数和显著性水平）

Evaluation(Measure, Simulation).r()
    '''相关系数和显著性水平'''

2.4.5 gma.math.Evaluation.R2（决定系数）

Evaluation(Measure, Simulation).R2()
    '''决定系数'''

2.4.6 gma.math.Evaluation.MaxAE（最大绝对误差）

Evaluation(Measure, Simulation).MaxAE()
    '''最大绝对误差'''

2.4.7 gma.math.Evaluation.Select（选择方法）

Evaluation(Measure, Simulation).Select(Method = 'ALL'):
	'''
	按选择的方法返回结果。
	----------
	
	**可选参数
	----------
	Method = str, list 或 tuple。默认为输出所有方法的结果（'ALL'）。也可为：
	
		list 或 tuple: 列表内所有方法（ Evaluation 已经定义过算法）的结果，未定义的方法将被忽略。
		
		其他 str: 单个评价方法（Evaluation 已经定义过算法，例如'RMSE'）的结果。
		
		若设置的方法或格式不存在，则选择 RMSE 结果输出。

	'''

2.4.8 gma.math.Evaluation.Methods（记录方法）

Evaluation(Measure, Simulation).Methods():
	'''记录Evaluation类中所有的评估方法。'''

3 osf 系统交互

3.1 gma.osf.GetPath（获取路径）

GetPath(Path, Search = 'FILE', EXT = None, String = None)  
    '''
    简介
    ----------
    获取目标 【路径或路径集合】 下满足条件的所有 【文件夹和文件路径】。

    参数
    ----------
    Path: str 或 list。路径或路径集合。可以是：
        
        1.路径（str）。 例：'C:/SP'。
        
        2.路径集合（list）。 例： ['C:/SD', 'C:/SP']
        
	**可选参数
	---------- 
    Search = 'FILE' 或其他类型。要查找路径的类型，默认为查找文件（'FILE'）。 
        
        其他类型包括'DIR'(文件夹)，'ALL'(文件夹和文件)。如果设置的值不为以上所有类型，则认为是 'FILE' 。
        
    EXT = None 或 str、list。查找文件的扩展名或扩展名列表。只有在 SearchPath = 'FILE' 时, 此参数才生效。默认查找所有文件（None）。

    String = None 或 str、list。查找的文件路径中包含的 字符串 。  
    
    返回
    ----------
    类型：list。满足条件的所有 【文件夹和文件路径】集合。重复的路径只会保留一个。

    '''  

3.2 gma.osf.Zip（压缩）

Zip(Path, ZipFilePath, Mode = 'w')
    '''
    简介
    ----------
    将【目标路径】下所有文件【压缩】为'.zip'格式。

    参数
    ----------
    Path: str。压缩目标路径。

    ZipFilePath: str。压缩结果文件路径。扩展名为'.zip'。
 
    **可选参数
    ---------- 
        
    Mode = 'w' 或 'a' 。压缩文件处理方法。

        'w': 如果目标'.zip'存在，则目标文件将会被替换。
           
        'a': 如果目标'.zip'存在，则目标文件内容会被更新。

    '''

3.3 gma.osf.UnZip（压缩）

UnZip(ZipFilePath, OutPath)
    '''
    简介
    ----------
    【解压缩】.zip文件。

    参数
    ----------
    ZipFilePath: str。需要解压缩的'.zip'文件路径。

    OutPath: str。解压后存储文件的路径。

    '''

3.4 gma.osf.DateSeries（日期序列）

DateSeries(StartDate, EndDate, DateDelta, Format = '%Y%m%d')
    '''
    简介
    ----------
    创建一个【日期序列】列表。

    参数
    ----------
    StartDate: str。初始日期。例如'20200101'。
        
    EndDate: str。结束日期。例如'20201231'。      

    DateDelta: int。间隔日期(天)。
    
    **可选参数
    ----------
    Format = '%Y%m%d'。日期序列格式。默认为 %Y%m%d'（年月日）。

    '''

3.5 gma.osf.Rename 类（重命名）

Rename(FilePath)
    '''
    类简介
    ----------
    【重命名】文件或文件夹。

    初始化
    ----------
    FilePath: str。要重命名的文件或文件夹路径。   

    '''   

3.5.1 gma.osf.Rename.Modify（修改）

Rename(FilePath).Modify(NewName):
	'''
	简介
	----------
	将原文件或文件夹名【修改】为 NewName。
    
	参数
	----------
	NewName: str。新文件或文件夹名。

	'''

3.5.2 gma.osf.Rename.Replace（替换）

Rename(FilePath).Replace(OldString, NewString):
	'''
	简介
	----------
	将原文件或文件夹名中的 OldString【替换】为 NewString 后作为新文件或文件夹名。

	参数
	----------
	OldString: str。需要替换的字符串。

	NewString: str。替换后的新字符串。

	'''

3.5.3 gma.osf.Rename.Intercept（截取）

Rename(FilePath).Intercept(Start, Length):
	'''
	简介
	----------
	从原文件或文件夹名中第 Start 个字符开始【截取】 Length 个字符作为新文件或文件夹名。

	注：此方法自动忽略扩展名。即：不论 Start, Length设置为多少，扩展名都将被保留。

	参数
	----------
	Start: int。截取字符串的位置。

	Length: int。截取字符串的长度。

	'''

4 rasp 栅格处理

4.1 gma.rasp.BandSynthesis（文件合并）

BandSynthesis(InFiles, OutFile, OutFormat = 'GTiff')
    '''
    简介
    ----------
    波段合成。将单波段文件合成多波段文件。

    参数
    ----------
    InFiles: str 或 list。波段合成路径的结合。

    OutFile: str。输出栅格路径。

    **可选参数
    ----------
    OutFormat = str。输出文件格式，默认为 'GTiff'。其他格式详见 ToOtherFormat 函数。

    '''

4.2 gma.rasp.BandDecomposition（波段分解）

BandDecomposition(InFile, OutPath, Bands = None, OutFormat = 'GTiff')
    '''
    简介
    ----------
    波段分解。将多波段文件拆分（或提取）为单波段文件。

    参数
    ----------
    InFile: str。输入栅格路径。

    OutPath: str。输出文件夹路径。

    **可选参数
    ----------
    Bands = None 或 list。需要导出文件的波段，编号从 1 开始。默认全部导出（None）。

    OutFormat = str。输出文件格式，默认为 'GTiff'。其他格式详见 ToOtherFormat 函数。

    '''

4.3 gma.rasp.Clip（裁剪）

Clip(InFile, OutFile, CutLineFile, InNoData = None, OutNoData = None, MaskBoundary = True, OutFormat = 'GTiff')
    '''
    简介
    ----------
    按矢量边界裁剪栅格 。

    参数
    ----------
    InFile: str。输入栅格路径。

    OutFile: str。输出栅格路径。

    CutLineFile: str。裁剪矢量文件路径。

    **可选参数
    ----------
    InNoData = number。输入栅格的无效值。默认不指定（None）无效值。

    OutNoData = number。输出栅格的无效值。默认不指定（None）无效值。

    MaskBoundary = bool。是否掩膜边界外数据。默认掩膜（True）。

    OutFormat = str。输出文件格式，默认为 'GTiff'。其他格式详见 ToOtherFormat 函数。

    '''

4.4 gma.rasp.ToOtherFormat（格式转换）

ToOtherFormat(InFile, OutFile, OutFormat = 'GTiff')
    '''
    简介
    ----------
    一种栅格格式转换为另一种栅格格式。

    参数
    ----------
    InFile: str。输入栅格路径。

    OutFile: str。输出栅格路径。

    **可选参数
    ----------
    OutFarmat = str。输出数据驱动。默认为'GTiff'。

        其他支持的格式:'AAIGrid', 'BT', 'CALS', 'COG', 'DTED', 'EHdr', 'ENVI', 'ERS', 
                        'EXR', 'FIT', 'GIF', 'GPKG', 'GRIB', 'GS7BG', 'GSAG', 'GSBG', 
                        'GTiff', 'HDF4Image','HF2', 'HFA', 'ISCE', 'ISIS2', 'ISIS3', 
                        'JP2OpenJPEG', 'JPEG', 'LAN', 'MBTiles', 'XPM', 'XYZ', 'netCDF',
                        'MFF2', 'MRF', 'NITF', 'PAux', 'PCIDSK', 'PCRaster', 'PNG', 
                        'RST', 'Rasterlite', 'SIGDEM', 'USGSDEM', 'VICAR', 'VRT'。

        注意：目前，除部分自带压缩的驱动，仅对 GTiff, HFA, netCDF 进行了完整的压缩支持。
        多维数据（netCDF, HDF4Image等）转出请使用 MultiSDSToTif。

    '''

4.5 gma.rasp.Mosaic（栅格镶嵌）

Mosaic(InFiles, OutFile, InNoData = None, OutNoData = None, OutFormat = 'GTiff')
    '''
    简介
    ----------
    栅格【镶嵌】。将多个栅格数据集合并到一个新的栅格数据集中。

    参数
    ----------
    InFiles: list。镶嵌影像路径集合。

    OutFile: str。输出文件路径。

    **可选参数
    ----------
    InNoData = number 或 list。输入栅格的无效值。默认自动搜索每个输入栅格的无效值（None）。

    OutNoData = number。输出栅格的无效值。默认根据输入栅格自动设置（None）。

    OutFarmat = str。输出数据格式。默认为'GTiff'。其他格式详见 ToOtherFormat 函数。

    '''

4.6 gma.rasp.Resample（重采样）

Resample(InFile, OutFile, Resolution, Method = 2, InNoData = None, OutNoData = None, OutFormat = 'GTiff')
    '''
    简介
    ----------
    栅格【重采样】。更改栅格数据的空间分辨率。

    参数
    ----------
    InFile: str。输入栅格路径。

    OutFile: str。输出栅格路径。

    Resolution: number。重采样分辨率。

    **可选参数
    ----------
    Method = int 或 str。重采样方法。默认为 'Cubic'法（2）。

        支持的重采样方法包括：0: Nearest Neighbour, 1: Bilinear, 2: Cubic, 3: CubicSpline, 4: Lanczos,
        5: Average, 6: RMS, 7: Mode。

    InNoData = number。输入栅格的无效值。默认自动搜索输入栅格的无效值（None）。

    OutNoData = number。输出栅格的无效值。默认与 InNoData 的无效值相同（None）。

    OutFarmat = str。输出数据格式。默认为'GTiff'。其他格式详见 ToOtherFormat 函数。

    '''

4.7 gma.rasp.Reproject（重投影）

Reproject(InFile, OutFile, OutProjection, InNoData = None, OutNoData = None, OutFormat = 'GTiff')
    '''
    简介
    ----------
    栅格【重投影】。将空间数据从一种坐标系投影到另一种坐标系。

    参数
    ----------
    InFile: str。输入栅格路径。

    OutFile: str。输出栅格路径。

    OutProjection: str。输出栅格坐标系（EPSG 或 wkb 格式）。

    **可选参数
    ----------
    InNoData = number。输入栅格的无效值。默认自动搜索输入栅格的无效值（None）。

    OutNoData = number。输出栅格的无效值。默认与 InNoData 的无效值相同（None）。

    OutFormat = str。输出文件格式，默认为 'GTiff'。其他格式详见 ToOtherFormat 函数。

    '''

4.8 gma.rasp.ChangeDataType（数据类型转换）

ChangeDataType(InFile, OutFile, DataType, BitDepth = None, OutFormat = 'GTiff')
    '''
    简介
    ----------
    【数据类型转换】。转换栅格数据的数据类型。

    参数
    ----------
    InFiles: str 输入栅格路径。

    OutFile: str。输出栅格路径。

    DataType: int。输出栅格数据类型的代码。

        数据类型包括：
            '未知类型': 0, '8位无符号整型': 1, '16位无符号整型': 2, '16位整型': 3, '32位无符号整型': 4,
            '32位整型': 5, '32位浮点': 6, '64位浮点': 7, '16位复整型': 8, '32位复整型': 9,
            '32位复浮点型': 10, '64位复浮点型': 11。

    **可选参数
    ----------
    BitDepth = int。输出栅格位深。仅为 'GTiff' 文件提供位深支持。

    OutFormat = str。输出栅格格式，默认为 'GTiff'。其他格式详见 ToOtherFormat 函数。

    '''

4.9 gma.rasp.MultiSDSToTif（多维数据转GTiff）

MultiSDSToTif(InFile, OutPath, Variable = None, Dimension = None, Projection = 'WGS84')
    '''
    简介
    ----------
    多维数据转GTiff。将含有子数据集的多维数据提取为GTiff。

    参数
    ----------
    InFile: str。输入栅格路径。

    OutPath: str。输出文件夹路径。

    **可选参数
    ----------
    Variable = list。要转换变量的 字符串 列表。默认转换所有变量（None）。

    Dimension = list。要转换维度的 整型数 列表。默认转换所有维度（None）。

    Projection = str。输入数据的 X,Y 坐标系。默认为 'WGS84'。

    '''

4.10 gma.rasp.ToVector（栅格转矢量）

ToVector(InFile, OutVector, FieldName = 'Value', TranBand = 1, OutFormat = 'ESRI Shapefile')
    '''
    简介
    ----------
    【栅格转矢量】。将栅格数据转换为矢量数据。

    参数
    ----------
    InFile: str。输入栅格路径。

    OutVector: str。输出矢量路径

    **可选参数
    ----------
    FieldName = str。输出矢量字段的名称。默认为 'Value'。

    TranBand = int。要转换的波段。默认转换第一个波段（1）。

    OutFormat = str。输出文件格式，默认为 'ESRI Shapefile'。其他格式详见 gma.vesp.ToOtherFormat 函数。

    描述
    ----------
    不需要设置类型（点、线、面等），默认根据栅格数据自动确定类型。

    '''

4.11 gma.rasp.WriteRaster（写出栅格）

WriteRaster(OutFile, DataArray, Projection = None, Transform = None, Format = 'GTiff', DataType = 6, NoData = None)
    '''
    简介
    ----------
    【写出栅格】。将数组保存为栅格文件。

    参数
    ----------
    OutFile: str。输出栅格路径。

    DataArray: array。输入数组。

    **可选参数
    ----------
    Projection = str。输出栅格坐标系。默认不指定坐标系（None）。

    Transform = tuple。输出栅格的仿射变换。默认不指定仿射变换（None）。

    Format = str。输出文件格式。默认为 'GTiff'。其他格式详见 ToOtherFormat 函数。

    DataType = int。输出栅格数据类型。默认为 float32（6）。

        其他的数据类型还包括：
            '未知类型': 0, '8位无符号整型': 1, '16位无符号整型': 2, '16位整型': 3, '32位无符号整型': 4,
            '32位整型': 5, '32位浮点': 6, '64位浮点': 7, '16位复整型': 8, '32位复整型': 9,
            '32位复浮点型': 10, '64位复浮点型': 11。

    NoData = int。输出栅格的无效值。默认不设置无效值（None）。

    '''

4.12 gma.rasp.GenerateOVR（构建栅格金字塔）

GenerateOVR(InFile, Force = False)
    '''
    简介
    ----------
    【构建栅格金字塔】。为GTiff文件构造.ovr栅格金字塔，或为其他类型的栅格数据强制构造.ovr金字塔 。

    参数
    ----------
    InFile: str。栅格文件路径。

    **可选参数
    ----------
    Force = bool。是否为所有类型的文件添加 .ovr 金字塔。默认（False）只为 GTiff 驱动的栅格添加金字塔。

    '''

4.13 gma.rasp.OrthophotoCorrection（正射校正）

OrthophotoCorrection(InFile, OutFile, DEM = None, Resample = 0, OutFormat = 'GTiff')
    '''
    参数
    ----------
    正射校正。根据有理多项式系数（RPC）对影像进行正射校正。

    参数
    ----------
    InFile: str。栅格文件路径。

        输入栅格必须有内部 RPC（有理多项式系数）元数据或同路径下描述 RPC 的外部 .rpb 或 _RPC.txt 文件。

    OutFile: str。输出栅格路径。

    **可选参数
    ----------
    DEM = number 或 str。用于 RPC 计算的固定高度 或 DEM 文件的名称。默认不设置此参数（None）。

    Resample = int 或 str。重采样方法。默认为 'Nearest Neighbour'法（0）。

        支持的重采样方法包括：0: Nearest Neighbour, 1: Bilinear, 2: Cubic, 3: CubicSpline, 4: Lanczos,
        5: Average, 6: RMS, Mode。

    OutFormat = str。输出文件格式，默认为 'GTiff'。其他格式详见 ToOtherFormat 函数。

    '''

4.14 gma.rasp.Deformation（流程化处理）

Deformation(InFiles, OutFile, CutLineFile = None,
            ResampleMethod = 0, Resolution = None,
            OutProjection = 'WGS84',
            InNoData = None, OutNoData = None,
            OutFormat = 'GTiff')

    '''
    简介
    ----------
    【流程化处理】。完成镶嵌-裁剪-重采样-重投影-格式转换等其中一个或多个功能。

    参数
    ----------
    InFiles: str 或 list。输入栅格路径。如果为列表，则列表内所有的栅格将被【镶嵌】（Mosaic）。

    OutFile: str。输出栅格路径。

    **可选参数
    ----------
    CutLineFile = str。【裁剪】。如果有，将用此 矢量文件 裁剪输出栅格。

    Resolution = number。【重采样分辨率】。设置重采样分辨率。

    ResampleMethod = int 或 str。【重采样】方法。默认为 'Nearest Neighbour'法（0）。

        支持的重采样方法包括：0: Nearest Neighbour, 1: Bilinear, 2: Cubic, 3: CubicSpline, 4: Lanczos,
        5: Average, 6: RMS, Mode。

    OutProjection = str。【重投影】栅格坐标系名称。输出栅格坐标系（EPSG 、 wkb 或 坐标名称）。

    InNoData = number。【输入无效值】。输入栅格的无效值。

    OutNoData = number。【输出无效值】。输出栅格的无效值。

    OutFormat = str。【格式转换】。输出栅格格式，默认为 'GTiff'。其他格式详见 ToOtherFormat 函数。

    '''

4.15 gma.rasp.Fusion 类（影像融合）

Fusion(InPanchromatic, InMultispectral, OutFile)
    '''
    类简介
    ----------
    【影像融合】。

    初始化
    ----------
    InPanchromatic: str。输入全色影像路径。

    Multispectral: str。输入多光谱影像数据。

    OutFile: str。输出栅格路径。

    '''

4.15.1 gma.rasp.Fusion.Pansharpen（Pansharpen融合）

Fusion(InPanchromatic, InMultispectral, OutFile).Pansharpen(ResampleMethod = None, 
				SpatAdjust = None, Bands = None, NumThreads = None, BitDepth = None, 
				InNoData = None, OutFormat = 'GTiff'):
	'''
	简介
	----------
	【Pansharp】融合。对全色影像和多光谱影像基于Pansharpen方法进行融合。

	**可选参数
	----------
	ResampleMethod: str。重采样方法。默认为 'Cubic'（None）。

		重采样方法包括：'Nearest', 'Bilinear', 'Cubic', 'CubicSpline', 'Lanczos', 'Average'。

	SpatAdjust: str。空间坐标系调整。默认为'Union'（None）。

		调整方法包括：'Union', 'Intersection', 'None', 'NoneWithoutWarning'。

	Bands = list。融合多光谱波段列表。例如[1,2...]，波段计数从 1 开始。默认融合输入多光谱数据的所有波段（None）。

		***每个波段的权重值（'Weights'）相同，根据 Bands 数量确定，为 1 / len(Bands)。

	NumThreads = int 或 'ALL_CPUS'。融合使用计算机 CPU 的线程数。默认不使用多线程（None）。

	BitDepth = int。生成数据的位深。默认不设置位深（None）, 但如果全色波段存在 NBITS 值，则使用该值作为位深。

	InNoData = number。全色和多光谱影像的无效值（所有输入数据的无效值应当相同，否则该设置无效），输出文件的无效值也为该值。默认不设置无效值（None）。

	OutFormat = str。输出文件格式，默认为 'GTiff'。其他格式详见 ToOtherFormat 函数。

	'''

4.16 gma.rasp.AddColorTable（添加色彩映射表）

AddColorTable(InFile, TemplateFile = None, ColorTable = None):
    '''
    简介
    ----------
    【添加色彩映射表】。为栅格数据添加色彩映射。

    参数
    ----------
    InFile: str 输入栅格路径。

    **可选参数
    ----------
    TemplateFile = str。模板栅格路径。若设置模板栅格，则将模板栅格的色彩映射表添加到输入栅格。

    ColorTable = dict。色彩映射表。格式为 {值: (R,G,B,A)}。默认不设置（None）。

        例如：ColorTable = {10:(200,50,100,255), 20:(200,50,100,255)}。

        若设置了 ColorTable，则：

        1、若 TemplateFile 未设置（None），则用 ColorTable 更新输入栅格的色彩映射表。

        2、若设置了 TemplateFile，则以 TemplateFile 色彩映射表为基础，并用 ColorTable 更新该基础色彩映射表，
        然后将更新后的色彩映射表添加到输入栅格中。

    '''

5 vesp 矢量处理

5.1 gma.vesp.Split（矢量文件分解）

Split(InFile, OutPath, OutNameField = None, Separator = None, OutFormat = 'ESRI Shapefile')
    '''
    简介
    ----------
    【矢量文件分解】。将矢量文件中的每个要素【拆分】为单个矢量文件。

    参数
    ----------
    InFile: str。输入矢量文件路径。

    OutPath: str。输出文件夹路径

    **可选参数
    ----------
    OutNameField = str 或 list。标记输出文件名的字段名称或多个字段名称组成的列表。
        默认(None)按照 <0.shp, 1.shp, ...>的方式输出。

    Separator = str。多字段连接方式。如果 OutNameField 定义了一个多字段名称的列表，
        则 Separator 为输出文件名中不同字段的连接方式，默认（None）不以任何进行字段连接。例如：

            OutNameField = ['City', 'Country'], Separator = '_'

            > > > City_County.shp

    OutFormat = str。输出文件格式，默认为 'ESRI Shapefile'。其他格式详见 ToOtherFormat 函数。

    '''

5.2 gma.vesp.Check（检查）

Check(InFile)
    '''
    简介
    ----------
    【检查】文件每个要素的有效性。

    参数
    ----------
    InFile: str。输入矢量文件路径。

    返回
    ----------
    如果输入矢量通过检查，则返回 'Pass'。否则返回无效信息(tuple)。

    无效信息组成：

        Invalid number: 无效要素的数量。

        Invalid layer&FID: 无效图层和图层内无效要素的FID。

    '''

5.3 gma.vesp.ToRaster（矢量转栅格）

ToRaster(InFile, OutFile, Resolution, Attribute = None, OutNoData = None, OutFormat = 'GTiff')
    '''
    简介
    ----------
    【矢量转栅格】。将矢量图层转换为栅格文件。

    参数
    ----------
    InFile: str。输入矢量文件路径。

    OutFile: str。输出栅格文件路径。

    Resolution: int。输出栅格的分辨率。

    **可选参数
    ----------
    Attribute = None。进行转换的矢量数据的字段。如果未设置（None），则生成由 0 和 1 组成的栅格，0 是 nodata 值。

    OutNoData = None。输出栅格的值无效。默认不设置（None）无效值。如果 Attribute 不为 None 且 OutNoData 未设置，则 OutNoData 修改为无穷大（inf）。

    OutFormat = str。输出文件格式，默认为 'GTiff'。其他格式详见 gma.rasp.ToOtherFormat 函数。
    '''

5.4 gma.vesp.Clip（裁剪）

Clip(InFile, MethodFile, OutFile, OutFormat = 'ESRI Shapefile')
    '''
    简介
    ----------
    矢量【裁剪】。矢量裁剪矢量。

    参数
    ----------
    InFile: str。输入矢量文件路径。

    MethodFile: str。裁剪矢量范围文件路径。

    OutFile: str。输出矢量文件路径。

    **可选参数
    ----------
    OutFormat = str。输出文件格式，默认为 'ESRI Shapefile'。其他格式详见 ToOtherFormat 函数。

    '''

5.5 gma.vesp.Erase（擦除）

Erase(InFile, MethodFile, OutFile, OutFormat = 'ESRI Shapefile')
    '''
    简介
    ----------
    【擦除】。从第一个矢量中去除与第二个矢量交叉的部分。

    参数
    ----------
    InFile: str。输入矢量文件路径。

    MethodFile: str。擦除矢量范围文件路径。

    OutFile: str。输出矢量文件路径。

    **可选参数
    ----------
    OutFormat = str。输出文件格式，默认为 'ESRI Shapefile'。其他格式详见 ToOtherFormat 函数。

    '''

5.6 gma.vesp.Intersection（交集）

Intersection(InFile, MethodFile, OutFile, OutFormat = 'ESRI Shapefile')
    '''
    简介
    ----------
    矢量取【交集】。取两个矢量的交集。

    参数
    ----------
    InFile: str。第一个矢量文件路径。

    MethodFile: str。第二个矢量文件路径。

    OutFile: str。输出矢量文件路径。

    **可选参数
    ----------
    OutFormat = str。输出文件格式，默认为 'ESRI Shapefile'。其他格式详见 ToOtherFormat 函数。

    '''

5.7 gma.vesp.Union（融合）

Union(InFile, MethodFile, OutFile, OutFormat = 'ESRI Shapefile')
    '''
    简介
    ----------
    矢量【合并】。取两个矢量的并集。

    参数
    ----------
    InFile: str。输入矢量文件路径。

    MethodFile: str。合并矢量文件路径。

    OutFile: str。输出矢量文件路径。

    **可选参数
    ----------
    OutFormat = str。输出文件格式，默认为 'ESRI Shapefile'。其他格式详见 ToOtherFormat 函数。

    '''

5.8 gma.vesp.Update（更新）

Update(InFile, MethodFile, OutFile, OutFormat = 'ESRI Shapefile')
    '''
    简介
    ----------
    矢量【更新】。用一个矢量更新另一个矢量。

    参数
    ----------
    InFile: str。输入矢量文件路径。

    MethodFile: str。更新矢量文件路径。

    OutFile: str。输出矢量文件路径。

    **可选参数
    ----------
    OutFormat = str。输出文件格式，默认为 'ESRI Shapefile'。其他格式详见 ToOtherFormat 函数。

    '''

5.9 gma.vesp.ToOtherFormat（格式转换）

ToOtherFormat(InFile, OutFile, OutFormat = 'ESRI Shapefile')
    '''
    简介
    ----------
    矢量【格式转换】。一种矢量格式转换为另一种矢量格式。

    参数
    ----------
    InFile: str。输入矢量文件路径。

    OutFile: str。输出矢量文件路径。

    **可选参数
    ----------
    OutFormat = str。输出文件格式，默认为 'ESRI Shapefile'。

        其他支持的格式: 'ESRI Shapefile', 'PCIDSK', 'PDS4', 'PDF', 
        			'MBTiles', 'MapInfo File', 'Memory', 'CSV', 'GML', 
        			'LIBKML', 'KML', 'GeoJSON', 'OGR_GMT', 'GPKG', 'SQLite', 
        			'WAsP', 'FlatGeobuf', 'Geoconcept', 'GeoRSS', 'ODS', 
        			'XLSX','JML', 'VDV', 'MVT', 'MapML'。

    '''