RadialSatelliteAlignment

class halotools.empirical_models.RadialSatelliteAlignment(prim_gal_axis='major', **kwargs)

Bases: object

radial alignment model for satellite galaxies

Parameters:

satellite_alignment_strengthfloat

parameter between [-1,1] that sets the alignment strength

prim_gal_axisstring, optional

string indicating which galaxy principle axis is correlated with the halo alignment axis. The options are: major, intermediate, or minor.

Notes

If the kwargs or table contain a key “satellite_alignment_strength”, this will be used instead.

Methods Summary

assign_satellite_orientation(**kwargs)	assign a a set of three orthoganl unit vectors indicating the orientation of the galaxies' major, intermediate, and minor axis
get_radial_vector([Lbox])	caclulate the radial vector for satellite galaxies
inherit_halocat_properties([seed])	inherit the box size during mock population
set_default_params()	set default parameters

Methods Documentation

assign_satellite_orientation(**kwargs)

assign a a set of three orthoganl unit vectors indicating the orientation of the galaxies’ major, intermediate, and minor axis

Returns:

major_aixs, intermediate_axis, minor_axisnumpy nd.arrays

arrays of galaxies’ axies

get_radial_vector(Lbox=None, **kwargs)

caclulate the radial vector for satellite galaxies

Parameters:

x, y, zarray_like

galaxy positions

halo_x, halo_y, halo_zarray_like

host halo positions

halo_rarray_like

halo size

Lboxarray_like

array len(3) giving the simulation box size along each dimension

Returns:

r_vecnumpy.array

array of radial vectors of shape (Ngal, 3) between host halos and satellites

rnumpy.array

radial distance

inherit_halocat_properties(seed=None, **kwargs)

inherit the box size during mock population

set_default_params()

set default parameters