| Name | gtwtools JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | https://github.com/lcx366/GTWTOOLS |
| Summary | A package to processes IPD files to extract observation times and star/satellite data, aligns the star data with a simplified star catalog, calculates the orientation of the camera, and writes the results into GTW-formatted files. |
| upload_time | 2024-10-30 14:41:22 |
| maintainer | None |
| docs_url | None |
| author | Chunxiao Li |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
ipd
gtw
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# GTWTOOLS
# Welcome to the GTWTOOLS package
[](https://pypi.python.org/pypi/gtwtools/) [](https://pypi.python.org/pypi/gtwtools/) [](https://pypi.python.org/pypi/gtwtools/) [](https://GitHub.com/lcx366/GTWTOOLS/graphs/contributors/) [](https://GitHub.com/lcx366/GTWTOOLS/graphs/commit-activity) [](https://github.com/lcx366/GTWTOOLS/blob/master/LICENSE) [](http://gtwtools.readthedocs.io/?badge=latest) [](https://travis-ci.org/lcx366/gtwtools)
A package for processing IPD files and GTW files. Currently, key features of the package include:
- Parse the IPD file, extracting pixel coordinates and grayscale values of stars and targets.
- Parse the GTW file, extracting rectangular coordinates of the site, angle-only measurement data(Ra and Dec) and apparent magnitude of the target.
- Generating the GTW file:
- Interpolates ephemeris and attitude of the site
- Aligns stars in IPD data with star catalogs
- Estimate the celestial coordinates and apparent magnitude of targets
- Writes results to GTW files and ICR file.
## How to Install
On Linux, macOS and Windows architectures, the binary wheels can be installed using pip by executing one of the following commands:
```
pip install gtwtools
pip install gtwtools --upgrade # to upgrade a pre-existing installation
```
## How to use
1. Edit the parameter configuration file *config.yaml*. The YAML file is as follows:
```yaml
# Field of View in degrees
FOV: [12.2, 12.2]
# Pixel width in degrees
PIXEL_WIDTH: 0.0014
# Width and height of the camera resolution
WIDTH: 8900
HEIGHT: 8900
# Directory of the star catalog
DIR_FROM_SIMPLIFIED: "starcatalogs/simplified/at-hyg24/mag10.0/epoch2024.5/"
# Mode of geometric invariants used in similarity transformation
# Available options are 'triangles' and 'quads'
MODE_INVARIANTS: "triangles"
# Method for distortion calibration
# Available options are null, 'gpr', 'polynomial' and 'piecewise-affine'.
# If null, the distortion calibration is ignored.
# Note: 'gpr' is usually more time-consuming.
DISTORTION_CALIBRATE: null
ASTROMETRY_CORRECTIONS:
proper-motion: True # A switch for the proper motion correction
aberration: False # A switch for the aberration correction
parallax: False # A switch for the parallax correction
deflection: False # A switch for the light deflection correction
# Semi-major axis of the target orbit in km
a: 42164
# A switch for the reverse aberration correction during light travel.
ABERRATION_INVERSE_CORRECTION: False
```
2. Run the program and enjoy!
Set the directory of the input files(.IPD), output files(.GTW and .ICR), and path of the auxiliary files(.eph and .pos).
```python
>>> from gtw_utils.generate_gtw import generate_gtw_files
>>> ipd_dir = '20240829_IPDGTW/IPD'
>>> GTW_dir = '20240829_IPDGTW/GTW'
>>> RES_dir = '20240829_IPDGTW/RES'
>>> eph_path = '20240829_IPDGTW/AUX/EPH/9511_P202408281011_012346_L0_GEOGC.eph'
>>> att_path = '20240829_IPDGTW/AUX/POS/9511_P202408281011_012346_L0_GEOGC.pos'
>>> # Run the test
>>> generate_gtw_files(ipd_dir,GTW_dir,RES_dir,eph_path,att_path)
```
3. Check the results
- The GTW files should be like this
```
C BEGIN
C
C 20240829_IPDGTW/AUX/EPH/9511_P202408281011_012346_L0_GEOGC.eph
C 20240829_IPDGTW/AUX/POS/9511_P202408281011_012346_L0_GEOGC.pos
C 10808 0907 38705 9602 8 0
C 20240501080001 20240501080213 132
C
C
10808 0907 38705 9602 8 0 41 3 20240501 080001250000 296065434 10136310 0000 000 00 0000 000 0 0126 0000 0532 00003056303924 10006497839351 10000074466185 01695896 01196940 000049 0000018686 001260 03231201 03231201 060 9511_P202408291011_012346_20240501080000_L0_GEOGC_000001.ipd
...
10808 0907 38705 9602 8 0 41 3 20240501 080213250000 295115183 10155144 0000 000 00 0000 000 0 0126 0000 0532 00003899857605 10006028817986 00000113342740 01233262 01383577 000051 0000019594 001255 03231201 03231201 050 9511_P202408291011_012346_20240501080212_L0_GEOGC_000045.ipd
C END
```
- The ICR file should be like this
```
9511_P202408291011_012346_20240501080000_L0_GEO_GY_000001.ipd
ra dec dist mag pm_ra pm_dec epoch pixelx pixely x_camera y_camera dx dy dRa dDec dmag
0 291.37628845 3.11533077 0.0155255 3.360 253.060 80.670 2024.5 -1719.95647799 2203.20325970 1749.962 -2241.659 -0.00926576 -0.00740982 -0.00001293 -0.00001036 0.02917998
1 298.11826358 1.00560277 0.2723685 3.870 8.890 -8.322 2024.5 3102.58153044 694.29679336 -3156.715 -706.415 0.00967466 -0.00177527 0.00001347 -0.00000250 -0.12884212
3 291.62953196 0.33854926 1.1426485 4.640 -0.562 -2.294 2024.5 -1538.83517643 215.87554678 1565.696 -219.636 0.00657611 0.00673822 0.00000919 0.00000943 -0.02988498
6 288.42799892 2.29370167 0.2095138 5.140 10.102 -0.825 2024.5 -3836.00346734 1620.25967761 3902.957 -1648.527 0.01122548 0.00771403 0.00001557 0.00001079 0.08206885
7 294.79853911 5.39774525 0.2406307 5.180 4.528 -4.507 2024.5 725.49285975 3841.23692359 -738.139 -3908.278 0.01419714 -0.00730739 0.00001978 -0.00001017 0.05901266
.. ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ...
181 293.17617903 2.11950498 0.3429472 8.740 20.601 -10.017 2024.5 -433.37420674 1488.55460217 440.931 -1514.539 -0.00585609 -0.00737470 -0.00000819 -0.00001031 -0.10569402
190 292.89204929 -5.11925642 0.1647095 8.964 0.132 -43.958 2024.5 -636.40576537 -3693.14582406 647.519 3757.580 0.00741538 -0.01464478 0.00001034 -0.00002035 0.05345855
189 292.33544334 -4.37743632 0.2194996 8.890 11.155 5.749 2024.5 -1034.16439617 -3160.11076697 1052.200 3215.233 -0.01120229 -0.02442397 -0.00001563 -0.00003395 -0.02579377
186 298.83685884 0.33426935 1.0236140 8.790 3.077 2.019 2024.5 3619.35372973 213.57940204 -3682.505 -217.314 0.01008516 -0.00706671 0.00001401 -0.00000986 -0.15488674
191 292.76161576 -4.25453978 0.4675050 8.999 1.733 -3.002 2024.5 -729.59683623 -3071.30264499 742.334 3124.884 0.00508545 -0.01565266 0.00000710 -0.00002180 0.05372077
[153 rows x 16 columns]
fp_calibrated: [2.93782894e+02 3.65653795e-02]
xy_rms: [0.00863628 0.00853516]
radec_rms: [1.20301163e-05 1.18871404e-05]
mag_rms: 0.06580293778813431
```
### Real-time monitoring and processing
#### For monitoring list file modification
1. Run the following program to start real-time monitoring and processing.
```python
from gtw_utils.classes import run_ipd_listfile_monitor
if __name__ == "__main__":
"""
Main function that starts monitoring the IPD.list file.
"""
base_dir = "S12345" # Set the base directory to be monitored
eph_path = '20240829_IPDGTW/AUX/EPH/9511_P202408281011_012346_L0_GEOGC.eph'
att_path = '20240829_IPDGTW/AUX/POS/9511_P202408281011_012346_L0_GEOGC.pos'
ipd_list_file = 'IPD.list'
output_dir = "S12345"
run_ipd_listfile_monitor(base_dir, eph_path, att_path, output_dir, ipd_list_file)
```
2. Modify the IPD list file by adding new entries(IPD directories) to it.
3. Create a empty 'success.fin' file to stop the file system observer and exits the monitoring loop.
## Change log
- **0.1.1 — Oct 30, 2024**
- Added the ability to automatically filter out grayscale value anomalies of point sources, such as non-positive grayscale values.
- **0.1.0 — Sep 26, 2024**
- Added the ability to monitor the 'IPD.list' file in a specified directory and process the IPD files listed in this file **by parallel**.
- Removed the ability to monitor the creation of IPD directories and process the IPD files in these directories.
- **0.0.5 — Sep 26, 2024**
- Added the ability to monitor the processing of the IPD files in real time.
- Added `format_gtw` to directly convert angle-only measurement data to GTW files.
- Added **interpolation** for right ascension (RA) and declination (Dec) using SLERP.
- **0.0.4 — Sep 02, 2024**
- Add astrometric corrections to yaml-formatted parameter configuration.
- Adjusted the position of the IPD file name in the gtw file to the last column and modified the corresponding file parsing program `parse_ipd_file`.
- Restored the deleted variable 'net_grayscale' from `parse_ipd_file`.
- **0.0.3 — Aug 27, 2024**
- Use yaml for parameter configuration
- **0.0.2 — Aug 08, 2024**
- Removed 'net_grayscale' from `parse_ipd_file`.
- Added a switch that controls whether to perform the reverse aberration correction(from the apparent position to the true position) during light travel.
- **0.0.1 — Jul 12, 2024**
- First release of the ***gtwtools*** package.
Raw data
{
"_id": null,
"home_page": "https://github.com/lcx366/GTWTOOLS",
"name": "gtwtools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "IPD, GTW",
"author": "Chunxiao Li",
"author_email": "lcx366@126.com",
"download_url": null,
"platform": null,
"description": "# GTWTOOLS\n\n# Welcome to the GTWTOOLS package\n\n[](https://pypi.python.org/pypi/gtwtools/) [](https://pypi.python.org/pypi/gtwtools/) [](https://pypi.python.org/pypi/gtwtools/) [](https://GitHub.com/lcx366/GTWTOOLS/graphs/contributors/) [](https://GitHub.com/lcx366/GTWTOOLS/graphs/commit-activity) [](https://github.com/lcx366/GTWTOOLS/blob/master/LICENSE) [](http://gtwtools.readthedocs.io/?badge=latest) [](https://travis-ci.org/lcx366/gtwtools)\n\nA package for processing IPD files and GTW files. Currently, key features of the package include:\n\n- Parse the IPD file, extracting pixel coordinates and grayscale values of stars and targets.\n- Parse the GTW file, extracting rectangular coordinates of the site, angle-only measurement data(Ra and Dec) and apparent magnitude of the target.\n- Generating the GTW file:\n - Interpolates ephemeris and attitude of the site\n - Aligns stars in IPD data with star catalogs\n - Estimate the celestial coordinates and apparent magnitude of targets\n - Writes results to GTW files and ICR file.\n\n## How to Install\n\nOn Linux, macOS and Windows architectures, the binary wheels can be installed using pip by executing one of the following commands:\n\n```\npip install gtwtools\npip install gtwtools --upgrade # to upgrade a pre-existing installation\n```\n\n## How to use\n\n1. Edit the parameter configuration file *config.yaml*. The YAML file is as follows:\n\n```yaml\n# Field of View in degrees\nFOV: [12.2, 12.2]\n\n# Pixel width in degrees\nPIXEL_WIDTH: 0.0014\n\n# Width and height of the camera resolution\nWIDTH: 8900\nHEIGHT: 8900\n\n# Directory of the star catalog\nDIR_FROM_SIMPLIFIED: \"starcatalogs/simplified/at-hyg24/mag10.0/epoch2024.5/\"\n\n# Mode of geometric invariants used in similarity transformation\n# Available options are 'triangles' and 'quads'\nMODE_INVARIANTS: \"triangles\"\n\n# Method for distortion calibration\n# Available options are null, 'gpr', 'polynomial' and 'piecewise-affine'.\n# If null, the distortion calibration is ignored.\n# Note: 'gpr' is usually more time-consuming.\nDISTORTION_CALIBRATE: null\n\nASTROMETRY_CORRECTIONS:\n proper-motion: True # A switch for the proper motion correction\n aberration: False # A switch for the aberration correction\n parallax: False # A switch for the parallax correction\n deflection: False # A switch for the light deflection correction\n\n# Semi-major axis of the target orbit in km\na: 42164\n\n# A switch for the reverse aberration correction during light travel.\nABERRATION_INVERSE_CORRECTION: False\n```\n\n2. Run the program and enjoy!\n\nSet the directory of the input files(.IPD), output files(.GTW and .ICR), and path of the auxiliary files(.eph and .pos).\n\n```python\n>>> from gtw_utils.generate_gtw import generate_gtw_files\n>>> ipd_dir = '20240829_IPDGTW/IPD'\n>>> GTW_dir = '20240829_IPDGTW/GTW'\n>>> RES_dir = '20240829_IPDGTW/RES'\n>>> eph_path = '20240829_IPDGTW/AUX/EPH/9511_P202408281011_012346_L0_GEOGC.eph'\n>>> att_path = '20240829_IPDGTW/AUX/POS/9511_P202408281011_012346_L0_GEOGC.pos'\n>>> # Run the test\n>>> generate_gtw_files(ipd_dir,GTW_dir,RES_dir,eph_path,att_path)\n```\n\n3. Check the results\n- The GTW files should be like this\n\n```\nC BEGIN\nC\nC 20240829_IPDGTW/AUX/EPH/9511_P202408281011_012346_L0_GEOGC.eph\nC 20240829_IPDGTW/AUX/POS/9511_P202408281011_012346_L0_GEOGC.pos\nC 10808 0907 38705 9602 8 0\nC 20240501080001 20240501080213 132\nC\nC\n10808 0907 38705 9602 8 0 41 3 20240501 080001250000 296065434 10136310 0000 000 00 0000 000 0 0126 0000 0532 00003056303924 10006497839351 10000074466185 01695896 01196940 000049 0000018686 001260 03231201 03231201 060 9511_P202408291011_012346_20240501080000_L0_GEOGC_000001.ipd\n...\n10808 0907 38705 9602 8 0 41 3 20240501 080213250000 295115183 10155144 0000 000 00 0000 000 0 0126 0000 0532 00003899857605 10006028817986 00000113342740 01233262 01383577 000051 0000019594 001255 03231201 03231201 050 9511_P202408291011_012346_20240501080212_L0_GEOGC_000045.ipd\nC END\n```\n\n- The ICR file should be like this\n\n```\n9511_P202408291011_012346_20240501080000_L0_GEO_GY_000001.ipd\n ra dec dist mag pm_ra pm_dec epoch pixelx pixely x_camera y_camera dx dy dRa dDec dmag\n0 291.37628845 3.11533077 0.0155255 3.360 253.060 80.670 2024.5 -1719.95647799 2203.20325970 1749.962 -2241.659 -0.00926576 -0.00740982 -0.00001293 -0.00001036 0.02917998\n1 298.11826358 1.00560277 0.2723685 3.870 8.890 -8.322 2024.5 3102.58153044 694.29679336 -3156.715 -706.415 0.00967466 -0.00177527 0.00001347 -0.00000250 -0.12884212\n3 291.62953196 0.33854926 1.1426485 4.640 -0.562 -2.294 2024.5 -1538.83517643 215.87554678 1565.696 -219.636 0.00657611 0.00673822 0.00000919 0.00000943 -0.02988498\n6 288.42799892 2.29370167 0.2095138 5.140 10.102 -0.825 2024.5 -3836.00346734 1620.25967761 3902.957 -1648.527 0.01122548 0.00771403 0.00001557 0.00001079 0.08206885\n7 294.79853911 5.39774525 0.2406307 5.180 4.528 -4.507 2024.5 725.49285975 3841.23692359 -738.139 -3908.278 0.01419714 -0.00730739 0.00001978 -0.00001017 0.05901266\n.. ... ... ... ... ... ... ... ... ... ... ... ... ... ... ... ...\n181 293.17617903 2.11950498 0.3429472 8.740 20.601 -10.017 2024.5 -433.37420674 1488.55460217 440.931 -1514.539 -0.00585609 -0.00737470 -0.00000819 -0.00001031 -0.10569402\n190 292.89204929 -5.11925642 0.1647095 8.964 0.132 -43.958 2024.5 -636.40576537 -3693.14582406 647.519 3757.580 0.00741538 -0.01464478 0.00001034 -0.00002035 0.05345855\n189 292.33544334 -4.37743632 0.2194996 8.890 11.155 5.749 2024.5 -1034.16439617 -3160.11076697 1052.200 3215.233 -0.01120229 -0.02442397 -0.00001563 -0.00003395 -0.02579377\n186 298.83685884 0.33426935 1.0236140 8.790 3.077 2.019 2024.5 3619.35372973 213.57940204 -3682.505 -217.314 0.01008516 -0.00706671 0.00001401 -0.00000986 -0.15488674\n191 292.76161576 -4.25453978 0.4675050 8.999 1.733 -3.002 2024.5 -729.59683623 -3071.30264499 742.334 3124.884 0.00508545 -0.01565266 0.00000710 -0.00002180 0.05372077\n\n[153 rows x 16 columns]\nfp_calibrated: [2.93782894e+02 3.65653795e-02]\nxy_rms: [0.00863628 0.00853516]\nradec_rms: [1.20301163e-05 1.18871404e-05]\nmag_rms: 0.06580293778813431\n```\n\n### Real-time monitoring and processing\n\n#### For monitoring list file modification\n\n1. Run the following program to start real-time monitoring and processing.\n\n```python\nfrom gtw_utils.classes import run_ipd_listfile_monitor\n\nif __name__ == \"__main__\":\n \"\"\"\n Main function that starts monitoring the IPD.list file.\n \"\"\"\n base_dir = \"S12345\" # Set the base directory to be monitored\n eph_path = '20240829_IPDGTW/AUX/EPH/9511_P202408281011_012346_L0_GEOGC.eph'\n att_path = '20240829_IPDGTW/AUX/POS/9511_P202408281011_012346_L0_GEOGC.pos'\n ipd_list_file = 'IPD.list'\n output_dir = \"S12345\"\n\n run_ipd_listfile_monitor(base_dir, eph_path, att_path, output_dir, ipd_list_file)\n```\n\n2. Modify the IPD list file by adding new entries(IPD directories) to it.\n3. Create a empty 'success.fin' file to stop the file system observer and exits the monitoring loop.\n\n\n## Change log\n\n- **0.1.1 \u2014 Oct 30, 2024**\n \n - Added the ability to automatically filter out grayscale value anomalies of point sources, such as non-positive grayscale values.\n\n- **0.1.0 \u2014 Sep 26, 2024**\n \n - Added the ability to monitor the 'IPD.list' file in a specified directory and process the IPD files listed in this file **by parallel**. \n - Removed the ability to monitor the creation of IPD directories and process the IPD files in these directories.\n\n- **0.0.5 \u2014 Sep 26, 2024**\n \n - Added the ability to monitor the processing of the IPD files in real time.\n - Added `format_gtw` to directly convert angle-only measurement data to GTW files.\n - Added **interpolation** for right ascension (RA) and declination (Dec) using SLERP.\n\n- **0.0.4 \u2014 Sep 02, 2024**\n \n - Add astrometric corrections to yaml-formatted parameter configuration.\n - Adjusted the position of the IPD file name in the gtw file to the last column and modified the corresponding file parsing program `parse_ipd_file`.\n - Restored the deleted variable 'net_grayscale' from `parse_ipd_file`.\n\n- **0.0.3 \u2014 Aug 27, 2024**\n \n - Use yaml for parameter configuration\n\n- **0.0.2 \u2014 Aug 08, 2024**\n \n - Removed 'net_grayscale' from `parse_ipd_file`.\n - Added a switch that controls whether to perform the reverse aberration correction(from the apparent position to the true position) during light travel.\n\n- **0.0.1 \u2014 Jul 12, 2024**\n \n - First release of the ***gtwtools*** package.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A package to processes IPD files to extract observation times and star/satellite data, aligns the star data with a simplified star catalog, calculates the orientation of the camera, and writes the results into GTW-formatted files.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/lcx366/GTWTOOLS"
},
"split_keywords": [
"ipd",
" gtw"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "101f75974e40a023228836b05aaf3cb07fa6591bba412ca89d9005f6fd783e2d",
"md5": "c19c48afe7d9d0f0c21e10f350de25ab",
"sha256": "7af2a9bbfa2098aedc3d7edbfc25317d99e3a643eca1bfd3c6bc889f2a6be19c"
},
"downloads": -1,
"filename": "gtwtools-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c19c48afe7d9d0f0c21e10f350de25ab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 29806,
"upload_time": "2024-10-30T14:41:22",
"upload_time_iso_8601": "2024-10-30T14:41:22.969432Z",
"url": "https://files.pythonhosted.org/packages/10/1f/75974e40a023228836b05aaf3cb07fa6591bba412ca89d9005f6fd783e2d/gtwtools-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 14:41:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lcx366",
"github_project": "GTWTOOLS",
"github_not_found": true,
"lcname": "gtwtools"
}
