SegmentSignalPy 0.1.3__cp315-cp315-win_amd64.whl

Python Extension/setup.py

@@ -0,0 +1,26 @@
+import os
+from   setuptools                     import setup
+from   setuptools                     import Extension
+from   pybind11                       import get_include
+
+
+sourceDirectory = os.path.join("src", "CPP Static Library")
+pythonDirectory = os.path.join("src", "Python Extension")
+
+setup(
+    ext_modules=[
+        Extension(
+            name="SegmentSignalPy",
+            sources=[
+                os.path.join(pythonDirectory, file)
+                for file in ["module.cpp", "SegmentationResultsPy.cpp"]
+            ] + [
+                os.path.join(sourceDirectory, file)
+                for file in ["SegmentSignalFunctions.cpp", "SegmentationResults.cpp", "SegmentSignal.cpp"]
+            ],
+            include_dirs=[get_include(), sourceDirectory],
+            language="c++",
+            extra_compile_args=[]
+        )
+    ]
+)

segmentsignalpy-0.1.3.dist-info/METADATA

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: SegmentSignalPy
+Version: 0.1.3
+Summary: Signal segmentation algorithm by S. Radhakrishnan, et al. This is a Python interface for the C++ algorithm.
+License: Copyright (c) 2021-2024 Lance A. Endres
+        
+        Permission is hereby granted, free of charge, to any person obtaining
+        a copy of this software and associated documentation files (the
+        "Software"), to deal in the Software without restriction, including
+        without limitation the rights to use, copy, modify, merge, publish,
+        distribute, sublicense, and/or sell copies of the Software, and to
+        permit persons to whom the Software is furnished to do so, subject to
+        the following conditions:
+        
+        The above copyright notice and this permission notice shall be
+        included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+        LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+        OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+        WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        
+Project-URL: homepage, https://github.com/lendres/Segment-Signals
+Requires-Python: >=3.11.0
+Description-Content-Type: text/markdown
+License-File: License.txt
+Dynamic: license-file
+
+# Segment Signals
+A signal segmentation algorithm.
+
+## Introduction
+This library implements the algorithm found in:
+[_Segmentation of well logs by maximum likelihood estimation: the algorithm and FORTRAN-77 implementation_](https://www.sciencedirect.com/science/article/pii/0098300491900237) by S.Radhakrishnan, G.Srikanth, and C.H.Mehta
+
+The original algorithm was written in Fortran.  This version converts it to C++ and C#.  In addition, the following changes have been made:
+- Converted the binary event array (Q) from double to int.  Likely, the original was a double to keep all options as floats and prevent accidental round off.  C/C++ automatically perform calculations as doubles when any of the parameters is a double.  The binary event sequence is, of course, meant to be binary, so conversion to int is logical.  This also meant a few lines could be simplified (such as comparisons).  E.g. you could directly test "if (Q[i])" rather than requiring the inequality.
+- Removed a bug from the GETSPK/GetSpikeyZone function.  The fix prevents over running the end of an array.
+- Addition of `FindSignificantZones` to allow simple filtering (removal) of small zones.
+
+## Organization
+A high-level view of the organization is as follows.
+
+- CPP Static Library
+	- SegmentSignalFunctions.
+		- **It is suggested not to use these directly, but to use the class `SegmentSignal` instead.**
+		These files implement the original algorithm in C++.  The function names have changed to something more readable.  The original function names can be found in the comments in
+		the .cpp file.  The functions have otherwise been directly converted from Fortran and should be easily comparable to those in the source paper.
+	- SegmentSignal.*
+		- A class interface to the functions that makes use of the algorithm easier.
+	- SegmentationResults.*
+		- Small class to return results of the algorithm.
+	- NoiseVarianceEstimateMethod.h
+		- Enumeration for the noise variance estimation method.
+
+- C DLL
+	- DLL wrapper around the main SegmentSignal function.  The DLL exposes a C function for calling.
+
+- C Sharp DLL Wrapper
+	- C# interface to the DLL.  Classes mirror those in C++.
+
+-  Unit Tests
+	- Testing projects.  Also provides examples.  See the "LogSeparateTest" functions for a basic example.
+
+- Python Extensions
+	- Builds a library for use with Python.  See the `src/Python Extensions/Read Me.txt` file in that project for more information.
+
+## Compiling
+The Python Extension library requires knowledge of your local Python. See the `src/Python Extensions/Read Me.txt` file in that directory for more information.

segmentsignalpy-0.1.3.dist-info/RECORD

@@ -0,0 +1,21 @@
+SegmentSignalPy.cp315-win_amd64.pyd,sha256=6TV2agvQ_z-A5mH9FPLt0N6dXScA4JlKsRHTMpoCHxM,243200
+C DLL/DLLExport.h,sha256=aln1fWfsFe4JmnINjJ8ePh4jcbZnhTM5lSrHsG9OYLQ,510
+CPP Static Library/NoiseVarianceEstimateMethod.h,sha256=Cj6KIgU3t9utRitQsDSKF5iOkcf9dWr-rfRKjS3QQhs,365
+CPP Static Library/SegmentSignal.cpp,sha256=XGf7SdVFowKUA1XTUV3w3vPlVMmObtCqfpLlgtpqhRY,7486
+CPP Static Library/SegmentSignal.h,sha256=Bi7YPvFVZuxhvqhmw9SDZihzi_ZrspYnWaG_0U_3xaA,14853
+CPP Static Library/SegmentSignalFunctions.cpp,sha256=nvjUUJrsMl8Bm3EfHlmtepXPw8xHL_4gen54zmbndXE,20026
+CPP Static Library/SegmentSignalFunctions.h,sha256=mfYm32rUx65EGldEx_TIHfLGQ6wPKaW7q-w_50zSxuc,2733
+CPP Static Library/SegmentationResults.cpp,sha256=TfETLOiGQgIQhEcCUqBjSvT4gejc0ls24hrX8OL8k1s,1812
+CPP Static Library/SegmentationResults.h,sha256=o6kW4WkUFNVjYVYC0d6qE02UMwUVPTInrqC_X_UO0mM,3372
+CPP Unit Tests/InputDataEnum.h,sha256=Mx0YNYCtwFNGhBBpbZZsh-8_6lJ0dPaC-LFp5YIFtrU,218
+CPP Unit Tests/stdafx.h,sha256=r6zd1sbn6SgNbxw5RRdde7EVZu9FHrpW2lbZVH8DCEM,330
+CPP Unit Tests/targetver.h,sha256=onYf29TIkldB3epnjug5jekwIH5Edma8anbV9yaEwE8,314
+Python Extension/SegmentationResultsPy.cpp,sha256=KZXoTBjRYUfwmM_ObRcycDKB4hciLWxElIIJ5WJze4k,4112
+Python Extension/SegmentationResultsPy.h,sha256=PNARsmd5hFZChK3nPzSaY_MPMZMW5UT63su_KvJLnxM,4074
+Python Extension/module.cpp,sha256=7vzVS5YOBfL2S21BOwMKiR6z8GDM1hT9wYWvCTJjPv0,6726
+Python Extension/setup.py,sha256=dFtWw5IhNRdH2SsEmtIMhsjb7tAe2WYkWe5keuzxqXA,877
+segmentsignalpy-0.1.3.dist-info/licenses/License.txt,sha256=P9Td1RUysGlkcCTbn7PzBHFee-iPtG0zuLzEuVOB_j8,1084
+segmentsignalpy-0.1.3.dist-info/METADATA,sha256=3cdHh9l1oOHd7qUPWUGneA5QRZXaoOf9FGmKEQXcBeE,4272
+segmentsignalpy-0.1.3.dist-info/WHEEL,sha256=0gLwYZa0C2fhgCxWR2c8HahwUiopqonVCV0wVwEg6fE,101
+segmentsignalpy-0.1.3.dist-info/top_level.txt,sha256=Gg1JGAQCkw2ZivMSVOurzJ3yu03GWXQVKWOrCRc_oA0,135
+segmentsignalpy-0.1.3.dist-info/RECORD,,

segmentsignalpy-0.1.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: false
+Tag: cp315-cp315-win_amd64
+

segmentsignalpy-0.1.3.dist-info/licenses/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2021-2024 Lance A. Endres
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

segmentsignalpy-0.1.3.dist-info/top_level.txt

@@ -0,0 +1,9 @@
+C DLL
+C Sharp Unit Tests
+C Sharp Wrapper
+CPP Static Library
+CPP Unit Tests
+Matlab Extension
+Python Extension
+SegmentSignalPy
+Test Data