pyUSID.io.anc_build_utils.make_indices_matrix

pyUSID.io.anc_build_utils.make_indices_matrix(num_steps, is_position=True)

Makes an ancillary indices matrix given the number of steps in each dimension. In other words, this function builds a matrix whose rows correspond to unique combinations of the multiple dimensions provided.

Parameters:

• num_steps (List / numpy array / int) – Number of steps in each spatial or spectral dimension Note that the axes must be ordered from fastest varying to slowest varying

• is_position (bool, optional, default = True) – Whether the returned matrix is meant for position (True) indices (tall and skinny) or spectroscopic (False) indices (short and wide)

Returns:

indices_matrix – arranged as [steps, spatial dimension]

Return type:

2D unsigned int numpy array