podpac.interpolators.Interpolator

class podpac.interpolators.Interpolator(**kwargs)[source]

Bases: traitlets.traitlets.HasTraits

Interpolation Method

method

Current interpolation method to use in Interpolator (i.e. ‘nearest’). This attribute is set during node evaluation when a new Interpolation class is constructed. See the podpac.data.DataSource interpolation attribute for more information on specifying the interpolator method.

Type

str

methods_supported

List of methods supported by the interpolator. This attribute should be defined by the implementing Interpolator. See INTERPOLATION_METHODS for list of available method strings.

Type

list

dims_supported

List of unstacked dimensions supported by the interpolator. This attribute should be defined by the implementing Interpolator. Used by private convience method _filter_udims_supported().

Type

list

Methods

__init__(**kwargs)

can_interpolate(udims, source_coordinates, …)

Evaluate if this interpolation method can handle the requested coordinates and source_coordinates.

can_select(udims, source_coordinates, …)

Evaluate if interpolator can downselect the source coordinates from the requested coordinates for the unstacked dims supplied.

init()

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

interpolate(udims, source_coordinates, …)

Interpolate data from requested coordinates to source coordinates.

select_coordinates(udims, …)

Downselect coordinates with interpolator method

Attributes

definition

Interpolator definition

dims_supported

An instance of a Python list.

method

A trait for unicode strings.

methods_supported

An instance of a Python list.

name

Interpolator definition

Members

__init__(**kwargs)[source]
can_interpolate(udims, source_coordinates, eval_coordinates)[source]

Evaluate if this interpolation method can handle the requested coordinates and source_coordinates. If not overwritten, this method returns an empty tuple (tuple())

Parameters
Returns

Returns a tuple of dimensions that can be interpolated with this interpolator If no dimensions can be interpolated, method should return an emtpy tuple

Return type

tuple

can_select(udims, source_coordinates, eval_coordinates)[source]

Evaluate if interpolator can downselect the source coordinates from the requested coordinates for the unstacked dims supplied. If not overwritten, this method returns an empty tuple (tuple())

Parameters
Returns

Returns a tuple of dimensions that can be selected with this interpolator If no dimensions can be selected, method should return an emtpy tuple

Return type

tuple

definition

Interpolator definition

Returns

String name of interpolator.

Return type

str

dims_supported

An instance of a Python list.

init()[source]

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

interpolate(udims, source_coordinates, source_data, eval_coordinates, output_data)[source]

Interpolate data from requested coordinates to source coordinates.

Parameters
  • udims (tuple) – dimensions to interpolate

  • source_coordinates (podpac.Coordinates) – Description

  • source_data (podpac.core.units.UnitsDataArray) – Description

  • eval_coordinates (podpac.Coordinates) – Description

  • output_data (podpac.core.units.UnitsDataArray) – Description

Raises

NotImplementedError

Returns

returns the updated output of interpolated data

Return type

podpac.core.units.UnitDataArray

method

A trait for unicode strings.

methods_supported

An instance of a Python list.

name

Interpolator definition

Returns

String name of interpolator.

Return type

str

select_coordinates(udims, source_coordinates, source_coordinates_index, eval_coordinates)[source]

Downselect coordinates with interpolator method

Parameters
  • udims (tuple) – dimensions to select coordinates

  • source_coordinates (podpac.Coordinates) – Description

  • source_coordinates_index (list) – Description

  • eval_coordinates (podpac.Coordinates) – Description

Returns

returns the new down selected coordinates and the new associated index. These coordinates must exist in the native coordinates of the source data

Return type

(podpac.Coordinates, list)

Raises

NotImplementedError