.. contents::
:depth: 3
..
--------------
**EllipSect**
=============
|DOI|
EllipSect creates surface brightness profiles and extracts other
photometric data from the GALFIT output peng et al. (2002).
This code is “similar” (but not substitute) to IRAF’s ellipse routine. It
creates a Surface brightness profile for the galaxy, model and
, optionally, individual model components.
In addition, *EllipSect* computes variables such as Absolute Magnitude,
luminosity, Flux, total apparent magnitude, Bulge to Total Ratio, Tidal,
Chinu within a radius containing 90% of total light, Bumpiness, Signal to Noise Ratio, Akaike
Information criterion, Bayesian information criterion, mean surface
brightness at effective radius, percentage of total light per component,
radius at 90% of light (for Sersic components only), effective radius in
kpc, etc.
--------------
**Installation**
----------------
The code is written for python 3.
The python libraries required are:
- numpy
- astropy
- scipy
- matplotlib
- mgefit
Install GALFIT if you haven't done so.
Download the latest release, and installed it via
::
cd ellipsect
pip install .
or
::
cd ellipsect
python setup.py install
Also, you can install it via pip:
::
pip install EllipSect
Run the automated tests:
::
tox
**Note**: *EllipSect* needs the GALFIT output files (GALFIT.XX) to work.
Although *GALFIT* is not stricly required, it will required it to create
the model components and sigma image. Make sure you can call GALFIT from
the command line. Otherwise the automated tests will fail.
--------------
For Linux or Mac, just run ellipsect in the command line:
::
ellipsect
and that’s it!!
--------------
**HOW TO USE**
~~~~~~~~~~~~~~
**easy run:**
^^^^^^^^^^^^^
Once installed, run *ellipsect* in the same directory that you run
GALFIT. It only requires the latest GALFIT’s output file. *The easiest
way to run the program is:*
::
ellipsect galfit.01
It will display images like the ones below:
|A85a| |A85b|
for more options:
::
ellipsect --help
**Full manual:**
^^^^^^^^^^^^^^^^
To see other options for EllipSect:
`How to use <docs/howto.rst>`__
**Script run:**
^^^^^^^^^^^^^^^
If you want to use EllipSect inside your own python script, you can call
it in the following way:
::
from ellipsect import ArgParsing
from ellipsect import SectorsGalfit
#put all the argument parsing in a list:
args=['galfit.01','--logx', '--phot','--noplot']
parser_args = ArgParsing(args)
photapi = SectorsGalfit(parser_args)
print("Akaike Criterion: ",photapi.AICrit)
print("Bulge to Total: ",photapi.BulgeToTotal)
To check all the output variables besides AICrit and BulgeToTotal,
check:
`Output variables <docs/api.rst>`__
--------------
**Questions?**
--------------
Do you have any questions or suggestions? Please send an email to
canorve [at] gmail [dot] com or open an
`issue <https://github.com/canorve/EllipSect/issues>`__
I’m open to new ideas that can benefit the software *EllipSect* and the
*GALFIT* community
--------------
**License**
-----------
The code is under the license of **GNU**
-----------
**Cite as**
-----------
If you find this code useful, please cite as:
Añorve, Christopher, Ríos-López, Emmanuel, Reyes-Amador,
Ulises, & López-Cruz, Omar. (2022). canorve/EllipSect:
EllipSect v2.7.5 (v2.7.5). Zenodo. https://doi.org/10.5281/zenodo.6975592
--------------
**References**
--------------
Akaike, H. (1974). A New Look at the Statistical Model Identification.
IEEE Transactions on Automatic Control, 19, 716–723.
Añorve, C. (2012, July). (PhD thesis). INAOE.
Barden, M., Häußler, B., Peng, C. Y., McIntosh, D. H., & Guo, Y. (2012).
GALAPAGOS: from pixels to parameters, 422(1), 449–468.
doi:10.1111/j.1365-2966.2012.20619.x
Blakeslee, J. P., Holden, B. P., Franx, M., Rosati, P., Bouwens, R. J.,
Demarco, R., Ford, H. C., et al. (2006). Clusters at Half Hubble Time:
Galaxy Structure and Colors in RX J0152.7-1357 and MS 1054-03, 644(1),
30–53. doi:10.1086/503539
Cappellari, M. (2002). Efficient multi-Gaussian expansion of galaxies,
333(2), 400–410. doi:10.1046/j.1365-8711.2002.05412.x
de Vaucouleurs, G. (1948). d’Astrophysique, 11, 247. Recherches sur les
Nebuleuses Extragalactiques.Annales
Häußler, B., Bamford, S. P., Vika, M., Rojas, A. L., Barden, M., Kelvin,
L. S., Alpaslan, M., et al. (2013). MegaMorph - multiwavelength
measurement of galaxy structure: complete Sérsic profile information
from modern surveys, 430(1), 330–369. doi:10.1093/mnras/ sts633
Jedrzejewski, R. I. (1987). CCD surface photometry of elliptical
galaxies - I. Observations, reduction and results., 226, 747–768.
doi:10.1093/mnras/226.4.747
Peng, C. Y., Ho, L. C., Impey, C. D., & Rix, H.-W. (2002). Detailed
Structural Decomposition of Galaxy Images, 124(1), 266–293.
doi:10.1086/340952
Schwarz, G. (1978). Estimating the Dimension of a Model. Annals of
Statistics, 6(2), 461– 464.
Sersic, J. L. (1968). Atlas de Galaxias Australes.
Tal, T., van Dokkum, P. G., Nelan, J., & Bezanson, R. (2009). The
Frequency of Tidal Fea- tures Associated with Nearby Luminous Elliptical
Galaxies From a Statistically Complete Sample, 138(5), 1417–1427.
doi:10.1088/0004-6256/138/5/1417
Vikram, V., Wadadekar, Y., Kembhavi, A. K., & Vijayagovindan, G. V.
(2010). PYMORPH: automated galaxy structural parameter estimation using
PYTHON, 409(4), 1379–1392. doi:10.1111/j.1365-2966.2010.17426.x \__\_
**Other Stuff**
---------------
Check my others GALFIT tools
`here <https://github.com/canorve/GALFITools>`__
--------------
.. |DOI| image:: https://zenodo.org/badge/282223217.svg
:target: https://zenodo.org/badge/latestdoi/282223217
.. |A85a| image:: img/A85.cub.png
.. |A85b| image:: img/A85.def.png
Raw data
{
"_id": null,
"home_page": "https://github.com/canorve/EllipSect",
"name": "EllipSect",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Christopher A\u00f1orve",
"author_email": "canorve@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4c/5d/f9240bb0b2756857d5c1b5d09902474f114fdd71bdb209fee4498c23206d/EllipSect-3.4.0.tar.gz",
"platform": "Linux",
"description": ".. contents::\n :depth: 3\n..\n\n--------------\n\n**EllipSect**\n=============\n\n|DOI|\n\nEllipSect creates surface brightness profiles and extracts other\nphotometric data from the GALFIT output peng et al.\u00a0(2002).\n\nThis code is \u201csimilar\u201d (but not substitute) to IRAF\u2019s ellipse routine. It\ncreates a Surface brightness profile for the galaxy, model and\n, optionally, individual model components.\n\nIn addition, *EllipSect* computes variables such as Absolute Magnitude,\nluminosity, Flux, total apparent magnitude, Bulge to Total Ratio, Tidal,\nChinu within a radius containing 90% of total light, Bumpiness, Signal to Noise Ratio, Akaike\nInformation criterion, Bayesian information criterion, mean surface\nbrightness at effective radius, percentage of total light per component,\nradius at 90% of light (for Sersic components only), effective radius in\nkpc, etc.\n\n--------------\n\n**Installation**\n----------------\n\nThe code is written for python 3.\n\nThe python libraries required are:\n\n- numpy\n- astropy\n- scipy\n- matplotlib\n- mgefit\n\nInstall GALFIT if you haven't done so.\n\nDownload the latest release, and installed it via\n\n::\n\n cd ellipsect\n pip install . \n\nor\n\n::\n\n cd ellipsect\n python setup.py install\n\n\nAlso, you can install it via pip:\n\n::\n\n pip install EllipSect\n\n\n\nRun the automated tests:\n\n::\n\n tox \n\n\n**Note**: *EllipSect* needs the GALFIT output files (GALFIT.XX) to work.\nAlthough *GALFIT* is not stricly required, it will required it to create\nthe model components and sigma image. Make sure you can call GALFIT from\nthe command line. Otherwise the automated tests will fail.\n\n--------------\n\nFor Linux or Mac, just run ellipsect in the command line:\n\n::\n\n ellipsect\n\nand that\u2019s it!!\n\n--------------\n\n**HOW TO USE**\n~~~~~~~~~~~~~~\n\n**easy run:**\n^^^^^^^^^^^^^\n\nOnce installed, run *ellipsect* in the same directory that you run\nGALFIT. It only requires the latest GALFIT\u2019s output file. *The easiest\nway to run the program is:*\n\n::\n\n ellipsect galfit.01\n\nIt will display images like the ones below:\n\n|A85a| |A85b|\n\nfor more options:\n\n::\n\n ellipsect --help \n\n**Full manual:**\n^^^^^^^^^^^^^^^^\n\nTo see other options for EllipSect:\n\n`How to use <docs/howto.rst>`__\n\n**Script run:**\n^^^^^^^^^^^^^^^\n\nIf you want to use EllipSect inside your own python script, you can call\nit in the following way:\n\n::\n\n from ellipsect import ArgParsing \n from ellipsect import SectorsGalfit\n\n #put all the argument parsing in a list:\n args=['galfit.01','--logx', '--phot','--noplot']\n\n\n parser_args = ArgParsing(args)\n\n photapi = SectorsGalfit(parser_args)\n\n print(\"Akaike Criterion: \",photapi.AICrit)\n print(\"Bulge to Total: \",photapi.BulgeToTotal)\n\nTo check all the output variables besides AICrit and BulgeToTotal,\ncheck:\n\n`Output variables <docs/api.rst>`__\n\n--------------\n\n**Questions?**\n--------------\n\nDo you have any questions or suggestions? Please send an email to\ncanorve [at] gmail [dot] com or open an\n`issue <https://github.com/canorve/EllipSect/issues>`__\n\nI\u2019m open to new ideas that can benefit the software *EllipSect* and the\n*GALFIT* community\n\n--------------\n\n**License**\n-----------\n\nThe code is under the license of **GNU**\n\n\n-----------\n\n**Cite as**\n-----------\n\nIf you find this code useful, please cite as:\n\nA\u00f1orve, Christopher, R\u00edos-L\u00f3pez, Emmanuel, Reyes-Amador, \nUlises, & L\u00f3pez-Cruz, Omar. (2022). canorve/EllipSect: \nEllipSect v2.7.5 (v2.7.5). Zenodo. https://doi.org/10.5281/zenodo.6975592\n\n\n--------------\n\n**References**\n--------------\n\nAkaike, H. (1974). A New Look at the Statistical Model Identification.\nIEEE Transactions on Automatic Control, 19, 716\u2013723.\n\nA\u00f1orve, C. (2012, July). (PhD thesis). INAOE.\n\nBarden, M., H\u00e4u\u00dfler, B., Peng, C. Y., McIntosh, D. H., & Guo, Y. (2012).\nGALAPAGOS: from pixels to parameters, 422(1), 449\u2013468.\ndoi:10.1111/j.1365-2966.2012.20619.x\n\nBlakeslee, J. P., Holden, B. P., Franx, M., Rosati, P., Bouwens, R. J.,\nDemarco, R., Ford, H. C., et al.\u00a0(2006). Clusters at Half Hubble Time:\nGalaxy Structure and Colors in RX J0152.7-1357 and MS 1054-03, 644(1),\n30\u201353. doi:10.1086/503539\n\nCappellari, M. (2002). Efficient multi-Gaussian expansion of galaxies,\n333(2), 400\u2013410. doi:10.1046/j.1365-8711.2002.05412.x\n\nde Vaucouleurs, G. (1948). d\u2019Astrophysique, 11, 247. Recherches sur les\nNebuleuses Extragalactiques.Annales\n\nH\u00e4u\u00dfler, B., Bamford, S. P., Vika, M., Rojas, A. L., Barden, M., Kelvin,\nL. S., Alpaslan, M., et al.\u00a0(2013). MegaMorph - multiwavelength\nmeasurement of galaxy structure: complete S\u00e9rsic profile information\nfrom modern surveys, 430(1), 330\u2013369. doi:10.1093/mnras/ sts633\n\nJedrzejewski, R. I. (1987). CCD surface photometry of elliptical\ngalaxies - I. Observations, reduction and results., 226, 747\u2013768.\ndoi:10.1093/mnras/226.4.747\n\nPeng, C. Y., Ho, L. C., Impey, C. D., & Rix, H.-W. (2002). Detailed\nStructural Decomposition of Galaxy Images, 124(1), 266\u2013293.\ndoi:10.1086/340952\n\nSchwarz, G. (1978). Estimating the Dimension of a Model. Annals of\nStatistics, 6(2), 461\u2013 464.\n\nSersic, J. L. (1968). Atlas de Galaxias Australes.\n\nTal, T., van Dokkum, P. G., Nelan, J., & Bezanson, R. (2009). The\nFrequency of Tidal Fea- tures Associated with Nearby Luminous Elliptical\nGalaxies From a Statistically Complete Sample, 138(5), 1417\u20131427.\ndoi:10.1088/0004-6256/138/5/1417\n\nVikram, V., Wadadekar, Y., Kembhavi, A. K., & Vijayagovindan, G. V.\n(2010). PYMORPH: automated galaxy structural parameter estimation using\nPYTHON, 409(4), 1379\u20131392. doi:10.1111/j.1365-2966.2010.17426.x \\__\\_\n\n**Other Stuff**\n---------------\n\nCheck my others GALFIT tools\n`here <https://github.com/canorve/GALFITools>`__\n\n--------------\n\n.. |DOI| image:: https://zenodo.org/badge/282223217.svg\n :target: https://zenodo.org/badge/latestdoi/282223217\n.. |A85a| image:: img/A85.cub.png\n.. |A85b| image:: img/A85.def.png\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 (GPLv3)",
"summary": "A surface brightness analysis tool for GALFIT output.",
"version": "3.4.0",
"project_urls": {
"Documentation": "https://github.com/canorve/EllipSect/blob/master/README.rst",
"Homepage": "https://github.com/canorve/EllipSect",
"Source": "https://github.com/canorve/EllipSect"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "979cf3f07cd3cc5c0e1bdf46517f949281f2d6ee025aec7bd59c0bf06750514e",
"md5": "a3770b5632dd180718b48efe834c0f85",
"sha256": "40f8837199cbcd7fed41b50b68d9183772eddbeb7faa1941a2cf341474b721b9"
},
"downloads": -1,
"filename": "EllipSect-3.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a3770b5632dd180718b48efe834c0f85",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 73102,
"upload_time": "2024-04-13T02:13:16",
"upload_time_iso_8601": "2024-04-13T02:13:16.909238Z",
"url": "https://files.pythonhosted.org/packages/97/9c/f3f07cd3cc5c0e1bdf46517f949281f2d6ee025aec7bd59c0bf06750514e/EllipSect-3.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4c5df9240bb0b2756857d5c1b5d09902474f114fdd71bdb209fee4498c23206d",
"md5": "e5abcd0a43f1159c4ddcbbb858a5bb63",
"sha256": "55c21fad9197ccabeddf66d29ab4fbe457b40082857a1e6d680b592f6e206bb9"
},
"downloads": -1,
"filename": "EllipSect-3.4.0.tar.gz",
"has_sig": false,
"md5_digest": "e5abcd0a43f1159c4ddcbbb858a5bb63",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3838382,
"upload_time": "2024-04-13T02:13:19",
"upload_time_iso_8601": "2024-04-13T02:13:19.322350Z",
"url": "https://files.pythonhosted.org/packages/4c/5d/f9240bb0b2756857d5c1b5d09902474f114fdd71bdb209fee4498c23206d/EllipSect-3.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-13 02:13:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "canorve",
"github_project": "EllipSect",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "ellipsect"
}
JSON
