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

Clarify and width and height are for calculating an aspect ratio only #477

Closed
jpstroop opened this Issue Jun 8, 2015 · 8 comments

Comments

Projects
None yet
4 participants
@jpstroop
Copy link
Member

commented Jun 8, 2015

width and height and sizes : [ ] are redundant.

Should we clarify the use of width and height as an aspect ratio by renaming to something like aspect_x, asepect_y. Or maybe even reduce to a single property, aspect: { " x" : 123, "y" : 456 }?

size comes from sizes.

  • fixed on 2.1.1 branch
  • merged to master

@jpstroop jpstroop added the image label Jun 8, 2015

@jpstroop jpstroop added this to the Image 3.0 milestone Jun 8, 2015

@jpstroop

This comment has been minimized.

Copy link
Member Author

commented Jun 8, 2015

Actually, just rely on sizes and get rid of the redundant w/h properties altogether. If the server supports arbitrary sizes the client can calculate the aspect ratio from the largest size.

@azaroth42 azaroth42 added the defer label Jul 16, 2015

@azaroth42

This comment has been minimized.

Copy link
Member

commented Jul 17, 2015

Is this agreed upon and scheduled, or discussion deferred until 3.0 ?

@jpstroop

This comment has been minimized.

Copy link
Member Author

commented Jul 17, 2015

I think we can defer, though it might still be worth discussing f2f during this eds meeting.

@azaroth42

This comment has been minimized.

Copy link
Member

commented Jul 17, 2015

👍

@zimeon

This comment has been minimized.

Copy link
Member

commented Jul 27, 2015

I think that width and height have different and useful meaning separate from the largests size in "sizes": [ ]:

  • sizes in sizes : [ ] are defined for the client to request complete images at different sizes that the server has available and should have a region parameter of “full” (http://iiif.io/api/image/2.0/#image-information) -- the expectation is the ability to get the complete image at these sizes
  • width and height indicate the maximum size that a zoom viewer should zoom to. Such an image may only be available using tiles of rather smaller size (e.g. imagine I have 10^9 by 10^9 pixel image from Sean's fractal generator of a sky survey than cannot practically be represented as a single full-region image, or an institution does not want to make full-region images at full-resolution to be easily downloadable).

Note that it still would not be appropriate to say max_width and max_height because implementations may allow scaled-up images to be requests.

Probably the best terminology is full_width and full_height because these are the dimensions of region=full, size=full (whether or not it is actually available). However, it may be easier/better to fix that in the description rather than changing the property names.

@azaroth42 azaroth42 added TheHague and removed TheHague labels Sep 26, 2016

@zimeon zimeon changed the title Clarify and width and height are for calculating an aspect ratio only. Clarify and width and height are for calculating an aspect ratio only Oct 19, 2016

@zimeon zimeon modified the milestones: Image 2.1.1, Image 3.0 Oct 20, 2016

@zimeon

This comment has been minimized.

Copy link
Member

commented Oct 20, 2016

Agreement at The Hague: clarify language to explain meaning but not change parameter names, can be done in point release.

@tomcrane

This comment has been minimized.

Copy link
Contributor

commented Oct 20, 2016

(from The Hague)

In a level 0 implementation with sizes only, sizes means "these are the only requests you can make".

In a dynamic implementation that supports arbitrary sizes, sizes means "I'd prefer it if you asked for one of these as I have them cached / they are faster to extract from the JP2, but you can still ask for any size (up to maxWidth/maxHeight)".

If the info.json also has maxWidth (/ maxHeight), should that implied max size always be in the sizes array, if there is one? Not necessarily, the server might be capable of returning 10,000 x 10,000 but still not list that in preferred sizes, which are optimised for the current image and provide hints to clients to help make for a good user experience.

@azaroth42 azaroth42 removed the TheHague label Oct 24, 2016

@jpstroop

This comment has been minimized.

Copy link
Member Author

commented Nov 2, 2016

Eds: add something under the table here: http://iiif.io/api/image/2.1/#technical-properties

  • Server may not support the full width and height
  • This info is still important for making tile requests and knowing the aspect ratio of the image.

@jpstroop jpstroop self-assigned this Nov 2, 2016

@azaroth42 azaroth42 added Ready-for-Eds and removed defer labels Mar 29, 2017

@jpstroop jpstroop closed this Jun 9, 2017

@jpstroop jpstroop removed the image label Jun 9, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.