podpac.interpolators.NearestNeighbor¶

class podpac.interpolators.NearestNeighbor(**kwargs)[source]¶

Bases: podpac.core.data.interpolator.Interpolator

Nearest Neighbor Interpolation

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

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

spatial_tolerance¶

Maximum distance to the nearest coordinate in space. Cooresponds to the unit of the space measurement.

Type: float

time_tolerance¶

Maximum distance to the nearest coordinate in time coordinates. Accepts p.timedelta64() (i.e. np.timedelta64(1, ‘D’) for a 1-Day tolerance)

Type: float

Methods

`__init__`(**kwargs)
`can_interpolate`(udims, source_coordinates, …)	Interpolate data from requested coordinates to 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`
`method`	A trait for unicode strings.
`methods_supported`
`name`	Interpolator definition
`spatial_tolerance`	A float trait.
`time_tolerance`	A trait whose value must be an instance of a specified class.

Members

__init__(**kwargs)¶

can_interpolate(udims, source_coordinates, eval_coordinates)[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

dims_supported = ['lat', 'lon', 'alt', 'time']

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 = ['nearest']¶

spatial_tolerance: A float trait.

time_tolerance

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

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute