search

DOI-USGS / ISIS3

Integrated Software for Imagers and Spectrometers v3. ISIS3 is a digital image processing software package to manipulate imagery collected by current and past NASA and International planetary missions.
https://isis.astrogeology.usgs.gov
Other
195 stars 166 forks source link

website's description of ISIS cube format different from distribution template #2671

Closed ascbot closed 5 years ago

ascbot commented 5 years ago

Author Name: Jean-Luc Margot (Jean-Luc Margot)

Original Assignee: Stuart Sides

Hello,

The description of the ISIS cube format at [[https://isis.astrogeology.usgs.gov/documents/LabelDictionary/LabelDictionary.html]] differs from the description of the ISIS cube format at $ISIS3DATA/base/templates/labels/CubeFormatTemplate.pft.

Specifically, the former spells "EndGroup", "EndObject", etc. whereas the latter spells "End_Group", "End_Object", etc. Which one is correct?

The documentation does not describe whether the indents in the label are necessary or optional and does not describe an ISIS cube label validator.

Thank you.

ascbot commented 5 years ago

Original Redmine Comment Author Name: Stuart Sides (@scsides) Original Date: 2018-08-08T18:29:06Z

Hi Jean-Luc, The cube labels mostly follow the PVL format described in https://pds.nasa.gov/datastandards/pds3/standards/sr/StdRef_20090227_v3.8.pdf They are not PDS PVL complaint however. They can use both the underscore form and the upper camel case form (End_Object, End_Group and EndObject, EndGroup) because it is a user preference. The ISIS3 code can read and write both.

As far as white space, indents, and blank lines go: They are only for us humans to more easily read it. The ISIS3 code ignores all indenting and white space outside quotes. All of the validation is done within the ISIS3 code because the cube format was not designed to be used outside of ISIS3 (e.g., it is not an archive format).

Hope this helps. Let us know if you need more.

I've resolved this issue, please close it if I've answered your question, or set it back to open and add a note if not

ascbot commented 5 years ago

Original Redmine Comment Author Name: Jean-Luc Margot (Jean-Luc Margot) Original Date: 2018-09-06T15:45:05Z

Thank you Stuart. You answered my question, but other users may encounter the discrepancy and ask a similar question. Consider updating the documentation to convey that both forms are acceptable. Also, if an accurate specification for the cube labels is only available in an external document, consider providing a link to that document. The cube file structure ought to be described unambiguously and the description ought to be accessible to users. Thank you.