Field and mesh (fieldmesh)#
Handle fields and mesh grids.
|
Record binned vectors given a binning scheme and mesh grid parameters. |
- triumvirate.fieldmesh.record_binned_vectors(binning, paramset=None, boxsize=None, ngrid=None)[source]#
Record binned vectors given a binning scheme and mesh grid parameters.
- Parameters
binning (
Binning) – Binning.paramset (
ParameterSet, optional) – Parameters set including the mesh grid parameters. If None (default), boxsize and ngrid must be provided.boxsize (float or sequence of [float, float, float], optional) – Box size in each dimension (default is None). Must be provided if paramset is None. This will override the corresponding entries in paramset.
ngrid (int or sequence of [int, int, int], optional) – Grid number in each dimension (default is None). Must be provided if paramset is set. This will override the corresponding entries in paramset.
- Returns
binned_vectors – Binned vectors as a structured array with the following fields—
'index': bin index;'lower_edge': lower edge of the bin;'upper_edge': upper edge of the bin;'vecx': x-component of the vector;'vecy': y-component of the vector;'vecz': z-component of the vector,
- Return type