Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions docs/source/user_guide/attrs_contract.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,13 @@ write.
primary nodata source. The read-side precedence chain is
``nodata``, then ``nodatavals``, then ``_FillValue``; see
``_resolve_nodata_attr``.
* - ``masked_nodata``
- bool
- Paired with ``nodata``. ``True`` when the in-memory array is
float dtype and the reader's sentinel-to-NaN step ran;
``False`` when the array still carries the literal integer
sentinel. Only set when ``nodata`` is set; absence means no
declared sentinel.
* - ``raster_type``
- str
- ``'point'`` when the file declares ``RasterPixelIsPoint``;
Expand Down
12 changes: 9 additions & 3 deletions xrspatial/geotiff/_attrs.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,15 @@
``(pixel_width, 0.0, origin_x, 0.0, pixel_height, origin_y)``. Omitted
for files with no GeoTIFF transform tags (ModelTransformation,
ModelPixelScale, or ModelTiepoint).
- ``nodata``: declared file sentinel as stored in the GDAL_NODATA tag. The
declared-vs-masked split is tracked in issue #1988; the canonical
semantics here describe the intended behaviour once #1988 lands.
- ``nodata``: declared file sentinel as stored in the GDAL_NODATA tag.
Set whenever the source declares one, as a scalar of the source
dtype, regardless of whether the in-memory array is float-with-NaN
or int-with-sentinels.
- ``masked_nodata``: boolean flag paired with ``nodata``. ``True`` iff
the in-memory array is float dtype and the reader's sentinel-to-NaN
step ran; ``False`` iff the array still carries the literal integer
sentinel. Only emitted when ``nodata`` is set; absence is the
"no declared sentinel" signal. See ``_set_nodata_attrs``.
- ``raster_type``: ``'area'`` (implicit / RasterPixelIsArea) or ``'point'``
(explicit / RasterPixelIsPoint).
- ``extra_tags``: list of ``(tag_id, type_id, count, value)`` tuples for
Expand Down
Loading