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

The class Object. More...

#include "Headers/Object.h"

Inheritance diagram for cbl::catalogue::Object:

Public Member Functions

Constructors/destructors
 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 std::shared_ptr< ObjectgetShared ()
 function that allows copying private variables of the class when an object of class Catalogue is copied More...
 
virtual ~Object ()=default
 default destructor
 
Member functions used to get the protected members
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 vx () const
 get the member m_vx More...
 
virtual double vy () const
 get the member m_vy More...
 
virtual double vz () const
 get the member m_vz More...
 
virtual double mass () const
 get the member m_mass 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...
 
Member functions used to set the protected members
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_vx (const double vx)
 set the member m_vx More...
 
virtual void set_vy (const double vy)
 set the member m_vy More...
 
virtual void set_vz (const double vz)
 set the member m_vz More...
 
virtual void set_mass (const double mass)
 set the member m_mass 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...
 
Member functions used to check if the protected members are set
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_vx ()
 check if the member m_vx is set More...
 
virtual bool isSet_vy ()
 check if the member m_vy is set More...
 
virtual bool isSet_vz ()
 check if the member m_vz is set More...
 
virtual bool isSet_mass ()
 check if the member m_mass 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...
 

Static Public Member Functions

Static factories
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

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 Object.

This class is used to handle objects of type object

Definition at line 132 of file Object.h.

Constructor & Destructor Documentation

◆ Object() [1/8]

cbl::catalogue::Object::Object ( const int  ID)
inline

specific constructor for ChainMeshCell

Parameters
IDthe object ID

Definition at line 213 of file Object.h.

◆ Object() [2/8]

cbl::catalogue::Object::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 
)
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
redshiftMinminimum redshift
redshiftMaxmaximum redshift
snsignal-to-noise

Definition at line 243 of file Object.h.

◆ Object() [3/8]

cbl::catalogue::Object::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 
)
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
redshiftMinminimum redshift
redshiftMaxmaximum redshift
snsignal-to-noise

Definition at line 281 of file Object.h.

◆ Object() [4/8]

cbl::catalogue::Object::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 
)
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
redshiftMinminimum redshift
redshiftMaxmaximum redshift
snsignal-to-noise

Definition at line 315 of file Object.h.

◆ Object() [5/8]

cbl::catalogue::Object::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 
)
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
redshiftMinminimum redshift
redshiftMaxmaximum redshift
snsignal-to-noise

Definition at line 348 of file Object.h.

◆ Object() [6/8]

cbl::catalogue::Object::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 
)
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
redshiftMinminimum redshift
redshiftMaxmaximum redshift
snsignal-to-noise

Definition at line 383 of file Object.h.

◆ Object() [7/8]

cbl::catalogue::Object::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 
)
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
redshiftMinminimum redshift
redshiftMaxmaximum redshift
snsignal-to-noise

Definition at line 423 of file Object.h.

◆ Object() [8/8]

cbl::catalogue::Object::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 
)
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
redshiftMinminimum redshift
redshiftMaxmaximum redshift
snsignal-to-noise

Definition at line 451 of file Object.h.

Member Function Documentation

◆ bias()

virtual double cbl::catalogue::Object::bias ( ) const
inlinevirtual

get the member m_bias

Returns
the bias of the derived object, or an error message if the derived object does not have this member

Definition at line 1072 of file Object.h.

◆ centralDensity()

virtual double cbl::catalogue::Object::centralDensity ( ) const
inlinevirtual

get the member m_radius

Returns
the central density of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Void.

Definition at line 1104 of file Object.h.

◆ coords()

std::vector<double> cbl::catalogue::Object::coords ( ) const
inline

get the object coordinates

Returns
a vector containing the object coordinates

Definition at line 881 of file Object.h.

◆ Create() [1/9]

std::shared_ptr< Object > cbl::catalogue::Object::Create ( const int  ID = par::defaultInt,
const std::vector< unsigned int >  part = {},
std::vector< std::vector< unsigned int >>  nearCells = {} 
)
static

static factory used to construct objects of ChainMeshCell type

Parameters
IDthe object ID
partthe particles in the cell
nearCellsthe cells near the object, sorted for distance
Returns
object of a given type

Definition at line 175 of file Object.cpp.

◆ Create() [2/9]

std::shared_ptr< Object > cbl::catalogue::Object::Create ( const ObjectType  ObjectType)
static

static factory used to construct objects of any type, providing in input comoving coordinates

Parameters
ObjectTypethe object type; it can be: GenericObject, RandomObject, Mock, Halo, Galaxy, Cluster, Void, HostHalo, ChainMeshCell
Returns
object of a given type

Definition at line 46 of file Object.cpp.

◆ Create() [3/9]

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

static factory used to construct objects of any type, providing in input comoving coordinates and a cosmological model to estimate the redshift

Parameters
ObjectTypethe object type; it can be: GenericObject, RandomObject, Mock, Halo, Galaxy, Cluster, Void, HostHalo
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
Returns
object of a given type

Definition at line 81 of file Object.cpp.

◆ Create() [4/9]

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

static factory used to construct objects of any type, providing in input comoving coordinates

Parameters
ObjectTypethe object type; it can be: GenericObject, RandomObject, Mock, Halo, Galaxy, Cluster, Void, HostHalo
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
Returns
object of a given type

Definition at line 64 of file Object.cpp.

◆ Create() [5/9]

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

static factory used to construct objects of any kind, providing in input both comoving and observed coordinates

Parameters
ObjectTypethe object type; it can be: GenericObject, RandomObject, Mock, Halo, Galaxy, Cluster, Void, HostHalo
xxcomoving coordinate
yycomoving coordinate
zzcomoving coordinate
raRight Ascension
decDeclination
redshiftredshift
weightweight
regionthe object region, 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
Returns
object of a given type

Definition at line 161 of file Object.cpp.

◆ Create() [6/9]

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

static factory used to construct objects of any kind, providing in input observed coordinates and a cosmological model to estimate the comoving coordinates

Parameters
ObjectTypethe object type; it can be: GenericObject, RandomObject, Mock, Halo, Galaxy, Cluster, Void, HostHalo
coordstructure containing the observed coordinates {R.A., Dec, redshitf}
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
Returns
object of a given type

Definition at line 145 of file Object.cpp.

◆ Create() [7/9]

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

static factory used to construct objects of any kind, providing in input observed coordinates in any angular units

Parameters
ObjectTypethe object type; it can be: GenericObject, RandomObject, Mock, Halo, Galaxy, Cluster, Void, HostHalo
coordstructure containing the observed coordinates {ra Right Ascension}
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
Returns
object of a given type

Definition at line 113 of file Object.cpp.

◆ Create() [8/9]

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

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

Parameters
ObjectTypethe object type; it can be: GenericObject, RandomObject, Mock, Halo, Galaxy, Cluster, Void, HostHalo
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
Returns
object of a given type

Definition at line 129 of file Object.cpp.

◆ Create() [9/9]

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

static factory used to construct objects of any kind, providing in input observed coordinates in radians

Parameters
ObjectTypethe object type; it can be: GenericObject, RandomObject, Mock, Halo, Galaxy, Cluster, Void, HostHalo
coordstructure containing the observed coordinates {R.A., Dec, redshitf}
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
Returns
object of a given type

Definition at line 97 of file Object.cpp.

◆ dc()

double cbl::catalogue::Object::dc ( ) const
inline

get the member m_dc

Returns
the comoving distance of the object

Definition at line 765 of file Object.h.

◆ dec()

double cbl::catalogue::Object::dec ( ) const
inline

get the member m_dec

Returns
the Declination of the object

Definition at line 779 of file Object.h.

◆ dec_tile()

double cbl::catalogue::Object::dec_tile ( ) const
inline

get the member m_dec_tile

Returns
the central Declination of the object's tile

Definition at line 793 of file Object.h.

◆ densityContrast()

virtual double cbl::catalogue::Object::densityContrast ( ) const
inlinevirtual

get the member m_radius

Returns
the density contrast of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Void.

Definition at line 1096 of file Object.h.

◆ field()

std::string cbl::catalogue::Object::field ( ) const
inline

get the member m_field

Returns
the field where the object has been observed

Definition at line 850 of file Object.h.

◆ galaxyTag()

virtual double cbl::catalogue::Object::galaxyTag ( ) const
inlinevirtual

get the member m_galaxyTag

Returns
the galaxyTag of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1048 of file Object.h.

◆ generic()

virtual double cbl::catalogue::Object::generic ( ) const
inlinevirtual

get the member m_generic

Returns
the generic variable of the derived object, or an error message if the derived object does not have this member

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

Definition at line 1080 of file Object.h.

◆ getShared()

virtual std::shared_ptr<Object> cbl::catalogue::Object::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 in cbl::catalogue::Void, cbl::catalogue::Mock, cbl::catalogue::HostHalo, cbl::catalogue::Halo, cbl::catalogue::Galaxy, cbl::catalogue::Cluster, and cbl::catalogue::ChainMeshCell.

Definition at line 463 of file Object.h.

◆ ID()

int cbl::catalogue::Object::ID ( ) const
inline

get the member m_radius

Returns
the ID of the derived object, or an error message if the derived object does not have this member

Definition at line 843 of file Object.h.

◆ IDHost()

virtual int cbl::catalogue::Object::IDHost ( ) const
inlinevirtual

get the member m_IDHost

Returns
the IDHost of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1040 of file Object.h.

◆ isSet_bias()

virtual bool cbl::catalogue::Object::isSet_bias ( )
inlinevirtual

check if the member m_bias is set

Returns
true if the bias is set; false otherwise, or an error message if the derived object does not have this member

Definition at line 2108 of file Object.h.

◆ isSet_centralDensity()

virtual bool cbl::catalogue::Object::isSet_centralDensity ( )
inlinevirtual

check if the member m_centralDensity is set

Returns
true if the central density is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Void.

Definition at line 2148 of file Object.h.

◆ isSet_dc()

bool cbl::catalogue::Object::isSet_dc ( )
inline

check if the member m_dc is set

Returns
true if the comoving distance is set; false otherwise

Definition at line 1915 of file Object.h.

◆ isSet_dec()

bool cbl::catalogue::Object::isSet_dec ( )
inline

check if the member m_dec is set

Returns
true if the coordinate Dec is set; false otherwise

Definition at line 1810 of file Object.h.

◆ isSet_dec_tile()

bool cbl::catalogue::Object::isSet_dec_tile ( )
inline

check if the member m_dec_tile is set

Returns
true if the coordinate Dec is set; false otherwise

Definition at line 1826 of file Object.h.

◆ isSet_densityContrast()

virtual bool cbl::catalogue::Object::isSet_densityContrast ( )
inlinevirtual

check if the member m_densityContrast is set

Returns
true if the density contrast is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Void.

Definition at line 2138 of file Object.h.

◆ isSet_field()

bool cbl::catalogue::Object::isSet_field ( )
inline

check if the member m_field is set

Returns
true if the field is set; false otherwise

Definition at line 1939 of file Object.h.

◆ isSet_galaxyTag()

virtual bool cbl::catalogue::Object::isSet_galaxyTag ( )
inlinevirtual

get the member m_galaxyTag

Returns
the galaxyTag of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 2324 of file Object.h.

◆ isSet_generic()

virtual bool cbl::catalogue::Object::isSet_generic ( )
inlinevirtual

check if the member m_generic is set

Returns
true if the generic properties is set; false otherwise, or an error message if the derived object does not have this member

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

Definition at line 2118 of file Object.h.

◆ isSet_ID()

virtual bool cbl::catalogue::Object::isSet_ID ( )
inlinevirtual

check if the member m_ID is set

Returns
true if the object ID is set; false otherwise, or an error message if the derived object does not have this member

Definition at line 2308 of file Object.h.

◆ isSet_IDHost()

virtual bool cbl::catalogue::Object::isSet_IDHost ( )
inlinevirtual

get the member m_IDHost

Returns
the IDHost of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 2316 of file Object.h.

◆ isSet_lensingCalib()

virtual bool cbl::catalogue::Object::isSet_lensingCalib ( )
inlinevirtual

check if the member m_lensingCalib is set

Returns
true if the lensing calibration factor is set; false otherwise

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1906 of file Object.h.

◆ isSet_lensingWeight()

virtual bool cbl::catalogue::Object::isSet_lensingWeight ( )
inlinevirtual

check if the member m_lensingWeight is set

Returns
true if the lensing weight is set; false otherwise

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1897 of file Object.h.

◆ isSet_magnitude()

virtual bool cbl::catalogue::Object::isSet_magnitude ( )
inlinevirtual

check if the member m_magnitude is set

Returns
true if the magnitude is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 2019 of file Object.h.

◆ isSet_magnitudeG()

virtual bool cbl::catalogue::Object::isSet_magnitudeG ( )
inlinevirtual

check if the member m_magnitudeG is set

Returns
true if the g magnitude is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 2039 of file Object.h.

◆ isSet_magnitudeI()

virtual bool cbl::catalogue::Object::isSet_magnitudeI ( )
inlinevirtual

check if the member m_magnitudeI is set

Returns
true if the i magnitude is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 2059 of file Object.h.

◆ isSet_magnitudeR()

virtual bool cbl::catalogue::Object::isSet_magnitudeR ( )
inlinevirtual

check if the member m_magnitudeR is set

Returns
true if the r magnitude is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 2049 of file Object.h.

◆ isSet_magnitudeU()

virtual bool cbl::catalogue::Object::isSet_magnitudeU ( )
inlinevirtual

check if the member m_magnitudeU is set

Returns
true if the u magnitude is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 2029 of file Object.h.

◆ isSet_mass()

virtual bool cbl::catalogue::Object::isSet_mass ( )
inlinevirtual

check if the member m_mass is set

Returns
true if the mass is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Halo, cbl::catalogue::Galaxy, and cbl::catalogue::Cluster.

Definition at line 2009 of file Object.h.

◆ isSet_mass_estimate()

virtual bool cbl::catalogue::Object::isSet_mass_estimate ( )
inlinevirtual

check if the member m_mass_estimate is set

Returns
true if the is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 2158 of file Object.h.

◆ isSet_mass_proxy()

virtual bool cbl::catalogue::Object::isSet_mass_proxy ( )
inlinevirtual

check if the member m_mass_proxy is set

Returns
true if the mass proxy is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Cluster.

Definition at line 2088 of file Object.h.

◆ isSet_mass_proxy_error()

virtual bool cbl::catalogue::Object::isSet_mass_proxy_error ( )
inlinevirtual

check if the member m_mass_proxy_error is set

Returns
true if the error on the mass proxy is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Cluster.

Definition at line 2098 of file Object.h.

◆ isSet_massinfall()

virtual bool cbl::catalogue::Object::isSet_massinfall ( )
inlinevirtual

check if the member m_massinfall is set

Returns
true if the massinfall is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 2344 of file Object.h.

◆ isSet_mstar()

virtual bool cbl::catalogue::Object::isSet_mstar ( )
inlinevirtual

check if the member m_mstar is set

Returns
true if the mstar is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 2334 of file Object.h.

◆ isSet_nsub()

virtual bool cbl::catalogue::Object::isSet_nsub ( )
inlinevirtual

check if the member m_nsub is set

Returns
true if the is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 2298 of file Object.h.

◆ isSet_odds()

virtual bool cbl::catalogue::Object::isSet_odds ( )
inlinevirtual

check if the member m_odds is set

Returns
true if the odds is set; false otherwise

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1888 of file Object.h.

◆ isSet_parent()

virtual bool cbl::catalogue::Object::isSet_parent ( )
inlinevirtual

check if the member m_parent is set

Returns
true if the is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 2288 of file Object.h.

◆ isSet_ra()

bool cbl::catalogue::Object::isSet_ra ( )
inline

check if the member m_ra is set

Returns
true if the coordinate RA is set; false otherwise

Definition at line 1802 of file Object.h.

◆ isSet_ra_tile()

bool cbl::catalogue::Object::isSet_ra_tile ( )
inline

check if the member m_ra_tile is set

Returns
true if the coordinate RA is set; false otherwise

Definition at line 1818 of file Object.h.

◆ isSet_radius()

virtual bool cbl::catalogue::Object::isSet_radius ( )
inlinevirtual

check if the member m_radius is set

Returns
true if the radius is set; false otherwise, or an error message if the derived object does not have this member

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

Definition at line 2128 of file Object.h.

◆ isSet_radius_estimate()

virtual bool cbl::catalogue::Object::isSet_radius_estimate ( )
inlinevirtual

check if the member m_radius_estimate is set

Returns
true if the is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 2168 of file Object.h.

◆ isSet_redshift()

bool cbl::catalogue::Object::isSet_redshift ( )
inline

check if the member m_redshift is set

Returns
true if the redshift is set; false otherwise

Definition at line 1843 of file Object.h.

◆ isSet_redshiftMax()

bool cbl::catalogue::Object::isSet_redshiftMax ( )
inline

check if the member m_redshiftMax is set

Returns
true if the max redshift is set; false otherwise

Definition at line 1861 of file Object.h.

◆ isSet_redshiftMin()

bool cbl::catalogue::Object::isSet_redshiftMin ( )
inline

check if the member m_redshiftMin is set

Returns
true if the min redshift is set; false otherwise

Definition at line 1852 of file Object.h.

◆ isSet_region()

bool cbl::catalogue::Object::isSet_region ( )
inline

check if the member m_region is set

Returns
true if the region is set; false otherwise

Definition at line 1931 of file Object.h.

◆ isSet_SFR()

virtual bool cbl::catalogue::Object::isSet_SFR ( )
inlinevirtual

check if the member m_SFR is set

Returns
true if the SFR is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 2068 of file Object.h.

◆ isSet_shear1()

virtual bool cbl::catalogue::Object::isSet_shear1 ( )
inlinevirtual

check if the member m_shear1 is set

Returns
true if the shear1 is set; false otherwise

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1870 of file Object.h.

◆ isSet_shear2()

virtual bool cbl::catalogue::Object::isSet_shear2 ( )
inlinevirtual

check if the member m_shear2 is set

Returns
true if the shear2 is set; false otherwise

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1879 of file Object.h.

◆ isSet_sn()

bool cbl::catalogue::Object::isSet_sn ( )
inline

check if the member m_sn is set

Returns
true if the signal-to-noise is set; false otherwise

Definition at line 1834 of file Object.h.

◆ isSet_spin_x()

virtual bool cbl::catalogue::Object::isSet_spin_x ( )
inlinevirtual

check if the member m_spin_x is set

Returns
true if the is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 2218 of file Object.h.

◆ isSet_spin_y()

virtual bool cbl::catalogue::Object::isSet_spin_y ( )
inlinevirtual

check if the member m_spin_y is set

Returns
true if the is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 2228 of file Object.h.

◆ isSet_spin_z()

virtual bool cbl::catalogue::Object::isSet_spin_z ( )
inlinevirtual

check if the member m_spin_z is set

Returns
true if the is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 2238 of file Object.h.

◆ isSet_sSFR()

virtual bool cbl::catalogue::Object::isSet_sSFR ( )
inlinevirtual

check if the private member Galaxy::m_sSFR is set

Returns
true if the sSFR is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 2078 of file Object.h.

◆ isSet_tot_mass()

virtual bool cbl::catalogue::Object::isSet_tot_mass ( )
inlinevirtual

check if the member m_tot_mass is set

Returns
true if the is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 2278 of file Object.h.

◆ isSet_veldisp()

virtual bool cbl::catalogue::Object::isSet_veldisp ( )
inlinevirtual

check if the member m_veldisp is set

Returns
true if the is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 2248 of file Object.h.

◆ isSet_veldisp_estimate()

virtual bool cbl::catalogue::Object::isSet_veldisp_estimate ( )
inlinevirtual

check if the member m_veldisp_estimate is set

Returns
true if the is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 2178 of file Object.h.

◆ isSet_vmax()

virtual bool cbl::catalogue::Object::isSet_vmax ( )
inlinevirtual

check if the member m_vmax is set

Returns
true if the is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 2258 of file Object.h.

◆ isSet_vmax_rad()

virtual bool cbl::catalogue::Object::isSet_vmax_rad ( )
inlinevirtual

check if the member m_vmax_rad is set

Returns
true if the is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 2268 of file Object.h.

◆ isSet_vx()

virtual bool cbl::catalogue::Object::isSet_vx ( )
inlinevirtual

check if the member m_vx is set

Returns
true if the velocity component Vx is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Halo.

Definition at line 1979 of file Object.h.

◆ isSet_vy()

virtual bool cbl::catalogue::Object::isSet_vy ( )
inlinevirtual

check if the member m_vy is set

Returns
true if the the velocity component Vy is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Halo.

Definition at line 1989 of file Object.h.

◆ isSet_vz()

virtual bool cbl::catalogue::Object::isSet_vz ( )
inlinevirtual

check if the member m_vz is set

Returns
true if the the velocity component Vz is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Halo.

Definition at line 1999 of file Object.h.

◆ isSet_weight()

bool cbl::catalogue::Object::isSet_weight ( )
inline

check if the member m_weight is set

Returns
true if the weight is set; false otherwise

Definition at line 1923 of file Object.h.

◆ isSet_x_displacement()

bool cbl::catalogue::Object::isSet_x_displacement ( )
inline

check if the member m_x_displacement is set

Returns
true if the displacement along the x direction is set; false otherwise

Definition at line 1949 of file Object.h.

◆ isSet_xcm()

virtual bool cbl::catalogue::Object::isSet_xcm ( )
inlinevirtual

check if the member m_xcm is set

Returns
true if the is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 2188 of file Object.h.

◆ isSet_xx()

bool cbl::catalogue::Object::isSet_xx ( ) const
inline

check if the member m_xx is set

Returns
true if the coordinate x is set; false otherwise

Definition at line 1778 of file Object.h.

◆ isSet_y_displacement()

bool cbl::catalogue::Object::isSet_y_displacement ( )
inline

check if the member m_y_displacement is set

Returns
true if the displacement along the y direction is set; false otherwise

Definition at line 1959 of file Object.h.

◆ isSet_ycm()

virtual bool cbl::catalogue::Object::isSet_ycm ( )
inlinevirtual

check if the member m_ycm is set

Returns
true if the is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 2198 of file Object.h.

◆ isSet_yy()

bool cbl::catalogue::Object::isSet_yy ( ) const
inline

check if the member m_yy is set

Returns
true if the coordinate y is set; false otherwise

Definition at line 1786 of file Object.h.

◆ isSet_z_displacement()

bool cbl::catalogue::Object::isSet_z_displacement ( )
inline

check if the member m_z_displacement is set

Returns
true if the displacement along the z direction is set; false otherwise

Definition at line 1969 of file Object.h.

◆ isSet_zcm()

virtual bool cbl::catalogue::Object::isSet_zcm ( )
inlinevirtual

check if the member m_zcm is set

Returns
true if the is set; false otherwise, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 2208 of file Object.h.

◆ isSet_zz()

bool cbl::catalogue::Object::isSet_zz ( )
inline

check if the member m_zz is set

Returns
true if the coordinate z is set; false otherwise

Definition at line 1794 of file Object.h.

◆ lensingCalib()

virtual double cbl::catalogue::Object::lensingCalib ( ) const
inlinevirtual

get the member m_lensingCalib

Returns
the lensing calibration factor of the object

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1002 of file Object.h.

◆ lensingWeight()

virtual double cbl::catalogue::Object::lensingWeight ( ) const
inlinevirtual

get the member m_lensingWeight

Returns
the lensing weight of the object

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 995 of file Object.h.

◆ magnitude()

virtual double cbl::catalogue::Object::magnitude ( ) const
inlinevirtual

get the member m_magnitude

Returns
the magnitude of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 935 of file Object.h.

◆ magnitudeG()

virtual double cbl::catalogue::Object::magnitudeG ( ) const
inlinevirtual

get the member m_magnitudeG

Returns
the g magnitude of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 951 of file Object.h.

◆ magnitudeI()

virtual double cbl::catalogue::Object::magnitudeI ( ) const
inlinevirtual

get the member m_magnitudeI

Returns
the i magnitude of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 967 of file Object.h.

◆ magnitudeR()

virtual double cbl::catalogue::Object::magnitudeR ( ) const
inlinevirtual

get the member m_magnitudeR

Returns
the r magnitude of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 959 of file Object.h.

◆ magnitudeU()

virtual double cbl::catalogue::Object::magnitudeU ( ) const
inlinevirtual

get the member m_magnitudeU

Returns
the u magnitude of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 943 of file Object.h.

◆ mass()

virtual double cbl::catalogue::Object::mass ( ) const
inlinevirtual

get the member m_mass

Returns
the mass of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Halo, cbl::catalogue::Galaxy, and cbl::catalogue::Cluster.

Definition at line 920 of file Object.h.

◆ mass_estimate()

virtual double cbl::catalogue::Object::mass_estimate ( ) const
inlinevirtual

get the private member m_mass_estimate

Returns
the mass estimate of the group, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1112 of file Object.h.

◆ mass_proxy()

virtual double cbl::catalogue::Object::mass_proxy ( ) const
inlinevirtual

get the member m_mass_proxy

Returns
the mass proxy of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Cluster.

Definition at line 1024 of file Object.h.

◆ mass_proxy_error()

virtual double cbl::catalogue::Object::mass_proxy_error ( ) const
inlinevirtual

get the member m_mass_proxy_error

Returns
the mass proxy erro of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Cluster.

Definition at line 1032 of file Object.h.

◆ massinfall()

virtual double cbl::catalogue::Object::massinfall ( ) const
inlinevirtual

get the member m_massinfall

Returns
the massinfall of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1064 of file Object.h.

◆ mstar()

virtual double cbl::catalogue::Object::mstar ( ) const
inlinevirtual

get the member m_mstar

Returns
the mstar of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1056 of file Object.h.

◆ nearCells()

virtual std::vector<std::vector<unsigned int> > cbl::catalogue::Object::nearCells ( ) const
inlinevirtual

get the virtual member m_nearCells, member of ChainMeshCell

Returns
the cells near the selected one (sorted for distance), or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::ChainMeshCell.

Definition at line 1247 of file Object.h.

◆ nsub()

virtual int cbl::catalogue::Object::nsub ( ) const
inlinevirtual

get the private member m_nsub

Returns
the number of sub-groups in the group, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1223 of file Object.h.

◆ odds()

virtual double cbl::catalogue::Object::odds ( ) const
inlinevirtual

get the member m_odds

Returns
the odds of the object

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 974 of file Object.h.

◆ parent()

virtual int cbl::catalogue::Object::parent ( ) const
inlinevirtual

get the private member m_parent

Returns
the id of the parent group, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1216 of file Object.h.

◆ part()

virtual std::vector<unsigned int> cbl::catalogue::Object::part ( ) const
inlinevirtual

get the virtual member m_part, member of ChainMeshCell

Returns
the particles on the selected cell, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::ChainMeshCell.

Definition at line 1239 of file Object.h.

◆ proxyerror()

virtual double cbl::catalogue::Object::proxyerror ( ) const
inlinevirtual

get the member m_proxyerror

Returns
the cluster mass proxy error

Definition at line 927 of file Object.h.

◆ ra()

double cbl::catalogue::Object::ra ( ) const
inline

get the member m_ra

Returns
the Right Ascension of the object

Definition at line 772 of file Object.h.

◆ ra_tile()

double cbl::catalogue::Object::ra_tile ( ) const
inline

get the member m_ra_tile

Returns
the central Right Ascension of the object's tile

Definition at line 786 of file Object.h.

◆ radius()

virtual double cbl::catalogue::Object::radius ( ) const
inlinevirtual

get the member m_radius

Returns
the radius of the derived object, or an error message if the derived object does not have this member

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

Definition at line 1088 of file Object.h.

◆ radius_estimate()

virtual double cbl::catalogue::Object::radius_estimate ( ) const
inlinevirtual

get the private member m_radius_estimate

Returns
the radius estimate of the group, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1120 of file Object.h.

◆ redshift()

double cbl::catalogue::Object::redshift ( ) const
inline

get the member m_redshift

Returns
the redshift of the object

Definition at line 807 of file Object.h.

◆ redshiftMax()

double cbl::catalogue::Object::redshiftMax ( ) const
inline

get the member m_redshiftMax

Returns
the maximum redshift of the object

Definition at line 821 of file Object.h.

◆ redshiftMin()

double cbl::catalogue::Object::redshiftMin ( ) const
inline

get the member m_redshiftMin

Returns
the minimum redshift of the object

Definition at line 814 of file Object.h.

◆ region()

long cbl::catalogue::Object::region ( ) const
inline

get the member m_region

Returns
the index of the subRegion in which the object is located

Definition at line 835 of file Object.h.

◆ satellites()

virtual std::vector<std::shared_ptr<Object> > cbl::catalogue::Object::satellites ( ) const
inlinevirtual

get the member m_satellites

Returns
a vector of pointers to satellite objects of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1231 of file Object.h.

◆ set_bias()

virtual void cbl::catalogue::Object::set_bias ( const double  bias)
inlinevirtual

set the member m_bias

Parameters
biasthe bias, or an error message if the derived object does not have this member

Definition at line 1593 of file Object.h.

◆ set_centralDensity()

virtual void cbl::catalogue::Object::set_centralDensity ( const double  centralDensity)
inlinevirtual

set the member m_centralDensity

Parameters
centralDensitythe central density

Reimplemented in cbl::catalogue::Void.

Definition at line 1624 of file Object.h.

◆ set_dc()

void cbl::catalogue::Object::set_dc ( const double  dc)
inline

set the member m_dc, updating the comoving coordinates accordingly

Parameters
dcthe comoving distance of the object

Definition at line 1405 of file Object.h.

◆ set_dec()

void cbl::catalogue::Object::set_dec ( const double  dec,
const CoordinateUnits  inputUnits = CoordinateUnits::_radians_ 
)
inline

set the member m_dec, updating the comoving coordinates accordingly (if already set)

Parameters
decthe Declination of the object
inputUnitsthe units of the input coordinates

Definition at line 1296 of file Object.h.

◆ set_dec_tile()

void cbl::catalogue::Object::set_dec_tile ( const double  dec,
const CoordinateUnits  inputUnits = CoordinateUnits::_radians_ 
)
inline

set the member m_dec_tile

Parameters
decthe Declination of the object
inputUnitsthe units of the input coordinates

Definition at line 1317 of file Object.h.

◆ set_densityContrast()

virtual void cbl::catalogue::Object::set_densityContrast ( const double  densityContrast)
inlinevirtual

set the member m_densityContrast

Parameters
densityContrastthe density contrast

Reimplemented in cbl::catalogue::Void.

Definition at line 1616 of file Object.h.

◆ set_field()

void cbl::catalogue::Object::set_field ( const std::string  field)
inline

set the member m_field

Parameters
fieldthe field were the object has been observed

Definition at line 1437 of file Object.h.

◆ set_galaxyTag()

virtual void cbl::catalogue::Object::set_galaxyTag ( const double  galaxyTag)
inlinevirtual

set the member m_galaxyTag

Parameters
galaxyTagthe tag of the galaxy indeed "central" or "satellite"

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1500 of file Object.h.

◆ set_generic()

virtual void cbl::catalogue::Object::set_generic ( const double  generic)
inlinevirtual

set the member m_generic

Parameters
genericthe generic variable, or an error message if the derived object does not have this member

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

Definition at line 1602 of file Object.h.

◆ set_ID()

void cbl::catalogue::Object::set_ID ( const int  ID)
inline

set the member m_ID

Parameters
IDthe ID

Definition at line 1430 of file Object.h.

◆ set_IDHost()

virtual void cbl::catalogue::Object::set_IDHost ( const int  IDHost)
inlinevirtual

set the member m_IDHost

Parameters
IDHostthe ID of host halo

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1493 of file Object.h.

◆ set_lensingCalib()

virtual void cbl::catalogue::Object::set_lensingCalib ( const double  lensingCalib)
inlinevirtual

set the member m_lensingCalib

Parameters
lensingCalibthe lensing calibration factor

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1397 of file Object.h.

◆ set_lensingWeight()

virtual void cbl::catalogue::Object::set_lensingWeight ( const double  lensingWeight)
inlinevirtual

set the member m_lensingWeight

Parameters
lensingWeightthe lensing weight

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1390 of file Object.h.

◆ set_magnitude()

virtual void cbl::catalogue::Object::set_magnitude ( const double  magnitude)
inlinevirtual

set the member m_magnitude

Parameters
magnitudethe magnitude

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1528 of file Object.h.

◆ set_magnitudeG()

virtual void cbl::catalogue::Object::set_magnitudeG ( const double  magnitudeG)
inlinevirtual

set the member m_magnitudeG

Parameters
magnitudeGthe g magnitude

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1542 of file Object.h.

◆ set_magnitudeI()

virtual void cbl::catalogue::Object::set_magnitudeI ( const double  magnitudeI)
inlinevirtual

set the member m_magnitudeI

Parameters
magnitudeIthe i magnitude

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1556 of file Object.h.

◆ set_magnitudeR()

virtual void cbl::catalogue::Object::set_magnitudeR ( const double  magnitudeR)
inlinevirtual

set the member m_magnitudeR

Parameters
magnitudeRthe r magnitude

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1549 of file Object.h.

◆ set_magnitudeU()

virtual void cbl::catalogue::Object::set_magnitudeU ( const double  magnitudeU)
inlinevirtual

set the member m_magnitudeU

Parameters
magnitudeUthe u magnitude

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1535 of file Object.h.

◆ set_mass()

virtual void cbl::catalogue::Object::set_mass ( const double  mass)
inlinevirtual

set the member m_mass

Parameters
massthe mass

Reimplemented in cbl::catalogue::Halo, cbl::catalogue::Galaxy, and cbl::catalogue::Cluster.

Definition at line 1486 of file Object.h.

◆ set_mass_estimate()

virtual void cbl::catalogue::Object::set_mass_estimate ( const double  mass_estimate)
inlinevirtual

set the private member m_mass_estimate

Parameters
mass_estimatethe mass estimate of the group

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1631 of file Object.h.

◆ set_mass_proxy()

virtual void cbl::catalogue::Object::set_mass_proxy ( const double  mass_proxy)
inlinevirtual

set the member m_mass_proxy

Parameters
mass_proxythe mass proxy

Reimplemented in cbl::catalogue::Cluster.

Definition at line 1577 of file Object.h.

◆ set_mass_proxy_error()

virtual void cbl::catalogue::Object::set_mass_proxy_error ( const double  mass_proxy_error)
inlinevirtual

set the member m_mass_proxy_error

Parameters
mass_proxy_errorthe mass proxy error

Reimplemented in cbl::catalogue::Cluster.

Definition at line 1584 of file Object.h.

◆ set_massinfall()

virtual void cbl::catalogue::Object::set_massinfall ( const double  massinfall)
inlinevirtual

set the member m_massinfall

Parameters
massinfallthe infall mass of the substructure

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1514 of file Object.h.

◆ set_mstar()

virtual void cbl::catalogue::Object::set_mstar ( const double  mstar)
inlinevirtual

set the member m_mstar

Parameters
mstarthe stellar mass

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1507 of file Object.h.

◆ set_nearCells()

virtual void cbl::catalogue::Object::set_nearCells ( const std::vector< std::vector< unsigned int >>  nearCells)
inlinevirtual

set the virtual private member m_nearCells (member of ChainMeshCell)

Parameters
nearCellsthe matrix of near cells to be set

Reimplemented in cbl::catalogue::ChainMeshCell.

Definition at line 1762 of file Object.h.

◆ set_nsub()

virtual void cbl::catalogue::Object::set_nsub ( const int  nsub)
inlinevirtual

set the private member m_nsub

Parameters
nsubthe number of sub-groups in the group

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1730 of file Object.h.

◆ set_odds()

virtual void cbl::catalogue::Object::set_odds ( const double  odds)
inlinevirtual

set the member m_odds

Parameters
oddsthe odds

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1369 of file Object.h.

◆ set_parent()

virtual void cbl::catalogue::Object::set_parent ( const int  parent)
inlinevirtual

set the private member m_parent

Parameters
parentthe id of the parent group

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1723 of file Object.h.

◆ set_part()

virtual void cbl::catalogue::Object::set_part ( const std::vector< unsigned int >  part)
inlinevirtual

set the virtual private member m_part (member of ChainMeshCell)

Parameters
partthe vector to be replaced to the particles vector

Reimplemented in cbl::catalogue::ChainMeshCell.

Definition at line 1754 of file Object.h.

◆ set_proxyerror()

virtual void cbl::catalogue::Object::set_proxyerror ( const double  value)
inlinevirtual

set the member m_proxyerror

Parameters
valueargument value

Definition at line 1521 of file Object.h.

◆ set_ra()

void cbl::catalogue::Object::set_ra ( const double  ra,
const CoordinateUnits  inputUnits = CoordinateUnits::_radians_ 
)
inline

set the member m_ra, updating the comoving coordinates accordingly (if already set)

Parameters
rathe Right Ascension of the object
inputUnitsthe units of the input coordinates

Definition at line 1284 of file Object.h.

◆ set_ra_tile()

void cbl::catalogue::Object::set_ra_tile ( const double  ra,
const CoordinateUnits  inputUnits = CoordinateUnits::_radians_ 
)
inline

set the member m_ra_tile

Parameters
rathe central Right Ascension of the object's tile
inputUnitsthe units of the input coordinates

Definition at line 1307 of file Object.h.

◆ set_radius()

virtual void cbl::catalogue::Object::set_radius ( const double  radius)
inlinevirtual

set the member m_radius

Parameters
radiusthe radius

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

Definition at line 1609 of file Object.h.

◆ set_radius_estimate()

virtual void cbl::catalogue::Object::set_radius_estimate ( const double  radius_estimate)
inlinevirtual

set the private member m_radius_estimate

Parameters
radius_estimatethe radius estimate of the group

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1638 of file Object.h.

◆ set_redshift()

void cbl::catalogue::Object::set_redshift ( const double  redshift,
const cosmology::Cosmology  cosmology,
const bool  update_coordinates = true 
)
inline

set the member m_redshift, updating the comoving coordinates accordingly (if already set)

Parameters
redshiftthe redshift of the object
cosmologyobject of class Cosmology, used to estimate the comoving distance from the given redshift
update_coordinatesif true the function cbl::catalogue::Object::set_redshift update the coordinates according to the redshift value

Definition at line 1342 of file Object.h.

◆ set_redshiftMax()

void cbl::catalogue::Object::set_redshiftMax ( const double  redshiftMax)
inline

set the member m_redshiftMax

Parameters
redshiftMaxthe maximum redshift of the object

Definition at line 1362 of file Object.h.

◆ set_redshiftMin()

void cbl::catalogue::Object::set_redshiftMin ( const double  redshiftMin)
inline

set the member m_redshiftMin

Parameters
redshiftMinthe minimum redshift of the object

Definition at line 1355 of file Object.h.

◆ set_region()

void cbl::catalogue::Object::set_region ( const long  region)
inline

set the member m_region

Parameters
regionthe index of the subRegion in which the object is located

Definition at line 1423 of file Object.h.

◆ set_satellite()

virtual void cbl::catalogue::Object::set_satellite ( const std::shared_ptr< Object satellite)
inlinevirtual

set the private member m_satellites

Parameters
satellitethe shared pointers to be added to the satellite objects pointer vector

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1739 of file Object.h.

◆ set_satellites()

virtual void cbl::catalogue::Object::set_satellites ( const std::vector< std::shared_ptr< Object >>  satellites)
inlinevirtual

set the private member m_satellites

Parameters
satellitesthe vector of shared pointers to satellite objects

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1746 of file Object.h.

◆ set_SFR()

virtual void cbl::catalogue::Object::set_SFR ( const double  SFR)
inlinevirtual

set the private member Galaxy::m_SFR

Parameters
SFRthe star formation rate of the galaxy

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1563 of file Object.h.

◆ set_shear1()

virtual void cbl::catalogue::Object::set_shear1 ( const double  shear1)
inlinevirtual

set the member m_shear1

Parameters
shear1the first shear component

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1376 of file Object.h.

◆ set_shear2()

virtual void cbl::catalogue::Object::set_shear2 ( const double  shear2)
inlinevirtual

set the member m_shear2

Parameters
shear2the second shear component

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1383 of file Object.h.

◆ set_sn()

void cbl::catalogue::Object::set_sn ( const double  sn)
inline

set the member m_sn

Parameters
snthesignal-to-noise of the object

Definition at line 1326 of file Object.h.

◆ set_spin_x()

virtual void cbl::catalogue::Object::set_spin_x ( const double  spin_x)
inlinevirtual

set the private member m_spin_x

Parameters
spin_xthe x-axis component of the spin

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1674 of file Object.h.

◆ set_spin_y()

virtual void cbl::catalogue::Object::set_spin_y ( const double  spin_y)
inlinevirtual

set the private member m_spin_y

Parameters
spin_ythe y-axis component of the spin

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1681 of file Object.h.

◆ set_spin_z()

virtual void cbl::catalogue::Object::set_spin_z ( const double  spin_z)
inlinevirtual

set the private member m_spin_z

Parameters
spin_zthe z-axis component of the spin

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1688 of file Object.h.

◆ set_sSFR()

virtual void cbl::catalogue::Object::set_sSFR ( const double  sSFR)
inlinevirtual

set the private member Galaxy::m_sSFR

Parameters
sSFRthe specific star formation rate of the galaxy

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1570 of file Object.h.

◆ set_tot_mass()

virtual void cbl::catalogue::Object::set_tot_mass ( const double  tot_mass)
inlinevirtual

set the private member m_tot_mass

Parameters
tot_massthe total mass of the parent halo

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1716 of file Object.h.

◆ set_veldisp()

virtual void cbl::catalogue::Object::set_veldisp ( const double  veldisp)
inlinevirtual

set the private member m_veldisp

Parameters
veldispthe velocity dispersion of the sub-group

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1695 of file Object.h.

◆ set_veldisp_estimate()

virtual void cbl::catalogue::Object::set_veldisp_estimate ( const double  veldisp_estimate)
inlinevirtual

set the private member m_veldisp_estimate

Parameters
veldisp_estimatethe velocity dispersion estimate of the group

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1646 of file Object.h.

◆ set_vmax()

virtual void cbl::catalogue::Object::set_vmax ( const double  vmax)
inlinevirtual

set the private member m_vmax

Parameters
vmaxthe maximum total velocity of the sub-group

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1702 of file Object.h.

◆ set_vmax_rad()

virtual void cbl::catalogue::Object::set_vmax_rad ( const double  vmax_rad)
inlinevirtual

set the private member m_vmax_rad

Parameters
vmax_radthe maximum radial velocity of the sub-group

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1709 of file Object.h.

◆ set_vx()

virtual void cbl::catalogue::Object::set_vx ( const double  vx)
inlinevirtual

set the member m_vx

Parameters
vxthe peculiar velocity along the x direction

Reimplemented in cbl::catalogue::Halo.

Definition at line 1465 of file Object.h.

◆ set_vy()

virtual void cbl::catalogue::Object::set_vy ( const double  vy)
inlinevirtual

set the member m_vy

Parameters
vythe peculiar velocity along the y direction

Reimplemented in cbl::catalogue::Halo.

Definition at line 1472 of file Object.h.

◆ set_vz()

virtual void cbl::catalogue::Object::set_vz ( const double  vz)
inlinevirtual

set the member m_vz

Parameters
vzthe peculiar velocity along the z direction

Reimplemented in cbl::catalogue::Halo.

Definition at line 1479 of file Object.h.

◆ set_weight()

void cbl::catalogue::Object::set_weight ( const double  weight)
inline

set the member m_weight

Parameters
weightthe weight of the object

Definition at line 1415 of file Object.h.

◆ set_x_displacement()

void cbl::catalogue::Object::set_x_displacement ( const double  x_displacement)
inline

set the member m_x_displacement

Parameters
x_displacementthe displacement (in Mpc) of the x coordinate

Definition at line 1444 of file Object.h.

◆ set_xcm()

virtual void cbl::catalogue::Object::set_xcm ( const double  xcm)
inlinevirtual

set the private member m_xcm

Parameters
xcmthe x-axis coordinate of the centre of mass

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1653 of file Object.h.

◆ set_xx()

void cbl::catalogue::Object::set_xx ( const double  xx)
inline

set the member m_xx

Parameters
xxthe coordinate x of the object

Definition at line 1261 of file Object.h.

◆ set_y_displacement()

void cbl::catalogue::Object::set_y_displacement ( const double  y_displacement)
inline

set the member m_y_displacement

Parameters
y_displacementthe displacement (in Mpc) of the y coordinate

Definition at line 1451 of file Object.h.

◆ set_ycm()

virtual void cbl::catalogue::Object::set_ycm ( const double  ycm)
inlinevirtual

set the private member m_ycm

Parameters
ycmthe y-axis coordinate of the centre of mass

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1660 of file Object.h.

◆ set_yy()

void cbl::catalogue::Object::set_yy ( const double  yy)
inline

set the member m_yy

Parameters
yythe coordinate y of the object

Definition at line 1268 of file Object.h.

◆ set_z_displacement()

void cbl::catalogue::Object::set_z_displacement ( const double  z_displacement)
inline

set the member m_z_displacement

Parameters
z_displacementthe displacement (in Mpc) of the x coordinate

Definition at line 1458 of file Object.h.

◆ set_zcm()

virtual void cbl::catalogue::Object::set_zcm ( const double  zcm)
inlinevirtual

set the private member m_zcm

Parameters
zcmthe z-axis coordinate of the centre of mass

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1667 of file Object.h.

◆ set_zz()

void cbl::catalogue::Object::set_zz ( const double  zz)
inline

set the member m_zz

Parameters
zzthe coordinate z of the object

Definition at line 1275 of file Object.h.

◆ SFR()

virtual double cbl::catalogue::Object::SFR ( ) const
inlinevirtual

get the private member Galaxy::m_SFR

Returns
the star formation rate of the galaxy

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1009 of file Object.h.

◆ shear1()

virtual double cbl::catalogue::Object::shear1 ( ) const
inlinevirtual

get the member m_shear1

Returns
the first shear component of the object

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 981 of file Object.h.

◆ shear2()

virtual double cbl::catalogue::Object::shear2 ( ) const
inlinevirtual

get the member m_shear1

Returns
the first shear component of the object

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 988 of file Object.h.

◆ sn()

double cbl::catalogue::Object::sn ( ) const
inline

get the member m_sn

Returns
the signal-to-noise of the object

Definition at line 800 of file Object.h.

◆ spin_x()

virtual double cbl::catalogue::Object::spin_x ( ) const
inlinevirtual

get the private member m_spin_x

Returns
the x-axis component of the spin, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1160 of file Object.h.

◆ spin_y()

virtual double cbl::catalogue::Object::spin_y ( ) const
inlinevirtual

get the private member m_spin_y

Returns
the y-axis component of the spin, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1168 of file Object.h.

◆ spin_z()

virtual double cbl::catalogue::Object::spin_z ( ) const
inlinevirtual

get the private member m_spin_z

Returns
the z-axis component of the spin, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1176 of file Object.h.

◆ sSFR()

virtual double cbl::catalogue::Object::sSFR ( ) const
inlinevirtual

get the private member Galaxy::m_sSFR

Returns
the specific star formation rate of the galaxy

Reimplemented in cbl::catalogue::Galaxy.

Definition at line 1016 of file Object.h.

◆ tot_mass()

virtual double cbl::catalogue::Object::tot_mass ( ) const
inlinevirtual

get the private member m_tot_mass

Returns
the total mass of the host halo (sum over all contributions), or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1208 of file Object.h.

◆ veldisp()

virtual double cbl::catalogue::Object::veldisp ( ) const
inlinevirtual

get the private member m_veldisp

Returns
the velocity dispersion of the sub-group, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1184 of file Object.h.

◆ veldisp_estimate()

virtual double cbl::catalogue::Object::veldisp_estimate ( ) const
inlinevirtual

get the private member m_veldisp_estimate

Returns
the velocity dispersion estimate of the group, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1128 of file Object.h.

◆ vmax()

virtual double cbl::catalogue::Object::vmax ( ) const
inlinevirtual

get the private member m_vmax

Returns
the maximum total velocity of the sub-group, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1192 of file Object.h.

◆ vmax_rad()

virtual double cbl::catalogue::Object::vmax_rad ( ) const
inlinevirtual

get the private member m_vmax_rad

Returns
the maximum radial velocity of the sub-group, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1200 of file Object.h.

◆ vx()

virtual double cbl::catalogue::Object::vx ( ) const
inlinevirtual

get the member m_vx

Returns
the peculiar velocity along the x direction of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Halo.

Definition at line 894 of file Object.h.

◆ vy()

virtual double cbl::catalogue::Object::vy ( ) const
inlinevirtual

get the member m_vy

Returns
the peculiar velocity along the y direction of the derived object, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::Halo.

Definition at line 903 of file Object.h.

◆ vz()

virtual double cbl::catalogue::Object::vz ( ) const
inlinevirtual

get the member m_vz

Returns
the peculiar velocity along the z direction of the derived object, or an message if the derived object does not have this member

Reimplemented in cbl::catalogue::Halo.

Definition at line 912 of file Object.h.

◆ weight()

double cbl::catalogue::Object::weight ( ) const
inline

get the member m_weight

Returns
the weight of the object

Definition at line 828 of file Object.h.

◆ x_displacement()

double cbl::catalogue::Object::x_displacement ( ) const
inline

get the member m_x_displacement

Returns
the displacement along the x axis

Definition at line 860 of file Object.h.

◆ xcm()

virtual double cbl::catalogue::Object::xcm ( ) const
inlinevirtual

get the private member m_xcm

Returns
the x-axis coordinate of the centre of mass, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1136 of file Object.h.

◆ xx()

double cbl::catalogue::Object::xx ( ) const
inline

get the member m_xx

Returns
the coordinate x of the derived object

Definition at line 744 of file Object.h.

◆ y_displacement()

double cbl::catalogue::Object::y_displacement ( ) const
inline

get the member m_y_displacement

Returns
the displacement along the x axis

Definition at line 867 of file Object.h.

◆ ycm()

virtual double cbl::catalogue::Object::ycm ( ) const
inlinevirtual

get the private member m_ycm

Returns
the y-axis coordinate of the centre of mass, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1144 of file Object.h.

◆ yy()

double cbl::catalogue::Object::yy ( ) const
inline

get the member m_yy

Returns
the coordinate y of the derived object

Definition at line 751 of file Object.h.

◆ z_displacement()

double cbl::catalogue::Object::z_displacement ( ) const
inline

get the member m_z_displacement

Returns
the displacement along the z axis

Definition at line 874 of file Object.h.

◆ zcm()

virtual double cbl::catalogue::Object::zcm ( ) const
inlinevirtual

get the private member m_zcm

Returns
the z-axis coordinate of the centre of mass, or an error message if the derived object does not have this member

Reimplemented in cbl::catalogue::HostHalo.

Definition at line 1152 of file Object.h.

◆ zz()

double cbl::catalogue::Object::zz ( ) const
inline

get the member m_zz

Returns
the coordinate z of the derived object

Definition at line 758 of file Object.h.


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