Skip to content

253-assuming-default-of-cartesian-vectorcomponents-is-too-risky #266

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

253-assuming-default-of-cartesian-vectorcomponents-is-too-risky #266

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions hapi-dev/HAPI-data-access-spec-dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -613,7 +613,7 @@ it is unconstrained.
|----------------|--------------------------------------|------------------------------------------------------------------------|
| `spase2.4.1` | [https://spase-group.org/data/schema/spase-2.4.1.xsd](https://spase-group.org/data/schema/spase-2.4.1.xsd) | Schema containing the names and definitions of coordinate systems commonly used in Heliophysics. See also [an ΗΤΜL version of relevant section of schema.](https://spase-group.org/data/model/spase-2.4.1/spase-2_4_1_xsd.html#CoordinateSystemName) |

This schema captures a Heliophysics-specific list of coordinate systems and is part of the larger SPASE metadata model (also Heliophysics-specific). It serves as an example of how a publically accessible list of coordinate frames can be referenced by the `coordinateSystemSchema` keyword. Different communities can reference their schemas.
This schema captures a Heliophysics-specific list of coordinate systems and is part of the larger SPASE metadata model (also Heliophysics-specific). It serves as an example of how a publicly accessible list of coordinate frames can be referenced by the `coordinateSystemSchema` keyword. Different communities can reference their schemas.

Within the `parameter` object is the `coordinateSystemName` keyword, which contains the name of the coordinate
system (must be from the schema). There is also the `vectorComponents` keyword to capture the details about which
Expand Down Expand Up @@ -807,7 +807,7 @@ The focus of the header is to list the parameters in a dataset. The first parame
| `label` | string OR array of string | **Optional** A word or very short phrase that could serve as a label for this parameter (as on a plot axis or in a selection list of parameters). It is intended to be less cryptic than the parameter name. If the parameter is a scalar, this label must be a single string. If the parameter is an array, a single string label or an array of string labels are allowed. `null` and the empty string `""` are not allowed. A single label string will be applied to all elements in the array, whereas an array of label strings specifies a different label string for each element in the array parameter. The shape of the array of label strings must match the `size` attribute, and the ordering of multi-dimensional arrays of label strings is as discussed in the `size` attribute definition above. See also the following example responses to an `info` query for examples of a single string and string array labels and additional details in [Units and Label Arrays](#3610-units-and-label-array).|
| `stringType` | string or object | **Optional** A string parameter can have a specialized type. Currently, the only supported specialized type is a URI. See [The `stringType` Object](#366-stringtype-object) for more details on syntax and allowed values for `stringType`. |
| `coordinateSystemName`| string | **Optional** Some parameters contain directional or position information, such as look direction, spacecraft location, or a measured vector quantity. This keyword specifies the name of the coordinate system for these quantities. If `coordinateSystemName` is given, `vectorComponents` should be given (but this is not required). If a [`coordinateSystemSchema`](#364-coordinatesystemschema-details) was given for this dataset, then the `coordinateSystemName` must come from the schema. [See the `vectorComponents` Object](#3611-vectorcomponents-object) for more about coordinate systems. |
| `vectorComponents` | string or array of strings| **Optional** The name or list of names of the vector-related elements. For a scalar `parameter`, only a single string indicating its component type is allowed. For an array `parameter`, an array of corresponding component names is expected. If a parameter has a `coordinateSystemName` and three elements, and they represent Cartesian (x,y,z) values, then as a convenience, you may omit the `vectorComponents`. For any other situation (not three elements, not Cartesian, not ordered as x,y,z), then you must specify the `vectorComponents` explicitly. [See the `vectorComponents` Object](#3611-vectorcomponents-object) for additional details. |
| `vectorComponents` | string or array of strings| **Optional** The name or list of names of the vector-related elements. For a scalar `parameter`, only a single string indicating its component type is allowed. For an array `parameter`, an array of corresponding component names is expected. [See the `vectorComponents` Object](#3611-vectorcomponents-object) for additional details. |
| `bins` | array of Bins object | **Optional** For array parameters, each object in the `bins` array corresponds to one of the dimensions of the array and describes values associated with each element in the corresponding dimension of the array. The [bins object table](3611-bins-object) below describes all required and optional attributes within each `bins` object. For example, if the parameter represents a 1-D frequency spectrum, the `bins` array will have one object describing the frequency values for each frequency bin; within that object, the `centers` attribute points to an array of values to use for the central frequency of each channel, and the `ranges` attribute specifies a range associated with each channel. |

**Example**
Expand Down Expand Up @@ -1017,7 +1017,7 @@ Possible component names are constrained to be one of the following:

Note that `vectorComponents` should be interpreted as describing vector-related elements. In some instances, the `vectorComponents` will describe a proper vector (e.g., if `vectorComponents = ["x", "y", "z"]`).

Many angular quantities in datasets have different names than the ones here
Many angular quantities in datasets have different names from the ones here
(azimuth instead of longitude, or elevation or inclination instead of latitude),
but most quantities directly map to these commonly used component names, which come from
spherical or cylindrical coordinate systems. A [future version](https://github.com/hapi-server/data-specification/issues/115) of HAPI may offer
Expand Down