podpac.algorithm.GroupReduce

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

Bases: podpac.core.algorithm.algorithm.Algorithm

Group a time-dependent source node and then compute a statistic for each result.

custom_reduce_fn

required if reduce_fn is ‘custom’.

Type

function

groupby

datetime sub-accessor. Currently ‘dayofyear’ is the enabled option.

Type

str

reduce_fn

builtin xarray groupby reduce function, or ‘custom’.

Type

str

source

Source node

Type

podpac.Node

Methods

__init__(**kwargs)

Do not overwrite me

algorithm(inputs)

param inputs

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

base_ref()

Default pipeline node reference/name in pipeline node definitions

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.

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.

coordinates_source

custom_reduce_fn

A trait which allows any value.

definition

Full pipeline definition for this node.

dtype

A trait which allows any value.

groupby

An enum of strings where the case should be ignored.

hash

json

definition for this node in json format

json_pretty

pipeline

Create a pipeline node from this node

reduce_fn

An enum of strings where the case should be ignored.

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

base_ref()[source]

Default pipeline node reference/name in pipeline node definitions

Returns

Default pipeline node reference/name in pipeline node definitions

Return type

str

coordinates_source
custom_reduce_fn

A trait which allows any value.

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

Raises

ValueError – If source it not time-depended (required by this node).

groupby

An enum of strings where the case should be ignored.

reduce_fn

An enum of strings where the case should be ignored.

source