Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NDCube.fill method #829

Open
wants to merge 31 commits into
base: main
Choose a base branch
from
Open

NDCube.fill method #829

wants to merge 31 commits into from

Conversation

PCJY
Copy link
Contributor

@PCJY PCJY commented Mar 14, 2025

PR Description

This pull request aims to resolve the issue created by @DanRyanIrish , #828 .

Copy link
Member

@DanRyanIrish DanRyanIrish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @PCJY. Here are some suggested improvements.

Once you've handled these, you should also consider how to handle the case where the cube (including the uncertainty) has a unit.

Then this PR will also need tests.

PCJY and others added 7 commits March 16, 2025 00:57
Co-authored-by: DanRyanIrish <ryand5@tcd.ie>
rename the method

Co-authored-by: DanRyanIrish <ryand5@tcd.ie>
Co-authored-by: DanRyanIrish <ryand5@tcd.ie>
Co-authored-by: DanRyanIrish <ryand5@tcd.ie>
remove code about kwargs when fill_in_place is True.

Co-authored-by: DanRyanIrish <ryand5@tcd.ie>
Already know that self.mask is not None, now, check whether uncertainty_fill_value and self.uncertainty is None, raise an error if self.uncertainty is None.

Co-authored-by: DanRyanIrish <ryand5@tcd.ie>
Filling in the uncertainty_fill_value

Co-authored-by: DanRyanIrish <ryand5@tcd.ie>
@DanRyanIrish DanRyanIrish added this to the 2.4.0 milestone Mar 17, 2025
PCJY and others added 2 commits March 17, 2025 13:32
Co-authored-by: DanRyanIrish <ryand5@tcd.ie>
Co-authored-by: DanRyanIrish <ryand5@tcd.ie>
@DanRyanIrish
Copy link
Member

@PCJY Let me know when this is ready for another review. Also, be sure to pull the latest changes from the main branch into this branch.

@PCJY
Copy link
Contributor Author

PCJY commented Mar 18, 2025

Hi @DanRyanIrish I have just implemented the method more, finished adding tests for the method. Apologies for the delay. I also handled units by keeping the unit the same (which might not be what you were trying to suggest, because you might mean: the fill_value itself has a unit? ).

(1.0 * u.cm, 0.02, False, False), # what if the fill_value has a unit??
]
)
def test_fill_masked(ndcube_2d_ln_lt_mask_uncert_unit, fill_value, uncertainty_fill_value, unmask, fill_in_place):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest two separate tests for fill_in_place equal True and False. I also suggest that you provide the expected cube in the parameterisation. This would be much easier if your test cube only had a few data elements, e.g. a 2x3 array.

Where it's feasible, it's better to explicitly define the expected value, rather than calculate it based on the inputs provided. This leaves more possibility for the same error to exist in the code you're testing and your calculation of the expected value.

PCJY and others added 2 commits March 18, 2025 15:18
make kwargs ndcube and return it

Co-authored-by: DanRyanIrish <ryand5@tcd.ie>
Co-authored-by: DanRyanIrish <ryand5@tcd.ie>
PCJY and others added 6 commits March 18, 2025 15:23
what's needed to be done regarding units is checking whether units assigned are consistent, if users do assign it

Co-authored-by: DanRyanIrish <ryand5@tcd.ie>
Co-authored-by: DanRyanIrish <ryand5@tcd.ie>
Co-authored-by: DanRyanIrish <ryand5@tcd.ie>
@PCJY
Copy link
Contributor Author

PCJY commented Mar 24, 2025

Hi @DanRyanIrish , just so you know, the last three commits are the latest ones I made. Thank you.

Co-authored-by: DanRyanIrish <ryand5@tcd.ie>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants