Update celltype docs #1722
Merged
Update celltype docs #1722
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fosskers
suggested changes
Oct 27, 2016
|
|
||
| The above table lists `CellType` `DataType`s in the leftmost column | ||
| and `NoData` policies along the top row. A couple of points are worth | ||
| making here: |
There was a problem hiding this comment.
Adding a space here will fix the rendering.
| /** A custom, 'user defined' NoData CellType for comparison; we will | ||
| treat 42 as `NoData` for this one */ | ||
| val customCellType = IntUserDefinedNoDataValue(42) | ||
| val customTile = IntArrayTile(myData, 2, 2, myNormalCellType) |
There was a problem hiding this comment.
myNormalCellType -> customCellType?
| (no matter your underlying type, `get` on a tile will return an `Int` | ||
| and `getDouble` will return a `Double` */ | ||
| assert(customTile.get(0, 0) == Int.MinValue) | ||
| assert(customTile.getDouble(0, 0) == Double.NaN) |
There was a problem hiding this comment.
Relevant to reference https://github.com/geotrellis/geotrellis/blob/master/raster/src/main/scala/geotrellis/raster/NoData.scala here?
fosskers
reviewed
Oct 27, 2016
|
|
||
| In addition to keeping track of the memory used by each cell in a tile, | ||
| the cell type is where decisions about which values count as data (and | ||
| which, if any, are treated |
fosskers
reviewed
Oct 27, 2016
| /** While the value in (0, 0) is NoData, it is now 1 instead of 42 | ||
| (which matches our new CellType's expectations) */ | ||
| val converted = tileBefore.convert(IntUserDefinedNoData(1)) | ||
| assert(converted.getRaw.get(0, 0) !== converted.get(0, 0)) |
fosskers
reviewed
Oct 27, 2016
|
|
||
| /** Here, the first value is still 42. But because the NoData value is | ||
| now 1, the first value is no longer treated as NoData */ | ||
| (which matches our new CellType's expectations) */ |
There was a problem hiding this comment.
Some weirdness with */ here.
moradology
force-pushed
the
docs-celltype
branch
from
ffe14bf to
9573b25
Compare
fosskers
reviewed
Oct 28, 2016
|
|
||
| /** Here, the first value is still 42. But because the NoData value is | ||
| * now 1, the first value is no longer treated as NoData | ||
| */ |
There was a problem hiding this comment.
The */ here is causing weirdness with the next line.
fosskers
approved these changes
Oct 28, 2016
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR should include all CellType documentation. Still being worked on: the piece concerning code still in flight from #1702. I'm going to go ahead and write that part up, as I don't think the API is likely to change a great deal prior to 1.0
Closes #1580 and #1508