The class CatalogueChainMesh. More...

#include "Headers/Halo.h"

Inheritance diagram for cbl::catalogue::Halo:

[legend]

Collaboration diagram for cbl::catalogue::Halo:

Public Member Functions
Constructors/destructors
	Halo ()
	default constructor

std::shared_ptr< Object >	getShared ()
	function that allows copying private variables of the class when an object of class Catalogue is copied More...

	Halo (const comovingCoordinates coord, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double vx=par::defaultDouble, const double vy=par::defaultDouble, const double vz=par::defaultDouble, const double mass=par::defaultDouble)
	constructor that uses comoving coordinates More...

	Halo (const comovingCoordinates coord, const cosmology::Cosmology &cosm, const double z1_guess=0., const double z2_guess=10., const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double vx=par::defaultDouble, const double vy=par::defaultDouble, const double vz=par::defaultDouble, const double mass=par::defaultDouble)
	constructor that uses comoving coordinates and a cosmological model to estimate the redshift More...

	Halo (const observedCoordinates coord, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double vx=par::defaultDouble, const double vy=par::defaultDouble, const double vz=par::defaultDouble, const double mass=par::defaultDouble)
	constructor that uses observed coordinates in radians More...

	Halo (const observedCoordinates coord, const CoordinateUnits inputUnits, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double vx=par::defaultDouble, const double vy=par::defaultDouble, const double vz=par::defaultDouble, const double mass=par::defaultDouble)
	constructor that uses observed coordinates in any angular units More...

	Halo (const observedCoordinates coord, const cosmology::Cosmology &cosm, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double vx=par::defaultDouble, const double vy=par::defaultDouble, const double vz=par::defaultDouble, const double mass=par::defaultDouble)
	constructor that uses observed coordinates in radians and a cosmological model to estimate the comoving coordinates More...

	Halo (const observedCoordinates coord, const CoordinateUnits inputUnits, const cosmology::Cosmology &cosm, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double vx=par::defaultDouble, const double vy=par::defaultDouble, const double vz=par::defaultDouble, const double mass=par::defaultDouble)
	constructor that uses observed coordinates and a cosmological model to estimate the comoving coordinates More...

	Halo (const double xx, const double yy, const double zz, const double ra, const double dec, const double redshift, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double vx=par::defaultDouble, const double vy=par::defaultDouble, const double vz=par::defaultDouble, const double mass=par::defaultDouble)
	constructor that uses both comoving and observed coordinates More...

	~Halo ()=default
	default destructor

Member functions used to get the private members
double	vx () const override
	get the protected member m_vx More...

double	vy () const override
	get the protected member m_vy More...

double	vz () const override
	get the protected member m_vz More...

double	mass () const override
	get the protected member m_mass More...

Member functions used to set the private members
void	set_vx (const double vx=par::defaultDouble) override
	set the protected member m_vx More...

void	set_vy (const double vy=par::defaultDouble) override
	set the protected member m_vy More...

void	set_vz (const double vz=par::defaultDouble) override
	set the protected member m_vz More...

void	set_mass (const double mass=par::defaultDouble) override
	set the protected member m_mass More...

Member functions used to check if the private members are set
bool	isSet_vx () override
	check if the protected member m_vx is set More...

bool	isSet_vy () override
	check if the protected member m_vy is set More...

bool	isSet_vz () override
	check if the protected member m_vz is set More...

bool	isSet_mass () override
	check if the protected member m_mass is set More...

Public Member Functions inherited from cbl::catalogue::Object
	Object ()=default
	default constructor

	Object (const int ID)
	specific constructor for ChainMeshCell More...

	Object (const comovingCoordinates coord, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double redshiftMin=par::defaultDouble, const double redshiftMax=par::defaultDouble, const double sn=par::defaultDouble)
	constructor that uses comoving coordinates More...

	Object (const comovingCoordinates coord, const cosmology::Cosmology &cosm, const double z1_guess=0., const double z2_guess=10., const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double redshiftMin=par::defaultDouble, const double redshiftMax=par::defaultDouble, const double sn=par::defaultDouble)
	constructor that uses comoving coordinates and a cosmological model to estimate the redshift More...

	Object (const observedCoordinates coord, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double redshiftMin=par::defaultDouble, const double redshiftMax=par::defaultDouble, const double sn=par::defaultDouble)
	constructor that uses observed coordinates in radians More...

	Object (const observedCoordinates coord, const CoordinateUnits inputUnits, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double redshiftMin=par::defaultDouble, const double redshiftMax=par::defaultDouble, const double sn=par::defaultDouble)
	constructor that uses observed coordinates in any angular units More...

	Object (const observedCoordinates coord, const cosmology::Cosmology &cosm, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double redshiftMin=par::defaultDouble, const double redshiftMax=par::defaultDouble, const double sn=par::defaultDouble)
	constructor that uses observed coordinates in radians and a cosmological model to estimate the comoving coordinates More...

	Object (const observedCoordinates coord, const CoordinateUnits inputUnits, const cosmology::Cosmology &cosm, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double redshiftMin=par::defaultDouble, const double redshiftMax=par::defaultDouble, const double sn=par::defaultDouble)
	constructor that uses observed coordinates and a cosmological model to estimate the comoving coordinates More...

	Object (const double xx, const double yy, const double zz, const double ra, const double dec, const double redshift, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double redshiftMin=par::defaultDouble, const double redshiftMax=par::defaultDouble, const double sn=par::defaultDouble)
	constructor that uses both comoving and observed coordinates More...

virtual	~Object ()=default
	default destructor

double	xx () const
	get the member m_xx More...

double	yy () const
	get the member m_yy More...

double	zz () const
	get the member m_zz More...

double	dc () const
	get the member m_dc More...

double	ra () const
	get the member m_ra More...

double	dec () const
	get the member m_dec More...

double	ra_tile () const
	get the member m_ra_tile More...

double	dec_tile () const
	get the member m_dec_tile More...

double	sn () const
	get the member m_sn More...

double	redshift () const
	get the member m_redshift More...

double	redshiftMin () const
	get the member m_redshiftMin More...

double	redshiftMax () const
	get the member m_redshiftMax More...

double	weight () const
	get the member m_weight More...

long	region () const
	get the member m_region More...

int	ID () const
	get the member m_radius More...

std::string	field () const
	get the member m_field More...

double	x_displacement () const
	get the member m_x_displacement More...

double	y_displacement () const
	get the member m_y_displacement More...

double	z_displacement () const
	get the member m_z_displacement More...

std::vector< double >	coords () const
	get the object coordinates More...

virtual double	proxyerror () const
	get the member m_proxyerror More...

virtual double	magnitude () const
	get the member m_magnitude More...

virtual double	magnitudeU () const
	get the member m_magnitudeU More...

virtual double	magnitudeG () const
	get the member m_magnitudeG More...

virtual double	magnitudeR () const
	get the member m_magnitudeR More...

virtual double	magnitudeI () const
	get the member m_magnitudeI More...

virtual double	odds () const
	get the member m_odds More...

virtual double	shear1 () const
	get the member m_shear1 More...

virtual double	shear2 () const
	get the member m_shear1 More...

virtual double	lensingWeight () const
	get the member m_lensingWeight More...

virtual double	lensingCalib () const
	get the member m_lensingCalib More...

virtual double	SFR () const
	get the private member Galaxy::m_SFR More...

virtual double	sSFR () const
	get the private member Galaxy::m_sSFR More...

virtual double	mass_proxy () const
	get the member m_mass_proxy More...

virtual double	mass_proxy_error () const
	get the member m_mass_proxy_error More...

virtual int	IDHost () const
	get the member m_IDHost More...

virtual double	galaxyTag () const
	get the member m_galaxyTag More...

virtual double	mstar () const
	get the member m_mstar More...

virtual double	massinfall () const
	get the member m_massinfall More...

virtual double	bias () const
	get the member m_bias More...

virtual double	generic () const
	get the member m_generic More...

virtual double	radius () const
	get the member m_radius More...

virtual double	densityContrast () const
	get the member m_radius More...

virtual double	centralDensity () const
	get the member m_radius More...

virtual double	mass_estimate () const
	get the private member m_mass_estimate More...

virtual double	radius_estimate () const
	get the private member m_radius_estimate More...

virtual double	veldisp_estimate () const
	get the private member m_veldisp_estimate More...

virtual double	xcm () const
	get the private member m_xcm More...

virtual double	ycm () const
	get the private member m_ycm More...

virtual double	zcm () const
	get the private member m_zcm More...

virtual double	spin_x () const
	get the private member m_spin_x More...

virtual double	spin_y () const
	get the private member m_spin_y More...

virtual double	spin_z () const
	get the private member m_spin_z More...

virtual double	veldisp () const
	get the private member m_veldisp More...

virtual double	vmax () const
	get the private member m_vmax More...

virtual double	vmax_rad () const
	get the private member m_vmax_rad More...

virtual double	tot_mass () const
	get the private member m_tot_mass More...

virtual int	parent () const
	get the private member m_parent More...

virtual int	nsub () const
	get the private member m_nsub More...

virtual std::vector< std::shared_ptr< Object > >	satellites () const
	get the member m_satellites More...

virtual std::vector< unsigned int >	part () const
	get the virtual member m_part, member of ChainMeshCell More...

virtual std::vector< std::vector< unsigned int > >	nearCells () const
	get the virtual member m_nearCells, member of ChainMeshCell More...

void	set_xx (const double xx)
	set the member m_xx More...

void	set_yy (const double yy)
	set the member m_yy More...

void	set_zz (const double zz)
	set the member m_zz More...

void	set_ra (const double ra, const CoordinateUnits inputUnits=CoordinateUnits::_radians_)
	set the member m_ra, updating the comoving coordinates accordingly (if already set) More...

void	set_dec (const double dec, const CoordinateUnits inputUnits=CoordinateUnits::_radians_)
	set the member m_dec, updating the comoving coordinates accordingly (if already set) More...

void	set_ra_tile (const double ra, const CoordinateUnits inputUnits=CoordinateUnits::_radians_)
	set the member m_ra_tile More...

void	set_dec_tile (const double dec, const CoordinateUnits inputUnits=CoordinateUnits::_radians_)
	set the member m_dec_tile More...

void	set_sn (const double sn)
	set the member m_sn More...

void	set_redshift (const double redshift, const cosmology::Cosmology cosmology, const bool update_coordinates=true)
	set the member m_redshift, updating the comoving coordinates accordingly (if already set) More...

void	set_redshiftMin (const double redshiftMin)
	set the member m_redshiftMin More...

void	set_redshiftMax (const double redshiftMax)
	set the member m_redshiftMax More...

virtual void	set_odds (const double odds)
	set the member m_odds More...

virtual void	set_shear1 (const double shear1)
	set the member m_shear1 More...

virtual void	set_shear2 (const double shear2)
	set the member m_shear2 More...

virtual void	set_lensingWeight (const double lensingWeight)
	set the member m_lensingWeight More...

virtual void	set_lensingCalib (const double lensingCalib)
	set the member m_lensingCalib More...

void	set_dc (const double dc)
	set the member m_dc, updating the comoving coordinates accordingly More...

void	set_weight (const double weight)
	set the member m_weight More...

void	set_region (const long region)
	set the member m_region More...

void	set_ID (const int ID)
	set the member m_ID More...

void	set_field (const std::string field)
	set the member m_field More...

void	set_x_displacement (const double x_displacement)
	set the member m_x_displacement More...

void	set_y_displacement (const double y_displacement)
	set the member m_y_displacement More...

void	set_z_displacement (const double z_displacement)
	set the member m_z_displacement More...

virtual void	set_IDHost (const int IDHost)
	set the member m_IDHost More...

virtual void	set_galaxyTag (const double galaxyTag)
	set the member m_galaxyTag More...

virtual void	set_mstar (const double mstar)
	set the member m_mstar More...

virtual void	set_massinfall (const double massinfall)
	set the member m_massinfall More...

virtual void	set_proxyerror (const double value)
	set the member m_proxyerror More...

virtual void	set_magnitude (const double magnitude)
	set the member m_magnitude More...

virtual void	set_magnitudeU (const double magnitudeU)
	set the member m_magnitudeU More...

virtual void	set_magnitudeG (const double magnitudeG)
	set the member m_magnitudeG More...

virtual void	set_magnitudeR (const double magnitudeR)
	set the member m_magnitudeR More...

virtual void	set_magnitudeI (const double magnitudeI)
	set the member m_magnitudeI More...

virtual void	set_SFR (const double SFR)
	set the private member Galaxy::m_SFR More...

virtual void	set_sSFR (const double sSFR)
	set the private member Galaxy::m_sSFR More...

virtual void	set_mass_proxy (const double mass_proxy)
	set the member m_mass_proxy More...

virtual void	set_mass_proxy_error (const double mass_proxy_error)
	set the member m_mass_proxy_error More...

virtual void	set_bias (const double bias)
	set the member m_bias More...

virtual void	set_generic (const double generic)
	set the member m_generic More...

virtual void	set_radius (const double radius)
	set the member m_radius More...

virtual void	set_densityContrast (const double densityContrast)
	set the member m_densityContrast More...

virtual void	set_centralDensity (const double centralDensity)
	set the member m_centralDensity More...

virtual void	set_mass_estimate (const double mass_estimate)
	set the private member m_mass_estimate More...

virtual void	set_radius_estimate (const double radius_estimate)
	set the private member m_radius_estimate More...

virtual void	set_veldisp_estimate (const double veldisp_estimate)
	set the private member m_veldisp_estimate More...

virtual void	set_xcm (const double xcm)
	set the private member m_xcm More...

virtual void	set_ycm (const double ycm)
	set the private member m_ycm More...

virtual void	set_zcm (const double zcm)
	set the private member m_zcm More...

virtual void	set_spin_x (const double spin_x)
	set the private member m_spin_x More...

virtual void	set_spin_y (const double spin_y)
	set the private member m_spin_y More...

virtual void	set_spin_z (const double spin_z)
	set the private member m_spin_z More...

virtual void	set_veldisp (const double veldisp)
	set the private member m_veldisp More...

virtual void	set_vmax (const double vmax)
	set the private member m_vmax More...

virtual void	set_vmax_rad (const double vmax_rad)
	set the private member m_vmax_rad More...

virtual void	set_tot_mass (const double tot_mass)
	set the private member m_tot_mass More...

virtual void	set_parent (const int parent)
	set the private member m_parent More...

virtual void	set_nsub (const int nsub)
	set the private member m_nsub More...

virtual void	set_satellite (const std::shared_ptr< Object > satellite)
	set the private member m_satellites More...

virtual void	set_satellites (const std::vector< std::shared_ptr< Object >> satellites)
	set the private member m_satellites More...

virtual void	set_part (const std::vector< unsigned int > part)
	set the virtual private member m_part (member of ChainMeshCell) More...

virtual void	set_nearCells (const std::vector< std::vector< unsigned int >> nearCells)
	set the virtual private member m_nearCells (member of ChainMeshCell) More...

bool	isSet_xx () const
	check if the member m_xx is set More...

bool	isSet_yy () const
	check if the member m_yy is set More...

bool	isSet_zz ()
	check if the member m_zz is set More...

bool	isSet_ra ()
	check if the member m_ra is set More...

bool	isSet_dec ()
	check if the member m_dec is set More...

bool	isSet_ra_tile ()
	check if the member m_ra_tile is set More...

bool	isSet_dec_tile ()
	check if the member m_dec_tile is set More...

bool	isSet_sn ()
	check if the member m_sn is set More...

bool	isSet_redshift ()
	check if the member m_redshift is set More...

bool	isSet_redshiftMin ()
	check if the member m_redshiftMin is set More...

bool	isSet_redshiftMax ()
	check if the member m_redshiftMax is set More...

virtual bool	isSet_shear1 ()
	check if the member m_shear1 is set More...

virtual bool	isSet_shear2 ()
	check if the member m_shear2 is set More...

virtual bool	isSet_odds ()
	check if the member m_odds is set More...

virtual bool	isSet_lensingWeight ()
	check if the member m_lensingWeight is set More...

virtual bool	isSet_lensingCalib ()
	check if the member m_lensingCalib is set More...

bool	isSet_dc ()
	check if the member m_dc is set More...

bool	isSet_weight ()
	check if the member m_weight is set More...

bool	isSet_region ()
	check if the member m_region is set More...

bool	isSet_field ()
	check if the member m_field is set More...

bool	isSet_x_displacement ()
	check if the member m_x_displacement is set More...

bool	isSet_y_displacement ()
	check if the member m_y_displacement is set More...

bool	isSet_z_displacement ()
	check if the member m_z_displacement is set More...

virtual bool	isSet_magnitude ()
	check if the member m_magnitude is set More...

virtual bool	isSet_magnitudeU ()
	check if the member m_magnitudeU is set More...

virtual bool	isSet_magnitudeG ()
	check if the member m_magnitudeG is set More...

virtual bool	isSet_magnitudeR ()
	check if the member m_magnitudeR is set More...

virtual bool	isSet_magnitudeI ()
	check if the member m_magnitudeI is set More...

virtual bool	isSet_SFR ()
	check if the member m_SFR is set More...

virtual bool	isSet_sSFR ()
	check if the private member Galaxy::m_sSFR is set More...

virtual bool	isSet_mass_proxy ()
	check if the member m_mass_proxy is set More...

virtual bool	isSet_mass_proxy_error ()
	check if the member m_mass_proxy_error is set More...

virtual bool	isSet_bias ()
	check if the member m_bias is set More...

virtual bool	isSet_generic ()
	check if the member m_generic is set More...

virtual bool	isSet_radius ()
	check if the member m_radius is set More...

virtual bool	isSet_densityContrast ()
	check if the member m_densityContrast is set More...

virtual bool	isSet_centralDensity ()
	check if the member m_centralDensity is set More...

virtual bool	isSet_mass_estimate ()
	check if the member m_mass_estimate is set More...

virtual bool	isSet_radius_estimate ()
	check if the member m_radius_estimate is set More...

virtual bool	isSet_veldisp_estimate ()
	check if the member m_veldisp_estimate is set More...

virtual bool	isSet_xcm ()
	check if the member m_xcm is set More...

virtual bool	isSet_ycm ()
	check if the member m_ycm is set More...

virtual bool	isSet_zcm ()
	check if the member m_zcm is set More...

virtual bool	isSet_spin_x ()
	check if the member m_spin_x is set More...

virtual bool	isSet_spin_y ()
	check if the member m_spin_y is set More...

virtual bool	isSet_spin_z ()
	check if the member m_spin_z is set More...

virtual bool	isSet_veldisp ()
	check if the member m_veldisp is set More...

virtual bool	isSet_vmax ()
	check if the member m_vmax is set More...

virtual bool	isSet_vmax_rad ()
	check if the member m_vmax_rad is set More...

virtual bool	isSet_tot_mass ()
	check if the member m_tot_mass is set More...

virtual bool	isSet_parent ()
	check if the member m_parent is set More...

virtual bool	isSet_nsub ()
	check if the member m_nsub is set More...

virtual bool	isSet_ID ()
	check if the member m_ID is set More...

virtual bool	isSet_IDHost ()
	get the member m_IDHost More...

virtual bool	isSet_galaxyTag ()
	get the member m_galaxyTag More...

virtual bool	isSet_mstar ()
	check if the member m_mstar is set More...

virtual bool	isSet_massinfall ()
	check if the member m_massinfall is set More...

Protected Attributes
double	m_vx
	halo peculiar velocity along the x direction

double	m_vy
	halo peculiar velocity along the y direction

double	m_vz
	halo peculiar velocity along the z direction

double	m_mass
	halo mass

Protected Attributes inherited from cbl::catalogue::Object
double	m_xx = cbl::par::defaultDouble
	comoving coordinate x

double	m_yy = cbl::par::defaultDouble
	comoving coordinate y

double	m_zz = cbl::par::defaultDouble
	comoving coordinate z

double	m_ra = cbl::par::defaultDouble
	Right Ascension.

double	m_dec = cbl::par::defaultDouble
	Declination.

double	m_ra_tile = cbl::par::defaultDouble
	Tile central Right Ascension.

double	m_dec_tile = cbl::par::defaultDouble
	Tile central Declination.

double	m_redshift = cbl::par::defaultDouble
	redshift

double	m_dc = cbl::par::defaultDouble
	comoving distance

double	m_weight = 1.
	weight

long	m_region = cbl::par::defaultLong
	region (used for jackknife/bootstrap)

int	m_ID = cbl::par::defaultInt
	ID.

std::string	m_field = cbl::par::defaultString
	observed field

double	m_x_displacement = cbl::par::defaultDouble
	displacement along the x-axis

double	m_y_displacement = cbl::par::defaultDouble
	displacement along the y-axis

double	m_z_displacement = cbl::par::defaultDouble
	displacement along the z-axis

double	m_redshiftMin = cbl::par::defaultDouble
	minimum redshift

double	m_redshiftMax = cbl::par::defaultDouble
	maximum redshift

double	m_sn = cbl::par::defaultDouble
	Signal-to-noise.

Additional Inherited Members
Static Public Member Functions inherited from cbl::catalogue::Object
static std::shared_ptr< Object >	Create (const ObjectType ObjectType)
	static factory used to construct objects of any type, providing in input comoving coordinates More...

static std::shared_ptr< Object >	Create (const ObjectType ObjectType, const comovingCoordinates coord, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble)
	static factory used to construct objects of any type, providing in input comoving coordinates More...

static std::shared_ptr< Object >	Create (const ObjectType ObjectType, const comovingCoordinates coord, const cosmology::Cosmology &cosm, const double z1_guess=0., const double z2_guess=10., const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble)
	static factory used to construct objects of any type, providing in input comoving coordinates and a cosmological model to estimate the redshift More...

static std::shared_ptr< Object >	Create (const ObjectType ObjectType, const observedCoordinates coord, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble)
	static factory used to construct objects of any kind, providing in input observed coordinates in radians More...

static std::shared_ptr< Object >	Create (const ObjectType ObjectType, const observedCoordinates coord, const CoordinateUnits inputUnits, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble)
	static factory used to construct objects of any kind, providing in input observed coordinates in any angular units More...

static std::shared_ptr< Object >	Create (const ObjectType ObjectType, const observedCoordinates coord, const cosmology::Cosmology &cosm, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble)
	static factory used to construct objects of any kind, providing in input observed coordinates in radians and a cosmological model to estimate the comoving coordinates More...

static std::shared_ptr< Object >	Create (const ObjectType ObjectType, const observedCoordinates coord, const CoordinateUnits inputUnits, const cosmology::Cosmology &cosm, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble)
	static factory used to construct objects of any kind, providing in input observed coordinates and a cosmological model to estimate the comoving coordinates More...

static std::shared_ptr< Object >	Create (const ObjectType ObjectType, const double xx, const double yy, const double zz, const double ra, const double dec, const double redshift, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble)
	static factory used to construct objects of any kind, providing in input both comoving and observed coordinates More...

static std::shared_ptr< Object >	Create (const int ID=par::defaultInt, const std::vector< unsigned int > part={}, std::vector< std::vector< unsigned int >> nearCells={})
	static factory used to construct objects of ChainMeshCell type More...

Detailed Description

The class CatalogueChainMesh.

The class Halo.

This class is used to handle objects of type CatalogueChainMesh

This class is used to handle objects of type halo

Definition at line 53 of file Halo.h.

Constructor & Destructor Documentation

◆ Halo() [1/7]

cbl::catalogue::Halo::Halo	(	const comovingCoordinates	coord,
		const double	weight = `1.`,
		const long	region = `par::defaultLong`,
		const int	ID = `par::defaultInt`,
		const std::string	field = `par::defaultString`,
		const double	x_displacement = `par::defaultDouble`,
		const double	y_displacement = `par::defaultDouble`,
		const double	z_displacement = `par::defaultDouble`,
		const double	vx = `par::defaultDouble`,
		const double	vy = `par::defaultDouble`,
		const double	vz = `par::defaultDouble`,
		const double	mass = `par::defaultDouble`
	)

inline

constructor that uses comoving coordinates

Parameters

coord	structure containing the comoving coordinates {x, y, z}
weight	weight
region	region, used e.g. for jackknife and bootstrap
ID	the object ID
field	the field where the object has been observed
x_displacement	the displacement along the x-axis
y_displacement	the displacement along the y-axis
z_displacement	the displacement along the z-axis
vx	halo peculiar velocity along the x direction
vy	halo peculiar velocity along the y direction
vz	halo peculiar velocity along the z direction
mass	the halo mass

Definition at line 125 of file Halo.h.

◆ Halo() [2/7]

cbl::catalogue::Halo::Halo	(	const comovingCoordinates	coord,
		const cosmology::Cosmology &	cosm,
		const double	z1_guess = `0.`,
		const double	z2_guess = `10.`,
		const double	weight = `1.`,
		const long	region = `par::defaultLong`,
		const int	ID = `par::defaultInt`,
		const std::string	field = `par::defaultString`,
		const double	x_displacement = `par::defaultDouble`,
		const double	y_displacement = `par::defaultDouble`,
		const double	z_displacement = `par::defaultDouble`,
		const double	vx = `par::defaultDouble`,
		const double	vy = `par::defaultDouble`,
		const double	vz = `par::defaultDouble`,
		const double	mass = `par::defaultDouble`
	)

inline

constructor that uses comoving coordinates and a cosmological model to estimate the redshift

Parameters

coord	structure containing the comoving coordinates {x, y, z}
cosm	object of class Cosmology, used to estimate comoving distances
z1_guess	minimum prior on the redshift
z2_guess	maximum prior on the redshift
weight	weight
region	region, used e.g. for jackknife and bootstrap
ID	the object ID
field	the field where the object has been observed
x_displacement	the displacement along the x-axis
y_displacement	the displacement along the y-axis
z_displacement	the displacement along the z-axis
vx	halo peculiar velocity along the x direction
vy	halo peculiar velocity along the y direction
vz	halo peculiar velocity along the z direction
mass	the halo mass

Definition at line 166 of file Halo.h.

◆ Halo() [3/7]

cbl::catalogue::Halo::Halo	(	const observedCoordinates	coord,
		const double	weight = `1.`,
		const long	region = `par::defaultLong`,
		const int	ID = `par::defaultInt`,
		const std::string	field = `par::defaultString`,
		const double	x_displacement = `par::defaultDouble`,
		const double	y_displacement = `par::defaultDouble`,
		const double	z_displacement = `par::defaultDouble`,
		const double	vx = `par::defaultDouble`,
		const double	vy = `par::defaultDouble`,
		const double	vz = `par::defaultDouble`,
		const double	mass = `par::defaultDouble`
	)

inline

constructor that uses observed coordinates in radians

Parameters

coord	structure containing the observed coordinates {R.A., Dec, redshift}
weight	weight
region	region, used e.g. for jackknife and bootstrap
ID	the object ID
field	the field where the object has been observed
x_displacement	the displacement along the x-axis
y_displacement	the displacement along the y-axis
z_displacement	the displacement along the z-axis
vx	halo peculiar velocity along the x direction
vy	halo peculiar velocity along the y direction
vz	halo peculiar velocity along the z direction
mass	the halo mass

Definition at line 199 of file Halo.h.

◆ Halo() [4/7]

cbl::catalogue::Halo::Halo	(	const observedCoordinates	coord,
		const CoordinateUnits	inputUnits,
		const double	weight = `1.`,
		const long	region = `par::defaultLong`,
		const int	ID = `par::defaultInt`,
		const std::string	field = `par::defaultString`,
		const double	x_displacement = `par::defaultDouble`,
		const double	y_displacement = `par::defaultDouble`,
		const double	z_displacement = `par::defaultDouble`,
		const double	vx = `par::defaultDouble`,
		const double	vy = `par::defaultDouble`,
		const double	vz = `par::defaultDouble`,
		const double	mass = `par::defaultDouble`
	)

inline

constructor that uses observed coordinates in any angular units

Parameters

coord	structure containing the observed coordinates {R.A., Dec, redshift}
inputUnits	the units of the input coordinates
weight	weight
region	region, used e.g. for jackknife and bootstrap
ID	the object ID
field	the field where the object has been observed
x_displacement	the displacement along the x-axis
y_displacement	the displacement along the y-axis
z_displacement	the displacement along the z-axis
vx	halo peculiar velocity along the x direction
vy	halo peculiar velocity along the y direction
vz	halo peculiar velocity along the z direction
mass	the halo mass

Definition at line 235 of file Halo.h.

◆ Halo() [5/7]

cbl::catalogue::Halo::Halo	(	const observedCoordinates	coord,
		const cosmology::Cosmology &	cosm,
		const double	weight = `1.`,
		const long	region = `par::defaultLong`,
		const int	ID = `par::defaultInt`,
		const std::string	field = `par::defaultString`,
		const double	x_displacement = `par::defaultDouble`,
		const double	y_displacement = `par::defaultDouble`,
		const double	z_displacement = `par::defaultDouble`,
		const double	vx = `par::defaultDouble`,
		const double	vy = `par::defaultDouble`,
		const double	vz = `par::defaultDouble`,
		const double	mass = `par::defaultDouble`
	)

inline

constructor that uses observed coordinates in radians and a cosmological model to estimate the comoving coordinates

Parameters

coord	structure containing the observed coordinates {R.A., Dec, redshitf}
cosm	object of class Cosmology, used to estimate comoving distances
weight	weight
region	region, used e.g. for jackknife and bootstrap
ID	the object ID
field	the field where the object has been observed
x_displacement	the displacement along the x-axis
y_displacement	the displacement along the y-axis
z_displacement	the displacement along the z-axis
vx	halo peculiar velocity along the x direction
vy	halo peculiar velocity along the y direction
vz	halo peculiar velocity along the z direction
mass	the halo mass

Definition at line 273 of file Halo.h.

◆ Halo() [6/7]

cbl::catalogue::Halo::Halo	(	const observedCoordinates	coord,
		const CoordinateUnits	inputUnits,
		const cosmology::Cosmology &	cosm,
		const double	weight = `1.`,
		const long	region = `par::defaultLong`,
		const int	ID = `par::defaultInt`,
		const std::string	field = `par::defaultString`,
		const double	x_displacement = `par::defaultDouble`,
		const double	y_displacement = `par::defaultDouble`,
		const double	z_displacement = `par::defaultDouble`,
		const double	vx = `par::defaultDouble`,
		const double	vy = `par::defaultDouble`,
		const double	vz = `par::defaultDouble`,
		const double	mass = `par::defaultDouble`
	)

inline

constructor that uses observed coordinates and a cosmological model to estimate the comoving coordinates

Parameters

coord	structure containing the observed coordinates {R.A., Dec, redshift}
inputUnits	the units of the input coordinates
cosm	object of class Cosmology, used to estimate comoving distances
weight	weight
region	region, used e.g. for jackknife and bootstrap
ID	the object ID
field	the field where the object has been observed
x_displacement	the displacement along the x-axis
y_displacement	the displacement along the y-axis
z_displacement	the displacement along the z-axis
vx	halo peculiar velocity along the x direction
vy	halo peculiar velocity along the y direction
vz	halo peculiar velocity along the z direction
mass	the halo mass

Definition at line 312 of file Halo.h.

◆ Halo() [7/7]

cbl::catalogue::Halo::Halo	(	const double	xx,
		const double	yy,
		const double	zz,
		const double	ra,
		const double	dec,
		const double	redshift,
		const double	weight = `1.`,
		const long	region = `par::defaultLong`,
		const int	ID = `par::defaultInt`,
		const std::string	field = `par::defaultString`,
		const double	x_displacement = `par::defaultDouble`,
		const double	y_displacement = `par::defaultDouble`,
		const double	z_displacement = `par::defaultDouble`,
		const double	vx = `par::defaultDouble`,
		const double	vy = `par::defaultDouble`,
		const double	vz = `par::defaultDouble`,
		const double	mass = `par::defaultDouble`
	)

inline

constructor that uses both comoving and observed coordinates

Parameters

xx	comoving coordinate
yy	comoving coordinate
zz	comoving coordinate
ra	Right Ascension
dec	Declination
redshift	redshift
weight	weight
region	region, used e.g. for jackknife and bootstrap
ID	the object ID
field	the field where the object has been observed
x_displacement	the displacement along the x-axis
y_displacement	the displacement along the y-axis
z_displacement	the displacement along the z-axis
vx	halo peculiar velocity along the x direction
vy	halo peculiar velocity along the y direction
vz	halo peculiar velocity along the z direction
mass	the halo mass

Definition at line 355 of file Halo.h.

Member Function Documentation

◆ getShared()

std::shared_ptr<Object> cbl::catalogue::Halo::getShared ( )

inlinevirtual

function that allows copying private variables of the class when an object of class Catalogue is copied

Returns: a shared pointer to the Object

Reimplemented from cbl::catalogue::Object.

Reimplemented in cbl::catalogue::Mock, and cbl::catalogue::HostHalo.

Definition at line 91 of file Halo.h.

◆ isSet_mass()

bool cbl::catalogue::Halo::isSet_mass ( )

inlineoverridevirtual

check if the protected member m_mass is set

Returns: true if the mass is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 475 of file Halo.h.

◆ isSet_vx()

bool cbl::catalogue::Halo::isSet_vx ( )

inlineoverridevirtual

check if the protected member m_vx is set

Returns: true if the peculiar velocity along the x direction is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 449 of file Halo.h.

◆ isSet_vy()

bool cbl::catalogue::Halo::isSet_vy ( )

inlineoverridevirtual

check if the protected member m_vy is set

Returns: true if the peculiar velocity along the y direction is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 458 of file Halo.h.

◆ isSet_vz()

bool cbl::catalogue::Halo::isSet_vz ( )

inlineoverridevirtual

check if the protected member m_vz is set

Returns: true if the peculiar velocity along the z direction is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 467 of file Halo.h.

◆ mass()

double cbl::catalogue::Halo::mass ( ) const

inlineoverridevirtual

get the protected member m_mass

Returns: the mass of the halo

Reimplemented from cbl::catalogue::Object.

Definition at line 396 of file Halo.h.

◆ set_mass()

void cbl::catalogue::Halo::set_mass ( const double mass = par::defaultDouble )

inlineoverridevirtual

set the protected member m_mass

Parameters

mass	the mass of the halo

Reimplemented from cbl::catalogue::Object.

Definition at line 432 of file Halo.h.

◆ set_vx()

void cbl::catalogue::Halo::set_vx ( const double vx = par::defaultDouble )

inlineoverridevirtual

set the protected member m_vx

Parameters

vx	the the halo peculiar velocity along the x direction

Reimplemented from cbl::catalogue::Object.

Definition at line 411 of file Halo.h.

◆ set_vy()

void cbl::catalogue::Halo::set_vy ( const double vy = par::defaultDouble )

inlineoverridevirtual

set the protected member m_vy

Parameters

vy	the the halo peculiar velocity along the y direction

Reimplemented from cbl::catalogue::Object.

Definition at line 418 of file Halo.h.

◆ set_vz()

void cbl::catalogue::Halo::set_vz ( const double vz = par::defaultDouble )

inlineoverridevirtual

set the protected member m_vz

Parameters

vz	the the halo peculiar velocity along the z direction

Reimplemented from cbl::catalogue::Object.

Definition at line 425 of file Halo.h.

◆ vx()

double cbl::catalogue::Halo::vx ( ) const

inlineoverridevirtual

get the protected member m_vx

Returns: the halo peculiar velocity along the x direction

Reimplemented from cbl::catalogue::Object.

Definition at line 375 of file Halo.h.

◆ vy()

double cbl::catalogue::Halo::vy ( ) const

inlineoverridevirtual

get the protected member m_vy

Returns: the halo peculiar velocity along the y direction

Reimplemented from cbl::catalogue::Object.

Definition at line 382 of file Halo.h.

◆ vz()

double cbl::catalogue::Halo::vz ( ) const

inlineoverridevirtual

get the protected member m_vz

Returns: the halo peculiar velocity along the z direction

Reimplemented from cbl::catalogue::Object.

Definition at line 389 of file Halo.h.

The documentation for this class was generated from the following file:

Headers/Halo.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Halo() [1/7]

◆ Halo() [2/7]

◆ Halo() [3/7]

◆ Halo() [4/7]

◆ Halo() [5/7]

◆ Halo() [6/7]

◆ Halo() [7/7]

Member Function Documentation

◆ getShared()

◆ isSet_mass()

◆ isSet_vx()

◆ isSet_vy()

◆ isSet_vz()

◆ mass()

◆ set_mass()

◆ set_vx()

◆ set_vy()

◆ set_vz()

◆ vx()

◆ vy()

◆ vz()