podpac.data.Rasterio

class podpac.data.Rasterio(**kwargs)[source]

Bases: podpac.core.data.file_source.LoadFileMixin, podpac.core.data.file_source.BaseFileSource

Create a DataSource using rasterio.

source

Path to the data source

Type

str, io.BytesIO

dataset

A reference to the datasource opened by rasterio

Type

rasterio._io.RasterReader

coordinates

The coordinates of the data source.

Type

podpac.Coordinates

band

The ‘band’ or index for the variable being accessed in files such as GeoTIFFs. Use None for all bounds.

crsstr, optional

The coordinate reference system. Normally this will come directly from the file, but this allows users to specify the crs in case this information is missing from the file.

Type

int

Alternative Constructors

from_definition(definition)

Create podpac Node from a dictionary definition.

from_json(s)

Create podpac Node from a JSON definition.

Methods

__init__(**kwargs)

Do not overwrite me

close_dataset()

Closes the file for the datasource

create_output_array(coords[, data])

Initialize an output data array

eval(coordinates[, output])

Evaluates this node using the supplied coordinates.

eval_group(group)

Evaluate the node for each of the coordinates in the group.

find_coordinates()

Get the available coordinates for the Node.

from_url(url)

Create podpac Node from a WMS/WCS request.

get_band_numbers(key, value)

Return the bands that have a key equal to a specified value.

get_cache(key[, coordinates])

Get cached data for this node.

get_coordinates()

Returns a Coordinates object that describes the coordinates of the data source.

get_data(coordinates, coordinates_index)

This method must be defined by the data source implementing the DataSource class.

has_cache(key[, coordinates])

Check for cached data for this node.

init()

Overwrite this method if a node needs to do any additional initialization after the standard initialization.

load(path)

Create podpac Node from file.

open_dataset(fp, **kwargs)

put_cache(data, key[, coordinates, overwrite])

Cache data for this node.

rem_cache(key[, coordinates, mode])

Clear cached data for this node.

save(path)

Write node to file.

set_coordinates(coordinates[, force])

Set the coordinates.

trait_is_defined(name)

Attributes

anon

A boolean (True, False) trait.

attrs

List of node attributes

aws_access_key_id

A trait for unicode strings.

aws_client_kwargs

An instance of a Python dict.

aws_region_name

A trait for unicode strings.

aws_secret_access_key

A trait for unicode strings.

band

A casting version of the int trait.

band_count

The number of bands

band_descriptions

band_keys

base_ref

Default reference/name in node definitions

boundary

An instance of a Python dict.

cache_coordinates

A boolean (True, False) trait.

cache_ctrl

A trait whose value must be an instance of a specified class.

cache_dataset

A boolean (True, False) trait.

cache_output

A boolean (True, False) trait.

config_kwargs

An instance of a Python dict.

coordinate_index_type

An enum whose value must be in a given sequence.

coordinates

{coordinates}

crs

A trait for unicode strings.

dataset

definition

driver

A trait for unicode strings.

dtype

A trait which allows any value.

force_eval

A boolean (True, False) trait.

hash

interpolation

interpolation_class

Get the interpolation class currently set for this data source.

interpolators

Return the interpolators selected for the previous node evaluation interpolation.

json

json_pretty

nan_vals

output

A trait for unicode strings.

outputs

An instance of a Python list.

s3

source

A trait for unicode strings.

style

A trait whose value must be an instance of a specified class.

units

A trait for unicode strings.

Members

__init__(**kwargs)

Do not overwrite me

band

A casting version of the int trait.

property band_count

The number of bands

property band_descriptions
property band_keys
close_dataset()[source]

Closes the file for the datasource

crs

A trait for unicode strings.

driver

A trait for unicode strings.

get_band_numbers(key, value)[source]

Return the bands that have a key equal to a specified value.

Parameters
  • key (str / list) – Key present in the metadata of the band. Can be a single key, or a list of keys.

  • value (str / list) – Value of the key that should be returned. Can be a single value, or a list of values

Returns

An array of band numbers that match the criteria

Return type

np.ndarray

get_coordinates()[source]

Returns a Coordinates object that describes the coordinates of the data source.

In most cases, this method is defined by the data source implementing the DataSource class. If method is not implemented by the data source, it will try to return self.coordinates if self.coordinates is not None.

Otherwise, this method will raise a NotImplementedError.

Returns

The coordinates describing the data source array.

Return type

podpac.Coordinates

Notes

Need to pay attention to: - the order of the dimensions - the stacking of the dimension - the type of coordinates

Coordinates should be non-nan and non-repeating for best compatibility

The default implementation tries to find the lat/lon coordinates based on dataset.affine. It cannot determine the alt or time dimensions, so child classes may have to overload this method.

get_data(coordinates, coordinates_index)[source]

This method must be defined by the data source implementing the DataSource class. When data source nodes are evaluated, this method is called with request coordinates and coordinate indexes. The implementing method can choose which input provides the most efficient method of getting data (i.e via coordinates or via the index of the coordinates).

Coordinates and coordinate indexes may be strided or subsets of the source data, but all coordinates and coordinate indexes will match 1:1 with the subset data.

This method may return a numpy array, an xarray DaraArray, or a podpac UnitsDataArray. If a numpy array or xarray DataArray is returned, podpac.data.DataSource.evaluate() will cast the data into a UnitsDataArray using the requested source coordinates. If a podpac UnitsDataArray is passed back, the podpac.data.DataSource.evaluate() method will not do any further processing. The inherited Node method create_output_array can be used to generate the template UnitsDataArray in your DataSource. See podpac.Node.create_output_array() for more details.

Parameters
  • coordinates (podpac.Coordinates) – The coordinates that need to be retrieved from the data source using the coordinate system of the data source

  • coordinates_index (List) – A list of slices or a boolean array that give the indices of the data that needs to be retrieved from the data source. The values in the coordinate_index will vary depending on the coordinate_index_type defined for the data source.

Returns

A subset of the returned data. If a numpy array or xarray DataArray is returned, the data will be cast into UnitsDataArray using the returned data to fill values at the requested source coordinates.

Return type

np.ndarray, xr.DataArray, podpac.UnitsDataArray

property nan_vals
open_dataset(fp, **kwargs)[source]