CosmoBolognaLib
Free Software C++/Python libraries for cosmological calculations
cbl::catalogue::HostHalo Class Reference

The class HostHalo. More...

#include "Headers/Lib/HostHalo.h"

Inheritance diagram for cbl::catalogue::HostHalo:
Collaboration diagram for cbl::catalogue::HostHalo:

Public Member Functions

Constructors/destructors
 HostHalo ()
 default constructor
 
std::shared_ptr< ObjectgetShared ()
 function that allows copying private variables of the class when an object of class Catalogue is copied More...
 
 HostHalo (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, const double tot_mass=par::defaultDouble, const double mass_estimate=par::defaultDouble, const double radius_estimate=par::defaultDouble, const double veldisp_estimate=par::defaultDouble, const comovingCoordinates cm_coord={par::defaultDouble, par::defaultDouble, par::defaultDouble}, const double spin_x=par::defaultDouble, const double spin_y=par::defaultDouble, const double spin_z=par::defaultDouble, const double veldisp=par::defaultDouble, const double vmax=par::defaultDouble, const double vmax_rad=par::defaultDouble, const double radius=par::defaultDouble, const int parent=par::defaultInt, const int nsub=par::defaultInt, std::vector< std::shared_ptr< Object >> satellites={})
 constructor that uses comoving coordinates More...
 
 HostHalo (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, const double tot_mass=par::defaultDouble, const double mass_estimate=par::defaultDouble, const double radius_estimate=par::defaultDouble, const double veldisp_estimate=par::defaultDouble, const comovingCoordinates cm_coord={par::defaultDouble, par::defaultDouble, par::defaultDouble}, const double spin_x=par::defaultDouble, const double spin_y=par::defaultDouble, const double spin_z=par::defaultDouble, const double veldisp=par::defaultDouble, const double vmax=par::defaultDouble, const double vmax_rad=par::defaultDouble, const double radius=par::defaultDouble, const int parent=par::defaultInt, const int nsub=par::defaultInt, std::vector< std::shared_ptr< Object >> satellites={})
 constructor that uses comoving coordinates and a cosmological model to estimate the redshift More...
 
 HostHalo (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, const double tot_mass=par::defaultDouble, const double mass_estimate=par::defaultDouble, const double radius_estimate=par::defaultDouble, const double veldisp_estimate=par::defaultDouble, const comovingCoordinates cm_coord={par::defaultDouble, par::defaultDouble, par::defaultDouble}, const double spin_x=par::defaultDouble, const double spin_y=par::defaultDouble, const double spin_z=par::defaultDouble, const double veldisp=par::defaultDouble, const double vmax=par::defaultDouble, const double vmax_rad=par::defaultDouble, const double radius=par::defaultDouble, const int parent=par::defaultInt, const int nsub=par::defaultInt, std::vector< std::shared_ptr< Object >> satellites={})
 constructor that uses observed coordinates in radians More...
 
 HostHalo (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, const double tot_mass=par::defaultDouble, const double mass_estimate=par::defaultDouble, const double radius_estimate=par::defaultDouble, const double veldisp_estimate=par::defaultDouble, const comovingCoordinates cm_coord={par::defaultDouble, par::defaultDouble, par::defaultDouble}, const double spin_x=par::defaultDouble, const double spin_y=par::defaultDouble, const double spin_z=par::defaultDouble, const double veldisp=par::defaultDouble, const double vmax=par::defaultDouble, const double vmax_rad=par::defaultDouble, const double radius=par::defaultDouble, const int parent=par::defaultInt, const int nsub=par::defaultInt, std::vector< std::shared_ptr< Object >> satellites={})
 constructor that uses observed coordinates in any angular units More...
 
 HostHalo (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, const double tot_mass=par::defaultDouble, const double mass_estimate=par::defaultDouble, const double radius_estimate=par::defaultDouble, const double veldisp_estimate=par::defaultDouble, const comovingCoordinates cm_coord={par::defaultDouble, par::defaultDouble, par::defaultDouble}, const double spin_x=par::defaultDouble, const double spin_y=par::defaultDouble, const double spin_z=par::defaultDouble, const double veldisp=par::defaultDouble, const double vmax=par::defaultDouble, const double vmax_rad=par::defaultDouble, const double radius=par::defaultDouble, const int parent=par::defaultInt, const int nsub=par::defaultInt, std::vector< std::shared_ptr< Object >> satellites={})
 constructor that uses observed coordinates in radians and a cosmological model to estimate the comoving coordinates More...
 
 HostHalo (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, const double tot_mass=par::defaultDouble, const double mass_estimate=par::defaultDouble, const double radius_estimate=par::defaultDouble, const double veldisp_estimate=par::defaultDouble, const comovingCoordinates cm_coord={par::defaultDouble, par::defaultDouble, par::defaultDouble}, const double spin_x=par::defaultDouble, const double spin_y=par::defaultDouble, const double spin_z=par::defaultDouble, const double veldisp=par::defaultDouble, const double vmax=par::defaultDouble, const double vmax_rad=par::defaultDouble, const double radius=par::defaultDouble, const int parent=par::defaultInt, const int nsub=par::defaultInt, std::vector< std::shared_ptr< Object >> satellites={})
 constructor that uses observed coordinates and a cosmological model to estimate the comoving coordinates More...
 
 HostHalo (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, const double tot_mass=par::defaultDouble, const double mass_estimate=par::defaultDouble, const double radius_estimate=par::defaultDouble, const double veldisp_estimate=par::defaultDouble, const comovingCoordinates cm_coord={par::defaultDouble, par::defaultDouble, par::defaultDouble}, const double spin_x=par::defaultDouble, const double spin_y=par::defaultDouble, const double spin_z=par::defaultDouble, const double veldisp=par::defaultDouble, const double vmax=par::defaultDouble, const double vmax_rad=par::defaultDouble, const double radius=par::defaultDouble, const int parent=par::defaultInt, const int nsub=par::defaultInt, std::vector< std::shared_ptr< Object >> satellites={})
 constructor that uses both comoving and observed coordinates More...
 
 ~HostHalo ()=default
 default destructor
 
Member functions used to get the private members
double tot_mass () const override
 get the private member HostHalo::m_tot_mass More...
 
double mass_estimate () const override
 get the private member HostHalo::m_mass_estimate More...
 
double radius_estimate () const override
 get the private member HostHalo::m_radius_estimate More...
 
double veldisp_estimate () const override
 get the private member HostHalo::m_veldisp_estimate More...
 
double xcm () const override
 get the private member HostHalo::m_xcm More...
 
double ycm () const override
 get the private member HostHalo::m_ycm More...
 
double zcm () const override
 get the private member HostHalo::m_zcm More...
 
double spin_x () const override
 get the private member HostHalo::m_spin_x More...
 
double spin_y () const override
 get the private member HostHalo::m_spin_y More...
 
double spin_z () const override
 get the private member HostHalo::m_spin_z More...
 
double veldisp () const override
 get the private member HostHalo::m_veldisp More...
 
double vmax () const override
 get the private member HostHalo::m_vmax More...
 
double vmax_rad () const override
 get the private member HostHalo::m_vmax_rad More...
 
double radius () const override
 get the private member HostHalo::m_radius More...
 
int parent () const override
 get the private member HostHalo::m_parent More...
 
int nsub () const override
 get the private member HostHalo::m_nsub More...
 
std::vector< std::shared_ptr< Object > > satellites () const override
 get the private member HostHalo::m_satellites More...
 
Member functions used to set the private members
void set_tot_mass (const double tot_mass=par::defaultDouble) override
 set the private member HostHalo::m_tot_mass More...
 
void set_mass_estimate (const double mass_estimate=par::defaultDouble) override
 set the private member HostHalo::m_mass_estimate More...
 
void set_radius_estimate (const double radius_estimate=par::defaultDouble) override
 set the private member HostHalo::m_radius_estimate More...
 
void set_veldisp_estimate (const double veldisp_estimate=par::defaultDouble) override
 set the private member HostHalo::m_veldisp_estimate More...
 
void set_xcm (const double xcm=par::defaultDouble) override
 set the private member HostHalo::m_xcm More...
 
void set_ycm (const double ycm=par::defaultDouble) override
 set the private member HostHalo::m_ycm More...
 
void set_zcm (const double zcm=par::defaultDouble) override
 set the private member HostHalo::m_zcm More...
 
void set_spin_x (const double spin_x=par::defaultDouble) override
 set the private member HostHalo::m_spin_x More...
 
void set_spin_y (const double spin_y=par::defaultDouble) override
 set the private member HostHalo::m_spin_y More...
 
void set_spin_z (const double spin_z=par::defaultDouble) override
 set the private member HostHalo::m_spin_z More...
 
void set_veldisp (const double veldisp=par::defaultDouble) override
 set the private member HostHalo::m_veldisp More...
 
void set_vmax (const double vmax=par::defaultDouble) override
 set the private member HostHalo::m_vmax More...
 
void set_vmax_rad (const double vmax_rad=par::defaultDouble) override
 set the private member HostHalo::m_vmax_rad More...
 
void set_radius (const double radius=par::defaultDouble) override
 set the private member HostHalo::m_radius More...
 
void set_parent (const int parent=par::defaultInt) override
 set the private member HostHalo::m_parent More...
 
void set_nsub (const int nsub=par::defaultInt) override
 set the private member HostHalo::m_nsub More...
 
void set_satellite (const std::shared_ptr< Object > satellite={}) override
 set the private member HostHalo::m_satellites More...
 
void set_satellites (const std::vector< std::shared_ptr< Object >> satellites={}) override
 set the private member HostHalo::m_satellites More...
 
Member functions used to check if the private members are set
bool isSet_tot_mass () override
 get the private member m_tot_mass More...
 
bool isSet_mass_estimate () override
 get the private member m_mass_estimate More...
 
bool isSet_radius_estimate () override
 get the private member m_radius_estimate More...
 
bool isSet_veldisp_estimate () override
 get the private member m_veldisp_estimate More...
 
bool isSet_xcm () override
 get the private member m_xcm More...
 
bool isSet_ycm () override
 get the private member m_ycm More...
 
bool isSet_zcm () override
 get the private member m_zcm More...
 
bool isSet_spin_x () override
 get the private member m_spin_x More...
 
bool isSet_spin_y () override
 get the private member m_spin_y More...
 
bool isSet_spin_z () override
 get the private member m_spin_z More...
 
bool isSet_veldisp () override
 get the private member m_veldisp More...
 
bool isSet_vmax () override
 get the private member m_vmax More...
 
bool isSet_vmax_rad () override
 get the private member m_vmax_rad More...
 
bool isSet_radius () override
 get the private member m_radius More...
 
bool isSet_parent () override
 get the private member m_parent More...
 
bool isSet_nsub () override
 get the private member m_nsub More...
 
- Public Member Functions inherited from cbl::catalogue::Halo
 Halo ()
 default constructor
 
 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
 
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...
 
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...
 
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 densityContrast () const
 get the member m_radius More...
 
virtual double centralDensity () const
 get the member m_radius 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_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_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_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_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...
 

Private Attributes

double m_tot_mass
 gas component of the total group mass
 
double m_SFR
 star formation rate
 
double m_mass_estimate
 mass estimate
 
double m_radius_estimate
 radius estimate
 
double m_veldisp_estimate
 velocity dispersion estimate
 
double m_xcm
 x-coordinate of the centre of mass
 
double m_ycm
 y-coordinate of the centre of mass
 
double m_zcm
 z-coordinate of the centre of mass
 
double m_spin_x
 x-axis component of the spin
 
double m_spin_y
 y-axis component of the spin
 
double m_spin_z
 z-axis component of the spin
 
double m_veldisp
 velocity dispersion
 
double m_vmax
 maximum velocity
 
double m_vmax_rad
 maximum radial velocity
 
double m_radius
 half-mass radius
 
int m_parent
 ID of the parent halo.
 
int m_nsub
 number of sub-haloes within the main group
 
std::vector< std::shared_ptr< Object > > m_satellites
 vector of pointers to satellites
 

Additional Inherited Members

- Static Public Member Functions inherited from cbl::catalogue::Object
static std::shared_ptr< ObjectCreate (const ObjectType ObjectType)
 static factory used to construct objects of any type, providing in input comoving coordinates More...
 
static std::shared_ptr< ObjectCreate (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< ObjectCreate (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< ObjectCreate (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< ObjectCreate (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< ObjectCreate (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< ObjectCreate (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< ObjectCreate (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< ObjectCreate (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...
 
- Protected Attributes inherited from cbl::catalogue::Halo
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.
 

Detailed Description

The class HostHalo.

This class is used to handle objects of type group

Definition at line 53 of file HostHalo.h.

Constructor & Destructor Documentation

◆ HostHalo() [1/7]

cbl::catalogue::HostHalo::HostHalo ( 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,
const double  tot_mass = par::defaultDouble,
const double  mass_estimate = par::defaultDouble,
const double  radius_estimate = par::defaultDouble,
const double  veldisp_estimate = par::defaultDouble,
const comovingCoordinates  cm_coord = {par::defaultDoublepar::defaultDoublepar::defaultDouble},
const double  spin_x = par::defaultDouble,
const double  spin_y = par::defaultDouble,
const double  spin_z = par::defaultDouble,
const double  veldisp = par::defaultDouble,
const double  vmax = par::defaultDouble,
const double  vmax_rad = par::defaultDouble,
const double  radius = par::defaultDouble,
const int  parent = par::defaultInt,
const int  nsub = par::defaultInt,
std::vector< std::shared_ptr< Object >>  satellites = {} 
)
inline

constructor that uses comoving coordinates

Parameters
coordstructure containing the comoving coordinates {x, y, z}
weightweight
regionregion, used e.g. for jackknife and bootstrap
IDthe object ID
fieldthe field where the object has been observed
x_displacementthe displacement along the x-axis
y_displacementthe displacement along the y-axis
z_displacementthe displacement along the z-axis
vxvelocity along the x-axis
vyvelocity along the y-axis
vzvelocity along the z-axis
masshalo mass
tot_massgas component of the total group mass
mass_estimatemass estimate
radius_estimateradius estimate
veldisp_estimatevelocity dispersion estimate
cm_coordx-coordinate of the centre of mass
spin_xx-axis component of the spin
spin_yy-axis component of the spin
spin_zz-axis component of the spin
veldispvelocity dispersion
vmaxmaximum velocity
vmax_radmaximum radial velocity
radiushalf-mass radius
parentID of the parent halo
nsubnumber of sub-haloes within the main group
satellitesvector of pointers to satellites

Definition at line 196 of file HostHalo.h.

◆ HostHalo() [2/7]

cbl::catalogue::HostHalo::HostHalo ( 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,
const double  tot_mass = par::defaultDouble,
const double  mass_estimate = par::defaultDouble,
const double  radius_estimate = par::defaultDouble,
const double  veldisp_estimate = par::defaultDouble,
const comovingCoordinates  cm_coord = {par::defaultDoublepar::defaultDoublepar::defaultDouble},
const double  spin_x = par::defaultDouble,
const double  spin_y = par::defaultDouble,
const double  spin_z = par::defaultDouble,
const double  veldisp = par::defaultDouble,
const double  vmax = par::defaultDouble,
const double  vmax_rad = par::defaultDouble,
const double  radius = par::defaultDouble,
const int  parent = par::defaultInt,
const int  nsub = par::defaultInt,
std::vector< std::shared_ptr< Object >>  satellites = {} 
)
inline

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

Parameters
coordstructure containing the comoving coordinates {x, y, z}
cosmobject of class Cosmology, used to estimate comoving distances
z1_guessminimum prior on the redshift
z2_guessmaximum prior on the redshift
weightweight
regionregion, used e.g. for jackknife and bootstrap
IDthe object ID
fieldthe field where the object has been observed
x_displacementthe displacement along the x-axis
y_displacementthe displacement along the y-axis
z_displacementthe displacement along the z-axis
vxvelocity along the x-axis
vyvelocity along the y-axis
vzvelocity along the z-axis
masshalo mass
tot_massgas component of the total group mass
mass_estimatemass estimate
radius_estimateradius estimate
veldisp_estimatevelocity dispersion estimate
cm_coordx-coordinate of the centre of mass
spin_xx-axis component of the spin
spin_yy-axis component of the spin
spin_zz-axis component of the spin
veldispvelocity dispersion
vmaxmaximum velocity
vmax_radmaximum radial velocity
radiushalf-mass radius
parentID of the parent halo
nsubnumber of sub-haloes within the main group
satellitesvector of pointers to satellites

Definition at line 267 of file HostHalo.h.

◆ HostHalo() [3/7]

cbl::catalogue::HostHalo::HostHalo ( 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,
const double  tot_mass = par::defaultDouble,
const double  mass_estimate = par::defaultDouble,
const double  radius_estimate = par::defaultDouble,
const double  veldisp_estimate = par::defaultDouble,
const comovingCoordinates  cm_coord = {par::defaultDoublepar::defaultDoublepar::defaultDouble},
const double  spin_x = par::defaultDouble,
const double  spin_y = par::defaultDouble,
const double  spin_z = par::defaultDouble,
const double  veldisp = par::defaultDouble,
const double  vmax = par::defaultDouble,
const double  vmax_rad = par::defaultDouble,
const double  radius = par::defaultDouble,
const int  parent = par::defaultInt,
const int  nsub = par::defaultInt,
std::vector< std::shared_ptr< Object >>  satellites = {} 
)
inline

constructor that uses observed coordinates in radians

Parameters
coordstructure containing the observed coordinates {R.A., Dec, redshift}
weightweight
regionregion, used e.g. for jackknife and bootstrap
IDthe object ID
fieldthe field where the object has been observed
x_displacementthe displacement along the x-axis
y_displacementthe displacement along the y-axis
z_displacementthe displacement along the z-axis
vxhalo peculiar velocity along the x direction
vyhalo peculiar velocity along the y direction
vzhalo peculiar velocity along the z direction
massthe mock mass
tot_massgas component of the total group mass
mass_estimatemass estimate
radius_estimateradius estimate
veldisp_estimatevelocity dispersion estimate
cm_coordx-coordinate of the centre of mass
spin_xx-axis component of the spin
spin_yy-axis component of the spin
spin_zz-axis component of the spin
veldispvelocity dispersion
vmaxmaximum velocity
vmax_radmaximum radial velocity
radiushalf-mass radius
parentID of the parent halo
nsubnumber of sub-haloes within the main group
satellitesvector of pointers to satellites

Definition at line 330 of file HostHalo.h.

◆ HostHalo() [4/7]

cbl::catalogue::HostHalo::HostHalo ( 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,
const double  tot_mass = par::defaultDouble,
const double  mass_estimate = par::defaultDouble,
const double  radius_estimate = par::defaultDouble,
const double  veldisp_estimate = par::defaultDouble,
const comovingCoordinates  cm_coord = {par::defaultDoublepar::defaultDoublepar::defaultDouble},
const double  spin_x = par::defaultDouble,
const double  spin_y = par::defaultDouble,
const double  spin_z = par::defaultDouble,
const double  veldisp = par::defaultDouble,
const double  vmax = par::defaultDouble,
const double  vmax_rad = par::defaultDouble,
const double  radius = par::defaultDouble,
const int  parent = par::defaultInt,
const int  nsub = par::defaultInt,
std::vector< std::shared_ptr< Object >>  satellites = {} 
)
inline

constructor that uses observed coordinates in any angular units

Parameters
coordstructure containing the observed coordinates {R.A., Dec, redshift}
inputUnitsthe units of the input coordinates
weightweight
regionregion, used e.g. for jackknife and bootstrap
IDthe object ID
fieldthe field where the object has been observed
x_displacementthe displacement along the x-axis
y_displacementthe displacement along the y-axis
z_displacementthe displacement along the z-axis
vxhalo peculiar velocity along the x direction
vyhalo peculiar velocity along the y direction
vzhalo peculiar velocity along the z direction
massthe mock mass
tot_massgas component of the total group mass
mass_estimatemass estimate
radius_estimateradius estimate
veldisp_estimatevelocity dispersion estimate
cm_coordx-coordinate of the centre of mass
spin_xx-axis component of the spin
spin_yy-axis component of the spin
spin_zz-axis component of the spin
veldispvelocity dispersion
vmaxmaximum velocity
vmax_radmaximum radial velocity
radiushalf-mass radius
parentID of the parent halo
nsubnumber of sub-haloes within the main group
satellitesvector of pointers to satellites

Definition at line 396 of file HostHalo.h.

◆ HostHalo() [5/7]

cbl::catalogue::HostHalo::HostHalo ( 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,
const double  tot_mass = par::defaultDouble,
const double  mass_estimate = par::defaultDouble,
const double  radius_estimate = par::defaultDouble,
const double  veldisp_estimate = par::defaultDouble,
const comovingCoordinates  cm_coord = {par::defaultDoublepar::defaultDoublepar::defaultDouble},
const double  spin_x = par::defaultDouble,
const double  spin_y = par::defaultDouble,
const double  spin_z = par::defaultDouble,
const double  veldisp = par::defaultDouble,
const double  vmax = par::defaultDouble,
const double  vmax_rad = par::defaultDouble,
const double  radius = par::defaultDouble,
const int  parent = par::defaultInt,
const int  nsub = par::defaultInt,
std::vector< std::shared_ptr< Object >>  satellites = {} 
)
inline

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

Parameters
coordstructure containing the observed coordinates {R.A., Dec, redshitf}
cosmobject of class Cosmology, used to estimate comoving distances
weightweight
regionregion, used e.g. for jackknife and bootstrap
IDthe object ID
fieldthe field where the object has been observed
x_displacementthe displacement along the x-axis
y_displacementthe displacement along the y-axis
z_displacementthe displacement along the z-axis
vxhalo peculiar velocity along the x direction
vyhalo peculiar velocity along the y direction
vzhalo peculiar velocity along the z direction
massthe mock mass
tot_massgas component of the total group mass
mass_estimatemass estimate
radius_estimateradius estimate
veldisp_estimatevelocity dispersion estimate
cm_coordx-coordinate of the centre of mass
spin_xx-axis component of the spin
spin_yy-axis component of the spin
spin_zz-axis component of the spin
veldispvelocity dispersion
vmaxmaximum velocity
vmax_radmaximum radial velocity
radiushalf-mass radius
parentID of the parent halo
nsubnumber of sub-haloes within the main group
satellitesvector of pointers to satellites

Definition at line 464 of file HostHalo.h.

◆ HostHalo() [6/7]

cbl::catalogue::HostHalo::HostHalo ( 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,
const double  tot_mass = par::defaultDouble,
const double  mass_estimate = par::defaultDouble,
const double  radius_estimate = par::defaultDouble,
const double  veldisp_estimate = par::defaultDouble,
const comovingCoordinates  cm_coord = {par::defaultDoublepar::defaultDoublepar::defaultDouble},
const double  spin_x = par::defaultDouble,
const double  spin_y = par::defaultDouble,
const double  spin_z = par::defaultDouble,
const double  veldisp = par::defaultDouble,
const double  vmax = par::defaultDouble,
const double  vmax_rad = par::defaultDouble,
const double  radius = par::defaultDouble,
const int  parent = par::defaultInt,
const int  nsub = par::defaultInt,
std::vector< std::shared_ptr< Object >>  satellites = {} 
)
inline

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

Parameters
coordstructure containing the observed coordinates {R.A., Dec, redshift}
inputUnitsthe units of the input coordinates
cosmobject of class Cosmology, used to estimate comoving distances
weightweight
regionregion, used e.g. for jackknife and bootstrap
IDthe object ID
fieldthe field where the object has been observed
x_displacementthe displacement along the x-axis
y_displacementthe displacement along the y-axis
z_displacementthe displacement along the z-axis
vxhalo peculiar velocity along the x direction
vyhalo peculiar velocity along the y direction
vzhalo peculiar velocity along the z direction
massthe mock mass
tot_massgas component of the total group mass
mass_estimatemass estimate
radius_estimateradius estimate
veldisp_estimatevelocity dispersion estimate
cm_coordx-coordinate of the centre of mass
spin_xx-axis component of the spin
spin_yy-axis component of the spin
spin_zz-axis component of the spin
veldispvelocity dispersion
vmaxmaximum velocity
vmax_radmaximum radial velocity
radiushalf-mass radius
parentID of the parent halo
nsubnumber of sub-haloes within the main group
satellitesvector of pointers to satellites

Definition at line 532 of file HostHalo.h.

◆ HostHalo() [7/7]

cbl::catalogue::HostHalo::HostHalo ( 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,
const double  tot_mass = par::defaultDouble,
const double  mass_estimate = par::defaultDouble,
const double  radius_estimate = par::defaultDouble,
const double  veldisp_estimate = par::defaultDouble,
const comovingCoordinates  cm_coord = {par::defaultDoublepar::defaultDoublepar::defaultDouble},
const double  spin_x = par::defaultDouble,
const double  spin_y = par::defaultDouble,
const double  spin_z = par::defaultDouble,
const double  veldisp = par::defaultDouble,
const double  vmax = par::defaultDouble,
const double  vmax_rad = par::defaultDouble,
const double  radius = par::defaultDouble,
const int  parent = par::defaultInt,
const int  nsub = par::defaultInt,
std::vector< std::shared_ptr< Object >>  satellites = {} 
)
inline

constructor that uses both comoving and observed coordinates

Parameters
xxcomoving coordinate
yycomoving coordinate
zzcomoving coordinate
raRight Ascension
decDeclination
redshiftredshift
weightweight
regionregion, used e.g. for jackknife and bootstrap
IDthe object ID
fieldthe field where the object has been observed
x_displacementthe displacement along the x-axis
y_displacementthe displacement along the y-axis
z_displacementthe displacement along the z-axis
vxhalo peculiar velocity along the x direction
vyhalo peculiar velocity along the y direction
vzhalo peculiar velocity along the z direction
massthe mock mass
tot_massgas component of the total group mass
mass_estimatemass estimate
radius_estimateradius estimate
veldisp_estimatevelocity dispersion estimate
cm_coordx-coordinate of the centre of mass
spin_xx-axis component of the spin
spin_yy-axis component of the spin
spin_zz-axis component of the spin
veldispvelocity dispersion
vmaxmaximum velocity
vmax_radmaximum radial velocity
radiushalf-mass radius
parentID of the parent halo
nsubnumber of sub-haloes within the main group
satellitesvector of pointers to satellites

Definition at line 603 of file HostHalo.h.

Member Function Documentation

◆ getShared()

std::shared_ptr<Object> cbl::catalogue::HostHalo::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::Halo.

Definition at line 132 of file HostHalo.h.

◆ isSet_mass_estimate()

bool cbl::catalogue::HostHalo::isSet_mass_estimate ( )
inlineoverridevirtual

get the private member m_mass_estimate

Returns
true if the mass estimate is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 864 of file HostHalo.h.

◆ isSet_nsub()

bool cbl::catalogue::HostHalo::isSet_nsub ( )
inlineoverridevirtual

get the private member m_nsub

Returns
true if the the number of sub-groups in the host halo is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 976 of file HostHalo.h.

◆ isSet_parent()

bool cbl::catalogue::HostHalo::isSet_parent ( )
inlineoverridevirtual

get the private member m_parent

Returns
true if the id of the parent is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 968 of file HostHalo.h.

◆ isSet_radius()

bool cbl::catalogue::HostHalo::isSet_radius ( )
inlineoverridevirtual

get the private member m_radius

Returns
true if the radius is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 960 of file HostHalo.h.

◆ isSet_radius_estimate()

bool cbl::catalogue::HostHalo::isSet_radius_estimate ( )
inlineoverridevirtual

get the private member m_radius_estimate

Returns
true if the radius estimate is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 872 of file HostHalo.h.

◆ isSet_spin_x()

bool cbl::catalogue::HostHalo::isSet_spin_x ( )
inlineoverridevirtual

get the private member m_spin_x

Returns
true if the x-axis component of the spin is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 912 of file HostHalo.h.

◆ isSet_spin_y()

bool cbl::catalogue::HostHalo::isSet_spin_y ( )
inlineoverridevirtual

get the private member m_spin_y

Returns
true if the y-axis component of the spin is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 920 of file HostHalo.h.

◆ isSet_spin_z()

bool cbl::catalogue::HostHalo::isSet_spin_z ( )
inlineoverridevirtual

get the private member m_spin_z

Returns
true if the z-axis component of the spin is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 928 of file HostHalo.h.

◆ isSet_tot_mass()

bool cbl::catalogue::HostHalo::isSet_tot_mass ( )
inlineoverridevirtual

get the private member m_tot_mass

Returns
true if the total mass is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 856 of file HostHalo.h.

◆ isSet_veldisp()

bool cbl::catalogue::HostHalo::isSet_veldisp ( )
inlineoverridevirtual

get the private member m_veldisp

Returns
true if the velocity dispersion is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 936 of file HostHalo.h.

◆ isSet_veldisp_estimate()

bool cbl::catalogue::HostHalo::isSet_veldisp_estimate ( )
inlineoverridevirtual

get the private member m_veldisp_estimate

Returns
true if the velocity dispersion estimate is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 880 of file HostHalo.h.

◆ isSet_vmax()

bool cbl::catalogue::HostHalo::isSet_vmax ( )
inlineoverridevirtual

get the private member m_vmax

Returns
true if the maximum total velocity is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 944 of file HostHalo.h.

◆ isSet_vmax_rad()

bool cbl::catalogue::HostHalo::isSet_vmax_rad ( )
inlineoverridevirtual

get the private member m_vmax_rad

Returns
true if the maximum radial velocity is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 952 of file HostHalo.h.

◆ isSet_xcm()

bool cbl::catalogue::HostHalo::isSet_xcm ( )
inlineoverridevirtual

get the private member m_xcm

Returns
true if the x-axis coordinate of the centre of mass is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 888 of file HostHalo.h.

◆ isSet_ycm()

bool cbl::catalogue::HostHalo::isSet_ycm ( )
inlineoverridevirtual

get the private member m_ycm

Returns
true if the y-axis coordinate of the centre of mass is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 896 of file HostHalo.h.

◆ isSet_zcm()

bool cbl::catalogue::HostHalo::isSet_zcm ( )
inlineoverridevirtual

get the private member m_zcm

Returns
true if the z-axis coordinate of the centre of mass is set; false otherwise

Reimplemented from cbl::catalogue::Object.

Definition at line 904 of file HostHalo.h.

◆ mass_estimate()

double cbl::catalogue::HostHalo::mass_estimate ( ) const
inlineoverridevirtual

get the private member HostHalo::m_mass_estimate

Returns
the mass estimate of the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 629 of file HostHalo.h.

◆ nsub()

int cbl::catalogue::HostHalo::nsub ( ) const
inlineoverridevirtual

get the private member HostHalo::m_nsub

Returns
the number of sub-groups in the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 713 of file HostHalo.h.

◆ parent()

int cbl::catalogue::HostHalo::parent ( ) const
inlineoverridevirtual

get the private member HostHalo::m_parent

Returns
the id of the parent host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 707 of file HostHalo.h.

◆ radius()

double cbl::catalogue::HostHalo::radius ( ) const
inlineoverridevirtual

get the private member HostHalo::m_radius

Returns
the radius of the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 701 of file HostHalo.h.

◆ radius_estimate()

double cbl::catalogue::HostHalo::radius_estimate ( ) const
inlineoverridevirtual

get the private member HostHalo::m_radius_estimate

Returns
the radius estimate of the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 635 of file HostHalo.h.

◆ satellites()

std::vector<std::shared_ptr<Object> > cbl::catalogue::HostHalo::satellites ( ) const
inlineoverridevirtual

get the private member HostHalo::m_satellites

Returns
the vector of pointers to the satellite objects

Reimplemented from cbl::catalogue::Object.

Definition at line 719 of file HostHalo.h.

◆ set_mass_estimate()

void cbl::catalogue::HostHalo::set_mass_estimate ( const double  mass_estimate = par::defaultDouble)
inlineoverridevirtual

set the private member HostHalo::m_mass_estimate

Parameters
mass_estimatethe mass estimate of the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 739 of file HostHalo.h.

◆ set_nsub()

void cbl::catalogue::HostHalo::set_nsub ( const int  nsub = par::defaultInt)
inlineoverridevirtual

set the private member HostHalo::m_nsub

Parameters
nsubthe number of sub-groups in the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 824 of file HostHalo.h.

◆ set_parent()

void cbl::catalogue::HostHalo::set_parent ( const int  parent = par::defaultInt)
inlineoverridevirtual

set the private member HostHalo::m_parent

Parameters
parentthe id of the parent host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 818 of file HostHalo.h.

◆ set_radius()

void cbl::catalogue::HostHalo::set_radius ( const double  radius = par::defaultDouble)
inlineoverridevirtual

set the private member HostHalo::m_radius

Parameters
radiusthe maximum radial velocity of the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 812 of file HostHalo.h.

◆ set_radius_estimate()

void cbl::catalogue::HostHalo::set_radius_estimate ( const double  radius_estimate = par::defaultDouble)
inlineoverridevirtual

set the private member HostHalo::m_radius_estimate

Parameters
radius_estimatethe radius estimate of the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 745 of file HostHalo.h.

◆ set_satellite()

void cbl::catalogue::HostHalo::set_satellite ( const std::shared_ptr< Object satellite = {})
inlineoverridevirtual

set the private member HostHalo::m_satellites

Parameters
satellitethe vector of shared pointers to satellite objects

Reimplemented from cbl::catalogue::Object.

Definition at line 831 of file HostHalo.h.

◆ set_satellites()

void cbl::catalogue::HostHalo::set_satellites ( const std::vector< std::shared_ptr< Object >>  satellites = {})
inlineoverridevirtual

set the private member HostHalo::m_satellites

Parameters
satellitesthe vector of shared pointers to satellite objects

Reimplemented from cbl::catalogue::Object.

Definition at line 839 of file HostHalo.h.

◆ set_spin_x()

void cbl::catalogue::HostHalo::set_spin_x ( const double  spin_x = par::defaultDouble)
inlineoverridevirtual

set the private member HostHalo::m_spin_x

Parameters
spin_xthe x-axis component of the spin

Reimplemented from cbl::catalogue::Object.

Definition at line 776 of file HostHalo.h.

◆ set_spin_y()

void cbl::catalogue::HostHalo::set_spin_y ( const double  spin_y = par::defaultDouble)
inlineoverridevirtual

set the private member HostHalo::m_spin_y

Parameters
spin_ythe y-axis component of the spin

Reimplemented from cbl::catalogue::Object.

Definition at line 782 of file HostHalo.h.

◆ set_spin_z()

void cbl::catalogue::HostHalo::set_spin_z ( const double  spin_z = par::defaultDouble)
inlineoverridevirtual

set the private member HostHalo::m_spin_z

Parameters
spin_zthe z-axis component of the spin

Reimplemented from cbl::catalogue::Object.

Definition at line 788 of file HostHalo.h.

◆ set_tot_mass()

void cbl::catalogue::HostHalo::set_tot_mass ( const double  tot_mass = par::defaultDouble)
inlineoverridevirtual

set the private member HostHalo::m_tot_mass

Parameters
tot_massthe total mass of the parent halo

Reimplemented from cbl::catalogue::Object.

Definition at line 733 of file HostHalo.h.

◆ set_veldisp()

void cbl::catalogue::HostHalo::set_veldisp ( const double  veldisp = par::defaultDouble)
inlineoverridevirtual

set the private member HostHalo::m_veldisp

Parameters
veldispthe velocity dispersion of the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 794 of file HostHalo.h.

◆ set_veldisp_estimate()

void cbl::catalogue::HostHalo::set_veldisp_estimate ( const double  veldisp_estimate = par::defaultDouble)
inlineoverridevirtual

set the private member HostHalo::m_veldisp_estimate

Parameters
veldisp_estimatethe velocity dispersion estimate of the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 752 of file HostHalo.h.

◆ set_vmax()

void cbl::catalogue::HostHalo::set_vmax ( const double  vmax = par::defaultDouble)
inlineoverridevirtual

set the private member HostHalo::m_vmax

Parameters
vmaxthe maximum total velocity of the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 800 of file HostHalo.h.

◆ set_vmax_rad()

void cbl::catalogue::HostHalo::set_vmax_rad ( const double  vmax_rad = par::defaultDouble)
inlineoverridevirtual

set the private member HostHalo::m_vmax_rad

Parameters
vmax_radthe maximum radial velocity of the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 806 of file HostHalo.h.

◆ set_xcm()

void cbl::catalogue::HostHalo::set_xcm ( const double  xcm = par::defaultDouble)
inlineoverridevirtual

set the private member HostHalo::m_xcm

Parameters
xcmthe x-axis coordinate of the centre of mass

Reimplemented from cbl::catalogue::Object.

Definition at line 758 of file HostHalo.h.

◆ set_ycm()

void cbl::catalogue::HostHalo::set_ycm ( const double  ycm = par::defaultDouble)
inlineoverridevirtual

set the private member HostHalo::m_ycm

Parameters
ycmthe y-axis coordinate of the centre of mass

Reimplemented from cbl::catalogue::Object.

Definition at line 764 of file HostHalo.h.

◆ set_zcm()

void cbl::catalogue::HostHalo::set_zcm ( const double  zcm = par::defaultDouble)
inlineoverridevirtual

set the private member HostHalo::m_zcm

Parameters
zcmthe z-axis coordinate of the centre of mass

Reimplemented from cbl::catalogue::Object.

Definition at line 770 of file HostHalo.h.

◆ spin_x()

double cbl::catalogue::HostHalo::spin_x ( ) const
inlineoverridevirtual

get the private member HostHalo::m_spin_x

Returns
the x-axis component of the spin

Reimplemented from cbl::catalogue::Object.

Definition at line 665 of file HostHalo.h.

◆ spin_y()

double cbl::catalogue::HostHalo::spin_y ( ) const
inlineoverridevirtual

get the private member HostHalo::m_spin_y

Returns
the y-axis component of the spin

Reimplemented from cbl::catalogue::Object.

Definition at line 671 of file HostHalo.h.

◆ spin_z()

double cbl::catalogue::HostHalo::spin_z ( ) const
inlineoverridevirtual

get the private member HostHalo::m_spin_z

Returns
the z-axis component of the spin

Reimplemented from cbl::catalogue::Object.

Definition at line 677 of file HostHalo.h.

◆ tot_mass()

double cbl::catalogue::HostHalo::tot_mass ( ) const
inlineoverridevirtual

get the private member HostHalo::m_tot_mass

Returns
the total mass of the host halo (sum over all contributions)

Reimplemented from cbl::catalogue::Object.

Definition at line 623 of file HostHalo.h.

◆ veldisp()

double cbl::catalogue::HostHalo::veldisp ( ) const
inlineoverridevirtual

get the private member HostHalo::m_veldisp

Returns
the velocity dispersion of the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 683 of file HostHalo.h.

◆ veldisp_estimate()

double cbl::catalogue::HostHalo::veldisp_estimate ( ) const
inlineoverridevirtual

get the private member HostHalo::m_veldisp_estimate

Returns
the velocity dispersion estimate of the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 641 of file HostHalo.h.

◆ vmax()

double cbl::catalogue::HostHalo::vmax ( ) const
inlineoverridevirtual

get the private member HostHalo::m_vmax

Returns
the maximum total velocity of the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 689 of file HostHalo.h.

◆ vmax_rad()

double cbl::catalogue::HostHalo::vmax_rad ( ) const
inlineoverridevirtual

get the private member HostHalo::m_vmax_rad

Returns
the maximum radial velocity of the host halo

Reimplemented from cbl::catalogue::Object.

Definition at line 695 of file HostHalo.h.

◆ xcm()

double cbl::catalogue::HostHalo::xcm ( ) const
inlineoverridevirtual

get the private member HostHalo::m_xcm

Returns
the x-axis coordinate of the centre of mass

Reimplemented from cbl::catalogue::Object.

Definition at line 647 of file HostHalo.h.

◆ ycm()

double cbl::catalogue::HostHalo::ycm ( ) const
inlineoverridevirtual

get the private member HostHalo::m_ycm

Returns
the y-axis coordinate of the centre of mass

Reimplemented from cbl::catalogue::Object.

Definition at line 653 of file HostHalo.h.

◆ zcm()

double cbl::catalogue::HostHalo::zcm ( ) const
inlineoverridevirtual

get the private member HostHalo::m_zcm

Returns
the z-axis coordinate of the centre of mass

Reimplemented from cbl::catalogue::Object.

Definition at line 659 of file HostHalo.h.


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