You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by bo...@apache.org on 2023/09/05 13:22:15 UTC

[streampipes] 01/01: remove resources of legacy pipeline element 'cusum'

This is an automated email from the ASF dual-hosted git repository.

bossenti pushed a commit to branch pipeline-element-remove-legacy-resource
in repository https://gitbox.apache.org/repos/asf/streampipes.git

commit 4b2cab86042b4e0af49410697d2ea63917423702
Author: bossenti <bo...@posteo.de>
AuthorDate: Tue Sep 5 15:22:03 2023 +0200

    remove resources of legacy pipeline element 'cusum'
---
 .../documentation.md                               |  68 ---------------------
 .../icon.png                                       | Bin 62957 -> 0 bytes
 .../strings.en                                     |  29 ---------
 3 files changed, 97 deletions(-)

diff --git a/streampipes-extensions/streampipes-processors-change-detection-jvm/src/main/resources/org.apache.streampipes.processors.changedetection.jvm.cusum/documentation.md b/streampipes-extensions/streampipes-processors-change-detection-jvm/src/main/resources/org.apache.streampipes.processors.changedetection.jvm.cusum/documentation.md
deleted file mode 100644
index cce634cf4..000000000
--- a/streampipes-extensions/streampipes-processors-change-detection-jvm/src/main/resources/org.apache.streampipes.processors.changedetection.jvm.cusum/documentation.md
+++ /dev/null
@@ -1,68 +0,0 @@
-<!--
-  ~ 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.
-  ~
-  -->
-
-## Cusum (Cumulative Sum) - Deprecated
-
-<!--
-<p align="center">
-    <img src="icon.png" width="150px;" class="pe-image-documentation"/>
-</p>
--->
-
-***
-
-## Description
-
-**This processing element is deprecated. Please use the `WelfordChangeDetection` processing element instead.**
-
-Performs change detection on a single dimension of the incoming data stream. A change is detected if the cumulative
-deviation from the mean exceeds a certain threshold. This implementation tracks the mean and the standard deviation
-using Welford's algorithm, which is well suited for data streams.
-
-***
-
-## Required input
-
-The cusum processor requires a data stream that has at least one field containing a numerical value.
-
-***
-
-## Configuration
-
-### Value to observe
-
-Specify the dimension of the data stream (e.g. the temperature) on which to perform change detection.
-
-### Parameter `k`
-
-`k` controls the sensitivity of the change detector. Its unit are standard deviations. For an observation `x_n`, the
-Cusum value is `S_n = max(0, S_{n-1} - z-score(x_n) - k)`. Thus, the cusum-score `S` icnreases
-if `S_{n-1} - z-score(x_n) > k`.
-
-### Parameter `h`
-
-The alarm theshold in standard deviations. An alarm occurs if `S_n > h`
-
-## Output
-
-This processor outputs the original data stream plus
-
-- `cusumLow`: The cusum value for negative changes
-- `cusumHigh`: The cusum value for positive changes
-- `changeDetectedLow`: Boolean indicating if a negative change was detected
-- `changeDetectedHigh`: Boolean indicating if a positive change was detected
\ No newline at end of file
diff --git a/streampipes-extensions/streampipes-processors-change-detection-jvm/src/main/resources/org.apache.streampipes.processors.changedetection.jvm.cusum/icon.png b/streampipes-extensions/streampipes-processors-change-detection-jvm/src/main/resources/org.apache.streampipes.processors.changedetection.jvm.cusum/icon.png
deleted file mode 100644
index 444fa4e2c..000000000
Binary files a/streampipes-extensions/streampipes-processors-change-detection-jvm/src/main/resources/org.apache.streampipes.processors.changedetection.jvm.cusum/icon.png and /dev/null differ
diff --git a/streampipes-extensions/streampipes-processors-change-detection-jvm/src/main/resources/org.apache.streampipes.processors.changedetection.jvm.cusum/strings.en b/streampipes-extensions/streampipes-processors-change-detection-jvm/src/main/resources/org.apache.streampipes.processors.changedetection.jvm.cusum/strings.en
deleted file mode 100644
index d576d497c..000000000
--- a/streampipes-extensions/streampipes-processors-change-detection-jvm/src/main/resources/org.apache.streampipes.processors.changedetection.jvm.cusum/strings.en
+++ /dev/null
@@ -1,29 +0,0 @@
-#
-# 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.
-#
-
-
-org.apache.streampipes.processors.changedetection.jvm.cusum.title=Cusum (Deprecated)
-org.apache.streampipes.processors.changedetection.jvm.cusum.description=This processor is deprecated. Please use the processing element `WelfordChangeDetection` instead.
-
-number-mapping.title=Value to observe
-number-mapping.description=Specifies the monitored dimension.
-
-param-k.title=Parameter k
-param-k.description=The sensitivity parameter. High value indicates low sensitivity. Unit: Standard deviations
-
-param-h.title=Parameter h
-param-h.description=The threshold above which a change is detected. Unit: Standard deviations
\ No newline at end of file