Add a support to write NDCube data into FITS file #179

yashrsharma44 · 2019-06-04T18:31:46Z

This PR addresses issue #111.
This is a continuation of the PR #154.
All the relevant discussions have taken place there.

Tasks before this is merged -

~~Tests for the new method in ndcube.py~~
Tests for the ndcubeio.py
Docs and examples
Squash the commits into one

Ping @DanRyanIrish

1. Used mixin class to implement the write method 2. This would ensure that we can add further read and write functions for different formats 3. Only three types of uncertainty have been added.

1. Added the NDCubeIOMixin as a mixin class for ndcube 2. Added a writer function 3. Registered the writer function 4. Added a cross-check for ensuring the fits convention is followed

1. Changed the uncertainty defaults 2. Now any uncertainty along with any uncertainty data type would be accepted.

1. Changed the mixin class design 2. Removed the constructor

1. Changed the comments of the flattened dictionary 2. Corrected some typo for fits_checker 3. Changed the name of the `to_hdu` to `to_hdulist` 4. Changed the name of the ImageHDU list 5. Used `isinstance` to conform to numpy mask 6. Changed the LABEL for extra coords 7. Shifted the `fits_ndcube_writer`

1. Moved the label for missing and extra_coords inside the function 2. Corrected the `self._mask` parameter

1. Changed to the correct import order 2. Added the function name to the list of public objects

ghost · 2019-06-04T18:31:50Z

Thanks for the pull request @yashrsharma44!

I am a bot that checks pull requests for milestones and changelog entries. If you have any questions about what I am saying, please ask!
I have the following to report on this pull request:

This pull request does not have a milestone assigned to it. Only maintainers can change this, so you don't need to worry about it. 😄
I didn't detect a changelog file in this pull request. Please add a changelog file to the changelog/ directory following the instructions in the changelog README.

If there are any issues with this message, please report them here.

pep8speaks · 2019-06-05T21:05:45Z

Hello @yashrsharma44! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

In the file ndcube/mixins/ndcubeio.py:

Line 67:5: E303 too many blank lines (3)
Line 74:5: E303 too many blank lines (2)
Line 140:9: E265 block comment should start with '# '
Line 142:9: E265 block comment should start with '# '
Line 152:9: E265 block comment should start with '# '
Line 154:9: E265 block comment should start with '# '
Line 165:9: E265 block comment should start with '# '
Line 167:9: E265 block comment should start with '# '
Line 177:9: E265 block comment should start with '# '
Line 179:9: E265 block comment should start with '# '
Line 216:9: E265 block comment should start with '# '

In the file ndcube/ndcube.py:

Line 632:71: W292 no newline at end of file

In the file ndcube/tests/helpers.py:

Line 109:13: E129 visually indented line with same indent as next logical line
Line 157:89: W292 no newline at end of file

In the file ndcube/tests/test_ndcubeio.py:

Line 5:5: E116 unexpected indentation (comment)
Line 6:5: E116 unexpected indentation (comment)
Line 7:5: E116 unexpected indentation (comment)
Line 9:5: E116 unexpected indentation (comment)
Line 11:5: E116 unexpected indentation (comment)
Line 13:5: E116 unexpected indentation (comment)
Line 15:5: E116 unexpected indentation (comment)
Line 57:1: E302 expected 2 blank lines, found 1
Line 58:101: E501 line too long (112 > 100 characters)
Line 58:111: E231 missing whitespace after ','
Line 59:35: E231 missing whitespace after ','
Line 59:54: E231 missing whitespace after ','
Line 59:78: E231 missing whitespace after ','
Line 59:84: E231 missing whitespace after ','
Line 59:91: E231 missing whitespace after ','
Line 59:99: E231 missing whitespace after ','
Line 59:101: E501 line too long (150 > 100 characters)
Line 59:110: E231 missing whitespace after ','
Line 59:122: E231 missing whitespace after ','
Line 59:140: E231 missing whitespace after ','
Line 62:101: E501 line too long (133 > 100 characters)
Line 100:1: E302 expected 2 blank lines, found 1
Line 101:50: E231 missing whitespace after ','
Line 101:78: E231 missing whitespace after ','
Line 101:86: E231 missing whitespace after ','
Line 101:99: E231 missing whitespace after ','
Line 101:101: E501 line too long (109 > 100 characters)
Line 101:102: E231 missing whitespace after ','
Line 102:5: E124 closing bracket does not match visual indentation
Line 121:50: E231 missing whitespace after ','
Line 121:78: E231 missing whitespace after ','
Line 121:86: E231 missing whitespace after ','
Line 121:99: E231 missing whitespace after ','
Line 121:101: E501 line too long (118 > 100 characters)
Line 121:109: E231 missing whitespace after ','
Line 122:5: E124 closing bracket does not match visual indentation
Line 141:43: E231 missing whitespace after ','
Line 141:71: E231 missing whitespace after ','
Line 141:79: E231 missing whitespace after ','
Line 141:92: E231 missing whitespace after ','
Line 142:5: E124 closing bracket does not match visual indentation
Line 158:1: E302 expected 2 blank lines, found 1
Line 159:44: E231 missing whitespace after ','
Line 159:72: E231 missing whitespace after ','
Line 159:83: E231 missing whitespace after ','
Line 159:101: E501 line too long (123 > 100 characters)
Line 159:108: E231 missing whitespace after ','
Line 160:5: E124 closing bracket does not match visual indentation
Line 179:20: E231 missing whitespace after ','
Line 180:27: E231 missing whitespace after ','
Line 180:41: E201 whitespace after '['
Line 181:41: E201 whitespace after '['
Line 182:41: E201 whitespace after '['
Line 184:41: E201 whitespace after '['
Line 195:1: E302 expected 2 blank lines, found 1
Line 196:20: E231 missing whitespace after ','
Line 197:27: E231 missing whitespace after ','
Line 197:41: E201 whitespace after '['
Line 198:41: E201 whitespace after '['
Line 199:41: E201 whitespace after '['
Line 201:41: E201 whitespace after '['
Line 212:1: E302 expected 2 blank lines, found 1
Line 213:20: E231 missing whitespace after ','
Line 214:27: E231 missing whitespace after ','
Line 229:1: E302 expected 2 blank lines, found 1
Line 230:20: E231 missing whitespace after ','
Line 231:27: E231 missing whitespace after ','

Comment last updated at 2020-04-09 16:03:55 UTC

yashrsharma44 · 2019-06-05T21:15:43Z

ndcube/tests/test_ndcubeio.py

+    ]
+)
+def test_meta_from_hdulist(header_obj, header_values1, header_values2, header_values3, header_values4, header_values5, missing_axes):
+    wcs_axes, crpix1, crpix2, crpix3 = header_values1


Here I haven't found a way to test meta values, so maybe we need to decide on the way we store meta values? So that we have only one way to access them.

DanRyanIrish · 2019-06-11T19:04:27Z

ndcube/mixins/ndcubeio.py

+
+    """
+
+    if len(key) > 8 and len(value) > 72:


Is it necessary that both these conditions are met? What if len(value) < 72 but len(key) > 8? Is this still correct?

stale · 2020-09-30T11:04:56Z

This pull request has been automatically marked as stale because it has not had any activity for the past five months. It will be closed if no further activity occurs. If the ideas in this pull request are still worth implementing, please make sure you open an issue to keep track of that idea!

stale · 2020-10-30T12:12:57Z

This pull request has been automatically closed since there was no activity for a month since it was marked as stale. If the ideas in this pull request are still worth implementing, please make sure you open an issue to keep track of that idea!

yashrsharma44 added 20 commits March 15, 2019 23:56

Added write method for saving NDCube objects in FITS format file

1515538

1. Used mixin class to implement the write method 2. This would ensure that we can add further read and write functions for different formats 3. Only three types of uncertainty have been added.

Added the NDCubeIO to the module

4f00b9f

Adding the changes for write method

13cb12e

1. Added the NDCubeIOMixin as a mixin class for ndcube 2. Added a writer function 3. Registered the writer function 4. Added a cross-check for ensuring the fits convention is followed

PEP8 fixes

0c703d6

Changed the uncertainty defaults

fa9234b

1. Changed the uncertainty defaults 2. Now any uncertainty along with any uncertainty data type would be accepted.

Removed the constructor from the mixin class

daf5945

1. Changed the mixin class design 2. Removed the constructor

Removed the conditional for missing axis

5bfc4c0

Added a header for missing axis which are present

9db0cf3

Changed some issues for ndcubeio.py

97fb929

1. Moved the label for missing and extra_coords inside the function 2. Corrected the `self._mask` parameter

Corrected the import order

abf93f8

1. Changed to the correct import order 2. Added the function name to the list of public objects

Added the fits writer

fd6630c

Changed the private attributes to public attributes

16d107b

Merge branch 'master' of https://github.com/sunpy/ndcube

f7ecc5e

Merge branch 'master' of https://github.com/sunpy/ndcube

64e9edd

Merge branch 'master' of https://github.com/sunpy/ndcube

5fbbb9b

Merge remote-tracking branch 'upstream/master'

994159c

Merge branch 'master' into write-method

f01b351

Added support for extra-coords

4185a2f

PEP8 fixes

ae97c89

yashrsharma44 added 5 commits June 5, 2019 00:08

Changed missing_axis to missing_axes

e81904b

Added a helper method for comparing rec arrays

09b90d1

Added a default value for unit in ndcubeio write method

e1f3467

Test file for ndcubeio.py

72502b8

PEP8 fixes

5cef1f6

More PEP8 fixes

0900e84

yashrsharma44 commented Jun 5, 2019

View reviewed changes

Merge branch 'master' into write-method

f58d27f

DanRyanIrish added this to the 2.1 milestone Apr 9, 2020

DanRyanIrish reviewed Apr 9, 2020

View reviewed changes

stale bot added the stale label Sep 30, 2020

stale bot closed this Oct 30, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a support to write NDCube data into FITS file #179

Add a support to write NDCube data into FITS file #179

yashrsharma44 commented Jun 4, 2019 •

edited

Loading

ghost commented Jun 4, 2019

pep8speaks commented Jun 5, 2019 •

edited

Loading

yashrsharma44 Jun 5, 2019

DanRyanIrish Jun 11, 2019

stale bot commented Sep 30, 2020

stale bot commented Oct 30, 2020

Add a support to write NDCube data into FITS file #179

Add a support to write NDCube data into FITS file #179

Conversation

yashrsharma44 commented Jun 4, 2019 • edited Loading

ghost commented Jun 4, 2019

pep8speaks commented Jun 5, 2019 • edited Loading

Comment last updated at 2020-04-09 16:03:55 UTC

yashrsharma44 Jun 5, 2019

Choose a reason for hiding this comment

DanRyanIrish Jun 11, 2019

Choose a reason for hiding this comment

stale bot commented Sep 30, 2020

stale bot commented Oct 30, 2020

yashrsharma44 commented Jun 4, 2019 •

edited

Loading

pep8speaks commented Jun 5, 2019 •

edited

Loading