podpac.algorithm.Convolution

class podpac.algorithm.Convolution(**kwargs)[source]

Bases: podpac.core.algorithm.algorithm.Algorithm

Compute a general convolution over a source node.

This node automatically resizes the requested coordinates to avoid edge effects.

source

Source node on which convolution will be performed.

Type

podpac.Node

kernel

The convolution kernel

Type

np.ndarray

kernel_ndim

Number of dimensions of the kernel

Type

int

kernel_type

If kernel is not defined, kernel_type will create a kernel based on the inputs. The format for the created kernels is ‘<kernel_type>, <kernel_size>, <kernel_params>’. Any kernel defined in scipy.signal as well as mean can be used. For example: kernel_type = ‘mean, 8’ or kernel_type = ‘gaussian,16,8’ are both valid. Note: These kernels are automatically normalized such that kernel.sum() == 1

Type

str, optional

Methods

__init__(**kwargs)

Do not overwrite me

algorithm(inputs)

param inputs

Evaluated outputs of the input nodes. The keys are the attribute names.

create_output_array(coords[, data])

Initialize an output data array

eval(coordinates[, output])

Evaluates this nodes using the supplied coordinates.

eval_group(group)

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

find_coordinates()

Get the available native coordinates for the inputs to the Node.

from_url(url)

Create podpac Node from a WMS/WCS request.

get_cache(key[, coordinates])

Get cached data for this node.

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.

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

Cache data for this node.

rem_cache(key[, coordinates, mode])

Clear cached data for this node.

Attributes

base_definition

Base node definition.

base_ref

Default pipeline node reference/name in pipeline node definitions

cache_ctrl

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

cache_output

A boolean (True, False) trait.

cache_update

A boolean (True, False) trait.

definition

Full pipeline definition for this node.

dtype

A trait which allows any value.

hash

json

definition for this node in json format

json_pretty

kernel

A coercing numpy array trait.

pipeline

Create a pipeline node from this node

source

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

eval(coordinates, output=None)[source]

Evaluates this nodes using the supplied coordinates.

Parameters
  • coordinates (podpac.Coordinates) – The set of coordinates requested by a user. The Node will be evaluated using these coordinates.

  • output (podpac.UnitsDataArray, optional) – Default is None. Optional input array used to store the output data. When supplied, the node will not allocate its own memory for the output array. This array needs to have the correct dimensions, coordinates, and coordinate reference system.

Returns

Unit-aware xarray DataArray containing the results of the node evaluation.

Return type

podpac.UnitsDataArray

kernel

A coercing numpy array trait.

source