Tool for measuring 3/4 PCFs on discrete periodic data.
Project description
A useful python
package to measure the 3/4 PCFs of discrete periodic data in $\mathcal{O}(N_g \log N_g)$ time. This is done using Fast Fourier Transforms.
Basic Usage:
import sarabande
NPCF_obj = sarabande.measure(**kwargs)
sarabande.calc_zeta(NPCF_obj)
zeta = NPCF_obj.zeta
Where **kwargs
can be any of the arguments to the measure constructor function. The possible arguments are:
Args:
-
nPCF
([int
]): Must be either 3 or 4. Determines how many points we use in our nPCF. -
projected
([bool
]): Flag to determine whether the user wants a projected 3/4 PCF or the Full. Defaults to False.- if
projected
:m_max
([int
]): If user chooses projected, we set an m_max (similar to theell_max
in 3D)
- if not
projected
:ell_max
([int
]): If user choosees not projected (full nPCF) then ell_max is the highest order for calculation.
- if
-
density_field_data
([ndarray
]): A square ndarray of data that is periodic. Must be 2D for projected and 3D for full. -
save_dir
([string
]): A string to tell the algorithm where to save and store files. All temporary files will be stored here. -
save_name
([string
]): A string to tell the algorithm what to name the files. -
nbins
([int]): Number of bins to be used in nPCF calculation. -
bin_spacing
([string
]): A string to determine the spacing of bins. Options are'LIN'
,'INV'
, or'LOG'
-
bin_min
([int
]): The lower bound of the inner most bin. Default is 1. Optional. -
physical_boxsize
([float
]): An optional parameter if using a physical scale. The length of one side of the data. -
rmin
([float
]): minimum calculation distance (determinsbin_min
) -
rmax
([float
]): maximum calculation distance (determinsbin_max
)
Workflow:
The map of SARABANDE is as follows:
For more information about each algorithm, please read (Sunseri et al. 2022)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sarabande-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9469a66a35276610e9336859e5e8d0a0d1bf63a38f3dd721437af173d6486962 |
|
MD5 | 9758e751936f82035bfb86da6b9d785d |
|
BLAKE2b-256 | a942cceb13871981d55689fccf1b9ea717ffb75a506eccfa9338ea4fde244879 |