FieldMap

Краткая информация

Объект FieldMap задает определение поля и список входных полей из набора таблиц или классов пространственных объектов.

Обсуждение

Свойства объекта FieldMap включают начальное и конечное положения входного текстового значения, поэтому выходное значение можно создать с использованием лишь части входного значения. Если объект FieldMap содержит несколько входных полей из одной таблицы или класса объектов, то значения каждой записи объединяются с помощью свойства mergeRule. Этот способ удобен для объединения таких значений, как название улицы из одного поля и тип улицы из другого поля, например: Eureka и Street. Свойство joinDelimiter объекта FieldMap используется, если Join задано в качестве значения mergeRule. Любой набор символов, например, пробел, можно использовать в качестве разделителя. В примере, приведенном выше, будет создано значение Eureka Street.

Объект FieldMappings представляет собой набор объектов FieldMap и используется как значение параметра для инструментов, выполняющих сопоставление полей; к таким инструментам относится, в частности, инструмент Слияние. Проще всего с этими объектами работать следующим образом — сначала создать объект FieldMappings, а затем инициализировать его объекты FieldMap посредством добавления входных классов объектов или таблиц, которые необходимо с ним соединить. Когда будут заданы все входные данные, объект FieldMappings будет содержать один объект FieldMap или выходное поле для каждого уникального имени поля из всех входных данных. Вы можете изменять этот список, добавляя в него новые поля, изменяя свойства или содержание выходного поля или удаляя из него ненужные выходные поля.

Синтаксис

 FieldMap  ()

Свойства

Свойство	Описание	Тип данных
inputFieldCount (только чтение)	Число определенных входных полей.	Integer
joinDelimiter (чтение и запись)	Строковое значение, используемое для отделения входных значений от той же таблицы, если тип выходного поля – строка и для mergeRule задано значение Join.	String
mergeRule (чтение и запись)	Определяет способ объединения значений из двух и более полей одной и той же входной таблицы в единственное выходное значение. Допустимые значения: First—Используется первое входное значение. Last—Используется последнее входное значение. Join—Позволяет соединить значения с использованием разделителя (допустимо, только если тип выходного поля текстовый). Min—Используется минимальное входное значение (допустимо, только если тип выходного поля числовой). Max—Используется максимальное входное значение (допустимо, только если тип выходного поля числовой). Mean—Среднее значение рассчитывается на основе входных значений (допустимо, только если тип выходного поля числовой). Median—Медианное значение рассчитывается на основе входных значений (допустимо, только если тип выходного поля числовой). Sum—Сумма рассчитывается на основе входных значений (допустимо, только если тип выходного поля числовой). StDev—Среднеквадратическое отклонение рассчитывается на основе входных значений (допустимо, только если тип выходного поля числовой). Count—Количество значений будет включено в статистику. Пересчитываются все значения, исключая пустые значения.	String
outputField (чтение и запись)	Свойства выходного поля либо задаются, либо возвращаются в объекте Field.	Field

Обзор метода

Метод	Описание
addInputField (table_dataset, field_name, {start_position}, {end_position})	Добавляет входное поле в список полей.
findInputFieldIndex (table_dataset, field_name)	Находит входное поле в списке полей.
getEndTextPosition (index)	Возвращает позицию конца текста на карте полей.
getInputFieldName (index)	Возвращает имя входного поля из карты полей на основе позиции индекса поля.
getInputTableName (index)	Возвращает имя входной таблицы из карты полей на основе позиции индекса таблицы.
getStartTextPosition (index)	Возвращает начальную текстовую позицию объекта FieldMap.
removeAll ()	Удаляет все значения и создает пустой объект.
removeInputField (index)	Удаляет входное поле из объект FieldMap.
setEndTextPosition (index, end_position)	Устанавливает конечное текстовое положение для списка полей.
setStartTextPosition (index, start_position)	Устанавливает начальное текстовое положение из списка полей.

Методы

addInputField (table_dataset, field_name, {start_position}, {end_position})

Параметр	Описание	Тип данных
table_dataset	Таблица, которая будет добавлена к списку полей.	String
field_name	Имя входного поля.	String
start_position	Начальное положение входного текстового значения. (Значение по умолчанию — -1)	Integer
end_position	Конечное положение входного текстового значения. (Значение по умолчанию — -1)	Integer

findInputFieldIndex (table_dataset, field_name)

Параметр	Описание	Тип данных
table_dataset	Таблица, которая будет добавлена к списку полей.	String
field_name	Имя поля.	String

Возвращаемое значение

Тип данных	Описание
Integer	Значение индекса имени поля.

getEndTextPosition (index)

Параметр	Описание	Тип данных
index	The index position.	Integer

Возвращаемое значение

Тип данных	Описание
Integer	Позиция конца текста.

getInputFieldName (index)

Параметр	Описание	Тип данных
index	The index position.	Integer

Возвращаемое значение

Тип данных	Описание
String	Имя входного поля.

getInputTableName (index)

Параметр	Описание	Тип данных
index	The index position.	Integer

Возвращаемое значение

Тип данных	Описание
String	Имя входной таблицы.

getStartTextPosition (index)

Параметр	Описание	Тип данных
index	The index position.	Integer

Возвращаемое значение

Тип данных	Описание
Integer	Начальная текстовая позиция.

removeAll ()

removeInputField (index)

Параметр	Описание	Тип данных
index	The index position.	Integer

setEndTextPosition (index, end_position)

Параметр	Описание	Тип данных
index	Значение индекса.	Integer
end_position	Конечное положение входного текстового значения.	Integer

setStartTextPosition (index, start_position)

Параметр	Описание	Тип данных
index	Значение индекса.	Integer
start_position	Начальное положение входного текстового значения.	Integer

Пример кода

FieldMap пример

Объекты FieldMap часто используются, когда требуется соединить наборы со схожими данными в один полный набор. В этом примере класс пространственных объектов Trees (деревья) и шейп-файл Plants.shp (растения) соединяются в один класс пространственных объектов Vegetation (растительность). Атрибутами обоих исходных классов пространственных объектов являются: Type и Diameter. В результате соединения оба эти атрибута должны быть сохранены.

import arcpy

# Set the workspace
arcpy.env.workspace = 'c:/base'

in_features_1 = 'data.gdb/Trees'
in_features_2 = 'Plants.shp'
out_features = 'data.gdb/Vegetation'

# Create the required FieldMap and FieldMappings objects.
fm_type = arcpy.FieldMap()
fm_diam = arcpy.FieldMap()
fms = arcpy.FieldMappings()

# Get the field names of vegetation type and diameter for both
# original files.
tree_type = "Tree_Type"
plant_type = "Plant_Type"

tree_diam = "Tree_Diameter"
plant_diam = "Diameter"

# Add fields to their corresponding FieldMap objects.
fm_type.addInputField(in_features_1, tree_type)
fm_type.addInputField(in_features_2, plant_type)

fm_diam.addInputField(in_features_1, tree_diam)
fm_diam.addInputField(in_features_2, plant_diam)

# Set the output field properties for both FieldMap objects.
type_field = fm_type.outputField
type_field.name = 'Veg_Type'
fm_type.outputField = type_field

diam_field = fm_diam.outputField
diam_field.name = 'Veg_Diam'
fm_diam.outputField = diam_field

# Add the FieldMap objects to the FieldMappings object.
fms.addFieldMap(fm_type)
fms.addFieldMap(fm_diam)

# Merge the two feature classes.
arcpy.management.Merge([in_features_1, in_features_2], out_features, fms)

FieldMap пример 2

В этом примере показано использование объектов FieldMap для объединения полей с помощью инструмента ExportFeatures. В этом примере класс объектов содержит информацию о количестве дорожных происшествий в городе в расчете на один перекресток. Каждый год данные сохраняются в одном поле. Пользователю требуется найти среднее количество происшествий на каждом перекрестке, не изменяя имеющейся таблицы.

import arcpy

in_features = r'c:/base/data.gdb/AccidentData'
out_features = r'c:/base/data.gdb/AverageAccidents'

# Create the necessary FieldMap and FieldMappings objects.
fm = arcpy.FieldMap()
fm1 = arcpy.FieldMap()
fms = arcpy.FieldMappings()

# Each field with accident data begins with 'Yr'.
# The next step loops through each of the fields beginning with 'Yr',
# and adds them to the FieldMap object.
for field in arcpy.ListFields(in_features, 'Yr*'):
    fm.addInputField(in_features, field.name)

# Set the merge rule to find the mean value of all fields in the
# FieldMap object.
fm.mergeRule = 'Mean'

# Set the properties of the output field.
out_field = fm.outputField
out_field.name = 'AvgAccidents'
out_field.aliasName = 'AvgAccidents'
fm.outputField = out_field

# Add the intersection field to the second FieldMap object.
fm1.addInputField(in_features, "Intersection")

# Add both FieldMap objects to the FieldMappings object.
fms.addFieldMap(fm)
fms.addFieldMap(fm1)

# Create the output feature class using the FieldMappings object.
arcpy.conversion.ExportFeatures(in_features, out_features, field_mapping=fms)