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

Hierarch helper #458

Merged
merged 7 commits into from Jul 10, 2023
Merged

Hierarch helper #458

merged 7 commits into from Jul 10, 2023

Conversation

attipaci
Copy link
Collaborator

@attipaci attipaci commented Jul 10, 2023

Make it easier to create HIERARCH-style header keywords, by hiding the internal naming convention for such keys from users, who can instead just create the long or hierarchical FITS keywords they desire. Users can just ise one of the static Hierarch.key() methods to constructs HIERARCH-style keywords for use within this library. E.g.:

  String key = Hierarch.key("myLongFitsKeyword");

which sets key to HIERARCH.myLongFitsKeyword (which is how we refer to this long keyword within the library, such as with header access methods).

or:

  String key = Hierarch.key("my.hierarchical.fits.keyword");

to set key to HIERARCH.my.hierarchical.fits.keyword, or equivalently to the one above:

  String key = Hierarch.key("my", "hierarchical", "fits", "keyword");

The resulting string can be used as the non-standard keyword in the library's header access methods.

@attipaci attipaci added the enhancement A new feature and/or an improved capability label Jul 10, 2023
@attipaci attipaci added this to the 1.18.0 milestone Jul 10, 2023
@attipaci attipaci self-assigned this Jul 10, 2023
@codecov
Copy link

codecov bot commented Jul 10, 2023

Codecov Report

Merging #458 (481b850) into master (abb6eab) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #458   +/-   ##
=========================================
  Coverage     97.58%   97.58%           
- Complexity     4702     4705    +3     
=========================================
  Files           205      206    +1     
  Lines         13565    13571    +6     
  Branches       2094     2095    +1     
=========================================
+ Hits          13237    13243    +6     
  Misses          124      124           
  Partials        204      204           
Flag Coverage Δ
unittests 97.58% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...in/java/nom/tam/fits/header/hierarch/Hierarch.java 100.00% <100.00%> (ø)

... and 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8f065ad...481b850. Read the comment docs.

@attipaci attipaci merged commit 0ba89d4 into nom-tam-fits:master Jul 10, 2023
3 checks passed
attipaci added a commit that referenced this pull request Jul 10, 2023
@attipaci attipaci deleted the hierarch-helper branch July 17, 2023 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement A new feature and/or an improved capability
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant