ftir-OMNIC-map-reader 1.0.0__tar.gz

ftir_omnic_map_reader-1.0.0/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present Henry Towbin <24940778+whtowbin@users.noreply.github.com>
+
+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.

ftir_omnic_map_reader-1.0.0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: ftir-OMNIC-map-reader
+Version: 1.0.0
+Author-email: Henry Towbin <24940778+whtowbin@users.noreply.github.com>
+License-Expression: MIT
+Project-URL: Documentation, https://github.com/whtowbin/FTIR_OMNIC_MAP_Reader#readme
+Project-URL: Source, https://github.com/whtowbin/FTIR_OMNIC_MAP_Reader
+Keywords: FTIR,Hyperspectral
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: matplotlib>=3.10.1
+Requires-Dist: numpy>=1.26
+Requires-Dist: xarray>=2024.6
+Dynamic: license-file
+
+# FTIR OMNIC Map Reader
+
+## Table of Contents
+- [Description](#description)
+- [Installation](#installation)
+- [Directions](#directions)
+- [License](#license)
+
+## Description
+This code aims to provide a convenient interface for reading FTIR Data specifically OMNIC .MAP files. It loads OMNIC .MAP files into python as Xarray dataset objects. This provides access to the coordinates and spectra of each point in the map. 
+
+The underlying code for reading OMINC .MAP files was part of the python package [PyMca](https://github.com/vasole/pymca?tab=readme-ov-file) X-Ray Fluorescence Toolkit. Developed by the European Synchrotron Radiation Facility.
+
+If there is interest in adding particular features please let me know in the issues or make a pull request with the change. 
+
+## Installation 
+You will already need to have a python environment installed on your computer to install this software. 
+If you do not have a python environment installed you can use [UV](https://docs.astral.sh/uv/) to install one.
+
+To install this package you can use pip. 
+
+```console
+pip install ftir-OMNIC-map-reader
+```
+
+If you are using [UV](https://docs.astral.sh/uv/) to manage your python environment you can install the package by running the command:
+
+```console
+uv add ftir-OMNIC-map-reader
+```
+
+if you are 
+If you would like to install the package from source you can do so by following these steps:
+1) Download or clone this repository to your computer and save it in a location where it can remain on your computer. 
+2) In the terminal navigate to the directory of the package.
+3) run the command:
+   - python -m pip install .
+   - if you have windows you might need to run: python3 -m pip install .
+
+## Directions
+
+ ### Xarray Dataset
+To load a map follow this example: 
+ ``` python
+ from ftir_map  import LoadOmnicMAP as omnic
+
+ map_path = "greatest_map_ever.map"
+ map = omnic.Load_Omnic_Map(map_path)
+ spectra = map['spectra']  # This is the spectra data
+ coordinates = map.coords  # This contains the spatial and spectral coordinates
+ metadata = map.attrs  # This contains the metadata from the .MAP file
+ ```
+ The map is an xarray [dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html) object. It should contain the three main attributes
+   - data_vars: This is all of the spectra in the map
+   - coords: These are the spatial and spectral coordinates of the map
+   - attrs: this is all of the meta data reported in the .MAP file
+   
+   If you are unfamiliar with recommend looking at the xarray [tutorial](https://tutorial.xarray.dev/overview/xarray-in-45-min)
+   
+   The main benefit of xarray is that it is straightforward to reference the data by spatial and spectral coordinates in the appropriate units. If you choose not to use it you should be able to access the underlying data as numpy arrays. 
+   
+   I eventually hope to provide further guidance for processing the map files efficiently using xarray. 
+
+ ### Data as a Dictionary
+   If you would like to access the data as a dictionary containing the spectra data, spatial and spectral coordiantes, and metadata; you can do so by  using the following code:
+   ``` python
+   from ftir_map  import LoadOmnicMAP as omnic
+   map_path = "greatest_map_ever.map"
+   map_dict = omnic.Load_Omnic_Map_as_dict(map_path)
+   spectra = map_dict['data']  # This is the spectra data
+   x_coordinates = map_dict['x'] # This contains the x spatial coordinates
+   y_coordinates = map_dict['y'] # This contains the y spatial coordinates
+   wn_coordinates = map_dict['wn'] # This contains the spectral coordinates
+   metadata = map_dict['metadata']  # This contains the metadata from the .MAP file
+   ```
+## License
+`FTIR OMNIC Map Reader` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

ftir_omnic_map_reader-1.0.0/README.md

@@ -0,0 +1,77 @@
+# FTIR OMNIC Map Reader
+
+## Table of Contents
+- [Description](#description)
+- [Installation](#installation)
+- [Directions](#directions)
+- [License](#license)
+
+## Description
+This code aims to provide a convenient interface for reading FTIR Data specifically OMNIC .MAP files. It loads OMNIC .MAP files into python as Xarray dataset objects. This provides access to the coordinates and spectra of each point in the map. 
+
+The underlying code for reading OMINC .MAP files was part of the python package [PyMca](https://github.com/vasole/pymca?tab=readme-ov-file) X-Ray Fluorescence Toolkit. Developed by the European Synchrotron Radiation Facility.
+
+If there is interest in adding particular features please let me know in the issues or make a pull request with the change. 
+
+## Installation 
+You will already need to have a python environment installed on your computer to install this software. 
+If you do not have a python environment installed you can use [UV](https://docs.astral.sh/uv/) to install one.
+
+To install this package you can use pip. 
+
+```console
+pip install ftir-OMNIC-map-reader
+```
+
+If you are using [UV](https://docs.astral.sh/uv/) to manage your python environment you can install the package by running the command:
+
+```console
+uv add ftir-OMNIC-map-reader
+```
+
+if you are 
+If you would like to install the package from source you can do so by following these steps:
+1) Download or clone this repository to your computer and save it in a location where it can remain on your computer. 
+2) In the terminal navigate to the directory of the package.
+3) run the command:
+   - python -m pip install .
+   - if you have windows you might need to run: python3 -m pip install .
+
+## Directions
+
+ ### Xarray Dataset
+To load a map follow this example: 
+ ``` python
+ from ftir_map  import LoadOmnicMAP as omnic
+
+ map_path = "greatest_map_ever.map"
+ map = omnic.Load_Omnic_Map(map_path)
+ spectra = map['spectra']  # This is the spectra data
+ coordinates = map.coords  # This contains the spatial and spectral coordinates
+ metadata = map.attrs  # This contains the metadata from the .MAP file
+ ```
+ The map is an xarray [dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html) object. It should contain the three main attributes
+   - data_vars: This is all of the spectra in the map
+   - coords: These are the spatial and spectral coordinates of the map
+   - attrs: this is all of the meta data reported in the .MAP file
+   
+   If you are unfamiliar with recommend looking at the xarray [tutorial](https://tutorial.xarray.dev/overview/xarray-in-45-min)
+   
+   The main benefit of xarray is that it is straightforward to reference the data by spatial and spectral coordinates in the appropriate units. If you choose not to use it you should be able to access the underlying data as numpy arrays. 
+   
+   I eventually hope to provide further guidance for processing the map files efficiently using xarray. 
+
+ ### Data as a Dictionary
+   If you would like to access the data as a dictionary containing the spectra data, spatial and spectral coordiantes, and metadata; you can do so by  using the following code:
+   ``` python
+   from ftir_map  import LoadOmnicMAP as omnic
+   map_path = "greatest_map_ever.map"
+   map_dict = omnic.Load_Omnic_Map_as_dict(map_path)
+   spectra = map_dict['data']  # This is the spectra data
+   x_coordinates = map_dict['x'] # This contains the x spatial coordinates
+   y_coordinates = map_dict['y'] # This contains the y spatial coordinates
+   wn_coordinates = map_dict['wn'] # This contains the spectral coordinates
+   metadata = map_dict['metadata']  # This contains the metadata from the .MAP file
+   ```
+## License
+`FTIR OMNIC Map Reader` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

ftir_omnic_map_reader-1.0.0/pyproject.toml

@@ -0,0 +1,26 @@
+
+
+
+[project]
+name = "ftir-OMNIC-map-reader"
+version = "1.0.0"
+#dynamic = ["version"]
+description = ''
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+keywords = ["FTIR", "Hyperspectral"]
+authors = [
+  { name = "Henry Towbin", email = "24940778+whtowbin@users.noreply.github.com" },
+]
+
+dependencies = [
+    "matplotlib>=3.10.1",
+    "numpy >= 1.26",
+    "xarray>=2024.6",
+]
+
+[project.urls]
+Documentation = "https://github.com/whtowbin/FTIR_OMNIC_MAP_Reader#readme"
+Source = "https://github.com/whtowbin/FTIR_OMNIC_MAP_Reader"
+

ftir_omnic_map_reader-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ftir_omnic_map_reader-1.0.0/src/ftir_OMNIC_map_reader.egg-info/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: ftir-OMNIC-map-reader
+Version: 1.0.0
+Author-email: Henry Towbin <24940778+whtowbin@users.noreply.github.com>
+License-Expression: MIT
+Project-URL: Documentation, https://github.com/whtowbin/FTIR_OMNIC_MAP_Reader#readme
+Project-URL: Source, https://github.com/whtowbin/FTIR_OMNIC_MAP_Reader
+Keywords: FTIR,Hyperspectral
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: matplotlib>=3.10.1
+Requires-Dist: numpy>=1.26
+Requires-Dist: xarray>=2024.6
+Dynamic: license-file
+
+# FTIR OMNIC Map Reader
+
+## Table of Contents
+- [Description](#description)
+- [Installation](#installation)
+- [Directions](#directions)
+- [License](#license)
+
+## Description
+This code aims to provide a convenient interface for reading FTIR Data specifically OMNIC .MAP files. It loads OMNIC .MAP files into python as Xarray dataset objects. This provides access to the coordinates and spectra of each point in the map. 
+
+The underlying code for reading OMINC .MAP files was part of the python package [PyMca](https://github.com/vasole/pymca?tab=readme-ov-file) X-Ray Fluorescence Toolkit. Developed by the European Synchrotron Radiation Facility.
+
+If there is interest in adding particular features please let me know in the issues or make a pull request with the change. 
+
+## Installation 
+You will already need to have a python environment installed on your computer to install this software. 
+If you do not have a python environment installed you can use [UV](https://docs.astral.sh/uv/) to install one.
+
+To install this package you can use pip. 
+
+```console
+pip install ftir-OMNIC-map-reader
+```
+
+If you are using [UV](https://docs.astral.sh/uv/) to manage your python environment you can install the package by running the command:
+
+```console
+uv add ftir-OMNIC-map-reader
+```
+
+if you are 
+If you would like to install the package from source you can do so by following these steps:
+1) Download or clone this repository to your computer and save it in a location where it can remain on your computer. 
+2) In the terminal navigate to the directory of the package.
+3) run the command:
+   - python -m pip install .
+   - if you have windows you might need to run: python3 -m pip install .
+
+## Directions
+
+ ### Xarray Dataset
+To load a map follow this example: 
+ ``` python
+ from ftir_map  import LoadOmnicMAP as omnic
+
+ map_path = "greatest_map_ever.map"
+ map = omnic.Load_Omnic_Map(map_path)
+ spectra = map['spectra']  # This is the spectra data
+ coordinates = map.coords  # This contains the spatial and spectral coordinates
+ metadata = map.attrs  # This contains the metadata from the .MAP file
+ ```
+ The map is an xarray [dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html) object. It should contain the three main attributes
+   - data_vars: This is all of the spectra in the map
+   - coords: These are the spatial and spectral coordinates of the map
+   - attrs: this is all of the meta data reported in the .MAP file
+   
+   If you are unfamiliar with recommend looking at the xarray [tutorial](https://tutorial.xarray.dev/overview/xarray-in-45-min)
+   
+   The main benefit of xarray is that it is straightforward to reference the data by spatial and spectral coordinates in the appropriate units. If you choose not to use it you should be able to access the underlying data as numpy arrays. 
+   
+   I eventually hope to provide further guidance for processing the map files efficiently using xarray. 
+
+ ### Data as a Dictionary
+   If you would like to access the data as a dictionary containing the spectra data, spatial and spectral coordiantes, and metadata; you can do so by  using the following code:
+   ``` python
+   from ftir_map  import LoadOmnicMAP as omnic
+   map_path = "greatest_map_ever.map"
+   map_dict = omnic.Load_Omnic_Map_as_dict(map_path)
+   spectra = map_dict['data']  # This is the spectra data
+   x_coordinates = map_dict['x'] # This contains the x spatial coordinates
+   y_coordinates = map_dict['y'] # This contains the y spatial coordinates
+   wn_coordinates = map_dict['wn'] # This contains the spectral coordinates
+   metadata = map_dict['metadata']  # This contains the metadata from the .MAP file
+   ```
+## License
+`FTIR OMNIC Map Reader` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

ftir_omnic_map_reader-1.0.0/src/ftir_OMNIC_map_reader.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE.txt
+README.md
+pyproject.toml
+src/ftir_OMNIC_map_reader.egg-info/PKG-INFO
+src/ftir_OMNIC_map_reader.egg-info/SOURCES.txt
+src/ftir_OMNIC_map_reader.egg-info/dependency_links.txt
+src/ftir_OMNIC_map_reader.egg-info/requires.txt
+src/ftir_OMNIC_map_reader.egg-info/top_level.txt
+src/ftir_map/LoadOmnicArrayMAP.py
+src/ftir_map/LoadOmnicMAP.py
+src/ftir_map/PyMca_Array_OmnicMap.py
+src/ftir_map/PyMca_OmnicMap.py
+src/ftir_map/__about__.py
+src/ftir_map/__init__.py
+src/ftir_map/testpoint.py

ftir_omnic_map_reader-1.0.0/src/ftir_OMNIC_map_reader.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ftir_omnic_map_reader-1.0.0/src/ftir_OMNIC_map_reader.egg-info/requires.txt

@@ -0,0 +1,3 @@
+matplotlib>=3.10.1
+numpy>=1.26
+xarray>=2024.6

ftir_omnic_map_reader-1.0.0/src/ftir_OMNIC_map_reader.egg-info/top_level.txt

@@ -0,0 +1 @@
+ftir_map