siemensfile 0.1.6__tar.gz

siemensfile-0.1.6/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Fernando
+
+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.

siemensfile-0.1.6/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.1
+Name: siemensfile
+Version: 0.1.6
+Summary: Paquete para leer archivos .dat de Siemens y realizar reconstrucciones de imágenes.
+Home-page: https://github.com/cenarius1985/SIEMENSFile
+Author: Fernando Jose Ramirez
+Author-email: tu_email@example.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12.4
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: pandas
+Requires-Dist: mri-nufft
+Requires-Dist: scipy
+Requires-Dist: tqdm
+Requires-Dist: tables
+Requires-Dist: gt-twixtools
+
+## Uso
+
+Aquí un ejemplo básico de cómo usar SIEMENSFile:
+
+```python
+from siemensfile import process_siemens_file
+
+# Procesar un archivo con reconstrucción Cartesiana
+metadata, rawdata = process_siemens_file('ruta/a/tu/archivo.dat', reconstruction="Cartesiana")
+
+# Procesar un archivo sin reconstrucción
+metadata, rawdata = process_siemens_file('ruta/a/tu/archivo.dat')
+
+# Trabajar con los resultados
+print(metadata)
+print(rawdata.shape)

siemensfile-0.1.6/README.md

@@ -0,0 +1,16 @@
+## Uso
+
+Aquí un ejemplo básico de cómo usar SIEMENSFile:
+
+```python
+from siemensfile import process_siemens_file
+
+# Procesar un archivo con reconstrucción Cartesiana
+metadata, rawdata = process_siemens_file('ruta/a/tu/archivo.dat', reconstruction="Cartesiana")
+
+# Procesar un archivo sin reconstrucción
+metadata, rawdata = process_siemens_file('ruta/a/tu/archivo.dat')
+
+# Trabajar con los resultados
+print(metadata)
+print(rawdata.shape)

siemensfile-0.1.6/setup.cfg

@@ -0,0 +1,8 @@
+[tool:pytest]
+filterwarnings = 
+	ignore:pkg_resources is deprecated as an API:DeprecationWarning
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

siemensfile-0.1.6/setup.py

@@ -0,0 +1,31 @@
+import os
+from setuptools import setup, find_packages
+
+setup(
+    name="siemensfile",  # Cambiado a minúsculas
+    version="0.1.6",
+    packages=find_packages(where="src"),  # Especifica dónde buscar los paquetes
+    package_dir={"": "src"},  # Indica que los paquetes están en el directorio src
+    install_requires=[
+        "numpy",
+        "matplotlib",
+        "pandas",
+        "mri-nufft",
+        "scipy",
+        "tqdm",
+        "tables",
+        "gt-twixtools"
+    ],
+    author="Fernando Jose Ramirez",
+    author_email="tu_email@example.com",
+    description="Paquete para leer archivos .dat de Siemens y realizar reconstrucciones de imágenes.",
+    long_description=open("README.md", encoding="utf-8").read(),
+    long_description_content_type="text/markdown",
+    url="https://github.com/cenarius1985/SIEMENSFile",
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires='>=3.12.4',
+)

siemensfile-0.1.6/src/siemensfile/__init__.py

@@ -0,0 +1,3 @@
+from .core import process_siemens_file
+
+__all__ = ['process_siemens_file']

siemensfile-0.1.6/src/siemensfile/core.py

@@ -0,0 +1,36 @@
+import os
+import numpy as np
+import pandas as pd
+from twixtools import read_twix
+from .utils import extraer_metadata_recursivamente
+from .reconstruction import reconstruct_image
+
+def process_siemens_file(file_path, reconstruction=None):
+    try:
+        twix = read_twix(file_path, parse_pmu=False)
+        metadata = []
+        rawdata = []
+
+        for i, scan in enumerate(twix):
+            hdr = scan['hdr']
+            metadata_planos = extraer_metadata_recursivamente(hdr)
+            metadata.append(metadata_planos)
+
+            image_mdbs = [mdb for mdb in scan['mdb'] if mdb.is_image_scan()]
+            if image_mdbs:
+                n_line = 1 + max([mdb.cLin for mdb in image_mdbs])
+                n_channel, n_column = image_mdbs[0].data.shape
+                kspace = np.zeros([n_line, n_channel, n_column], dtype=np.complex64)
+                for mdb in image_mdbs:
+                    if mdb.cLin < n_line and mdb.data.shape == (n_channel, n_column):
+                        kspace[mdb.cLin] = mdb.data
+                rawdata.append(kspace)
+
+        if reconstruction:
+            reconstruct_image(rawdata, reconstruction)
+
+        return metadata, rawdata
+
+    except Exception as e:
+        print(f"Error processing SIEMENS file: {str(e)}")
+        return None, None

siemensfile-0.1.6/src/siemensfile/reconstruction.py

@@ -0,0 +1,22 @@
+import matplotlib.pyplot as plt
+import numpy as np
+from .utils import ifftnd, rms_comb
+
+def reconstruct_image(rawdata, method="Cartesiana"):
+    if method.lower() == "cartesiana":
+        fig, axs = plt.subplots(len(rawdata), 2, figsize=(10, 5*len(rawdata)))
+        for i, kspace in enumerate(rawdata):
+            # Espacio K
+            axs[i, 0].imshow(np.abs(kspace[:, 0])**0.2, cmap='gray')
+            axs[i, 0].set_title(f'Espacio K - Scan {i+1}')
+            
+            # Reconstrucción IFFT
+            image_ifft = ifftnd(kspace, [0, -1])
+            image_ifft = rms_comb(image_ifft)
+            axs[i, 1].imshow(np.abs(image_ifft), cmap='gray')
+            axs[i, 1].set_title(f'Reconstrucción IFFT - Scan {i+1}')
+
+        plt.tight_layout()
+        plt.show()
+    else:
+        print(f"Método de reconstrucción '{method}' no implementado.")

siemensfile-0.1.6/src/siemensfile/siemensfile.py

@@ -0,0 +1,71 @@
+from twixtools.twixtools import read_twix
+import numpy as np
+import os
+import pandas as pd
+import shutil
+import traceback
+from .utils import *
+
+def lectura_twix(ruta_archivo):
+    carpeta_destino = os.path.join(os.path.dirname(__file__), "output")
+    if os.path.exists(carpeta_destino):
+        shutil.rmtree(carpeta_destino)
+    os.makedirs(carpeta_destino)
+    
+    try:
+        twix = read_twix(ruta_archivo, parse_pmu=False)
+        datos = []
+        for i, scan in enumerate(twix):
+            hdr = scan['hdr']
+            metadata_planos = extraer_metadata_recursivamente(hdr)
+            datos.append(metadata_planos)
+
+        df = pd.DataFrame(datos)
+        nombre_archivo_json = os.path.join(carpeta_destino, 'datos_twix.json')
+        df.to_json(nombre_archivo_json, index=False)
+        print(f'Datos guardados exitosamente en {nombre_archivo_json}')
+
+        print('\nNúmero de escaneos separados (multi-raid):', len(twix))
+        for i, scan in enumerate(twix):
+            print(f'\nProcesando Scan {i+1}:')
+            try:
+                print('TR = %d ms\n' % (scan['hdr']['Phoenix']['alTR'][0] / 1000))
+
+                image_mdbs = [mdb for mdb in scan['mdb'] if mdb.is_image_scan()]
+                if not image_mdbs:
+                    print(f"No se encontraron escaneos de imagen válidos para el Scan {i+1}. No se puede reconstruir la imagen.")
+                    continue
+
+                n_line = 1 + max([mdb.cLin for mdb in image_mdbs])
+                n_channel, n_column = image_mdbs[0].data.shape
+                kspace = np.zeros([n_line, n_channel, n_column], dtype=np.complex64)
+                for mdb in image_mdbs:
+                    if mdb.cLin < n_line and mdb.data.shape == (n_channel, n_column):
+                        kspace[mdb.cLin] = mdb.data
+                print('Forma del espacio k:', kspace.shape)
+
+                # Guardar imagen del espacio k
+                save_image(kspace[:, 0]**0.2, 
+                           os.path.join(carpeta_destino, f'espacio_k_scan_{i+1}.png'),
+                           f'Espacio K - Scan {i+1}',
+                           'Datos crudos antes de la reconstrucción')
+
+                # Reconstrucción IFFT (Cartesiana)
+                image_ifft = ifftnd(kspace, [0, -1])
+                image_ifft = rms_comb(image_ifft)
+                save_image(image_ifft, 
+                           os.path.join(carpeta_destino, f'reconstruccion_cartesiana_ifft_scan_{i+1}.png'),
+                           f'Reconstrucción Cartesiana (IFFT) - Scan {i+1}',
+                           'Transformada inversa de Fourier rápida')
+
+                print(f"Imágenes guardadas para el Scan {i+1}")
+            except Exception as e:
+                print(f"Error procesando Scan {i+1}: {str(e)}")
+                traceback.print_exc()
+
+        print(f"Procesamiento completado. Resultados guardados en {carpeta_destino}")
+    except Exception as e:
+        print(f"Error al leer el archivo twix: {str(e)}")
+        traceback.print_exc()
+
+    return os.path.abspath(carpeta_destino)

siemensfile-0.1.6/src/siemensfile/utils.py

@@ -0,0 +1,58 @@
+import numpy as np
+import matplotlib.pyplot as plt
+import pandas as pd
+
+def ifftnd(kspace, axes=None):
+    from numpy.fft import fftshift, ifftshift, ifftn
+    if axes is None:
+        axes = range(kspace.ndim)
+    elif isinstance(axes, int):
+        axes = [axes]
+    
+    if any(ax >= kspace.ndim or ax < -kspace.ndim for ax in axes):
+        raise ValueError("Invalid axis. Axis must be less than the dimensions of kspace.")
+
+    axes = [ax if ax >= 0 else kspace.ndim + ax for ax in axes]
+    
+    # Aplicar ifftshift solo a los ejes especificados
+    kspace_shifted = ifftshift(kspace, axes=axes)
+    
+    # Realizar la IFFT
+    img = ifftn(kspace_shifted, axes=axes, norm="ortho")
+    
+    # Aplicar fftshift solo a los ejes especificados
+    img = fftshift(img, axes=axes)
+    
+    return img
+
+
+def rms_comb(sig, axis=1):
+    if axis >= sig.ndim:
+        raise ValueError(f"Invalid axis {axis} for array with {sig.ndim} dimensions.")
+    return np.sqrt(np.mean(np.abs(sig)**2, axis=axis))
+
+def extraer_metadata_recursivamente(hdr, prefijo=''):
+    datos_planos = {}
+    for clave, valor in hdr.items():
+        nueva_clave = f"{prefijo}.{clave}" if prefijo else clave
+        if isinstance(valor, dict):
+            datos_planos.update(extraer_metadata_recursivamente(valor, nueva_clave))
+        else:
+            try:
+                if pd.isna(valor) or valor is None:
+                    valor = 'Desconocido'
+                datos_planos[nueva_clave] = valor
+            except:
+                datos_planos[nueva_clave] = 'Valor no compatible'
+    return datos_planos
+
+def save_image(data, filename, title, subtitle=None):
+    plt.figure(figsize=(8, 8))
+    plt.imshow(np.abs(data), cmap='gray', origin='lower')
+    plt.title(title, fontsize=14, fontweight='bold')
+    if subtitle:
+        plt.text(0.5, -0.05, subtitle, ha='center', va='center', transform=plt.gca().transAxes, fontsize=10)
+    plt.axis('off')
+    plt.tight_layout()
+    plt.savefig(filename, dpi=300, bbox_inches='tight')
+    plt.close()

siemensfile-0.1.6/src/siemensfile.egg-info/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.1
+Name: siemensfile
+Version: 0.1.6
+Summary: Paquete para leer archivos .dat de Siemens y realizar reconstrucciones de imágenes.
+Home-page: https://github.com/cenarius1985/SIEMENSFile
+Author: Fernando Jose Ramirez
+Author-email: tu_email@example.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12.4
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: pandas
+Requires-Dist: mri-nufft
+Requires-Dist: scipy
+Requires-Dist: tqdm
+Requires-Dist: tables
+Requires-Dist: gt-twixtools
+
+## Uso
+
+Aquí un ejemplo básico de cómo usar SIEMENSFile:
+
+```python
+from siemensfile import process_siemens_file
+
+# Procesar un archivo con reconstrucción Cartesiana
+metadata, rawdata = process_siemens_file('ruta/a/tu/archivo.dat', reconstruction="Cartesiana")
+
+# Procesar un archivo sin reconstrucción
+metadata, rawdata = process_siemens_file('ruta/a/tu/archivo.dat')
+
+# Trabajar con los resultados
+print(metadata)
+print(rawdata.shape)

siemensfile-0.1.6/src/siemensfile.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+setup.cfg
+setup.py
+src/siemensfile/__init__.py
+src/siemensfile/core.py
+src/siemensfile/reconstruction.py
+src/siemensfile/siemensfile.py
+src/siemensfile/utils.py
+src/siemensfile.egg-info/PKG-INFO
+src/siemensfile.egg-info/SOURCES.txt
+src/siemensfile.egg-info/dependency_links.txt
+src/siemensfile.egg-info/requires.txt
+src/siemensfile.egg-info/top_level.txt
+tests/test_siemensfile.py

siemensfile-0.1.6/src/siemensfile.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

siemensfile-0.1.6/src/siemensfile.egg-info/requires.txt

@@ -0,0 +1,8 @@
+numpy
+matplotlib
+pandas
+mri-nufft
+scipy
+tqdm
+tables
+gt-twixtools

siemensfile-0.1.6/src/siemensfile.egg-info/top_level.txt

@@ -0,0 +1 @@
+siemensfile

siemensfile-0.1.6/tests/test_siemensfile.py

@@ -0,0 +1,141 @@
+import unittest
+import numpy as np
+import shutil
+import os
+from unittest.mock import patch
+from src.siemensfile.siemensfile import lectura_twix
+from src.siemensfile.utils import ifftnd, rms_comb, extraer_metadata_recursivamente, save_image
+import os
+
+class TestSIEMENSFile(unittest.TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        cls.ruta_archivo = os.path.join(os.path.dirname(__file__), "datatest", "siemens_file_test_cartesian_sample.dat")
+
+    def test_ifftnd(self):
+        kspace = np.zeros((4, 4), dtype=np.complex64)
+        kspace[0, 0] = 1.0 + 1.0j
+        result = ifftnd(kspace)
+        print("Resultado de ifftnd:", result)
+        self.assertEqual(result.shape, (4, 4))
+        print("Valor en [2, 0]:", np.abs(result[2, 0]))
+        self.assertAlmostEqual(np.abs(result[0, 0]), 0.3535533905932738, places=7)
+
+    def test_ifftnd_2d(self):
+        kspace = np.zeros((4, 4), dtype=np.complex64)
+        kspace[0, 0] = 1.0
+        result = ifftnd(kspace, axes=[0, 1])
+        self.assertEqual(result.shape, (4, 4))
+        # Verificar que todos los valores tienen la misma magnitud
+        self.assertTrue(np.allclose(np.abs(result), 0.25, atol=1e-7))
+        # Verificar que la suma de los valores absolutos al cuadrado es cercana a 1
+        self.assertAlmostEqual(np.sum(np.abs(result)**2), 1.0, places=7)
+
+    def test_ifftnd_complex(self):
+        kspace = np.zeros((8, 8), dtype=np.complex64)
+        kspace[0, 0] = 1 + 1j
+        kspace[0, 1] = 1 - 1j
+        result = ifftnd(kspace)
+        # Verificar que el resultado tiene valores complejos
+        self.assertFalse(np.allclose(result.imag, 0, atol=1e-7))
+        # Verificar que la suma de los valores absolutos al cuadrado es igual a la entrada
+        input_energy = np.sum(np.abs(kspace)**2)
+        output_energy = np.sum(np.abs(result)**2)
+        self.assertAlmostEqual(output_energy, input_energy, places=6)  # Reducimos la precisión a 6 decimales
+        # Verificar que la energía total es cercana a 4 (2^2 + 2^2)
+        self.assertAlmostEqual(output_energy, 4.0, places=6)  # Reducimos la precisión a 6 decimales
+        # Verificar que la diferencia relativa entre energías es pequeña
+        relative_error = abs(output_energy - input_energy) / input_energy
+        self.assertLess(relative_error, 1e-6)  # Permitimos un error relativo de hasta 0.0001%
+
+    def test_rms_comb(self):
+        sig = np.array([[1.0, 2.0], [3.0, 4.0]])
+        result = rms_comb(sig, axis=1)
+        self.assertEqual(result.shape, (2,))
+        self.assertAlmostEqual(result[0], 1.5811388300841898, places=7)
+        self.assertAlmostEqual(result[1], 3.5355339059327378, places=7)
+
+    def test_rms_comb_3d(self):
+        sig = np.ones((2, 3, 4))
+        result = rms_comb(sig, axis=2)
+        self.assertEqual(result.shape, (2, 3))
+        self.assertAlmostEqual(result[0, 0], 1.0, places=7)
+
+    def test_rms_comb_invalid_axis(self):
+        sig = np.array([[1, 2], [3, 4]])
+        with self.assertRaises(ValueError):
+            rms_comb(sig, axis=2)  # Invalid axis
+
+    def test_extraer_metadata_recursivamente(self):
+        hdr = {
+            'Phoenix': {
+                'alTR': [2000],
+                'alTE': [30]
+            },
+            'Meas': {
+                'TE': 30
+            }
+        }
+        result = extraer_metadata_recursivamente(hdr)
+        expected = {
+            'Phoenix.alTR': [2000],
+            'Phoenix.alTE': [30],
+            'Meas.TE': 30
+        }
+        self.assertDictEqual(result, expected)
+    def test_extraer_metadata_recursivamente_nested(self):
+        hdr = {
+            'level1': {
+                'level2': {
+                    'key': 'value'
+                }
+            },
+            'another_key': 42
+        }
+        result = extraer_metadata_recursivamente(hdr)
+        self.assertEqual(result['level1.level2.key'], 'value')
+        self.assertEqual(result['another_key'], 42)
+
+    def test_save_image(self):
+        data = np.random.rand(4, 4)
+        filename = "test_image.png"
+        save_image(data, filename, "Test Image")
+        self.assertTrue(os.path.exists(filename))
+        os.remove(filename)
+
+    def test_save_image_with_subtitle(self):
+        data = np.random.rand(10, 10)
+        filename = "test_image_subtitle.png"
+        save_image(data, filename, "Test Title", "Test Subtitle")
+        self.assertTrue(os.path.exists(filename))
+        os.remove(filename)
+
+    def test_lectura_twix(self):
+        if os.path.exists(self.ruta_archivo):
+            result_dir = lectura_twix(self.ruta_archivo)
+            self.assertTrue(os.path.exists(result_dir))
+            self.assertTrue(os.path.exists(os.path.join(result_dir, 'datos_twix.json')))
+            self.assertTrue(os.path.exists(os.path.join(result_dir, 'espacio_k_scan_1.png')))
+            self.assertTrue(os.path.exists(os.path.join(result_dir, 'reconstruccion_cartesiana_ifft_scan_1.png')))
+            print(f"Imágenes guardadas en: {result_dir}")
+            shutil.rmtree(result_dir)
+        else:
+            self.fail(f"Archivo de prueba no encontrado: {self.ruta_archivo}")
+
+    @patch('src.siemensfile.siemensfile.read_twix')
+    def test_lectura_twix_mocked(self, mock_read_twix):
+        mock_scan = {
+            'hdr': {'Phoenix': {'alTR': [2000]}},
+            'mdb': []
+        }
+        mock_read_twix.return_value = [mock_scan]
+        with patch('builtins.print') as mock_print:
+            result = lectura_twix("mock_file.dat")
+            self.assertTrue(os.path.exists(result))
+            self.assertTrue(os.path.exists(os.path.join(result, 'datos_twix.json')))
+            mock_print.assert_any_call("No se encontraron escaneos de imagen válidos para el Scan 1. No se puede reconstruir la imagen.")
+        shutil.rmtree(result)
+
+if __name__ == '__main__':
+    unittest.main()