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

confusing syntax for vis-subtract, "no sources specified for subtraction" #29

Open
d3v-null opened this issue Feb 20, 2024 · 1 comment

Comments

@d3v-null
Copy link
Collaborator

d3v-null commented Feb 20, 2024

without --invert , vis-subtract will throw an error No sources were specified for subtraction for a perfectly valid seeming command like

hyperdrive vis-subtract -n ${num_sources} ...

Relevant help message

SKY-MODEL SOURCES:
    -i, --invert                                          Invert the subtraction; sources *not* specified in sources-to-subtract will be subtracted from the input data
        --sources-to-subtract <SOURCES_TO_SUBTRACT>...    The names of the sources in the sky-model source list that will be subtracted from the input data

potential solutions:

  • invert by default if no --sources-to-subtract
  • deprecate --invert and add --sources-to-skip
@JLBLine
Copy link

JLBLine commented Feb 20, 2024

Thanks @d3v-null . Probably easiest is to invert default with no sources-to-subtract just for backwards compatibility. The biggest confusion is probably this help message

-n, --num-sources <NUM_SOURCES>   The number of sources to use in the source list. The default is to use them all. Example: If 1000 sources are specified here, then the top 1000 sources are used (based on their flux densities after the beam attenuation) within the specified source distance cutoff

That reads like you don't need the --invert option at all.

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

No branches or pull requests

2 participants