RegularGrid2D

class kgpy.grid.RegularGrid2D(min=<factory>, max=<factory>, num_samples=1, axis=-1)

Bases: RegularGrid1D, Grid2D

Parameters
__init__(min=<factory>, max=<factory>, num_samples=1, axis=-1)
Parameters
Return type

None

Attributes

axis

max

min

name

num_samples

num_samples_normalized

points

range

shape

step_size

Methods

__init__([min, max, num_samples, axis])

copy()

rtype

typing.TypeVar(CopyableT, bound= Copyable)

copy_shallow()

rtype

typing.TypeVar(CopyableT, bound= Copyable)

mesh(shape, new_axes)

rtype

kgpy.vector.Vector2D

Inheritance Diagram

Inheritance diagram of kgpy.grid.RegularGrid2D

copy()
Return type

typing.TypeVar(CopyableT, bound= Copyable)

Parameters

self (CopyableT) –

copy_shallow()
Return type

typing.TypeVar(CopyableT, bound= Copyable)

Parameters

self (CopyableT) –

mesh(shape, new_axes)
Return type

kgpy.vector.Vector2D

Parameters
axis: int = -1
max: kgpy.vector.Vector2D = <Quantity 1.>
min: kgpy.vector.Vector2D = <Quantity 0.>
property name: Optional[ndarray]
num_samples: typing.Union[int, kgpy.vector.Vector2D] = 1
property num_samples_normalized: Vector2D
property points: Vector2D
property range: Vector2D
property shape: Tuple[int, ...]
property step_size: Vector2D