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

Docstring notation in condCovEst_wdiag #16

Closed
gapatron opened this issue Jul 22, 2023 · 1 comment
Closed

Docstring notation in condCovEst_wdiag #16

gapatron opened this issue Jul 22, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@gapatron
Copy link
Contributor

In script perstar.jl, condCovEst_wdiag, km refers to masked pixels, unlike what the docstring reads (line 141).

Since

k = .! km

Then k should be unmasked pixels. Also, k being unmasked is consistent with notation in paper.

Best,
Gabriel

@andrew-saydjari
Copy link
Owner

Hi Gabriel,

Thanks for catching the mistake in the docstring. You are right. I will fix momentarily.

In case it is useful, historical context for the reason the identity of the argument changed over the course of the project was to handle cases where we want to mask, but not interpolate pixels (the black regions in the corners of Figure 4 of the paper).

Best,
Andrew

@andrew-saydjari andrew-saydjari added the documentation Improvements or additions to documentation label Jul 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants