language: cn
model_unique_abbr: ANNI
version: 1.0
identification:
  docker_image_name: anni:1.0
  model_name: 平均最近邻指数
  semantic: average nearest neighbor index
  description: 基于最近邻地理空间对象的平均距离度量空间对象聚集程度的描述性算法
  category_application: 描述型
  category_data:
  - 矢量点数据
  keywords:
  - 最近邻距离
parameter_info:
  parameters:
  - arg_name: input
    is_single_en_dash: false
    param_type: input_data
    name: 空间点数据
    description: 待分析空间点数据，csv格式
    data_type: csv
    data_semantic: analysis_data

  - arg_name: x_field
    is_single_en_dash: false
    param_type: param
    name: X坐标字段
    description: X坐标列在输入文件中的列名
    data_type: str
    data_semantic: x_field
    param_switches:
    - switch_arg_name: input
      switch_arg_value_regex: csv$
      switch_arg_value_examples: [data.csv]
    specification:
      default: x

  - arg_name: y_field
    is_single_en_dash: false
    param_type: param
    name: Y坐标字段
    description: Y坐标列在输入文件中的列名
    data_type: str
    data_semantic: y_field
    param_switches:
    - switch_arg_name: input
      switch_arg_value_regex: csv$
      switch_arg_value_examples: [data.csv]
    specification:
      default: y

  - arg_name: output
    is_single_en_dash: false
    param_type: output_data
    name: 分析结果
    description: 计算过程中得到的平均最近邻距离、预期平均距离、最近邻指数、z得分，保存为json格式
    data_type: json
    data_semantic: analysis_result
  groups:
  - group_id: ixy
    group_name: 输入数据XY列
    group_param_arg_names:
    - input
    - x_field
    - y_field
application:
  domain: 空间点对象聚集程度度量
  objective: 研究空间点的聚集程度
  dimension:
  - 二维
  spatial_reference:
  - 投影坐标系
  mechanism: 根据每个地理空间对象与其最近邻对象之间的平均距离计算最近邻指数。
operation:
  usage: "该算法需要两个参数,X坐标列名(x_field),Y坐标列名(y_field)。"
  exec_example:
  - docker run -v $(pwd):/data anni:1.0 -i /data/data.csv --x_field x --y_field y -o /data/analysis_result.json
technique:
  language:
  - Python
  os:
  - Linux
  - Windows
source:
  maintainer: Nanwei Cheng
  organization: Central South University
  contact: 2247486718@qq.com
  references:
  - "Clark, P.J., and F.C. Evans (1954) Distance to nearest neighbour as a measure of spatial relationships in populations. Ecology 35:445-453"
