flomickl commented on code in PR #1303: URL: https://github.com/apache/streampipes/pull/1303#discussion_r1111296509
########## streampipes-extensions/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.jts.processor.buffergeometry/documentation.md: ########## @@ -0,0 +1,96 @@ +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one or more + ~ contributor license agreements. See the NOTICE file distributed with + ~ this work for additional information regarding copyright ownership. + ~ The ASF licenses this file to You under the Apache License, Version 2.0 + ~ (the "License"); you may not use this file except in compliance with + ~ the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, software + ~ distributed under the License is distributed on an "AS IS" BASIS, + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + ~ See the License for the specific language governing permissions and + ~ limitations under the License. + ~ + --> + +## Buffer Geometry + +<p align="center"> + <img src="icon.png" width="150px;" class="pe-image-documentation"/> +</p> + +*** + +## Description + +Creates a buffer polygon geometry from a geometry +*** + +## Required inputs + +* WKT of a JTS Geometry +* Integer value representing EPSG code +* Distance +* Cap Style +* Join Style +* Mitre-Limit +* Side +* Simplify Factor +* Quadrant Segments +*** + +## Configuration + +### 1st parameter +Input Geometry + +### 2nd parameter +EPSG code value + +### 3rd parameter +Distance +The buffer distance around in geometry in meter + +### 4rd parameter +Cap Style +CAP_ROUND - the usual round end caps +CAP_FLAT - end caps are truncated flat at the line ends +CAP_SQUARE - end caps are squared off at the buffer distance beyond the line ends + +### 5rd parameter +Simplify Factor +The default simplify factor Provides an accuracy of about 1%, which matches the accuracy of the +default Quadrant Segments parameter. + +### 6rd parameter +Quadrant Segments +The default number of facets into which to divide a fillet of 90 degrees. + +### 7rd parameter +Join Style +Defines the corners in a buffer +JOIN_ROUND - the usual round join +JOIN_MITRE - corners are "sharp" (up to a distance limit) +JOIN_BEVEL - corners are beveled (clipped off). + +### 8rd parameter +Mitre-Limit +mitre ratio limit (only affects mitered join style) + +### 9rd parameter +Side +: 'left' or 'right' performs a single-sided buffer on the geometry, with the buffered side +relative to the direction of the line. This is only applicable to LINESTRING geometry and +does not affect POINT or POLYGON geometries. + +*** + +## Output + Review Comment: There should also be a visible picture on this position because WKT String is not really helpful here. See #1316 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
