get_rms_robust#
- mufasa.signals.get_rms_robust(cube, sigma_cut=2.5, expand=20, trim=None, method='robust', return_sigmask=False, **kwargs)[source]#
Make a robust RMS estimate.
- Parameters:
cube (SpectralCube) – SpectralCube object.
sigma_cut (float, optional) – Signal-to-noise ratio to mask out regions containing signal.
expand (int, optional) – Number of spectral channels to expand the signal mask.
trim (int or None, optional) – Number of pixels to trim from the edges of the cube.
method ({'robust', 'signal_mask'}, optional) – Method to calculate RMS.
return_sigmask (bool, optional) – Whether to return the 3D signal mask along with the RMS.
**kwargs – Additional arguments.
- Returns:
RMS value, and optionally the signal mask.
- Return type:
Quantity or tuple of Quantity