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

Define some keywords for the primary hdu #141

Open
maxnoe opened this issue Mar 20, 2020 · 12 comments
Open

Define some keywords for the primary hdu #141

maxnoe opened this issue Mar 20, 2020 · 12 comments

Comments

@maxnoe
Copy link
Member

maxnoe commented Mar 20, 2020

I think now, we do not make any definitions for the primary hdu.

Maybe we should also include at least some header keywords here so a file can be immediately recognized as a file produced according to theses standards here.

@lmohrmann
Copy link
Collaborator

Sounds like a good idea. Can you make a proposal?

@kosack
Copy link
Collaborator

kosack commented Mar 23, 2020

Might consider just using the keywords that OFWG already recommends:

The OFWG recommends that the following set of keywords be used to for such purposes in each extension:

  • HDUCLASS - a character string giving a general identifier of data format used
  • HDUDOC - a character string giving the document (preferably published) that describes the format/classification used
  • HDUVERS - a character string giving the specific version of the document specified by HDUDOC.
  • HDUCLASn - an indexed set of character strings giving the classification of data in the extension

Current allowed values here: https://heasarc.gsfc.nasa.gov/docs/heasarc/ofwg/docs/ofwg_recomm/hduclas.html

You'd have to invent a HDUCLASS I guess.

@maxnoe
Copy link
Member Author

maxnoe commented Mar 23, 2020

These are used for the actual HDUs already.

So I'd suggest HDUCLASS = OGADF_PRIMARY?

@TarekHC
Copy link
Member

TarekHC commented Mar 23, 2020

These are used for the actual HDUs already.

So I'd suggest HDUCLASS = OGADF_PRIMARY?

I agree with this.

Maybe we should also include at least some header keywords here so a file can be immediately recognized as a file produced according to theses standards here.

Perhaps we could add a list of the different tables within the DL3 file? Perhaps that is too complex?

@maxnoe
Copy link
Member Author

maxnoe commented Mar 23, 2020

Perhaps that is too complex?

Not really, I think.

Is there a something standard for this?
If not, something like this:

HDU0 = OGADF_PRIMARY
HDU1 = EVENTS
HDU2 = RESPONSE/EFF_AREA/POINT-LIKE/AEFF_2D
HDU3 = RESPONSE/EDISP/POINT-LIKE/EDISP_2D

This could be optional but recommended in the standard, since you can always get this information thorugh looking at the individual hdus's

@jknodlseder
Copy link
Collaborator

jknodlseder commented Mar 24, 2020 via email

@maxnoe
Copy link
Member Author

maxnoe commented Mar 24, 2020

@jknodlseder this is about the first primary hdu, that is not used in this standard for anything right now.
HDUCLASS is recommended to be GADF in the current standard, so the primary hdu (the image hdu the FITS standard requires as first hdu) could have:

HDUCLASS = "GADF"
HDUDOC   = "https://..."
HDUVERS  = "v0.3"
HDUCLAS1 = "PRIMARY"

@adonath
Copy link
Collaborator

adonath commented Mar 24, 2020

@maxnoe your latest proposal seems reasonable to me as well. It's probably the minimal compliant information that can be put...

@TarekHC
Copy link
Member

TarekHC commented Mar 24, 2020

Going through the format used within the CREF# keywords in Fermi-LAT IRFs (also containing arrays), the way they store them is:

Instead of @maxnoe proposal:

HDU2 = RESPONSE/EFF_AREA/POINT-LIKE/AEFF_2D
HDU3 = RESPONSE/EDISP/POINT-LIKE/EDISP_2D

It would be:

HDU2 = (RESPONSE,EFF_AREA,POINT-LIKE,AEFF_2D)
HDU3 = (RESPONSE,EDISP,POINT-LIKE,EDISP_2D)

Maybe the initial "(" helps identifying that an array is coming? Anyway, if we can be as consistent as possible with other approaches used in the past, better.

@maxnoe
Copy link
Member Author

maxnoe commented Mar 24, 2020

That's actually not standard conform, so we should not use it.

Enclosed in quotes as a string, it would be.

@jknodlseder
Copy link
Collaborator

jknodlseder commented Mar 24, 2020 via email

@kosack
Copy link
Collaborator

kosack commented Mar 26, 2020

I agree with Jurgen. You don't need an HDUCLASS in the primary. Couldn't you just identify the file type by which HDUs are present? There's also the hierarchical grouping standard to group a set of HDUs together, but I think it also leaves the primary HDU blank. https://fits.gsfc.nasa.gov/registry/grouping.html

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

6 participants