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

Consistent and intuitive description for returned data cubes #149

Closed
m-mohr opened this issue Mar 18, 2020 · 4 comments
Closed

Consistent and intuitive description for returned data cubes #149

m-mohr opened this issue Mar 18, 2020 · 4 comments

Comments

@m-mohr
Copy link
Member

m-mohr commented Mar 18, 2020

The processes returning a data cube usually have a description such as:

A data cube with potentially lower resolution and potentially lower cardinality, but the same number of dimensions as the original data cube.

  1. Check that these all are correct and complete
  2. Replace "cardinality" with "number of dimension labels" (originates from Processes for climatology use cases #145 )
@m-mohr
Copy link
Member Author

m-mohr commented Jul 1, 2020

Things that are currently mentioned in the return value descriptions:

  • cardinality (number of dimension labels)
  • number of dimensions
  • resolution

Is that all that changes in data cube operations?

They are mentioned like this:

filter_bands: Therefore, the cardinality is potentially lower, but the resolution and the number of dimensions are the same as for the original data cube.

How would you prefer this to be specified?

@m-mohr
Copy link
Member Author

m-mohr commented Jul 1, 2020

  • label names?

@m-mohr
Copy link
Member Author

m-mohr commented Jul 6, 2020

A data cube with potentially lower resolution and potentially lower cardinality, but the same number of dimensions as the original data cube.

Replace with a list:

The data cube changes...

  • resolution: <=
  • number of dimension: =
  • number of dimension labels: <=

Add explanation for resolution to the glossary.

@m-mohr
Copy link
Member Author

m-mohr commented Jul 22, 2020

That wasn't really well thought out as you'd need to do that for every dimension. Thus I kept with text and usually did something like:

A data cube with the same dimensions. The dimension properties (name, type, labels, reference system and resolution) have not changed, except for the resolution and dimension labels of the given temporal dimension.

See PR #182.

m-mohr added a commit that referenced this issue Jul 24, 2020
…-cubes

Consistent and intuitive description for returned data cubes #149
@m-mohr m-mohr closed this as completed Jul 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant