qtam 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
qtam-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Your Name
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
qtam-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,37 @@
1
+ Metadata-Version: 2.4
2
+ Name: qtam
3
+ Version: 0.1.0
4
+ Summary: PyTorch implementation of invertible Q-Transform with Ampltude Modulation
5
+ Author-email: Lorenzo Asprea <lorenzo.asprea@gmail.com>, Francesco Sarandrea <fsarandrea94@gmail.com>
6
+ License: MIT
7
+ Project-URL: Homepage, https://github.com/dottormale/Qtransform_torch/tree/main/QTAM
8
+ Project-URL: Repository, https://github.com/dottormale/Qtransform_torch/tree/main/QTAM
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Intended Audience :: Science/Research
11
+ Classifier: License :: OSI Approved :: MIT License
12
+ Classifier: Operating System :: OS Independent
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Topic :: Scientific/Engineering :: Physics
15
+ Requires-Python: >=3.7
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ Requires-Dist: torch>=1.9.0
19
+ Requires-Dist: numpy>=1.20.0
20
+ Provides-Extra: dev
21
+ Requires-Dist: pytest>=6.0; extra == "dev"
22
+ Requires-Dist: black; extra == "dev"
23
+ Requires-Dist: flake8; extra == "dev"
24
+ Provides-Extra: full
25
+ Requires-Dist: torch_spline_interpolation>=1.0.0; extra == "full"
26
+ Dynamic: license-file
27
+
28
+ # QTAM - Q-Transform with Amplitude Modulation
29
+
30
+ A full PyTorch implementation of the invertible Q-transform. QTAM exploits Amplitude Modulation and de-Modulation to increase and decrease the size of the produced spectrograms, making it possible to encode all the physical information of a signal in 2D images of modest dimensions. The analytical invertibility of QTAM ensures that no physically relevant features are lost when going from time to time-frequency representation and vice versa. The package include classes for multi-configuration Q-scanning for time-frequency analysis; the user can perform a scan over the parameter space to choose the frequency window and Q value which best suite their analysis.
31
+
32
+ More information can be found at: "https://github.com/dottormale/Qtransform_torch/tree/main/QTAM".
33
+
34
+ ## Installation
35
+
36
+ ```bash
37
+ pip install qtam
qtam-0.1.0/README.md ADDED
@@ -0,0 +1,10 @@
1
+ # QTAM - Q-Transform with Amplitude Modulation
2
+
3
+ A full PyTorch implementation of the invertible Q-transform. QTAM exploits Amplitude Modulation and de-Modulation to increase and decrease the size of the produced spectrograms, making it possible to encode all the physical information of a signal in 2D images of modest dimensions. The analytical invertibility of QTAM ensures that no physically relevant features are lost when going from time to time-frequency representation and vice versa. The package include classes for multi-configuration Q-scanning for time-frequency analysis; the user can perform a scan over the parameter space to choose the frequency window and Q value which best suite their analysis.
4
+
5
+ More information can be found at: "https://github.com/dottormale/Qtransform_torch/tree/main/QTAM".
6
+
7
+ ## Installation
8
+
9
+ ```bash
10
+ pip install qtam
@@ -0,0 +1,56 @@
1
+ [build-system]
2
+ requires = ["setuptools>=45", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "qtam"
7
+ version = "0.1.0"
8
+ authors = [
9
+ {name = "Lorenzo Asprea", email = "lorenzo.asprea@gmail.com"},
10
+ {name = "Francesco Sarandrea", email = "fsarandrea94@gmail.com"},
11
+ ]
12
+ description = "PyTorch implementation of invertible Q-Transform with Ampltude Modulation"
13
+ readme = "README.md"
14
+ requires-python = ">=3.7"
15
+ license = {text = "MIT"}
16
+ classifiers = [
17
+ "Development Status :: 3 - Alpha",
18
+ "Intended Audience :: Science/Research",
19
+ "License :: OSI Approved :: MIT License",
20
+ "Operating System :: OS Independent",
21
+ "Programming Language :: Python :: 3",
22
+ "Topic :: Scientific/Engineering :: Physics",
23
+ ]
24
+
25
+ dependencies = [
26
+ "torch>=1.9.0",
27
+ "numpy>=1.20.0",
28
+ ]
29
+
30
+ [project.optional-dependencies]
31
+ dev = ["pytest>=6.0", "black", "flake8"]
32
+ full = ["torch_spline_interpolation>=1.0.0"]
33
+
34
+
35
+ [project.urls]
36
+ Homepage = "https://github.com/dottormale/Qtransform_torch/tree/main/QTAM"
37
+ Repository = "https://github.com/dottormale/Qtransform_torch/tree/main/QTAM"
38
+
39
+ [tool.setuptools]
40
+ package-dir = {"" = "src"}
41
+
42
+ [tool.setuptools.packages.find]
43
+ where = ["src"]
44
+
45
+ # Optional: development tool configurations
46
+ [tool.black]
47
+ line-length = 88
48
+ target-version = ['py37', 'py38', 'py39', 'py310', 'py311']
49
+
50
+ [tool.flake8]
51
+ max-line-length = 88
52
+ extend-ignore = ["E203", "W503"]
53
+
54
+ [tool.pytest.ini_options]
55
+ testpaths = ["tests"]
56
+ addopts = "-v"
qtam-0.1.0/setup.cfg ADDED
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,56 @@
1
+ """
2
+ QTAM - Q-Transform Amplitude Modulation
3
+
4
+ A PyTorch implementation of invertible Q-transform and multi-configuration Q-scanning
5
+ for time-frequency analysis of gravitational wave data and other signals.
6
+ """
7
+
8
+ __version__ = "0.1.0"
9
+
10
+ # Import main classes for easy access
11
+ from .core import (
12
+ QTile,
13
+ SingleQTransform,
14
+ QScan,
15
+ # Window functions
16
+ planck_taper_window_range,
17
+ kaiser_window_range,
18
+ tukey_window,
19
+ bisquare_window,
20
+ hann_window,
21
+ )
22
+
23
+ from .scan import (
24
+ QTileMulti,
25
+ SingleQMultiTransform,
26
+ QScanMulti,
27
+ # Batched window functions
28
+ planck_taper_window_range_batch,
29
+ kaiser_window_range_batch,
30
+ tukey_window_batch,
31
+ bisquare_window_batched,
32
+ hann_window_batched,
33
+ )
34
+
35
+ # Define what gets imported with "from qtam import *"
36
+ __all__ = [
37
+ # Core module
38
+ "QTile",
39
+ "SingleQTransform",
40
+ "QScan",
41
+ "planck_taper_window_range",
42
+ "kaiser_window_range",
43
+ "tukey_window",
44
+ "bisquare_window",
45
+ "hann_window",
46
+
47
+ # Scan module
48
+ "QTileMulti",
49
+ "SingleQMultiTransform",
50
+ "QScanMulti",
51
+ "planck_taper_window_range_batch",
52
+ "kaiser_window_range_batch",
53
+ "tukey_window_batch",
54
+ "bisquare_window_batched",
55
+ "hann_window_batched",
56
+ ]