Skip to content

Commit

Permalink
docs: added aggregate, interiorPoint, spatialJoin, formattedString
Browse files Browse the repository at this point in the history
  • Loading branch information
Kate Lyndegaard authored and Kate-Lyndegaard committed Jul 31, 2020
1 parent 1eb79b4 commit 2aec1b4
Show file tree
Hide file tree
Showing 11 changed files with 103 additions and 3 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<title>Formatted String</title>
</head>
<body>
<div id ="help">
<h4>Example mapping:</h4>
<p>
The formatted string function enables users to access attribute values and project variables to create concatenated string values. Enter text in the text field and double click
on any available attribute value displayed in the function dialog to add the value. Alternatively press <code>Ctrl+Space</code> to access available variables and project variables. The entered values are concatenated to create string values in the target attribute.<br>
</br>
<img src="../../eu.esdihumboldt.hale.common.align/help/formattedString/Formatted_string.png" /><br>
</br>
<img src="../../eu.esdihumboldt.hale.common.align/help/formattedString/Formatted_string_mapping.png" /><br>
</br>
</p>
</div>
</body>
</html>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<title>Aggregate</title>
</head>
<body>
<div id ="help">
<h4>Example mapping:</h4>
<p>
The aggregate function combines the input source features to create MultiLineString, MultiPoint or MultiPolygon features. The aggregate function performs a check to ensure that the input features have the same source CRS. In the cases of input multi geometries, a new multi geometry is created.
When different input geometry types are aggregated, you will receive a warning in the transformation log but the function will combine the geometries in a generic GeometryCollection.
In the case of lines the aggregate function tries to combine them to create a MultiLineString in which the individual lines are connected (i.e. end vertex of one line is the start vertex of the next one).
If this is not possible there is no guaranteed order in the MultiLineString.<br>
</br>
The aggregate function is often used in combination with the type level merge function. This is necessary to combine the geometries to create multi features and avoid selecting just one geometry from the merged geometries.
<br>
</br>
<img src="../../eu.esdihumboldt.cst.functions.geometric/help/aggregate/aggregate.png" /><br>
</br>
</p>
</div>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
<div id ="help">
<h4>Example mapping:</h4>
<p>
Lines<br>
<strong>Lines</strong><br>
</br>
The interior point algorithm finds an interior vertex which is closest to the centroid of the line string.<br>
</br>
Areas<br>
<strong>Lines</strong>Areas<br>
</br>
The interior point algorithm computes sections along a horizontal scan line in the interior of the polygon. The final interior point is the midpoint of the widest computed section in the interior of the polygon.
For properties with multiple geometries, the Interior Point function selects the first geometry.
Expand All @@ -21,7 +21,7 @@ For properties with multiple geometries, the Interior Point function selects the
Source:<a href="https://locationtech.github.io/jts/jts-features.html"
target="_blank">JTS Technical Documentation</a><br>
</br>
<img src="../../eu.esdihumboldt.hale.common.align/help/interiorPoint/interiorPoint.png" /><br>
<img src="../../eu.esdihumboldt.cst.functions.geometric/help/interiorPoint/interiorPoint.png" /><br>
</br>
</p>
</div>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<title>Spatial Join</title>
</head>
<body>
<div id ="help">
<h4>Example mapping:</h4>
<p>
Spatial joins can join multiple datasets together based on the spatial relationship between geometries.
Spatial joins support the relation types contains, covered by, covers, crosses, equals, intersects, overlaps, touches, and within.<br>
</br>
Spatial joins are implemented based on the DE-9IM model.<br>
</br>
CONTAINS: Every point of the other geometry is a point of this geometry, and the interiors of the two geometries have at least one point in common. Geometries do not contain their boundary.
if a geometry A is a subset of the points in the boundary of a geometry B, <code>B.contains(A) = false</code>.
CONTAINS is the converse of WITHIN.<br>
</br>
COVERED BY: Every point of this geometry is a point of the other geometry.
This predicate is similar to WITHIN but is more inclusive (i.e. returns true for more cases).
COVEREDBY is the converse of COVERS<br>
</br>
COVERS: Every point of the other geometry is a point of this geometry. This predicate is similar to CONTAINS but is more inclusive (i.e. returns true for more cases). Unlike CONTAINS it does not distinguish between points in the boundary and in the interior of geometries. For most situations, covers should be used in preference to contains.
COVERS is the converse of COVEREDBY.<br>
</br>
CROSSES: The geometries have some but not all interior points in common.<br>
</br>
EQUALS: Tests whether this geometry is topologically equal to the argument geometry.<br>
</br>
INTERSECTS: The geometries have at least one point in common.<br>
</br>
OVERLAPS: The geometries have at least one point each not shared by the other (or equivalently neither covers the other), they have the same dimension, and the intersection of the interiors of the two geometries has the same dimension as the geometries themselves.<br>
</br>
TOUCHES: The geometries have at least one point in common, but their interiors do not intersect.<br>
</br>
WITHIN: Every point of this geometry is a point of the other geometry, and the interiors of the two geometries have at least one point in common. The boundary of the geometry is not within the geometry.
If a geometry A is a subset of the points in the boundary of a geometry B, <code>A.within(B) = false</code>.
WITHIN is converse of CONTAINS<br>
</br>
Source:<a href="https://locationtech.github.io/jts/jts-features.html"
target="_blank">JTS Technical Documentation</a><br>
</br>

<img src="../../eu.esdihumboldt.cst.functions.geometric/help/spatialJoin/spatial_join.png" /><br>
</br>
<img src="../../eu.esdihumboldt.cst.functions.geometric/help/spatialJoin/spatial_join_mapping.png" /><br>
</br>
</p>
</div>
</body>
</html>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,7 @@
category="eu.esdihumboldt.cst.functions.geometric"
description="Aggregate similar input geometries"
icon="icons/geometry.png"
help="help/aggregate/help.xhtml"
identifier="eu.esdihumboldt.cst.functions.geometric.aggregate"
name="Aggregate">
<targetProperties>
Expand Down Expand Up @@ -325,6 +326,7 @@
cellExplanation="eu.esdihumboldt.cst.functions.geometric.interiorpoint.InteriorPointExplanation"
description="Computes an interior point of a geometry (up to 2D). An interior point is guaranteed to lie in the interior of the geometry, if it is possible to calculate such a point exactly. Otherwise, the point may lie on the boundary of the geometry (e.g. if the geometry is a line)."
icon="icons/geometry.png"
help="help/interiorPoint/help.xhtml"
identifier="eu.esdihumboldt.cst.functions.geometric.interiorPoint"
name="Interior Point">
<targetProperties>
Expand All @@ -347,6 +349,7 @@
<typeFunction
category="eu.esdihumboldt.cst.functions.geometric"
icon="icons/geometry.png"
help="help/spatialJoin/help.xhtml"
identifier="eu.esdihumboldt.cst.functions.geometric.spatialjoin"
name="Spatial Join">
<targetTypes>
Expand Down

0 comments on commit 2aec1b4

Please sign in to comment.