array_split.ShapeSplitter.__init__¶

ShapeSplitter.
__init__
(array_shape, indices_or_sections=None, axis=None, array_start=None, array_itemsize=1, tile_shape=None, max_tile_bytes=None, max_tile_shape=None, sub_tile_shape=None, halo=None, tile_bounds_policy=<property object>)[source]¶ Initialises parameters which define a split.
Parameters:  array_shape (sequence of
int
) – The shape to be split.  indices_or_sections (
None
,int
or sequence ofint
) – If an integer, indicates the number of elements in the calculated split array. If a sequence, indicates the indicies (per axis) at which the splits occur. See Splitting by number of tiles examples.  axis (
None
,int
or sequence ofint
) – If an integer, indicates the axis which is to be split. If a sequence integers, indicates the number of slices per axis, i.e. ifaxis = [3, 5]
then axis0
is cut into 3 slices and axis1
is cut into 5 slices for a total of 15 (3*5
) rectangular slices in the returned(3, 5)
shaped split. See Splitting by number of tiles examples and Splitting by peraxis cut indices examples.  array_start (
None
or sequence ofint
) – The start index. Defaults to[0,]*len(array_shape)
. The array indexing extents are assumed to range fromarray_start
toarray_start + array_shape
. See The array_start parameter examples.  array_itemsize (int or sequence of
int
) – Number of bytes per array element. Only relevant whenmax_tile_bytes
is specified. See Splitting by maximum bytes per tile examples.  tile_shape (
None
or sequence ofint
) – When notNone
, specifies explicit shape for tiles. Should be same length asarray_shape
. See Splitting by tile shape examples.  max_tile_bytes (
None
orint
) – The maximum number of bytes for calculatedtile_shape
. See Splitting by maximum bytes per tile examples.  max_tile_shape (
None
or sequence ofint
) – Per axis maximum shapes for the calculatedtile_shape
. Only relevant whenmax_tile_bytes
is specified. Should be same length asarray_shape
. See Splitting by maximum bytes per tile examples.  sub_tile_shape (
None
or sequence ofint
) – When notNone
, the calculatedtile_shape
will be an even multiple of this subtile shape. Only relevant whenmax_tile_bytes
is specified. Should be same length asarray_shape
. See Splitting by maximum bytes per tile examples.  halo (
None
,int
, sequence ofint
, or(len(array_shape), 2)
shapednumpy.ndarray
) – How tiles are extended per axis in ve and +ve directions with halo elements. See The halo parameter examples.  tile_bounds_policy (
str
) – Specifies whether tiles can extend beyond the array boundaries. Only relevant for halo values greater than one. Iftile_bounds_policy
isARRAY_BOUNDS
then the calculated tiles will not extend beyond the array extentsarray_start
andarray_start + array_shape
. Iftile_bounds_policy
isNO_BOUNDS
then the returned tiles will extend beyond thearray_start
andarray_start + array_shape
extend for positivehalo
values. See The halo parameter examples.
See also
 array_shape (sequence of