StratifiedRandomGrid2D¶

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

Bases: RegularGrid2D, StratifiedRandomGrid1D

Parameters

min (Vector2D) –
max (Vector2D) –
num_samples (Union[int, Vector2D]) –
axis (int) –

__init__(min=<factory>, max=<factory>, num_samples=1, axis=-1)¶

Parameters

min (Vector2D) –
max (Vector2D) –
num_samples (Union[int, Vector2D]) –
axis (int) –

Return type

None

Attributes

`axis`
`max`
`min`
`name`
`num_samples`
`num_samples_normalized`
`points`
`points_base`
`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`
`perturbation`(shape)	rtype `kgpy.vector.Vector2D`

Inheritance Diagram

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

shape (Tuple[int, ...]) –
new_axes (Sequence[int]) –

perturbation(shape)¶

Return type: kgpy.vector.Vector2D
Parameters: shape (Tuple[int, ...]) –

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 points_base: Quantity¶

property range: Vector2D¶

property shape: Tuple[int, ...]¶

property step_size: Vector2D¶