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

PriorityScheduler: Update _get_filled_indices() to avoid 'block already occupied' ValueError #550

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

Conversation

michaelbaisch
Copy link
Contributor

Previously, for blocks with a duration equal to the time_resolution, _get_filled_indices() was unable to identify overlapping slots. This was due to the comparison of start times not accounting for these specific cases.

This has been addressed by adjusting the start_time comparison to be slightly earlier (0.5 seconds). This change enables the correct identification of filled time slots for blocks with minimal duration, thus preventing the 'block already occupied' error.

Fixes #368

Comment on lines +713 to +724
filled = np.where((start_end[0]-0.5*u.second < times) & (times < start_end[1]))
is_open_time[filled[0]] = False
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd bet that fixing 0.5 s is fine in most cases, but maybe not all cases. I think it would be more correct and safer to raise a warning when np.diff(start_end) <= np.min(np.diff(times)). What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Including such a warning is probably good. Currently, I can't imagine a scenario where both time_resolution and duration are less than 1 second, which is why I opted to simply halve it. Consider revising to something like:

filled = np.where((start_end[0]-0.05*u.second <= times) & (times < start_end[1]))

Because in general I think we should mark "as filled" on one side when equal. Given that this is likely akin to floating point comparisons, subtracting a tolerance here seems logical. The addition of "<=" may provide further clarity to our intentions.

Copy link
Contributor

@bmorris3 bmorris3 left a comment

Choose a reason for hiding this comment

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

Please also add a changelog entry.

if len(filled[0]) > 0:
is_open_time[filled[0]] = False
is_open_time[min(filled[0]) - 1] = False
filled = np.where((start_end[0]-0.5*u.second < times) & (times < start_end[1]))
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
filled = np.where((start_end[0]-0.5*u.second < times) & (times < start_end[1]))
if np.diff(start_end) <= np.min(np.diff(times)):
warnings.warn(
"Unexpected behavior may occur when the time "
f"resolution ({np.min(np.diff(times))}) "
"is not smaller than the block duration "
f"({np.diff(start_end)}).", AstroplanWarning
)
filled = np.where((start_end[0]-0.5*u.second < times) & (times < start_end[1]))

If you accept this change, you'll also need to add the following import to this file:

from .exceptions import AstroplanWarning

michaelbaisch added a commit to michaelbaisch/astroplan that referenced this pull request Sep 21, 2023
…dy occupied' ValueError

Previously, for blocks with a duration equal to the time_resolution, _get_filled_indices()
was unable to identify overlapping slots. This was due to the comparison of start times not
accounting for these specific cases.

This has been addressed by adjusting the start_time comparison to be slightly earlier (0.5 seconds).
This change enables the correct identification of filled time slots for blocks with minimal duration,
thus preventing the 'block already occupied' error.
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.

ValueError: block already occupied
2 participants