numpkg

Search symbols

Type part of a name or a dotted path

Small package with numpy-style docstrings.

Exists so the parser tests cover the numpy section syntax (underlined section titles, name : type parameter lines).

Classes

Name	Description
Grid	A rectangular grid of samples.

Functions

Name	Description
resample	Scale a grid by a factor.

Gridclass#

View source

class Grid(width: int, height: int)

A rectangular grid of samples.

Parameters

Name	Type	Description
width	int	Number of columns.
height	int	Number of rows.

Attributes

Name	Type	Description
width	int	Number of columns.
height	int	Number of rows.

heightattributeinstance attribute#

View source

height = height

widthattributeinstance attribute#

View source

width = width

areamethod#

View source

def area() -> int

Compute the number of cells.

Returns

int

Width multiplied by height.

resamplefunction#

View source

def resample(grid: Grid, factor: float = 2.0) -> Grid

Scale a grid by a factor.

Parameters

Name	Type	Default	Description
grid	Grid	required	The grid to scale.
factor	float	2.0	Multiplier applied to both dimensions, by default 2.0.

Returns

Grid

A new, scaled grid.

Raises

ValueError

If factor is not positive.

Examples

>>> resample(Grid(2, 3), 2.0).area()
24