From f5fa336475419bc513c40cd76d2dba883b2fd2d8 Mon Sep 17 00:00:00 2001 From: "Alan D. Snow" Date: Wed, 26 Jun 2019 08:47:23 -0500 Subject: [PATCH] updated to 0.0.4; rebuild docs for release (#10) --- AUTHORS.rst | 1 + docs/html/.buildinfo | 2 +- docs/html/_modules/index.html | 20 +- docs/html/_modules/rioxarray/crs.html | 20 +- docs/html/_modules/rioxarray/exceptions.html | 28 +- docs/html/_modules/rioxarray/rioxarray.html | 126 ++- docs/html/_sources/history.rst.txt | 4 +- docs/html/_static/ajax-loader.gif | Bin 673 -> 0 bytes docs/html/_static/basic.css | 89 +- docs/html/_static/comment-bright.png | Bin 756 -> 0 bytes docs/html/_static/comment-close.png | Bin 829 -> 0 bytes docs/html/_static/comment.png | Bin 641 -> 0 bytes docs/html/_static/doctools.js | 5 +- docs/html/_static/documentation_options.js | 4 +- docs/html/_static/down-pressed.png | Bin 222 -> 0 bytes docs/html/_static/down.png | Bin 202 -> 0 bytes docs/html/_static/searchtools.js | 51 +- docs/html/_static/up-pressed.png | Bin 214 -> 0 bytes docs/html/_static/up.png | Bin 203 -> 0 bytes docs/html/_static/websupport.js | 808 ------------------- docs/html/authors.html | 25 +- docs/html/contributing.html | 58 +- docs/html/examples/clip_box.html | 20 +- docs/html/examples/clip_geom.html | 20 +- docs/html/examples/examples.html | 20 +- docs/html/examples/interpolate_na.html | 20 +- docs/html/examples/reproject.html | 20 +- docs/html/examples/reproject_match.html | 20 +- docs/html/examples/transform_bounds.html | 20 +- docs/html/genindex.html | 42 +- docs/html/history.html | 35 +- docs/html/index.html | 26 +- docs/html/installation.html | 20 +- docs/html/modules.html | 20 +- docs/html/objects.inv | Bin 2037 -> 2120 bytes docs/html/py-modindex.html | 20 +- docs/html/readme.html | 31 +- docs/html/rioxarray.html | 724 ++++++++--------- docs/html/search.html | 20 +- docs/html/searchindex.js | 2 +- rioxarray/_version.py | 2 +- 41 files changed, 799 insertions(+), 1524 deletions(-) delete mode 100644 docs/html/_static/ajax-loader.gif delete mode 100644 docs/html/_static/comment-bright.png delete mode 100644 docs/html/_static/comment-close.png delete mode 100644 docs/html/_static/comment.png delete mode 100644 docs/html/_static/down-pressed.png delete mode 100644 docs/html/_static/down.png delete mode 100644 docs/html/_static/up-pressed.png delete mode 100644 docs/html/_static/up.png delete mode 100644 docs/html/_static/websupport.js diff --git a/AUTHORS.rst b/AUTHORS.rst index f18b8ae4..86661b1a 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -11,3 +11,4 @@ Contributors ------------ * Alfredo Delos Santos (https://github.com/alfredoahds) +* David Hoese (https://github.com/djhoese) \ No newline at end of file diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo index 9e290dc6..c5c635b6 100644 --- a/docs/html/.buildinfo +++ b/docs/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 91cb83dabf3c3acec7a8b8970f0a0ecb +config: 43dece66df12c80adcd49160e80dff97 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/html/_modules/index.html b/docs/html/_modules/index.html index 39cfd6cf..240686cc 100644 --- a/docs/html/_modules/index.html +++ b/docs/html/_modules/index.html @@ -1,12 +1,10 @@ - + - - - Overview: module code — rioxarray 0.0.3 documentation + + Overview: module code — rioxarray 0.0.4 documentation @@ -26,7 +24,7 @@

Navigation

  • modules |
    • -
  • rioxarray 0.0.3 documentation »
    • +
  • rioxarray 0.0.4 documentation »
    • @@ -47,13 +45,11 @@

    All modules for which code is available

    @@ -70,13 +68,11 @@

    Source code for rioxarray.crs

             
@@ -57,6 +55,14 @@ 
    Source code for rioxarray.exceptions
     
 
    [docs]class SingleVariableDataset(RioXarrayError):
     """This is for when you have a dataset with a single variable."""
    
+
+
+
    [docs]class TooManyDimensions(RioXarrayError):
+    """This is raised when there are more dimensions than is supported by the method"""
    
+
+
+
    [docs]class InvalidDimensionOrder(RioXarrayError):
+    """This is raised when there the dimensions are not ordered correctly."""
    @@ -65,13 +71,11 @@

    Source code for rioxarray.exceptions

             
@@ -62,7 +60,12 @@ 
    Source code for rioxarray.rioxarray
     from rasterio.features import geometry_mask
 from scipy.interpolate import griddata
 
-from rioxarray.exceptions import NoDataInBounds, OneDimensionalRaster
+from rioxarray.exceptions import (
+    InvalidDimensionOrder,
+    NoDataInBounds,
+    OneDimensionalRaster,
+    TooManyDimensions,
+)
 from rioxarray.crs import crs_to_wkt
 
 FILL_VALUE_NAMES = ("_FillValue", "missing_value", "fill_value")
@@ -366,6 +369,34 @@ 
    Source code for rioxarray.rioxarray
             bottom = float(self._obj[self.y_dim][-1])
         return left, bottom, right, top
 
+    def _check_dimensions(self):
+        """
+        This function validates that the dimensions 2D/3D and
+        they are are in the proper order.
+
+        Returns:
+        --------
+        str or None: Name extra dimension.
+        """
+        extra_dims = list(set(list(self._obj.dims)) - set([self.x_dim, self.y_dim]))
+        if len(extra_dims) > 1:
+            raise TooManyDimensions("Only 2D and 3D data arrays supported.")
+        elif extra_dims and self._obj.dims != (extra_dims[0], self.y_dim, self.x_dim):
+            raise InvalidDimensionOrder(
+                "Invalid dimension order. Expected order: {0}. "
+                "You can use `DataArray.transpose{0}`"
+                " to reorder your dimensions.".format(
+                    (extra_dims[0], self.y_dim, self.x_dim)
+                )
+            )
+        elif not extra_dims and self._obj.dims != (self.y_dim, self.x_dim):
+            raise InvalidDimensionOrder(
+                "Invalid dimension order. Expected order: {0}"
+                "You can use `DataArray.transpose{0}` "
+                "to reorder your dimensions.".format((self.y_dim, self.x_dim))
+            )
+        return extra_dims[0] if extra_dims else None
+
 
    [docs]    def bounds(self, recalc=False):
         """Determine the bounds of the `xarray.DataArray`
 
@@ -477,17 +508,13 @@ 
    Source code for rioxarray.rioxarray
                 dst_affine, dst_width, dst_height = _make_dst_affine(
                 self._obj, self.crs, dst_crs, resolution
             )
-        extra_dims = list(set(list(self._obj.dims)) - set([self.x_dim, self.y_dim]))
-        if len(extra_dims) > 1:
-            raise RuntimeError("Reproject only supports 2D and 3D datasets.")
-        if extra_dims:
-            assert self._obj.dims == (extra_dims[0], self.y_dim, self.x_dim)
+        extra_dim = self._check_dimensions()
+        if extra_dim:
             dst_data = np.zeros(
-                (self._obj[extra_dims[0]].size, dst_height, dst_width),
+                (self._obj[extra_dim].size, dst_height, dst_width),
                 dtype=self._obj.dtype.type,
             )
         else:
-            assert self._obj.dims == (self.y_dim, self.x_dim)
             dst_data = np.zeros((dst_height, dst_width), dtype=self._obj.dtype.type)
 
         try:
@@ -781,13 +808,10 @@ 
    Source code for rioxarray.rioxarray
             :class:`xarray.DataArray`: An interpolated :class:`xarray.DataArray` object.
 
         """
-        extra_dims = list(set(list(self._obj.dims)) - set([self.x_dim, self.y_dim]))
-        if len(extra_dims) > 1:
-            raise RuntimeError("Interpolate only supports 2D and 3D datasets.")
-        if extra_dims:
-            assert self._obj.dims == (extra_dims[0], self.y_dim, self.x_dim)
+        extra_dim = self._check_dimensions()
+        if extra_dim:
             interp_data = []
-            for _, sub_xds in self._obj.groupby(extra_dims[0]):
+            for _, sub_xds in self._obj.groupby(extra_dim):
                 interp_data.append(
                     self._interpolate_na(sub_xds.load().data, method=method)
                 )
@@ -806,7 +830,57 @@ 
    Source code for rioxarray.rioxarray
             # make sure correct attributes preserved & projection added
         _add_attrs_proj(interp_array, self._obj)
 
-        return interp_array
    
+        return interp_array
    
+
+
    [docs]    def to_raster(
+        self, raster_path, driver="GTiff", dtype=None, tags=None, **profile_kwargs
+    ):
+        """
+        Export the DataArray to a raster file.
+
+        Parameters
+        ----------
+        raster_path: str
+            The path to output the raster to.
+        driver: str, optional
+            The name of the GDAL/rasterio driver to use to export the raster.
+            Default is "GTiff".
+        dtype: str, optional
+            The data type to write the raster to. Default is the datasets dtype.
+        tags: dict, optional
+            A dictionary of tags to write to the raster.
+        **profile_kwargs
+            Additional keyword arguments to pass into writing the raster. The
+            nodata, transform, crs, count, width, and height attributes
+            are automatically added.
+
+        """
+        width, height = self.shape
+        dtype = str(self._obj.dtype) if dtype is None else dtype
+        extra_dim = self._check_dimensions()
+        count = 1
+        if extra_dim is not None:
+            count = self._obj[extra_dim].size
+        with rasterio.open(
+            raster_path,
+            "w",
+            driver=driver,
+            height=int(height),
+            width=int(width),
+            count=count,
+            dtype=dtype,
+            crs=self.crs,
+            transform=self.transform(recalc=True),
+            nodata=self.nodata,
+            **profile_kwargs,
+        ) as dst:
+            data = self._obj.values.astype(dtype)
+            if data.ndim == 2:
+                dst.write(data, 1)
+            else:
+                dst.write(data)
+            if tags is not None:
+                dst.update_tags(**tags)
    
 
 
 
    [docs]@xarray.register_dataset_accessor("rio")
@@ -1018,13 +1092,11 @@ 
    Source code for rioxarray.rioxarray
           ');
-    }
-    // Prettify the comment rating.
-    comment.pretty_rating = comment.rating + ' point' +
-      (comment.rating == 1 ? '' : 's');
-    // Make a class (for displaying not yet moderated comments differently)
-    comment.css_class = comment.displayed ? '' : ' moderate';
-    // Create a div for this comment.
-    var context = $.extend({}, opts, comment);
-    var div = $(renderTemplate(commentTemplate, context));
-
-    // If the user has voted on this comment, highlight the correct arrow.
-    if (comment.vote) {
-      var direction = (comment.vote == 1) ? 'u' : 'd';
-      div.find('#' + direction + 'v' + comment.id).hide();
-      div.find('#' + direction + 'u' + comment.id).show();
-    }
-
-    if (opts.moderator || comment.text != '[deleted]') {
-      div.find('a.reply').show();
-      if (comment.proposal_diff)
-        div.find('#sp' + comment.id).show();
-      if (opts.moderator && !comment.displayed)
-        div.find('#cm' + comment.id).show();
-      if (opts.moderator || (opts.username == comment.username))
-        div.find('#dc' + comment.id).show();
-    }
-    return div;
-  }
-
-  /**
-   * A simple template renderer. Placeholders such as <%id%> are replaced
-   * by context['id'] with items being escaped. Placeholders such as <#id#>
-   * are not escaped.
-   */
-  function renderTemplate(template, context) {
-    var esc = $(document.createElement('div'));
-
-    function handle(ph, escape) {
-      var cur = context;
-      $.each(ph.split('.'), function() {
-        cur = cur[this];
-      });
-      return escape ? esc.text(cur || "").html() : cur;
-    }
-
-    return template.replace(/<([%#])([\w\.]*)\1>/g, function() {
-      return handle(arguments[2], arguments[1] == '%' ? true : false);
-    });
-  }
-
-  /** Flash an error message briefly. */
-  function showError(message) {
-    $(document.createElement('div')).attr({'class': 'popup-error'})
-      .append($(document.createElement('div'))
-               .attr({'class': 'error-message'}).text(message))
-      .appendTo('body')
-      .fadeIn("slow")
-      .delay(2000)
-      .fadeOut("slow");
-  }
-
-  /** Add a link the user uses to open the comments popup. */
-  $.fn.comment = function() {
-    return this.each(function() {
-      var id = $(this).attr('id').substring(1);
-      var count = COMMENT_METADATA[id];
-      var title = count + ' comment' + (count == 1 ? '' : 's');
-      var image = count > 0 ? opts.commentBrightImage : opts.commentImage;
-      var addcls = count == 0 ? ' nocomment' : '';
-      $(this)
-        .append(
-          $(document.createElement('a')).attr({
-            href: '#',
-            'class': 'sphinx-comment-open' + addcls,
-            id: 'ao' + id
-          })
-            .append($(document.createElement('img')).attr({
-              src: image,
-              alt: 'comment',
-              title: title
-            }))
-            .click(function(event) {
-              event.preventDefault();
-              show($(this).attr('id').substring(2));
-            })
-        )
-        .append(
-          $(document.createElement('a')).attr({
-            href: '#',
-            'class': 'sphinx-comment-close hidden',
-            id: 'ah' + id
-          })
-            .append($(document.createElement('img')).attr({
-              src: opts.closeCommentImage,
-              alt: 'close',
-              title: 'close'
-            }))
-            .click(function(event) {
-              event.preventDefault();
-              hide($(this).attr('id').substring(2));
-            })
-        );
-    });
-  };
-
-  var opts = {
-    processVoteURL: '/_process_vote',
-    addCommentURL: '/_add_comment',
-    getCommentsURL: '/_get_comments',
-    acceptCommentURL: '/_accept_comment',
-    deleteCommentURL: '/_delete_comment',
-    commentImage: '/static/_static/comment.png',
-    closeCommentImage: '/static/_static/comment-close.png',
-    loadingImage: '/static/_static/ajax-loader.gif',
-    commentBrightImage: '/static/_static/comment-bright.png',
-    upArrow: '/static/_static/up.png',
-    downArrow: '/static/_static/down.png',
-    upArrowPressed: '/static/_static/up-pressed.png',
-    downArrowPressed: '/static/_static/down-pressed.png',
-    voting: false,
-    moderator: false
-  };
-
-  if (typeof COMMENT_OPTIONS != "undefined") {
-    opts = jQuery.extend(opts, COMMENT_OPTIONS);
-  }
-
-  var popupTemplate = '\
-    
    \
-      
    \
-        Sort by:\
-        best rated\
-        newest\
-        oldest\
-      
    \
-      
    Comments
    \
-      
    \
-        loading comments... 
    \
-      
      \
-      
      \
-      
      Add a comment\
-        (markup):
      \
-      
      \
-        reStructured text markup: *emph*, **strong**, \
-        ``code``, \
-        code blocks: :: and an indented block after blank line
      \
-      
      \
-        \
-        
      \
-          \
-            Propose a change ▹\
-          \
-          \
-            Propose a change ▿\
-          \
-        
      \
-        \
-        \
-        \
-        \
-      
      \
-      
      \
-    
      ';
-
-  var commentTemplate = '\
-    
      \
-      
      \
-        
      \
-          \
-            \
-          \
-          \
-            \
-          \
-        
      \
-        
      \
-          \
-            \
-          \
-          \
-            \
-          \
-        
      \
-      
      \
-      
      \
-        
      \
-          <%username%>\
-          <%pretty_rating%>\
-          <%time.delta%>\
-        
      \
-        
      <#text#>
      \
-        
      \
-          \
-          reply ▿\
-          proposal ▹\
-          proposal ▿\
-          \
-          \
-        
      \
-        
      \
-<#proposal_diff#>\
-        
      \
-          
        \
-        
        \
-        
        \
-      
        \
-    
        ';
-
-  var replyTemplate = '\
-    
      • \
-      
        \
-        
        \
-          \
-          \
-          \
-          \
-          \
-        
        \
-      
        \
-    
        • ';
-
-  $(document).ready(function() {
-    init();
-  });
-})(jQuery);
-
-$(document).ready(function() {
-  // add comment anchors for all paragraphs that are commentable
-  $('.sphinx-has-comment').comment();
-
-  // highlight search words in search results
-  $("div.context").each(function() {
-    var params = $.getQueryParameters();
-    var terms = (params.q) ? params.q[0].split(/\s+/) : [];
-    var result = $(this);
-    $.each(terms, function() {
-      result.highlightText(this.toLowerCase(), 'highlighted');
-    });
-  });
-
-  // directly open comment window if requested
-  var anchor = document.location.hash;
-  if (anchor.substring(0, 9) == '#comment-') {
-    $('#ao' + anchor.substring(9)).click();
-    document.location.hash = '#s' + anchor.substring(9);
-  }
-});
diff --git a/docs/html/authors.html b/docs/html/authors.html
index 0a6c8ee6..fbb1e719 100644
--- a/docs/html/authors.html
+++ b/docs/html/authors.html
@@ -1,12 +1,10 @@
 
-
+
 
 
   
-    
-    
-    Credits — rioxarray 0.0.3 documentation
+    
+    Credits — rioxarray 0.0.4 documentation
     
     
     
@@ -34,7 +32,7 @@ 
        Navigation
        
         
      • 
           previous |
        • 
-        
      • rioxarray 0.0.3 documentation »
        •  
+        
      • rioxarray 0.0.4 documentation »
        •  
       
     
          
 
@@ -48,13 +46,14 @@ 
        Credits
 
        Development Lead
        
 
 
        
 
        
 
        Contributors
        
 
 
        
 
        
@@ -88,13 +87,11 @@ 
        This Page
        @@ -118,12 +115,12 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
        • \ No newline at end of file diff --git a/docs/html/contributing.html b/docs/html/contributing.html index 91edc754..cb4b964b 100644 --- a/docs/html/contributing.html +++ b/docs/html/contributing.html @@ -1,12 +1,10 @@ - + - - - Contributing — rioxarray 0.0.3 documentation + + Contributing — rioxarray 0.0.4 documentation @@ -34,7 +32,7 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
        • @@ -55,9 +53,9 @@

        Report Bugshttps://github.com/corteva/rioxarray/issues.

        If you are reporting a bug, please include:

        @@ -81,10 +79,10 @@

        Submit Feedbackhttps://github.com/corteva/rioxarray/issues.

        If you are proposing a feature:

          -
        • Explain in detail how it would work.
          • -
        • Keep the scope as narrow as possible, to make it easier to implement.
          • -
        • Remember that this is a volunteer-driven project, and that contributions -are welcome :)
          • +

        • Explain in detail how it would work.

          • +

        • Keep the scope as narrow as possible, to make it easier to implement.

          • +

        • Remember that this is a volunteer-driven project, and that contributions +are welcome :)

        @@ -92,27 +90,26 @@

        Submit Feedback

        Ready to contribute? Here’s how to set up rioxarray for local development.

          -

        1. Fork the rioxarray repo on GitHub.

          -
          2. -

        2. Clone your fork locally:

          +

        3. Fork the rioxarray repo on GitHub.

          4. +

        4. Clone your fork locally:

          $ git clone git@github.com:your_name_here/rioxarray.git
          5. -

        5. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

          +

        6. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

          $ python -m venv rioxarray_env
 $ cd rioxarray/
 $ python setup.py develop
          7. -

        7. Create a branch for local development:

          +

        8. Create a branch for local development:

          $ git checkout -b name-of-your-bugfix-or-feature

          Now you can make your changes locally.

          9. -

        9. When you’re done making changes, check that your changes pass flake8, are black formatter, +

        10. When you’re done making changes, check that your changes pass flake8, are black formatter, and the tests pass:

          $ flake8 rioxarray test
 $ black --check .
@@ -121,26 +118,25 @@ 
          Get Started!Commit your changes and push your branch to GitLab:
          
+
        11. Commit your changes and push your branch to GitLab:
          
 
          $ git add .
 $ git commit -m "Your detailed description of your changes."
 $ git push origin name-of-your-bugfix-or-feature
 
          
 
          
 
          12. 
-
        12. Submit a pull request through the GitHub website.
          
-
          13. 
+
        13. Submit a pull request through the GitHub website.
          14.

        Pull Request Guidelines

        Before you submit a pull request, check that it meets these guidelines:

          -
        1. The pull request should include tests.
          2. -
        2. If the pull request adds functionality, the docs should be updated. Put +

        3. The pull request should include tests.

          4. +

        4. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the -feature to the list in README.rst.

          5. -
        5. The pull request should work for Python 3.5, 3.6, and 3.7.
          6. +feature to the list in README.rst.

          +

        6. The pull request should work for Python 3.5, 3.6, and 3.7.

        @@ -190,13 +186,11 @@

        This Page

        @@ -220,12 +214,12 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
        • \ No newline at end of file diff --git a/docs/html/examples/clip_box.html b/docs/html/examples/clip_box.html index d0d020fd..11445b0b 100644 --- a/docs/html/examples/clip_box.html +++ b/docs/html/examples/clip_box.html @@ -1,12 +1,10 @@ - + - - - Example - Clip Box — rioxarray 0.0.3 documentation + + Example - Clip Box — rioxarray 0.0.4 documentation @@ -34,7 +32,7 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
      • Usage Examples »
        • @@ -441,13 +439,11 @@

        This Page

        @@ -471,13 +467,13 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
      • Usage Examples »
        • \ No newline at end of file diff --git a/docs/html/examples/clip_geom.html b/docs/html/examples/clip_geom.html index 2238c18f..06956980 100644 --- a/docs/html/examples/clip_geom.html +++ b/docs/html/examples/clip_geom.html @@ -1,12 +1,10 @@ - + - - - Example - Clip — rioxarray 0.0.3 documentation + + Example - Clip — rioxarray 0.0.4 documentation @@ -34,7 +32,7 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
      • Usage Examples »
        • @@ -455,13 +453,11 @@

        This Page

        @@ -485,13 +481,13 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
      • Usage Examples »
        • \ No newline at end of file diff --git a/docs/html/examples/examples.html b/docs/html/examples/examples.html index 4ea26353..af39c7ed 100644 --- a/docs/html/examples/examples.html +++ b/docs/html/examples/examples.html @@ -1,12 +1,10 @@ - + - - - Usage Examples — rioxarray 0.0.3 documentation + + Usage Examples — rioxarray 0.0.4 documentation @@ -34,7 +32,7 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
        • @@ -79,13 +77,11 @@

        This Page

        @@ -109,12 +105,12 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
        • \ No newline at end of file diff --git a/docs/html/examples/interpolate_na.html b/docs/html/examples/interpolate_na.html index 086d037a..7d979f1b 100644 --- a/docs/html/examples/interpolate_na.html +++ b/docs/html/examples/interpolate_na.html @@ -1,12 +1,10 @@ - + - - - Example - Interpolate Missing Data — rioxarray 0.0.3 documentation + + Example - Interpolate Missing Data — rioxarray 0.0.4 documentation @@ -34,7 +32,7 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
      • Usage Examples »
        • @@ -441,13 +439,11 @@

        This Page

        @@ -471,13 +467,13 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
      • Usage Examples »
        • \ No newline at end of file diff --git a/docs/html/examples/reproject.html b/docs/html/examples/reproject.html index 4e77b49b..12864f8f 100644 --- a/docs/html/examples/reproject.html +++ b/docs/html/examples/reproject.html @@ -1,12 +1,10 @@ - + - - - Example - Reproject — rioxarray 0.0.3 documentation + + Example - Reproject — rioxarray 0.0.4 documentation @@ -34,7 +32,7 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
      • Usage Examples »
        • @@ -430,13 +428,11 @@

        This Page

        @@ -460,13 +456,13 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
      • Usage Examples »
        • \ No newline at end of file diff --git a/docs/html/examples/reproject_match.html b/docs/html/examples/reproject_match.html index 6b11a733..3c0cca1d 100644 --- a/docs/html/examples/reproject_match.html +++ b/docs/html/examples/reproject_match.html @@ -1,12 +1,10 @@ - + - - - Example - Reproject Match — rioxarray 0.0.3 documentation + + Example - Reproject Match — rioxarray 0.0.4 documentation @@ -34,7 +32,7 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
      • Usage Examples »
        • @@ -511,13 +509,11 @@

        This Page

        @@ -541,13 +537,13 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
      • Usage Examples »
        • \ No newline at end of file diff --git a/docs/html/examples/transform_bounds.html b/docs/html/examples/transform_bounds.html index 0fe641cd..900a8d00 100644 --- a/docs/html/examples/transform_bounds.html +++ b/docs/html/examples/transform_bounds.html @@ -1,12 +1,10 @@ - + - - - Example - Transform Bounds — rioxarray 0.0.3 documentation + + Example - Transform Bounds — rioxarray 0.0.4 documentation @@ -34,7 +32,7 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
      • Usage Examples »
        • @@ -373,13 +371,11 @@

        This Page

        @@ -403,13 +399,13 @@

        Navigation

      • previous |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
      • Usage Examples »
        • \ No newline at end of file diff --git a/docs/html/genindex.html b/docs/html/genindex.html index b42ed054..f2e9c1f7 100644 --- a/docs/html/genindex.html +++ b/docs/html/genindex.html @@ -1,13 +1,11 @@ - + - - - Index — rioxarray 0.0.3 documentation + + Index — rioxarray 0.0.4 documentation @@ -27,7 +25,7 @@

        Navigation

      • modules |
        • -
      • rioxarray 0.0.3 documentation »
        • +
      • rioxarray 0.0.4 documentation »
        • @@ -92,12 +90,12 @@

        C

        +

        N

          @@ -174,7 +176,7 @@

          R

          S

          \ No newline at end of file diff --git a/docs/html/history.html b/docs/html/history.html index 47338d26..1af4515b 100644 --- a/docs/html/history.html +++ b/docs/html/history.html @@ -1,12 +1,10 @@ - + - - - History — rioxarray 0.0.3 documentation + + History — rioxarray 0.0.4 documentation @@ -30,7 +28,7 @@

          Navigation

        • previous |
          • -
        • rioxarray 0.0.3 documentation »
          • +
        • rioxarray 0.0.4 documentation »
          • @@ -41,7 +39,12 @@

          Navigation

          History

          -

          In pre-release stages now.

          +
          +

          0.0.4

          +
            +

          • Added ability to export data array to raster (pull #8)

            • +
          +
          @@ -50,6 +53,14 @@

          History
          +

          Table of Contents

          + +

          Previous topic

          Credits

          @@ -61,13 +72,11 @@

          This Page

          @@ -88,12 +97,12 @@

          Navigation

        • previous |
          • -
        • rioxarray 0.0.3 documentation »
          • +
        • rioxarray 0.0.4 documentation »
          • \ No newline at end of file diff --git a/docs/html/index.html b/docs/html/index.html index 5b0b3259..7ece7f96 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -1,12 +1,10 @@ - + - - - Welcome to rioxarray’s documentation! — rioxarray 0.0.3 documentation + + Welcome to rioxarray’s documentation! — rioxarray 0.0.4 documentation @@ -30,7 +28,7 @@

          Navigation

        • next |
          • -
        • rioxarray 0.0.3 documentation »
          • +
        • rioxarray 0.0.4 documentation »
          • @@ -58,9 +56,9 @@

          Welcome to rioxarray’s documentation!

          Indices and tables

          @@ -87,13 +85,11 @@

          This Page

          @@ -114,12 +110,12 @@

          Navigation

        • next |
          • -
        • rioxarray 0.0.3 documentation »
          • +
        • rioxarray 0.0.4 documentation »
          • \ No newline at end of file diff --git a/docs/html/installation.html b/docs/html/installation.html index bdeae4c4..fb2e80b4 100644 --- a/docs/html/installation.html +++ b/docs/html/installation.html @@ -1,12 +1,10 @@ - + - - - Installation — rioxarray 0.0.3 documentation + + Installation — rioxarray 0.0.4 documentation @@ -34,7 +32,7 @@

          Navigation

        • previous |
          • -
        • rioxarray 0.0.3 documentation »
          • +
        • rioxarray 0.0.4 documentation »
          • @@ -96,13 +94,11 @@

          This Page

          @@ -126,12 +122,12 @@

          Navigation

        • previous |
          • -
        • rioxarray 0.0.3 documentation »
          • +
        • rioxarray 0.0.4 documentation »
          • \ No newline at end of file diff --git a/docs/html/modules.html b/docs/html/modules.html index 8f3458ee..63f1c643 100644 --- a/docs/html/modules.html +++ b/docs/html/modules.html @@ -1,12 +1,10 @@ - + - - - rioxarray — rioxarray 0.0.3 documentation + + rioxarray — rioxarray 0.0.4 documentation @@ -34,7 +32,7 @@

          Navigation

        • previous |
          • -
        • rioxarray 0.0.3 documentation »
          • +
        • rioxarray 0.0.4 documentation »
          • @@ -77,13 +75,11 @@

          This Page

          @@ -107,12 +103,12 @@

          Navigation

        • previous |
          • -
        • rioxarray 0.0.3 documentation »
          • +
        • rioxarray 0.0.4 documentation »
          • \ No newline at end of file diff --git a/docs/html/objects.inv b/docs/html/objects.inv index ddc6ea65a78c09dd3b3f9d0a6ca41139ede729de..323f84d8747a9886cf162f4034adca88899d298d 100644 GIT binary patch delta 2020 zcmV;+8LOp+S+cp&4`zz2y&YDIDOdDtjsZZ2Uy$k zBKG-8+u_duUNF;JBvudecty9*Y;6&0|S( zaySP^vZ2StJZy1yNFjeO4>U&tCk0x{R?tkYx1}r$9~k`$r{Zix$sURHWjP(Ed8rou zLMEP*6eq{iQXY9DX6-F!5fMWL-%_?e8&R@!yBT+`S)0E0U$|jSmStPEWn#+*SH~;TXKY(a>sp~E$)sS!IiwQaP6>wTp%WJ=A$#ApX3AJ zNnihDVI})Rj@3wSF%qSGK>Nro9`}t2+|?#aq(hnKkm0{e%mv()B*VGf3*K-px3AI; z9W7Cvkgjr_=tap@F(?K4wwFI2_VS9D_3Ej z>3}(;TiCT!FCRWeyVrAN26StzcWJgnePcvmn9;PXmIG4vHBU&J%eTq~ZcN+7 zB|f5Ro$<@&B(WxkQ?cpuk3nkx-)b{};JP}@T+ySGZ&m$-C6@vrg6a%bT~;TTfJm!r zr?-l%S^$3nO^dvkkW$+rgi2JXhTGOnsgb>n8i1Ul43YxsXA#WmV`NC=&vw_!3`ha$ zciGxJRItNz@1IkJvP`O*tv{oc9Se2}iqW6W*0nd4jdemme;&gk_a`yDv+=Xn#hg2R z&BgdpJcg*L`-7t$Zu-O>Oe>PT4`EX{Cu9GhKe>Ot2GGGGyYE`T1L11+s}r^-mNEH8 zGu&$iHOAp`j8$RCfwdf1$vK1KEs@XMN}wWrBjN=PUYEiJ-+8$z1ZWVTLV!NPCpT)v z+ceHy_U((>@(_owmGx@l1T`%VAo!B_RQ z+pR@d-A7OKo@>?mZvAfk>xH~cXZSc4sLg*$-Zz}5^56vo?Y^7*!a?sv;wOV>C9g;- z-)>NmK~ZIPxQp8cz1JonO+cGW?l&z43JO~>kWak`8PS5AgS#tV{PSG>v<;upsz&kN zu#CM|TSoVg(~_mw!_Wig^d4PUWKSBNT;!=Mn z)hs94ra=u~I~6^LRhPDNx*8aRgkhBJ@i=I0@5cm>w;yjFZcQ)yS31Lc{E^OZ?pB{R zx>-g@i>U7V=cqTm@0^D30i{3WF@E6OBshC%^eINWL;shCcq18U_o#q|pVb%`-m#E; z(JgDsu-RjGQ(Di$WXLhvJB!XLh@gKsLnl{*JF1bCC%OzGYm)L*l|h8*@K#fVLxZ&H zj4&x|$Ab`&gDQ;xOpq*E;H)d#sB@^%;;h9V!N?$?tr4r5kZ6g6nvwuakSwl>OkV3E z6YI-Wh&p?%N;ot~tDtm`ic{9rute(|m%)U=-1^)JzA$la{{T#=tX|4+j;?F z*)RRgP4r2tq(}lqI9Q#SC?d zBor8}k}aFu{_)a@iIp|=(KS-xfGQ3itGg~@TcWq72!qAyb9_~dl-RKZBWDXuET6*W z%B{H~@$u5zQom)YTbgiatk!?Fm~e^GmLwDytFkLqTq3h$2}VW>Z9h0J656r^BWDXu z&hUUAk;OWMtB-qIaFvC65z&H{oI`rWreUyo`WBo321pGnL**&tNBxU-y0 z9HqFi4)N-jKL5uxzY*94au=NfT-C+V9`PMe^~cLpD~d2!h`ys1xEX)t2?B(fRneaI zNGY@S{IJYA023=qmtHRsrWt}z7j-SLikH#US?fG1+O5H!>fcf2n&}%}J~%F+a`QM# z)<*SAR*uQiDMw+8m1t&t(>UjDWe=!xab@qP`NB#toT+jvd2~vDhYOXm?Qes|+9Xru z<%O9duftmN>K$E;@+4Td|NH0PQNDMSN^Pko6TN$ySvqq#!KOj`Jm~*$sJm4sFU=^9 zRH%_Wtbvp1%YKfl@$jVxIYw;wEYvpb@ub_oR@k!IGD&Zb`AQ0v3v68mo9=&v44`ry CLilL_ delta 1937 zcmV;C2X6St5cLm`K>;(7LOp+y+$I#=&sX5;RAt3Xy!FoWa;9n~am_ffcPd(e14$r2>V>DI%em(s@o13lH6!$h7(=JalyOj=J{)LP|0mk64?eHXR+t}0SNXaU}j35K5dnBuYq#s}?PFMofdw@9Fe;+j@P zrkJ|MZ~>RU7xG?O#s46=V1E*bp`r(&(5jwm@Gk-n~{<20|-^k2!ubCTlZcv{ON7%KRV zvcuVklC^8a__bKHVjKUJtIcFtx86FYl`F30IoFzN`OdIdCRA&eOH23zE$*~$n(12d zESO4$_lkitS@0#h9t*RvS%bqkW893`bci{k z24NMG;U74sr95Z}m}8X9@Jyh$y#YK*!^KsnSss<9T{CFa{bN|B-W${4p&DX6ygPD) z+iK5!oE`3-9KnCJys&WXv4C74CUEAXGohd4X7Hk~-&t76q0F)B=^aL*l6$O=+~V=j zn!tTyvP3GYJckVbU12WZz9JdU5mFrm-t+BF)y z+8#*V1vuNH^t+FE41ZDgvb*%XC4eBMSFXZ*k$-IdrxJg2NO!Prsb9BzjCQXtwHeTz zG2f-x67`J{fni3|s-6x={jPaJ+FZWYHgId&F0Swq)$@#BwWo?pQl5(KkbeqN>;F!h z0R%Vo!RDGCoqU`67FJvegb1qhSbbTaVge#A^py3S}8oH`{PTYdaR~ z6cl4PoSo}nC|m1{fZ;fXMIH`f_`}AJULSMm@U<7yt#}GiL-z+qd)z(~cQ9>8_CAD7 z;hc=a6aVb|8bL>s?4fT3PlT({uaDZESjONR&G3Jq8B`yK%Q0q!AqO^cU@hkiig!fr zxwSw=`bNYn9KAP%3%>Vq)dSkXM+b}}?mLDG8Hl$F6 zUm<_YKFB;q)}w>MKG@tVX+;l>`^DWG<1cQrlVJiL&4w@CcR-zr@WwIbLkED(r@sgZ z#*FABz$P0qr|y+-`F?+z?$&LCdcI%v%>ce>uH9}OqH`xjhL6)&+N>gd#d#{vP(aZB z6UfgT4BiRe8AKa-MN;{qf{F}^I!VG^+%|vcgEj$a0@`G9ziBa0P}qrqeD0mbh!*4= z{J8QRKF`&yt^15t)r${?W$L}zF?xWURxHIHrUCR`UITq?AvFy?)&bTdmaB1*KbASJ zKS6q!N9Y%I3!2-DE1l@F98TK?)qUMi3>-FnD$VI?UAojkW;jG6rD8yL2<@Tt_F8hBU!G~o}{qt zo=ySoB7y)+kStorHQ7}aFkMv;EzW;hn-Gi)651KDDp`n@I4XGvzy!(Sss`dmQv+dr z_XtsEFQo{Fy0yCVOJO42{sEX!S%Zw#5?up=5Kxe^aTY9E*_a>%6rxP8Q~$5DuU^K} z9x3HA>bGsS1}6*_t8e;IGg6%*2mviomP|gIFHomQLV?jL*}B0U9*LZoSXqB_-~1vK zj;P|`vAUZ|s5N>UiZEELKF3F`NQpg5Fmkcb#PTI(soaJu5+5(UD;8U)x}yn)#%k@# z(bg#KNJ4?JD*Ix$H8OjaVB}(<$r<*|30bT|xcaz5uB-6Ri-;DqW_ur$6NbT->07bM zPl^@8p$oJw-s;Ut$RJd_xU+w3_>M};SciD^Yq!;DNoNFhh1^w}tE+f4+9Un}RC(z- z)rukv7NYN{1#Tywj01$36|bK5NGXff{J4ZR023=q*VL{NrWt}z7fpqyikH#US;0Cf z#caTyn$Af*lIa^>6gDl4aq~C}ktS6tR*u<%7)QB+m1tqr$~2Q|We&^tIl{`98yT^sf-VK*QYi;vt^76t=d^TaN+0ve_L3#3=|NZmtB=tARs&!PeIllwV zEDuwjVB4U5p7j3*(~s5UvCJrrteBBUYJjtutYNyN_3&kjI7V!|7iydKc+u^jYiw07 XnPjlWe1&4l1$Hi@MfU|iSgwE;rYpMG diff --git a/docs/html/py-modindex.html b/docs/html/py-modindex.html index 47ad5aa3..f7b37438 100644 --- a/docs/html/py-modindex.html +++ b/docs/html/py-modindex.html @@ -1,12 +1,10 @@ - + - - - Python Module Index — rioxarray 0.0.3 documentation + + Python Module Index — rioxarray 0.0.4 documentation @@ -29,7 +27,7 @@

          Navigation

        • modules |
          • -
        • rioxarray 0.0.3 documentation »
          • +
        • rioxarray 0.0.4 documentation »
          • @@ -79,13 +77,11 @@

          Python Module Index

          @@ -56,12 +54,11 @@

          rioxarray READMEhttps://coveralls.io/repos/github/corteva/rioxarray/badge.svg?branch=master

          Credits

          -
          -
          The reproject functionality was adopted from https://github.com/opendatacube/datacube-core
          -
          @@ -127,12 +122,12 @@

          Navigation

        • previous |
          • -
        • rioxarray 0.0.3 documentation »
          • +
        • rioxarray 0.0.4 documentation »
          • \ No newline at end of file diff --git a/docs/html/rioxarray.html b/docs/html/rioxarray.html index 5cfca674..f41182c0 100644 --- a/docs/html/rioxarray.html +++ b/docs/html/rioxarray.html @@ -1,12 +1,10 @@ - + - - - rioxarray package — rioxarray 0.0.3 documentation + + rioxarray package — rioxarray 0.0.4 documentation @@ -34,7 +32,7 @@

          Navigation

        • previous |
          • -
        • rioxarray 0.0.3 documentation »
          • +
        • rioxarray 0.0.4 documentation »
        • rioxarray »
          • @@ -57,54 +55,49 @@

          rioxarray packagehttps://github.com/opendatacube/datacube-core/blob/1d345f08a10a13c316f81100936b0ad8b1a374eb/LICENSE # noqa

          -class rioxarray.rioxarray.RasterArray(xarray_obj)[source]
          +class rioxarray.rioxarray.RasterArray(xarray_obj)[source]

          Bases: rioxarray.rioxarray.XRasterBase

          This is the GIS extension for xarray.DataArray

          -bounds(recalc=False)[source]
          +bounds(recalc=False)[source]

          Determine the bounds of the xarray.DataArray

          - --- - - - - - - - -
          Parameters:recalc (bool, optional) – Will force the bounds to be recalculated instead of using the -transform attribute.
          Returns:left, bottom, right, top – Outermost coordinates.
          Return type:float
          +
          +
          Parameters
          +

          recalc (bool, optional) – Will force the bounds to be recalculated instead of using the +transform attribute.

          +
          +
          Returns
          +

          left, bottom, right, top – Outermost coordinates.

          +
          +
          Return type
          +

          float

          +
          +
          -clip(geometries, crs, all_touched=False)[source]
          +clip(geometries, crs, all_touched=False)[source]

          Crops a xarray.DataArray by geojson like geometry dicts.

          Powered by rasterio.features.geometry_mask.

          - --- - - - - - - - -
          Parameters:
            -
          • geometries (list) – A list of geojson geometry dicts.
            • -
          • crs (rasterio.crs.CRS) – The CRS of the input geometries.
            • -
          • all_touched (boolean, optional) – If True, all pixels touched by geometries will be burned in. If +
            +
            Parameters
            +
              +

            • geometries (list) – A list of geojson geometry dicts.

              • +

            • crs (rasterio.crs.CRS) – The CRS of the input geometries.

              • +

            • all_touched (boolean, optional) – If True, all pixels touched by geometries will be burned in. If false, only pixels whose center is within the polygon or that -are selected by Bresenham’s line algorithm will be burned in.

              • +are selected by Bresenham’s line algorithm will be burned in.

            -
          Returns:

          DataArray

          -
          Return type:

          A clipped xarray.DataArray object.

          -
          +
          +
          Returns
          +

          DataArray

          +
          +
          Return type
          +

          A clipped xarray.DataArray object.

          +
          +

          Examples

          >>> geometry = ''' {"type": "Polygon",
 ...                 "coordinates": [
@@ -122,256 +115,241 @@ 
          rioxarray package
 
          
-clip_box(minx, miny, maxx, maxy, auto_expand=False, auto_expand_limit=3)[source]
          
+clip_box(minx, miny, maxx, maxy, auto_expand=False, auto_expand_limit=3)[source]
 
          Clip the xarray.DataArray by a bounding box.
          
-
---
-
-
-
-
-
-
-
-
          


          Parameters:
            
-
          • minx (float) – Minimum bound for x coordinate.
            • 
-
          • miny (float) – Minimum bound for y coordinate.
            • 
-
          • maxx (float) – Maximum bound for x coordinate.
            • 
-
          • maxy (float) – Maximum bound for y coordinate.
            • 
-
          • auto_expand (bool) – If True, it will expand clip search if only 1D raster found with clip.
            • 
-
          • auto_expand_limit (int) – maximum number of times the clip will be retried before raising
-an exception.
            • 
+
            
+
            Parameters
            
+
              
+
            • minx (float) – Minimum bound for x coordinate.
              • 
+
            • miny (float) – Minimum bound for y coordinate.
              • 
+
            • maxx (float) – Maximum bound for x coordinate.
              • 
+
            • maxy (float) – Maximum bound for y coordinate.
              • 
+
            • auto_expand (bool) – If True, it will expand clip search if only 1D raster found with clip.
              • 
+
            • auto_expand_limit (int) – maximum number of times the clip will be retried before raising
+an exception.
              • 
 
            
-
          Returns:
          DataArray
          
-
          Return type:
          A clipped xarray.DataArray object.
          
-
          
-
          - -
          + +
          Returns
          +

          DataArray

          +
          +
          Return type
          +

          A clipped xarray.DataArray object.

          +
          +
          + + +
          -crs
          -

          Retrieve projection from xarray.DataArray

          - --- - - - -
          Type:rasterio.crs.CRS
          +property crs +

          rasterio.crs.CRS: +Retrieve projection from xarray.DataArray

          -interpolate_na(method='nearest')[source]
          +interpolate_na(method='nearest')[source]

          This method uses scipy.interpolate.griddata to interpolate missing data.

          - --- - - - - - - - -
          Parameters:method ({‘linear’, ‘nearest’, ‘cubic’}, optional) – The method to use for interpolation in scipy.interpolate.griddata.
          Returns::class:`xarray.DataArray`
          Return type:An interpolated xarray.DataArray object.
          -
          - -
          +
          +
          Parameters
          +

          method ({‘linear’, ‘nearest’, ‘cubic’}, optional) – The method to use for interpolation in scipy.interpolate.griddata.

          +
          +
          Returns
          +

          :class:`xarray.DataArray`

          +
          +
          Return type
          +

          An interpolated xarray.DataArray object.

          +
          +
          +
          + +
          -nodata
          +property nodata

          Get the nodata value for the dataset.

          -reproject(dst_crs, resolution=None, dst_affine_width_height=None, resampling=<Resampling.nearest: 0>)[source]
          +reproject(dst_crs, resolution=None, dst_affine_width_height=None, resampling=<Resampling.nearest: 0>)[source]

          Reproject xarray.DataArray objects

          Powered by rasterio.warp.reproject

          -

          Note

          -

          Only 2D/3D arrays with dimensions ‘x’/’y’ are currently supported. +

          Note

          +

          Only 2D/3D arrays with dimensions ‘x’/’y’ are currently supported. Requires either a grid mapping variable with ‘spatial_ref’ or a ‘crs’ attribute to be set containing a valid CRS. If using a WKT (e.g. from spatiareference.org), make sure it is an OGC WKT.

          - --- - - - - - - - -
          Parameters:
            -
          • dst_crs (str) – OGC WKT string or Proj.4 string.
            • -
          • resolution (float or tuple(float, float), optional) – Size of a destination pixel in destination projection units -(e.g. degrees or metres).
            • -
          • dst_affine_width_height (tuple(dst_affine, dst_width, dst_height), optional) – Tuple with the destination affine, width, and height.
            • -
          • resampling (Resampling method, optional) – See rasterio.warp.reproject for more details.
            • +
            +
            Parameters
            +
              +

            • dst_crs (str) – OGC WKT string or Proj.4 string.

              • +

            • resolution (float or tuple(float, float), optional) – Size of a destination pixel in destination projection units +(e.g. degrees or metres).

              • +

            • dst_affine_width_height (tuple(dst_affine, dst_width, dst_height), optional) – Tuple with the destination affine, width, and height.

              • +

            • resampling (Resampling method, optional) – See rasterio.warp.reproject for more details.

            -
          Returns:

          :class:`xarray.DataArray`

          -
          Return type:

          A reprojected DataArray.

          -
          +
          +
          Returns
          +

          :class:`xarray.DataArray`

          +
          +
          Return type
          +

          A reprojected DataArray.

          +
          +
          -reproject_match(match_data_array, resampling=<Resampling.nearest: 0>)[source]
          +reproject_match(match_data_array, resampling=<Resampling.nearest: 0>)[source]

          Reproject a DataArray object to match the resolution, projection, and region of another DataArray.

          Powered by rasterio.warp.reproject

          -

          Note

          -

          Only 2D/3D arrays with dimensions ‘x’/’y’ are currently supported. +

          Note

          +

          Only 2D/3D arrays with dimensions ‘x’/’y’ are currently supported. Requires either a grid mapping variable with ‘spatial_ref’ or a ‘crs’ attribute to be set containing a valid CRS. If using a WKT (e.g. from spatiareference.org), make sure it is an OGC WKT.

          - --- - - - - - - - -
          Parameters:
            -
          • match_data_array (xarray.DataArray) – DataArray of the target resolution and projection.
            • -
          • resampling (Resampling method, optional) – See rasterio.warp.reproject for more details.
            • +
            +
            Parameters
            +
              +

            • match_data_array (xarray.DataArray) – DataArray of the target resolution and projection.

              • +

            • resampling (Resampling method, optional) – See rasterio.warp.reproject for more details.

            -
          Returns:

          Contains the data from the src_data_array, reprojected to match + +

          Returns
          +

          Contains the data from the src_data_array, reprojected to match match_data_array.

          -
          Return type:

          xarray.DataArray

          -
          +
          +
          Return type
          +

          xarray.DataArray

          +
          +
          -resolution(recalc=False)[source]
          +resolution(recalc=False)[source]

          Determine the resolution of the xarray.DataArray

          - --- - - - -
          Parameters:recalc (bool, optional) – Will force the resolution to be recalculated instead of using the -transform attribute.
          +
          +
          Parameters
          +

          recalc (bool, optional) – Will force the resolution to be recalculated instead of using the +transform attribute.

          +
          +
          -slice_xy(minx, miny, maxx, maxy)[source]
          +slice_xy(minx, miny, maxx, maxy)[source]

          Slice the array by x,y bounds.

          - --- - - - - - - - -
          Parameters:
            -
          • minx (float) – Minimum bound for x coordinate.
            • -
          • miny (float) – Minimum bound for y coordinate.
            • -
          • maxx (float) – Maximum bound for x coordinate.
            • -
          • maxy (float) – Maximum bound for y coordinate.
            • +
            +
            Parameters
            +
              +

            • minx (float) – Minimum bound for x coordinate.

              • +

            • miny (float) – Minimum bound for y coordinate.

              • +

            • maxx (float) – Maximum bound for x coordinate.

              • +

            • maxy (float) – Maximum bound for y coordinate.

            -
          Returns:

          DataArray

          -
          Return type:

          A sliced xarray.DataArray object.

          -
          +
          +
          Returns
          +

          DataArray

          +
          +
          Return type
          +

          A sliced xarray.DataArray object.

          +
          +
          + + +
          +
          +to_raster(raster_path, driver='GTiff', dtype=None, tags=None, **profile_kwargs)[source]
          +

          Export the DataArray to a raster file.

          +
          +
          Parameters
          +
            +

          • raster_path (str) – The path to output the raster to.

            • +

          • driver (str, optional) – The name of the GDAL/rasterio driver to use to export the raster. +Default is “GTiff”.

            • +

          • dtype (str, optional) – The data type to write the raster to. Default is the datasets dtype.

            • +

          • tags (dict, optional) – A dictionary of tags to write to the raster.

            • +

          • **profile_kwargs – Additional keyword arguments to pass into writing the raster. The +nodata, transform, crs, count, width, and height attributes +are automatically added.

            • +
          +
          +
          -transform(recalc=False)[source]
          +transform(recalc=False)[source]

          Determine the affine of the xarray.DataArray

          -transform_bounds(dst_crs, densify_pts=21, recalc=False)[source]
          +transform_bounds(dst_crs, densify_pts=21, recalc=False)[source]

          Transform bounds from src_crs to dst_crs.

          Optionally densifying the edges (to account for nonlinear transformations along these edges) and extracting the outermost bounds.

          Note: this does not account for the antimeridian.

          - --- - - - - - - - -
          Parameters:
            -
          • dst_crs (str, rasterio.crs.CRS, or dict) – Target coordinate reference system.
            • -
          • densify_pts (uint, optional) – Number of points to add to each edge to account for nonlinear +
            +
            Parameters
            +
              +

            • dst_crs (str, rasterio.crs.CRS, or dict) – Target coordinate reference system.

              • +

            • densify_pts (uint, optional) – Number of points to add to each edge to account for nonlinear edges produced by the transform process. Large numbers will produce -worse performance. Default: 21 (gdal default).

              • -
            • recalc (bool, optional) – Will force the bounds to be recalculated instead of using the transform -attribute.
              • +worse performance. Default: 21 (gdal default).

              +

            • recalc (bool, optional) – Will force the bounds to be recalculated instead of using the transform +attribute.

            -
          Returns:

          left, bottom, right, top – Outermost coordinates in target coordinate reference system.

          -
          Return type:

          float

          -
          +
          +
          Returns
          +

          left, bottom, right, top – Outermost coordinates in target coordinate reference system.

          +
          +
          Return type
          +

          float

          +
          +
          -class rioxarray.rioxarray.RasterDataset(xarray_obj)[source]
          +class rioxarray.rioxarray.RasterDataset(xarray_obj)[source]

          Bases: rioxarray.rioxarray.XRasterBase

          This is the GIS extension for xarray.Dataset

          -clip(geometries, crs, all_touched=False)[source]
          +clip(geometries, crs, all_touched=False)[source]

          Crops a xarray.Dataset by geojson like geometry dicts.

          -

          Warning

          -

          Only works if all variables in the dataset have the same +

          Warning

          +

          Only works if all variables in the dataset have the same coordinates.

          Powered by rasterio.features.geometry_mask.

          - --- - - - - - - - -
          Parameters:
            -
          • geometries (list) – A list of geojson geometry dicts.
            • -
          • crs (rasterio.crs.CRS) – The CRS of the input geometries.
            • -
          • all_touched (boolean, optional) – If True, all pixels touched by geometries will be burned in. If +
            +
            Parameters
            +
              +

            • geometries (list) – A list of geojson geometry dicts.

              • +

            • crs (rasterio.crs.CRS) – The CRS of the input geometries.

              • +

            • all_touched (boolean, optional) – If True, all pixels touched by geometries will be burned in. If false, only pixels whose center is within the polygon or that -are selected by Bresenham’s line algorithm will be burned in.

              • +are selected by Bresenham’s line algorithm will be burned in.

            -
          Returns:

          Dataset

          -
          Return type:

          A clipped xarray.Dataset object.

          -
          +
          +
          Returns
          +

          Dataset

          +
          +
          Return type
          +

          A clipped xarray.Dataset object.

          +
          +

          Examples

          >>> geometry = ''' {"type": "Polygon",
 ...                 "coordinates": [
@@ -389,225 +367,188 @@ 
          rioxarray package
 
          
-clip_box(minx, miny, maxx, maxy, auto_expand=False, auto_expand_limit=3)[source]
          
+clip_box(minx, miny, maxx, maxy, auto_expand=False, auto_expand_limit=3)[source]
 
          Clip the xarray.Dataset by a bounding box.
          
 
          
-
          Warning
          
-
          Only works if all variables in the dataset have the
+
          Warning
          
+
          Only works if all variables in the dataset have the
 same coordinates.
          
 
          
-
---
-
-
-
-
-
-
-
-
          


          Parameters:
            
-
          • minx (float) – Minimum bound for x coordinate.
            • 
-
          • miny (float) – Minimum bound for y coordinate.
            • 
-
          • maxx (float) – Maximum bound for x coordinate.
            • 
-
          • maxy (float) – Maximum bound for y coordinate.
            • 
-
          • auto_expand (bool) – If True, it will expand clip search if only 1D raster found with clip.
            • 
-
          • auto_expand_limit (int) – maximum number of times the clip will be retried before raising
-an exception.
            • 
+
            
+
            Parameters
            
+
              
+
            • minx (float) – Minimum bound for x coordinate.
              • 
+
            • miny (float) – Minimum bound for y coordinate.
              • 
+
            • maxx (float) – Maximum bound for x coordinate.
              • 
+
            • maxy (float) – Maximum bound for y coordinate.
              • 
+
            • auto_expand (bool) – If True, it will expand clip search if only 1D raster found with clip.
              • 
+
            • auto_expand_limit (int) – maximum number of times the clip will be retried before raising
+an exception.
              • 
 
            
-
          Returns:
          DataArray
          
-
          Return type:
          A clipped xarray.Dataset object.
          
-
          
-
          - -
          + +
          Returns
          +

          DataArray

          +
          +
          Return type
          +

          A clipped xarray.Dataset object.

          +
          +
          + + +
          -crs
          -

          Retrieve projection from xarray.Dataset

          - --- - - - -
          Type:rasterio.crs.CRS
          +property crs +

          rasterio.crs.CRS: +Retrieve projection from xarray.Dataset

          -interpolate_na(method='nearest')[source]
          +interpolate_na(method='nearest')[source]

          This method uses scipy.interpolate.griddata to interpolate missing data.

          - --- - - - - - - - -
          Parameters:method ({‘linear’, ‘nearest’, ‘cubic’}, optional) – The method to use for interpolation in scipy.interpolate.griddata.
          Returns::class:`xarray.DataArray`
          Return type:An interpolated xarray.DataArray object.
          +
          +
          Parameters
          +

          method ({‘linear’, ‘nearest’, ‘cubic’}, optional) – The method to use for interpolation in scipy.interpolate.griddata.

          +
          +
          Returns
          +

          :class:`xarray.DataArray`

          +
          +
          Return type
          +

          An interpolated xarray.DataArray object.

          +
          +
          -reproject(dst_crs, resolution=None, dst_affine_width_height=None, resampling=<Resampling.nearest: 0>)[source]
          +reproject(dst_crs, resolution=None, dst_affine_width_height=None, resampling=<Resampling.nearest: 0>)[source]

          Reproject xarray.Dataset objects

          -

          Note

          -

          Only 2D/3D arrays with dimensions ‘x’/’y’ are currently supported. +

          Note

          +

          Only 2D/3D arrays with dimensions ‘x’/’y’ are currently supported. Requires either a grid mapping variable with ‘spatial_ref’ or a ‘crs’ attribute to be set containing a valid CRS. If using a WKT (e.g. from spatiareference.org), make sure it is an OGC WKT.

          - --- - - - - - - - -
          Parameters:
            -
          • dst_crs (str) – OGC WKT string or Proj.4 string.
            • -
          • resolution (float or tuple(float, float), optional) – Size of a destination pixel in destination projection units -(e.g. degrees or metres).
            • -
          • dst_affine_width_height (tuple(dst_affine, dst_width, dst_height), optional) – Tuple with the destination affine, width, and height.
            • -
          • resampling (Resampling method, optional) – See rasterio.warp.reproject for more details.
            • +
            +
            Parameters
            +
              +

            • dst_crs (str) – OGC WKT string or Proj.4 string.

              • +

            • resolution (float or tuple(float, float), optional) – Size of a destination pixel in destination projection units +(e.g. degrees or metres).

              • +

            • dst_affine_width_height (tuple(dst_affine, dst_width, dst_height), optional) – Tuple with the destination affine, width, and height.

              • +

            • resampling (Resampling method, optional) – See rasterio.warp.reproject for more details.

            -
          Returns:

          :class:`xarray.Dataset`

          -
          Return type:

          A reprojected Dataset.

          -
          +
          +
          Returns
          +

          :class:`xarray.Dataset`

          +
          +
          Return type
          +

          A reprojected Dataset.

          +
          +
          -reproject_match(match_data_array, resampling=<Resampling.nearest: 0>)[source]
          +reproject_match(match_data_array, resampling=<Resampling.nearest: 0>)[source]

          Reproject a Dataset object to match the resolution, projection, and region of another DataArray.

          -

          Note

          -

          Only 2D/3D arrays with dimensions ‘x’/’y’ are currently supported. +

          Note

          +

          Only 2D/3D arrays with dimensions ‘x’/’y’ are currently supported. Requires either a grid mapping variable with ‘spatial_ref’ or a ‘crs’ attribute to be set containing a valid CRS. If using a WKT (e.g. from spatiareference.org), make sure it is an OGC WKT.

          - --- - - - - - - - -
          Parameters:
            -
          • match_data_array (xarray.DataArray) – DataArray of the target resolution and projection.
            • -
          • resampling (Resampling method, optional) – See rasterio.warp.reproject for more details.
            • +
            +
            Parameters
            +
              +

            • match_data_array (xarray.DataArray) – DataArray of the target resolution and projection.

              • +

            • resampling (Resampling method, optional) – See rasterio.warp.reproject for more details.

            -
          Returns:

          Contains the data from the src_data_array, + +

          Returns
          +

          Contains the data from the src_data_array, reprojected to match match_data_array.

          -
          Return type:

          xarray.Dataset

          -
          +
          +
          Return type
          +

          xarray.Dataset

          +
          +
          -
          +
          -vars
          +property vars

          Returns non-coordinate varibles

          - --- - - - -
          Type:list
          +
          +
          Type
          +

          list

          +
          +
          -class rioxarray.rioxarray.XRasterBase(xarray_obj)[source]
          +class rioxarray.rioxarray.XRasterBase(xarray_obj)[source]

          Bases: object

          This is the base class for the GIS extensions for xarray

          -
          +
          -crs
          -

          The projection of the dataset.

          - --- - - - -
          Type:rasterio.crs.CRS
          -
          - -
          +abstract property crs +

          rasterio.crs.CRS: +The projection of the dataset.

          +
          + +
          -shape
          +property shape

          Returns the shape (x_size, y_size)

          - --- - - - -
          Type:tuple
          +
          +
          Type
          +

          tuple

          +
          +
          -rioxarray.rioxarray.add_spatial_ref(in_ds, dst_crs, grid_map_name)[source]
          +rioxarray.rioxarray.add_spatial_ref(in_ds, dst_crs, grid_map_name)[source]
          -rioxarray.rioxarray.add_xy_grid_meta(coords)[source]
          +rioxarray.rioxarray.add_xy_grid_meta(coords)[source]

          Add x,y metadata to coordinates

          -rioxarray.rioxarray.affine_to_coords(affine, width, height, x_dim='x', y_dim='y')[source]
          +rioxarray.rioxarray.affine_to_coords(affine, width, height, x_dim='x', y_dim='y')[source]

          Generate 1d pixel centered coordinates from affine.

          Based on code from the xarray rasterio backend.

          - --- - - - - - - - -
          Parameters:
            -
          • affine (affine.Affine) – The affine of the grid.
            • -
          • width (int) – The width of the grid.
            • -
          • height (int) – The height of the grid.
            • -
          • x_dim (str, optional) – The name of the X dimension. Default is ‘x’.
            • -
          • y_dim (str, optional) – The name of the Y dimension. Default is ‘y’.
            • +
            +
            Parameters
            +
              +

            • affine (affine.Affine) – The affine of the grid.

              • +

            • width (int) – The width of the grid.

              • +

            • height (int) – The height of the grid.

              • +

            • x_dim (str, optional) – The name of the X dimension. Default is ‘x’.

              • +

            • y_dim (str, optional) – The name of the Y dimension. Default is ‘y’.

            -
          Returns:

          dict

          -
          Return type:

          x and y coordinate arrays.

          -
          +
          +
          Returns
          +

          dict

          +
          +
          Return type
          +

          x and y coordinate arrays.

          +
          +
          @@ -616,54 +557,67 @@

          rioxarray package
          -rioxarray.crs.crs_to_wkt(rasterio_crs)[source]
          +rioxarray.crs.crs_to_wkt(rasterio_crs)[source]

          This is to deal with change in rasterio.crs.CRS.

          - --- - - - - - - - -
          Parameters:rasterio_crs (rasterio.crs.CRS) – Rasterio object.
          Returns:str
          Return type:WKT string.
          +
          +
          Parameters
          +

          rasterio_crs (rasterio.crs.CRS) – Rasterio object.

          +
          +
          Returns
          +

          str

          +
          +
          Return type
          +

          WKT string.

          +
          +

          rioxarray.exceptions module

          This contains exceptions for rioxarray.

          +
          +
          +exception rioxarray.exceptions.InvalidDimensionOrder[source]
          +

          Bases: rioxarray.exceptions.RioXarrayError

          +

          This is raised when there the dimensions are not ordered correctly.

          +
          +
          -exception rioxarray.exceptions.NoDataInBounds[source]
          +exception rioxarray.exceptions.NoDataInBounds[source]

          Bases: rioxarray.exceptions.RioXarrayError

          This is for when there are no data in the bounds for clipping a raster.

          -exception rioxarray.exceptions.OneDimensionalRaster[source]
          +exception rioxarray.exceptions.OneDimensionalRaster[source]

          Bases: rioxarray.exceptions.RioXarrayError

          This is an error when you have a 1 dimensional raster.

          -exception rioxarray.exceptions.RioXarrayError[source]
          +exception rioxarray.exceptions.RioXarrayError[source]

          Bases: RuntimeError

          This is the base exception for errors in the rioxarray extension.

          -exception rioxarray.exceptions.SingleVariableDataset[source]
          +exception rioxarray.exceptions.SingleVariableDataset[source]

          Bases: rioxarray.exceptions.RioXarrayError

          This is for when you have a dataset with a single variable.

          +
          +
          +exception rioxarray.exceptions.TooManyDimensions[source]
          +

          Bases: rioxarray.exceptions.RioXarrayError

          +

          This is raised when there are more dimensions than is supported by the method

          +
          +
          @@ -697,13 +651,11 @@

          This Page

          @@ -727,13 +679,13 @@

          Navigation

        • previous |
          • -
        • rioxarray 0.0.3 documentation »
          • +
        • rioxarray 0.0.4 documentation »
        • rioxarray »
          • \ No newline at end of file diff --git a/docs/html/search.html b/docs/html/search.html index 7c7a8fb6..2d2ce377 100644 --- a/docs/html/search.html +++ b/docs/html/search.html @@ -1,12 +1,10 @@ - + - - - Search — rioxarray 0.0.3 documentation + + Search — rioxarray 0.0.4 documentation @@ -18,11 +16,7 @@ - - - + @@ -35,7 +29,7 @@

          Navigation

        • modules |
          • -
        • rioxarray 0.0.3 documentation »
          • +
        • rioxarray 0.0.4 documentation »
          • @@ -86,12 +80,12 @@

          Navigation

        • modules |
          • -
        • rioxarray 0.0.3 documentation »
          • +
        • rioxarray 0.0.4 documentation »
          • \ No newline at end of file diff --git a/docs/html/searchindex.js b/docs/html/searchindex.js index cad48eb6..458b8912 100644 --- a/docs/html/searchindex.js +++ b/docs/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["authors","contributing","examples/clip_box","examples/clip_geom","examples/examples","examples/interpolate_na","examples/reproject","examples/reproject_match","examples/transform_bounds","history","index","installation","modules","readme","rioxarray"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.viewcode":1,nbsphinx:1,sphinx:55},filenames:["authors.rst","contributing.rst","examples/clip_box.ipynb","examples/clip_geom.ipynb","examples/examples.rst","examples/interpolate_na.ipynb","examples/reproject.ipynb","examples/reproject_match.ipynb","examples/transform_bounds.ipynb","history.rst","index.rst","installation.rst","modules.rst","readme.rst","rioxarray.rst"],objects:{"rioxarray.crs":{crs_to_wkt:[14,1,1,""]},"rioxarray.exceptions":{NoDataInBounds:[14,2,1,""],OneDimensionalRaster:[14,2,1,""],RioXarrayError:[14,2,1,""],SingleVariableDataset:[14,2,1,""]},"rioxarray.rioxarray":{RasterArray:[14,3,1,""],RasterDataset:[14,3,1,""],XRasterBase:[14,3,1,""],add_spatial_ref:[14,1,1,""],add_xy_grid_meta:[14,1,1,""],affine_to_coords:[14,1,1,""]},"rioxarray.rioxarray.RasterArray":{bounds:[14,4,1,""],clip:[14,4,1,""],clip_box:[14,4,1,""],crs:[14,5,1,""],interpolate_na:[14,4,1,""],nodata:[14,5,1,""],reproject:[14,4,1,""],reproject_match:[14,4,1,""],resolution:[14,4,1,""],slice_xy:[14,4,1,""],transform:[14,4,1,""],transform_bounds:[14,4,1,""]},"rioxarray.rioxarray.RasterDataset":{clip:[14,4,1,""],clip_box:[14,4,1,""],crs:[14,5,1,""],interpolate_na:[14,4,1,""],reproject:[14,4,1,""],reproject_match:[14,4,1,""],vars:[14,5,1,""]},"rioxarray.rioxarray.XRasterBase":{crs:[14,5,1,""],shape:[14,5,1,""]},rioxarray:{crs:[14,0,0,"-"],exceptions:[14,0,0,"-"],rioxarray:[14,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","exception","Python exception"],"3":["py","class","Python class"],"4":["py","method","Python method"],"5":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:exception","3":"py:class","4":"py:method","5":"py:attribute"},terms:{"00000000e":[2,5,7],"004e":[2,5,7],"029e":7,"049e":2,"05e":[2,5,7],"084c84d78cb6e1326c7fbbe79c5b5d0bef37c078":14,"085e":6,"0x7f185c0c27f0":6,"0x7f185c1ca278":6,"0x7f3bf1865860":5,"0x7f3bf197f978":5,"0x7f6a17e1e278":2,"0x7f6a17ea1358":2,"0x7f99265b3ba8":3,"0x7f9926d34160":3,"0x7fd98c72c908":7,"0x7fd98d010630":7,"0x7fd98d0a1c50":7,"19t10":6,"1d345f08a10a13c316f81100936b0ad8b1a374eb":14,"228e":[2,5,7],"251e":3,"255e":3,"25e":3,"268e":3,"273e":2,"27400965e":[2,5,7],"274e":[2,5,7],"29t12":6,"31656358e":[2,5,7],"425e":7,"429e":7,"615e":3,"616e":3,"663e":6,"85124883e":7,"853e":7,"857e":7,"86651227e":7,"991e":7,"boolean":14,"class":14,"default":[2,3,5,6,7,8,14],"float":14,"function":[1,13,14],"import":[2,3,5,6,7,8],"int":14,"new":1,"return":14,"true":14,"var":14,CRS:14,GIS:14,The:[1,11,13,14],Will:14,_fillvalu:[3,5,7],about:1,account:14,add:[1,14],add_spatial_ref:14,add_xy_grid_meta:14,adopt:[13,14],affin:14,affine_to_coord:14,alan:0,alfredo:0,alfredoahd:0,algorithm:14,all:14,all_touch:14,along:14,alwai:[1,11],ani:1,anoth:14,antimeridian:14,anyth:1,apach:[13,14],api:14,appreci:1,arrai:[2,3,5,7,14],articl:1,assum:1,attribut:[2,3,5,6,7,14],auto_expand:14,auto_expand_limit:14,backend:14,band:3,base:14,befor:[1,14],best:1,bit:1,black:1,blob:14,blog:1,blue:6,bool:14,bottom:14,bound:[4,14],box:[4,14],branch:1,bresenham:14,bugfix:1,burn:14,call:[2,3,5,6,7,8],can:[1,11],capabl:14,center:14,chang:[1,14],check:1,checkout:1,clip:[4,14],clip_box:[2,14],clone:[1,11],code:14,collect:[2,3,4,5,6,7],com:[0,1,10,11,13,14],command:11,commit:1,config:[2,3,5,6,7,8],contain:[4,14],content:[4,10],contribut:10,cookiecutt:13,cool_rast:14,coord:14,coordin:[2,3,5,6,7,14],copi:1,core:[13,14],corteva:[1,10,11,13],could:1,creat:1,creation_d:6,credit:[1,10,14],crop:14,cropping_geometri:14,crs:[2,3,5,7,12],crs_to_wkt:14,cubic:14,current:14,dask:[2,3,5,6,7,8],data:[2,3,4,6,7,8,14],dataarrai:[2,3,5,7,14],datacub:[13,14],dataset:14,datetime64:6,datum:[6,7,8],deal:14,degre:14,delo:0,densifi:14,densify_pt:[8,14],deprec:[2,3,5,6,7,8],descript:1,destin:14,detail:[1,2,3,5,6,7,8,14],determin:14,develop:1,dict:14,dimens:[6,14],dimension:14,distribut:[2,3,5,6,7,8],doc:1,docstr:1,document:13,doe:14,don:11,done:1,download:11,driven:1,dst_affin:14,dst_affine_width_height:14,dst_cr:14,dst_height:14,dst_width:14,dtype:[2,3,5,7],each:14,easier:1,edg:14,either:14,ellp:[6,8],enhanc:1,env:[2,3,5,6,7,8],epsg:[3,8],error:14,even:1,everi:1,exampl:[10,14],except:12,expand:14,explain:1,extens:[2,3,5,6,7,8,13,14],extract:14,fals:14,featur:14,file:[1,13,14],flake8:1,float32:[2,5,7],float64:[2,3,5,6,7],forc:14,fork:1,formatt:1,found:14,from:[13,14],full:[2,3,5,6,7,8],gdal:14,gener:14,geo_xarrai:[13,14],geocub:[2,3,5,6,7,8],geojson:14,geometri:14,geometry_mask:14,get:14,git:[1,11],github:[0,1,10,11,13,14],gitlab:1,given:1,greatli:1,green:6,grid:14,grid_map:[2,3,5,7],grid_map_nam:14,griddata:14,guid:11,have:[1,11,14],height:14,help:1,helper:14,here:1,histori:10,home:[2,3,5,6,7,8],how:[1,4],http:[0,1,2,3,5,6,7,8,10,13,14],in_d:14,includ:[1,13],index:10,init:[3,8],inlin:[2,3,5,6,7,8],input:[7,14],instal:[1,10],instead:14,int64:[2,3,5,6,7],interpol:[4,14],interpolate_na:14,is_til:[2,3,5,7],isel:[5,6],issu:1,just:1,keep:1,larg:14,left:14,lib:[2,3,5,6,7,8],licens:[13,14],license_datacub:13,like:14,line:14,linear:14,link:4,list:[1,14],littl:1,load:[8,14],loader:[2,3,5,6,7,8],local:1,lon_0:[2,5,7,8],longlat:6,look:1,make:[1,14],mani:1,map:14,match:[4,14],match_data_arrai:14,matplotlib:[2,3,5,6,7,8],maxi:[2,14],maximum:14,maxx:[2,14],meet:1,merc:8,metadata:14,method:[11,14],metr:14,might:1,mini:[2,14],miniconda3:[2,3,5,6,7,8],minimum:14,minx:[2,14],miss:[4,14],mnt:7,modis_arrai:[2,5,7,8],modis_array_match:7,modul:[10,12],more:[1,14],most:11,msg:[2,3,5,6,7,8],name:[1,14],nan:[2,5,7],narrow:1,nearest:14,no_def:[2,5,6,7,8],nodata:[2,5,6,7,14],nodatainbound:14,nodatav:3,non:14,none:14,nonlinear:14,noqa:14,note:14,now:[1,9],number:14,object:14,offici:1,ogc:14,onedimensionalrast:14,onli:14,open:1,open_dataarrai:[2,5,7,8],open_dataset:6,open_rasterio:[3,14],opendatacub:[13,14],oper:1,option:14,org:[2,3,5,6,7,8,14],origin:[1,13],outermost:14,packag:[2,3,5,6,7,8,12,13],page:[4,10],paramet:14,part:1,pass:1,perform:14,pip:[1,11],pixel:14,planet_scope_3d:6,pleas:[1,2,3,5,6,7,8],plot:[2,3,5,6,7],point:14,polygon:[3,14],possibl:1,post:1,power:14,pre:9,prefer:11,process:[11,14],produc:14,proj:[2,5,6,7,8,14],project:[1,14],propos:1,provid:14,push:1,put:1,python3:[2,3,5,6,7,8],python:[1,11],pyyaml:[2,3,5,6,7,8],quadmesh:[2,3,5,6,7],rais:14,raster:14,rasterarrai:14,rasterdataset:14,rasterio:[13,14],rasterio_cr:14,read:[2,3,5,6,7,8],readi:1,readm:[1,10],recalc:14,recalcul:14,recent:11,refer:14,region:14,releas:9,rememb:1,repo:[1,11],reproduc:1,reproject:[4,13,14],reproject_match:[7,14],requir:14,res:[2,3,5,7],resampl:14,resolut:14,retri:14,retriev:14,right:14,rio:[2,3,5,6,7,8,14],rioxarrai:[1,2,3,4,5,6,7,8,11],rioxarray_env:1,rioxarrayerror:14,rst:1,run:[1,11],runtimeerror:14,same:14,santo:0,scipi:14,scope:1,script:7,search:[10,14],see:14,select:14,send:1,set:[1,14],setup:[1,11],shape:14,should:1,singl:14,singlevariabledataset:14,sinu:[2,5,7],site:[2,3,5,6,7,8],size:14,slice:[5,14],slice_xi:14,small_dem_3m_merg:3,snow:0,snowal:[2,3,5,6,7,8],snowman2:0,sourc:[13,14],spatial_ref:[2,3,5,6,7,14],spatiarefer:14,src_cr:14,src_data_arrai:14,stage:9,step:1,str:14,string:14,subset:1,support:14,sure:14,system:[1,14],tag:1,target:14,templat:13,termin:11,test:[1,7],test_data:7,test_rioxarrai:1,thei:1,them:1,thi:[1,4,11,13,14],through:[1,11],tif:[3,14],time:[6,14],top:14,touch:14,transform:[2,3,4,5,7,14],transform_bound:[8,14],troubleshoot:1,tupl:14,type:[3,14],uint16:3,uint:14,under:[13,14],unit:[7,8,14],unsaf:[2,3,5,6,7,8],updat:1,usag:10,use:[1,4,14],user:7,uses:14,using:14,utm:7,valid:14,valu:[3,14],variabl:[6,14],varibl:14,venv:1,version:[1,13,14],virtualenv:1,virtualenvwrapp:1,volunt:1,wai:1,want:1,warp:14,web:1,websit:1,welcom:1,wgs84:[6,7,8],when:[1,14],where:[3,6],whether:1,whoever:1,whose:14,width:14,within:14,without:[2,3,5,6,7,8],wkt:14,work:[1,14],wors:14,would:1,x_0:8,x_dim:14,x_size:14,xarrai:[8,13,14],xarray_obj:14,xds:[2,3,5,6,7,8,14],xds_lonlat:6,xds_match:7,xds_repr_match:7,xdsc:2,xrasterbas:14,y_0:8,y_dim:14,y_size:14,yaml:[2,3,5,6,7,8],yamlloadwarn:[2,3,5,6,7,8],you:[1,11,14],your:[1,11],your_name_her:1,zone:7},titles:["Credits","Contributing","Example - Clip Box","Example - Clip","Usage Examples","Example - Interpolate Missing Data","Example - Reproject","Example - Reproject Match","Example - Transform Bounds","History","Welcome to rioxarray\u2019s documentation!","Installation","rioxarray","rioxarray README","rioxarray package"],titleterms:{bound:[2,8],box:2,bug:1,clip:[2,3],contribut:1,contributor:0,credit:[0,13],crs:14,data:5,dataset:[2,3,5,6,7],develop:0,document:[1,10],exampl:[2,3,4,5,6,7,8],except:14,featur:1,feedback:1,fill:5,fix:1,from:11,geometri:3,get:1,guidelin:1,histori:9,implement:1,indic:10,instal:11,interpol:5,interpolate_na:5,lead:0,load:[2,3,5,6,7],match:7,miss:5,misss:5,modul:14,packag:14,pull:1,readm:13,releas:11,report:1,reproject:[6,7],request:1,rioxarrai:[10,12,13,14],sourc:11,stabl:11,start:1,submit:1,tabl:10,tip:1,transform:8,type:1,usag:4,using:[2,3],welcom:10,write:1,xarrai:[2,3,5,6,7]}}) \ No newline at end of file +Search.setIndex({docnames:["authors","contributing","examples/clip_box","examples/clip_geom","examples/examples","examples/interpolate_na","examples/reproject","examples/reproject_match","examples/transform_bounds","history","index","installation","modules","readme","rioxarray"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.viewcode":1,nbsphinx:1,sphinx:56},filenames:["authors.rst","contributing.rst","examples/clip_box.ipynb","examples/clip_geom.ipynb","examples/examples.rst","examples/interpolate_na.ipynb","examples/reproject.ipynb","examples/reproject_match.ipynb","examples/transform_bounds.ipynb","history.rst","index.rst","installation.rst","modules.rst","readme.rst","rioxarray.rst"],objects:{"rioxarray.crs":{crs_to_wkt:[14,1,1,""]},"rioxarray.exceptions":{InvalidDimensionOrder:[14,2,1,""],NoDataInBounds:[14,2,1,""],OneDimensionalRaster:[14,2,1,""],RioXarrayError:[14,2,1,""],SingleVariableDataset:[14,2,1,""],TooManyDimensions:[14,2,1,""]},"rioxarray.rioxarray":{RasterArray:[14,3,1,""],RasterDataset:[14,3,1,""],XRasterBase:[14,3,1,""],add_spatial_ref:[14,1,1,""],add_xy_grid_meta:[14,1,1,""],affine_to_coords:[14,1,1,""]},"rioxarray.rioxarray.RasterArray":{bounds:[14,4,1,""],clip:[14,4,1,""],clip_box:[14,4,1,""],crs:[14,4,1,""],interpolate_na:[14,4,1,""],nodata:[14,4,1,""],reproject:[14,4,1,""],reproject_match:[14,4,1,""],resolution:[14,4,1,""],slice_xy:[14,4,1,""],to_raster:[14,4,1,""],transform:[14,4,1,""],transform_bounds:[14,4,1,""]},"rioxarray.rioxarray.RasterDataset":{clip:[14,4,1,""],clip_box:[14,4,1,""],crs:[14,4,1,""],interpolate_na:[14,4,1,""],reproject:[14,4,1,""],reproject_match:[14,4,1,""],vars:[14,4,1,""]},"rioxarray.rioxarray.XRasterBase":{crs:[14,4,1,""],shape:[14,4,1,""]},rioxarray:{crs:[14,0,0,"-"],exceptions:[14,0,0,"-"],rioxarray:[14,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","exception","Python exception"],"3":["py","class","Python class"],"4":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:exception","3":"py:class","4":"py:method"},terms:{"00000000e":[2,5,7],"004e":[2,5,7],"029e":7,"049e":2,"05e":[2,5,7],"084c84d78cb6e1326c7fbbe79c5b5d0bef37c078":14,"085e":6,"0x7f185c0c27f0":6,"0x7f185c1ca278":6,"0x7f3bf1865860":5,"0x7f3bf197f978":5,"0x7f6a17e1e278":2,"0x7f6a17ea1358":2,"0x7f99265b3ba8":3,"0x7f9926d34160":3,"0x7fd98c72c908":7,"0x7fd98d010630":7,"0x7fd98d0a1c50":7,"19t10":6,"1d345f08a10a13c316f81100936b0ad8b1a374eb":14,"228e":[2,5,7],"251e":3,"255e":3,"25e":3,"268e":3,"273e":2,"27400965e":[2,5,7],"274e":[2,5,7],"29t12":6,"31656358e":[2,5,7],"425e":7,"429e":7,"615e":3,"616e":3,"663e":6,"85124883e":7,"853e":7,"857e":7,"86651227e":7,"991e":7,"abstract":14,"boolean":14,"class":14,"default":[2,3,5,6,7,8,14],"export":[9,14],"float":14,"function":[1,13,14],"import":[2,3,5,6,7,8],"int":14,"new":1,"return":14,"true":14,"var":14,Added:9,CRS:14,GIS:14,The:[1,11,13,14],Will:14,_fillvalu:[3,5,7],abil:9,about:1,account:14,add:[1,14],add_spatial_ref:14,add_xy_grid_meta:14,added:14,addit:14,adopt:[13,14],affin:14,affine_to_coord:14,alan:0,alfredo:0,alfredoahd:0,algorithm:14,all:14,all_touch:14,along:14,alwai:[1,11],ani:1,anoth:14,antimeridian:14,anyth:1,apach:[13,14],api:14,appreci:1,argument:14,arrai:[2,3,5,7,9,14],articl:1,assum:1,attribut:[2,3,5,6,7,14],auto_expand:14,auto_expand_limit:14,automat:14,backend:14,band:3,base:14,befor:[1,14],best:1,bit:1,black:1,blob:14,blog:1,blue:6,bool:14,bottom:14,bound:[4,14],box:[4,14],branch:1,bresenham:14,bugfix:1,burn:14,call:[2,3,5,6,7,8],can:[1,11],capabl:14,center:14,chang:[1,14],check:1,checkout:1,clip:[4,14],clip_box:[2,14],clone:[1,11],code:14,collect:[2,3,4,5,6,7],com:[0,1,10,11,13,14],command:11,commit:1,config:[2,3,5,6,7,8],contain:[4,14],content:[4,10],contribut:10,cookiecutt:13,cool_rast:14,coord:14,coordin:[2,3,5,6,7,14],copi:1,core:[13,14],correctli:14,corteva:[1,10,11,13],could:1,count:14,creat:1,creation_d:6,credit:[1,10,14],crop:14,cropping_geometri:14,crs:[2,3,5,7,12],crs_to_wkt:14,cubic:14,current:14,dask:[2,3,5,6,7,8],data:[2,3,4,6,7,8,9,14],dataarrai:[2,3,5,7,14],datacub:[13,14],dataset:14,datetime64:6,datum:[6,7,8],david:0,deal:14,degre:14,delo:0,densifi:14,densify_pt:[8,14],deprec:[2,3,5,6,7,8],descript:1,destin:14,detail:[1,2,3,5,6,7,8,14],determin:14,develop:1,dict:14,dictionari:14,dimens:[6,14],dimension:14,distribut:[2,3,5,6,7,8],djhoes:0,doc:1,docstr:1,document:13,doe:14,don:11,done:1,download:11,driven:1,driver:14,dst_affin:14,dst_affine_width_height:14,dst_cr:14,dst_height:14,dst_width:14,dtype:[2,3,5,7,14],each:14,easier:1,edg:14,either:14,ellp:[6,8],enhanc:1,env:[2,3,5,6,7,8],epsg:[3,8],error:14,even:1,everi:1,exampl:[10,14],except:12,expand:14,explain:1,extens:[2,3,5,6,7,8,13,14],extract:14,fals:14,featur:14,file:[1,13,14],flake8:1,float32:[2,5,7],float64:[2,3,5,6,7],forc:14,fork:1,formatt:1,found:14,from:[13,14],full:[2,3,5,6,7,8],gdal:14,gener:14,geo_xarrai:[13,14],geocub:[2,3,5,6,7,8],geojson:14,geometri:14,geometry_mask:14,get:14,git:[1,11],github:[0,1,10,11,13,14],gitlab:1,given:1,greatli:1,green:6,grid:14,grid_map:[2,3,5,7],grid_map_nam:14,griddata:14,gtiff:14,guid:11,have:[1,11,14],height:14,help:1,helper:14,here:1,histori:10,hoes:0,home:[2,3,5,6,7,8],how:[1,4],http:[0,1,2,3,5,6,7,8,10,13,14],in_d:14,includ:[1,13],index:10,init:[3,8],inlin:[2,3,5,6,7,8],input:[7,14],instal:[1,10],instead:14,int64:[2,3,5,6,7],interpol:[4,14],interpolate_na:14,invaliddimensionord:14,is_til:[2,3,5,7],isel:[5,6],issu:1,just:1,keep:1,keyword:14,larg:14,left:14,lib:[2,3,5,6,7,8],licens:[13,14],license_datacub:13,like:14,line:14,linear:14,link:4,list:[1,14],littl:1,load:[8,14],loader:[2,3,5,6,7,8],local:1,lon_0:[2,5,7,8],longlat:6,look:1,make:[1,14],mani:1,map:14,match:[4,14],match_data_arrai:14,matplotlib:[2,3,5,6,7,8],maxi:[2,14],maximum:14,maxx:[2,14],meet:1,merc:8,metadata:14,method:[11,14],metr:14,might:1,mini:[2,14],miniconda3:[2,3,5,6,7,8],minimum:14,minx:[2,14],miss:[4,14],mnt:7,modis_arrai:[2,5,7,8],modis_array_match:7,modul:[10,12],more:[1,14],most:11,msg:[2,3,5,6,7,8],name:[1,14],nan:[2,5,7],narrow:1,nearest:14,no_def:[2,5,6,7,8],nodata:[2,5,6,7,14],nodatainbound:14,nodatav:3,non:14,none:14,nonlinear:14,noqa:14,note:14,now:1,number:14,object:14,offici:1,ogc:14,onedimensionalrast:14,onli:14,open:1,open_dataarrai:[2,5,7,8],open_dataset:6,open_rasterio:[3,14],opendatacub:[13,14],oper:1,option:14,order:14,org:[2,3,5,6,7,8,14],origin:[1,13],outermost:14,output:14,packag:[2,3,5,6,7,8,12,13],page:[4,10],paramet:14,part:1,pass:[1,14],path:14,perform:14,pip:[1,11],pixel:14,planet_scope_3d:6,pleas:[1,2,3,5,6,7,8],plot:[2,3,5,6,7],point:14,polygon:[3,14],possibl:1,post:1,power:14,prefer:11,process:[11,14],produc:14,profile_kwarg:14,proj:[2,5,6,7,8,14],project:[1,14],properti:14,propos:1,provid:14,pull:9,push:1,put:1,python3:[2,3,5,6,7,8],python:[1,11],pyyaml:[2,3,5,6,7,8],quadmesh:[2,3,5,6,7],rais:14,raster:[9,14],raster_path:14,rasterarrai:14,rasterdataset:14,rasterio:[13,14],rasterio_cr:14,read:[2,3,5,6,7,8],readi:1,readm:[1,10],recalc:14,recalcul:14,recent:11,refer:14,region:14,rememb:1,repo:[1,11],reproduc:1,reproject:[4,13,14],reproject_match:[7,14],requir:14,res:[2,3,5,7],resampl:14,resolut:14,retri:14,retriev:14,right:14,rio:[2,3,5,6,7,8,14],rioxarrai:[1,2,3,4,5,6,7,8,11],rioxarray_env:1,rioxarrayerror:14,rst:1,run:[1,11],runtimeerror:14,same:14,santo:0,scipi:14,scope:1,script:7,search:[10,14],see:14,select:14,send:1,set:[1,14],setup:[1,11],shape:14,should:1,singl:14,singlevariabledataset:14,sinu:[2,5,7],site:[2,3,5,6,7,8],size:14,slice:[5,14],slice_xi:14,small_dem_3m_merg:3,snow:0,snowal:[2,3,5,6,7,8],snowman2:0,sourc:[13,14],spatial_ref:[2,3,5,6,7,14],spatiarefer:14,src_cr:14,src_data_arrai:14,step:1,str:14,string:14,subset:1,support:14,sure:14,system:[1,14],tag:[1,14],target:14,templat:13,termin:11,test:[1,7],test_data:7,test_rioxarrai:1,than:14,thei:1,them:1,thi:[1,4,11,13,14],through:[1,11],tif:[3,14],time:[6,14],to_rast:14,toomanydimens:14,top:14,touch:14,transform:[2,3,4,5,7,14],transform_bound:[8,14],troubleshoot:1,tupl:14,type:[3,14],uint16:3,uint:14,under:[13,14],unit:[7,8,14],unsaf:[2,3,5,6,7,8],updat:1,usag:10,use:[1,4,14],user:7,uses:14,using:14,utm:7,valid:14,valu:[3,14],variabl:[6,14],varibl:14,venv:1,version:[1,13,14],virtualenv:1,virtualenvwrapp:1,volunt:1,wai:1,want:1,warp:14,web:1,websit:1,welcom:1,wgs84:[6,7,8],when:[1,14],where:[3,6],whether:1,whoever:1,whose:14,width:14,within:14,without:[2,3,5,6,7,8],wkt:14,work:[1,14],wors:14,would:1,write:14,x_0:8,x_dim:14,x_size:14,xarrai:[8,13,14],xarray_obj:14,xds:[2,3,5,6,7,8,14],xds_lonlat:6,xds_match:7,xds_repr_match:7,xdsc:2,xrasterbas:14,y_0:8,y_dim:14,y_size:14,yaml:[2,3,5,6,7,8],yamlloadwarn:[2,3,5,6,7,8],you:[1,11,14],your:[1,11],your_name_her:1,zone:7},titles:["Credits","Contributing","Example - Clip Box","Example - Clip","Usage Examples","Example - Interpolate Missing Data","Example - Reproject","Example - Reproject Match","Example - Transform Bounds","History","Welcome to rioxarray\u2019s documentation!","Installation","rioxarray","rioxarray README","rioxarray package"],titleterms:{bound:[2,8],box:2,bug:1,clip:[2,3],contribut:1,contributor:0,credit:[0,13],crs:14,data:5,dataset:[2,3,5,6,7],develop:0,document:[1,10],exampl:[2,3,4,5,6,7,8],except:14,featur:1,feedback:1,fill:5,fix:1,from:11,geometri:3,get:1,guidelin:1,histori:9,implement:1,indic:10,instal:11,interpol:5,interpolate_na:5,lead:0,load:[2,3,5,6,7],match:7,miss:5,misss:5,modul:14,packag:14,pull:1,readm:13,releas:11,report:1,reproject:[6,7],request:1,rioxarrai:[10,12,13,14],sourc:11,stabl:11,start:1,submit:1,tabl:10,tip:1,transform:8,type:1,usag:4,using:[2,3],welcom:10,write:1,xarrai:[2,3,5,6,7]}}) \ No newline at end of file diff --git a/rioxarray/_version.py b/rioxarray/_version.py index 737cd9ff..e27531bf 100644 --- a/rioxarray/_version.py +++ b/rioxarray/_version.py @@ -1,2 +1,2 @@ # -*- coding: utf-8 -*- -__version__ = "0.0.3" +__version__ = "0.0.4"