get_scale_height_data

whampy.get_scale_height_data(data, track=None, deredden=False, return_pandas_dataframe=False, longitude_mask_width=None, step_size=None, R_sun=None, v_sun=None, closer=False, add_kinematic_distance=False, **kwargs)

Return data needed for scale height analysis

Parameters:

data: `skySurvey`

WHAM skySurvey object of full sky (requires track keyword), or spiral arm section

track: `str`, optional, must be keyword

if provided, will apply skySurvey.get_spiral_slice for provided track if None, will check for track as an attribute of data

deredden: `bool`, `dustmap`, optional, must be keyword

if True, will apply dereddening using 3D dustmaps of Marshall et al. (2006) or can input a dustmap to query from using the dustmaps package default to dustmaps.marshall.MarshallQuery Warning: Currently only supports Marshall Dustmap

return_pandas_dataframe: `bool`, optional, must be keyword

if True, returns pandas dataframe with subset of data specific to scale height analysis

longitude_mask_width: `number`, `u.Quantity`, optional, must be keyword

if provided, returns list of masks splitting data into sky sections of given width in degrees

step_size: `number`, `u.Quantity`, optional, must be keyword

if provided, sets step_size for longitude masks default to half width

R_sun: `u.Quantity`, optional, must be keyword

Sun Galactocentric Distance

v_sun: `u.Quantity`, optional, must be keyword

Sun rotation velocity

add_kinematic_distance: `bool`, optional, must be keyword

if True, adds in kinematic distances using a flat rotation curve where no parallax ones available

**kwargs: `dict`

keywords passed to data.get_spiral_slice if track is provided