def lines_to_vertex_points(
dataset_path: Union[Path, str],
*,
output_path: Union[Path, str],
dataset_where_sql: Optional[str] = None,
endpoints_only: bool = False,
log_level: int = logging.INFO,
) -> Counter:
"""Convert geometry from lines to points at every vertex.
Args:
dataset_path: Path to dataset.
output_path: Path to output dataset.
dataset_where_sql: SQL where-clause for dataset subselection.
endpoints_only: Output points should include line endpoints only if True.
log_level: Level to log the function at.
Returns:
Feature counts for original and output datasets.
"""
dataset_path = Path(dataset_path)
output_path = Path(output_path)
LOG.log(
log_level,
"Start: Convert lines in `%s` to vertex points in output `%s`.",
dataset_path,
output_path,
)
states = Counter()
states["in original dataset"] = dataset.feature_count(dataset_path)
view = DatasetView(dataset_path, dataset_where_sql=dataset_where_sql)
with view:
arcpy.management.FeatureVerticesToPoints(
in_features=view.name,
# ArcPy2.8.0: Convert Path to str.
out_feature_class=str(output_path),
point_location="ALL" if not endpoints_only else "BOTH_ENDS",
)
dataset.delete_field(output_path,
field_name="ORIG_FID",
log_level=logging.DEBUG)
states["in output"] = dataset.feature_count(output_path)
log_entity_states("features", states, logger=LOG, log_level=log_level)
LOG.log(log_level, "End: Convert.")
return states
def buffer(
dataset_path: Union[Path, str],
*,
dataset_where_sql: Optional[str] = None,
output_path: Union[Path, str],
distance: Union[float, int],
log_level: int = logging.INFO,
) -> Counter:
"""Buffer features a given distance & (optionally) dissolve on given fields.
Args:
dataset_path: Path to dataset.
dataset_where_sql: SQL where-clause for dataset subselection.
output_path: Path to output dataset.
distance: Distance to buffer from feature, in the units of the dataset.
log_level: Level to log the function at.
Returns:
Feature counts for original and output datasets.
"""
dataset_path = Path(dataset_path)
output_path = Path(output_path)
LOG.log(log_level, "Start: Buffer features in `%s`.", dataset_path)
states = Counter()
states["in original dataset"] = dataset.feature_count(dataset_path)
view = DatasetView(dataset_path, dataset_where_sql=dataset_where_sql)
with view:
# ArcPy2.8.0: Convert Path to str.
arcpy.analysis.Buffer(
in_features=view.name,
out_feature_class=str(output_path),
buffer_distance_or_field=distance,
)
for field_name in ["BUFF_DIST", "ORIG_FID"]:
dataset.delete_field(output_path, field_name=field_name)
states["in output"] = dataset.feature_count(output_path)
log_entity_states("features", states, logger=LOG, log_level=log_level)
LOG.log(log_level, "End: Buffer.")
return states
def union(
dataset_path: Union[Path, str],
*,
field_name: str,
union_path: Union[Path, str],
union_field_name: str,
dataset_where_sql: Optional[str] = None,
union_where_sql: Optional[str] = None,
output_path: Union[Path, str],
replacement_value: Optional[Any] = None,
log_level: int = logging.INFO,
) -> Counter:
"""Assign union attributes.
Notes:
Features with multiple union-features will be split.
Args:
dataset_path: Path to dataset.
field_name: Name of field to place union values.
union_path: Path to union-dataset.
union_field_name: Name of union-field.
dataset_where_sql: SQL where-clause for dataset subselection.
union_where_sql: SQL where-clause for the union-dataset subselection.
replacement_value: Value to replace a present union-field value with. If set to
None, no replacement will occur.
log_level: Level to log the function at.
Returns:
Feature counts for original and output datasets.
"""
dataset_path = Path(dataset_path)
union_path = Path(union_path)
LOG.log(
log_level,
"Start: Union-set attributes in `%s.%s` by features/values in `%s.%s`.",
dataset_path,
field_name,
union_path,
union_field_name,
)
states = Counter()
states["in original dataset"] = dataset.feature_count(dataset_path)
view = DatasetView(dataset_path, dataset_where_sql=dataset_where_sql)
# Do not include any field names - we do not want them added to output.
union_view = DatasetView(union_path,
field_names=[],
dataset_where_sql=union_where_sql)
with view, union_view:
# ArcPy2.8.0: Convert Path to str.
arcpy.analysis.Union(
in_features=[view.name, union_view.name],
out_feature_class=str(output_path),
join_attributes="ALL",
)
fid_field_names = [
name for name in Dataset(output_path).field_names
if name.startswith("FID_")
]
if replacement_value is not None:
attributes.update_by_value(
output_path,
field_name,
value=replacement_value,
dataset_where_sql=f"{fid_field_names[-1]} <> -1",
log_level=logging.DEBUG,
)
else:
attributes.update_by_joined_value(
output_path,
field_name,
key_field_names=[fid_field_names[-1]],
join_dataset_path=union_path,
join_field_name=union_field_name,
join_key_field_names=["OID@"],
dataset_where_sql=f"{fid_field_names[-1]} <> -1",
join_dataset_where_sql=union_where_sql,
log_level=logging.DEBUG,
)
attributes.update_by_value(
output_path,
field_name,
value=None,
dataset_where_sql=f"{fid_field_names[-1]} = -1",
log_level=logging.DEBUG,
)
for name in fid_field_names:
dataset.delete_field(output_path,
field_name=name,
log_level=logging.DEBUG)
states["in output"] = dataset.feature_count(output_path)
log_entity_states("features", states, logger=LOG, log_level=log_level)
LOG.log(log_level, "End: Union.")
return states
def spatial_join_by_center(
dataset_path: Union[Path, str],
*,
field_name: str,
join_path: Union[Path, str],
join_field_name: str,
dataset_where_sql: Optional[str] = None,
join_where_sql: Optional[str] = None,
output_path: Union[Path, str],
replacement_value: Optional[Any] = None,
log_level: int = logging.INFO,
) -> Counter:
"""Spatially-join attributes by their center.
Notes:
Features joined with multiple join-features will be duplicated.
Args:
dataset_path: Path to dataset.
field_name: Name of field to place joined values.
join_path: Path to join-dataset.
join_field_name: Name of join-field.
dataset_where_sql: SQL where-clause for dataset subselection.
join_where_sql: SQL where-clause for the join-dataset subselection.
output_path: Path to output dataset.
replacement_value: Value to replace a present join-field value with. If set to
None, no replacement will occur.
log_level: Level to log the function at.
Returns:
Feature counts for original and output datasets.
"""
dataset_path = Path(dataset_path)
join_path = Path(join_path)
LOG.log(
log_level,
"Start: Spatially-join attributes in `%s.%s` by features/values in `%s.%s`.",
dataset_path,
field_name,
join_path,
join_field_name,
)
states = Counter()
states["in original dataset"] = dataset.feature_count(dataset_path)
view = DatasetView(dataset_path, dataset_where_sql=dataset_where_sql)
# Do not include any field names - we do not want them added to output.
join_view = DatasetView(join_path,
field_names=[],
dataset_where_sql=join_where_sql)
with view, join_view:
# ArcPy2.8.0: Convert Path to str.
arcpy.analysis.SpatialJoin(
target_features=view.name,
join_features=join_view.name,
out_feature_class=str(output_path),
join_operation="JOIN_ONE_TO_MANY",
join_type="KEEP_ALL",
match_option="HAVE_THEIR_CENTER_IN",
)
if replacement_value is not None:
attributes.update_by_value(
output_path,
field_name,
value=replacement_value,
dataset_where_sql="JOIN_FID <> -1",
log_level=logging.DEBUG,
)
else:
attributes.update_by_joined_value(
output_path,
field_name,
key_field_names=["JOIN_FID"],
join_dataset_path=join_path,
join_field_name=join_field_name,
join_key_field_names=["OID@"],
dataset_where_sql="JOIN_FID <> -1",
join_dataset_where_sql=join_where_sql,
log_level=logging.DEBUG,
)
attributes.update_by_value(
output_path,
field_name,
value=None,
dataset_where_sql="JOIN_FID = -1",
log_level=logging.DEBUG,
)
for name in ["Join_Count", "TARGET_FID", "JOIN_FID"]:
dataset.delete_field(output_path,
field_name=name,
log_level=logging.DEBUG)
states["in output"] = dataset.feature_count(output_path)
log_entity_states("features", states, logger=LOG, log_level=log_level)
LOG.log(log_level, "End: Join.")
return states
def polygons_to_lines(
dataset_path: Union[Path, str],
*,
output_path: Union[Path, str],
dataset_where_sql: Optional[str] = None,
id_field_name: Optional[str] = None,
make_topological: bool = False,
log_level: int = logging.INFO,
) -> Counter:
"""Convert geometry from polygons to lines.
Note:
If `make_topological` is set to True, shared outlines will be a single, separate
feature. Note that one cannot pass attributes to a topological transformation
(as the values would not apply to all adjacent features).
If an id field name is specified, the output dataset will identify the input
features that defined the line feature with the name & values from the provided
field. This option will be ignored if the output is non-topological lines, as
the field will pass over with the rest of the attributes.
Args:
dataset_path: Path to dataset.
output_path: Path to output dataset.
dataset_where_sql: SQL where-clause for dataset subselection.
id_field_name: Name of ID field to apply on topological lines.
make_topological: Make line output topological, or merged where lines overlap.
log_level: Level to log the function at.
Returns:
Feature counts for original and output datasets.
"""
dataset_path = Path(dataset_path)
output_path = Path(output_path)
LOG.log(
log_level,
"Start: Convert polgyons in `%s` to lines in output `%s`.",
dataset_path,
output_path,
)
states = Counter()
states["in original dataset"] = dataset.feature_count(dataset_path)
view = DatasetView(dataset_path, dataset_where_sql=dataset_where_sql)
with view:
# ArcPy2.8.0: Convert Path to str.
arcpy.management.PolygonToLine(
in_features=view.name,
out_feature_class=str(output_path),
neighbor_option=("IDENTIFY_NEIGHBORS"
if make_topological else "IGNORE_NEIGHBORS"),
)
if make_topological:
_dataset = Dataset(dataset_path)
for side in ["left", "right"]:
oid_key = f"{side.upper()}_FID"
if id_field_name:
id_field = next(
_field for _field in _dataset.fields
if _field.name.lower() == id_field_name.lower())
id_field.name = f"{side.upper()}_{id_field_name}"
# Cannot create an OID-type field, so force to long.
if id_field.type.upper() == "OID":
id_field.type = "LONG"
dataset.add_field(output_path,
log_level=logging.DEBUG,
**id_field.field_as_dict)
attributes.update_by_joined_value(
output_path,
field_name=id_field.name,
key_field_names=[oid_key],
join_dataset_path=dataset_path,
join_field_name=id_field_name,
join_key_field_names=[_dataset.oid_field_name],
log_level=logging.DEBUG,
)
dataset.delete_field(output_path,
field_name=oid_key,
log_level=logging.DEBUG)
else:
dataset.delete_field(output_path,
field_name="ORIG_FID",
log_level=logging.DEBUG)
states["in output"] = dataset.feature_count(output_path)
log_entity_states("features", states, logger=LOG, log_level=log_level)
LOG.log(log_level, "End: Convert.")
return states