HostHalo.h

Go to the documentation of this file.

/********************************************************************
 *  Copyright (C) 2015 by Federico Marulli and Tommaso Ronconi      *
 *  federico.marulli3@sissa.it tronconi@sissa.it                    *
 *                                                                  *
 *  This program is free software; you can redistribute it and/or   *
 *  modify it under the terms of the GNU General Public License as  *
 *  published by the Free Software Foundation; either version 2 of  *
 *  the License, or (at your option) any later version.             *
 *                                                                  * 
 *  This program is distributed in the hope that it will be useful, *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of  *  
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the   *
 *  GNU General Public License for more details.                    *
 *                                                                  *
 *  You should have received a copy of the GNU General Public       *
 *  License along with this program; if not, write to the Free      *
 *  Software Foundation, Inc.,                                      *
 *  59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.       *
 ********************************************************************/
 
#ifndef __HOSTHALO__
#define __HOSTHALO__
 
 
// ===================================================================================================
 
 
namespace cbl {
 
  namespace catalogue {
    
    class HostHalo : public Halo {
 
    private :
 
      double m_tot_mass;
 
      double m_SFR;
 
      double m_mass_estimate;
 
      double m_radius_estimate;
 
      double m_veldisp_estimate;
 
      double m_xcm;
 
      double m_ycm;
 
      double m_zcm;
 
      double m_spin_x;
 
      double m_spin_y;
 
      double m_spin_z;
 
      double m_veldisp;
 
      double m_vmax;
 
      double m_vmax_rad;
 
      double m_radius;
 
      int m_parent;
 
      int m_nsub;
 
      std::vector<std::shared_ptr<Object>> m_satellites;
      
    public :
    
 
      HostHalo ()
    : Halo(), m_tot_mass(par::defaultDouble), m_mass_estimate(par::defaultDouble), m_radius_estimate(par::defaultDouble), m_veldisp_estimate(par::defaultDouble), m_xcm(par::defaultDouble), m_ycm(par::defaultDouble), m_zcm(par::defaultDouble), m_spin_x(par::defaultDouble), m_spin_y(par::defaultDouble), m_spin_z(par::defaultDouble), m_veldisp(par::defaultDouble), m_vmax(par::defaultDouble), m_vmax_rad(par::defaultDouble), m_radius(par::defaultDouble), m_parent(par::defaultInt), m_nsub(par::defaultInt), m_satellites({}) {}
      
      std::shared_ptr<Object> getShared() {
        return std::make_shared<HostHalo>(*this);
      }
 
      HostHalo (const comovingCoordinates coord, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double vx=par::defaultDouble, const double vy=par::defaultDouble, const double vz=par::defaultDouble, const double mass=par::defaultDouble, const double tot_mass=par::defaultDouble, const double mass_estimate=par::defaultDouble, const double radius_estimate=par::defaultDouble, const double veldisp_estimate=par::defaultDouble, const comovingCoordinates cm_coord={par::defaultDouble, par::defaultDouble, par::defaultDouble}, const double spin_x=par::defaultDouble, const double spin_y=par::defaultDouble, const double spin_z=par::defaultDouble, const double veldisp=par::defaultDouble, const double vmax=par::defaultDouble, const double vmax_rad=par::defaultDouble, const double radius=par::defaultDouble, const int parent=par::defaultInt, const int nsub=par::defaultInt, std::vector<std::shared_ptr<Object>> satellites = {})
    : Halo(coord, weight, region, ID, field, x_displacement, y_displacement, z_displacement, vx, vy, vz, mass), m_tot_mass(tot_mass), m_mass_estimate(mass_estimate), m_radius_estimate(radius_estimate), m_veldisp_estimate(veldisp_estimate), m_xcm(cm_coord.xx), m_ycm(cm_coord.yy), m_zcm(cm_coord.zz), m_spin_x(spin_x), m_spin_y(spin_y), m_spin_z(spin_z), m_veldisp(veldisp), m_vmax(vmax), m_vmax_rad(vmax_rad), m_radius(radius), m_parent(parent), m_nsub(nsub), m_satellites(satellites) {}
 
      HostHalo (const comovingCoordinates coord, const cosmology::Cosmology &cosm, const double z1_guess=0., const double z2_guess=10., const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double vx=par::defaultDouble, const double vy=par::defaultDouble, const double vz=par::defaultDouble, const double mass=par::defaultDouble, const double tot_mass=par::defaultDouble, const double mass_estimate=par::defaultDouble, const double radius_estimate=par::defaultDouble, const double veldisp_estimate=par::defaultDouble, const comovingCoordinates cm_coord={par::defaultDouble, par::defaultDouble, par::defaultDouble}, const double spin_x=par::defaultDouble, const double spin_y=par::defaultDouble, const double spin_z=par::defaultDouble, const double veldisp=par::defaultDouble, const double vmax=par::defaultDouble, const double vmax_rad=par::defaultDouble, const double radius=par::defaultDouble, const int parent=par::defaultInt, const int nsub=par::defaultInt, std::vector<std::shared_ptr<Object>> satellites = {}) 
    : Halo(coord, cosm, z1_guess, z2_guess, weight, region, ID, field, x_displacement, y_displacement, z_displacement, vx, vy, vz, mass), m_tot_mass(tot_mass), m_mass_estimate(mass_estimate), m_radius_estimate(radius_estimate), m_veldisp_estimate(veldisp_estimate), m_xcm(cm_coord.xx), m_ycm(cm_coord.yy), m_zcm(cm_coord.zz), m_spin_x(spin_x), m_spin_y(spin_y), m_spin_z(spin_z), m_veldisp(veldisp), m_vmax(vmax), m_vmax_rad(vmax_rad), m_radius(radius), m_parent(parent), m_nsub(nsub), m_satellites(satellites) {}
 
      HostHalo (const observedCoordinates coord, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double vx=par::defaultDouble, const double vy=par::defaultDouble, const double vz=par::defaultDouble, const double mass=par::defaultDouble, const double tot_mass=par::defaultDouble, const double mass_estimate=par::defaultDouble, const double radius_estimate=par::defaultDouble, const double veldisp_estimate=par::defaultDouble, const comovingCoordinates cm_coord={par::defaultDouble, par::defaultDouble, par::defaultDouble}, const double spin_x=par::defaultDouble, const double spin_y=par::defaultDouble, const double spin_z=par::defaultDouble, const double veldisp=par::defaultDouble, const double vmax=par::defaultDouble, const double vmax_rad=par::defaultDouble, const double radius=par::defaultDouble, const int parent=par::defaultInt, const int nsub=par::defaultInt, std::vector<std::shared_ptr<Object>> satellites = {}) 
    : Halo(coord, weight, region, ID, field, x_displacement, y_displacement, z_displacement, vx, vy, vz, mass), m_tot_mass(tot_mass), m_mass_estimate(mass_estimate), m_radius_estimate(radius_estimate), m_veldisp_estimate(veldisp_estimate), m_xcm(cm_coord.xx), m_ycm(cm_coord.yy), m_zcm(cm_coord.zz), m_spin_x(spin_x), m_spin_y(spin_y), m_spin_z(spin_z), m_veldisp(veldisp), m_vmax(vmax), m_vmax_rad(vmax_rad), m_radius(radius), m_parent(parent), m_nsub(nsub), m_satellites(satellites) {}
      
      HostHalo (const observedCoordinates coord, const CoordinateUnits inputUnits, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double vx=par::defaultDouble, const double vy=par::defaultDouble, const double vz=par::defaultDouble, const double mass=par::defaultDouble, const double tot_mass=par::defaultDouble, const double mass_estimate=par::defaultDouble, const double radius_estimate=par::defaultDouble, const double veldisp_estimate=par::defaultDouble, const comovingCoordinates cm_coord={par::defaultDouble, par::defaultDouble, par::defaultDouble}, const double spin_x=par::defaultDouble, const double spin_y=par::defaultDouble, const double spin_z=par::defaultDouble, const double veldisp=par::defaultDouble, const double vmax=par::defaultDouble, const double vmax_rad=par::defaultDouble, const double radius=par::defaultDouble, const int parent=par::defaultInt, const int nsub=par::defaultInt, std::vector<std::shared_ptr<Object>> satellites = {}) 
    : Halo(coord, inputUnits, weight, region, ID, field, x_displacement, y_displacement, z_displacement, vx, vy, vz, mass), m_tot_mass(tot_mass), m_mass_estimate(mass_estimate), m_radius_estimate(radius_estimate), m_veldisp_estimate(veldisp_estimate), m_xcm(cm_coord.xx), m_ycm(cm_coord.yy), m_zcm(cm_coord.zz), m_spin_x(spin_x), m_spin_y(spin_y), m_spin_z(spin_z), m_veldisp(veldisp), m_vmax(vmax), m_vmax_rad(vmax_rad), m_radius(radius), m_parent(parent), m_nsub(nsub), m_satellites(satellites) {}
      
      HostHalo (const observedCoordinates coord, const cosmology::Cosmology &cosm, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double vx=par::defaultDouble, const double vy=par::defaultDouble, const double vz=par::defaultDouble, const double mass=par::defaultDouble, const double tot_mass=par::defaultDouble, const double mass_estimate=par::defaultDouble, const double radius_estimate=par::defaultDouble, const double veldisp_estimate=par::defaultDouble, const comovingCoordinates cm_coord={par::defaultDouble, par::defaultDouble, par::defaultDouble}, const double spin_x=par::defaultDouble, const double spin_y=par::defaultDouble, const double spin_z=par::defaultDouble, const double veldisp=par::defaultDouble, const double vmax=par::defaultDouble, const double vmax_rad=par::defaultDouble, const double radius=par::defaultDouble, const int parent=par::defaultInt, const int nsub=par::defaultInt, std::vector<std::shared_ptr<Object>> satellites = {}) 
    : Halo(coord, cosm, weight, region, ID, field, x_displacement, y_displacement, z_displacement, vx, vy, vz, mass), m_tot_mass(tot_mass), m_mass_estimate(mass_estimate), m_radius_estimate(radius_estimate), m_veldisp_estimate(veldisp_estimate), m_xcm(cm_coord.xx), m_ycm(cm_coord.yy), m_zcm(cm_coord.zz), m_spin_x(spin_x), m_spin_y(spin_y), m_spin_z(spin_z), m_veldisp(veldisp), m_vmax(vmax), m_vmax_rad(vmax_rad), m_radius(radius), m_parent(parent), m_nsub(nsub), m_satellites(satellites) {}
 
      HostHalo (const observedCoordinates coord, const CoordinateUnits inputUnits, const cosmology::Cosmology &cosm, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double vx=par::defaultDouble, const double vy=par::defaultDouble, const double vz=par::defaultDouble, const double mass=par::defaultDouble, const double tot_mass=par::defaultDouble, const double mass_estimate=par::defaultDouble, const double radius_estimate=par::defaultDouble, const double veldisp_estimate=par::defaultDouble, const comovingCoordinates cm_coord={par::defaultDouble, par::defaultDouble, par::defaultDouble}, const double spin_x=par::defaultDouble, const double spin_y=par::defaultDouble, const double spin_z=par::defaultDouble, const double veldisp=par::defaultDouble, const double vmax=par::defaultDouble, const double vmax_rad=par::defaultDouble, const double radius=par::defaultDouble, const int parent=par::defaultInt, const int nsub=par::defaultInt, std::vector<std::shared_ptr<Object>> satellites = {}) 
    : Halo(coord, inputUnits, cosm, weight, region, ID, field, x_displacement, y_displacement, z_displacement, vx, vy, vz, mass), m_tot_mass(tot_mass), m_mass_estimate(mass_estimate), m_radius_estimate(radius_estimate), m_veldisp_estimate(veldisp_estimate), m_xcm(cm_coord.xx), m_ycm(cm_coord.yy), m_zcm(cm_coord.zz), m_spin_x(spin_x), m_spin_y(spin_y), m_spin_z(spin_z), m_veldisp(veldisp), m_vmax(vmax), m_vmax_rad(vmax_rad), m_radius(radius), m_parent(parent), m_nsub(nsub), m_satellites(satellites) {}
 
      HostHalo (const double xx, const double yy, const double zz, const double ra, const double dec, const double redshift, const double weight=1., const long region=par::defaultLong, const int ID=par::defaultInt, const std::string field=par::defaultString, const double x_displacement=par::defaultDouble, const double y_displacement=par::defaultDouble, const double z_displacement=par::defaultDouble, const double vx=par::defaultDouble, const double vy=par::defaultDouble, const double vz=par::defaultDouble, const double mass=par::defaultDouble, const double tot_mass=par::defaultDouble, const double mass_estimate=par::defaultDouble, const double radius_estimate=par::defaultDouble, const double veldisp_estimate=par::defaultDouble, const comovingCoordinates cm_coord={par::defaultDouble, par::defaultDouble, par::defaultDouble}, const double spin_x=par::defaultDouble, const double spin_y=par::defaultDouble, const double spin_z=par::defaultDouble, const double veldisp=par::defaultDouble, const double vmax=par::defaultDouble, const double vmax_rad=par::defaultDouble, const double radius=par::defaultDouble, const int parent=par::defaultInt, const int nsub=par::defaultInt, std::vector<std::shared_ptr<Object>> satellites = {}) 
    : Halo(xx, yy, zz, ra, dec, redshift, weight, region, ID, field, x_displacement, y_displacement, z_displacement, vx, vy, vz, mass), m_tot_mass(tot_mass), m_mass_estimate(mass_estimate), m_radius_estimate(radius_estimate), m_veldisp_estimate(veldisp_estimate), m_xcm(cm_coord.xx), m_ycm(cm_coord.yy), m_zcm(cm_coord.zz), m_spin_x(spin_x), m_spin_y(spin_y), m_spin_z(spin_z), m_veldisp(veldisp), m_vmax(vmax), m_vmax_rad(vmax_rad), m_radius(radius), m_parent(parent), m_nsub(nsub), m_satellites(satellites) {}
      
      ~HostHalo () = default;
 
  
  
    
      double tot_mass () const override { return m_tot_mass; }
    
      double mass_estimate () const override { return m_mass_estimate; }
    
      double radius_estimate () const override { return m_radius_estimate; }
    
      double veldisp_estimate () const override { return m_veldisp_estimate; }
    
      double xcm () const override { return m_xcm; }
    
      double ycm () const override { return m_ycm; }
    
      double zcm () const override { return m_zcm; }
    
      double spin_x () const override { return m_spin_x; }
    
      double spin_y () const override { return m_spin_y; }
    
      double spin_z () const override { return m_spin_z; }
    
      double veldisp () const override { return m_veldisp; }
    
      double vmax () const override { return m_vmax; }
    
      double vmax_rad () const override { return m_vmax_rad; }
    
      double radius () const override { return m_radius; }
    
      int parent () const override { return m_parent; }
    
      int nsub () const override { return m_nsub; }
    
      std::vector<std::shared_ptr<Object>> satellites () const override { return m_satellites; }
 
  
  
    
      void set_tot_mass (const double tot_mass=par::defaultDouble) override { m_tot_mass = tot_mass; }
    
      void set_mass_estimate (const double mass_estimate=par::defaultDouble) override { m_mass_estimate = mass_estimate; }
    
      void set_radius_estimate (const double radius_estimate=par::defaultDouble) override { m_radius_estimate = radius_estimate; }
    
    
      void set_veldisp_estimate (const double veldisp_estimate=par::defaultDouble) override { m_veldisp_estimate = veldisp_estimate; }
    
      void set_xcm (const double xcm=par::defaultDouble) override { m_xcm = xcm; }
    
      void set_ycm (const double ycm=par::defaultDouble) override { m_ycm = ycm; }
    
      void set_zcm (const double zcm=par::defaultDouble) override { m_zcm = zcm; }
    
      void set_spin_x (const double spin_x=par::defaultDouble) override { m_spin_x = spin_x; }
    
      void set_spin_y (const double spin_y=par::defaultDouble) override { m_spin_y = spin_y; }
    
      void set_spin_z (const double spin_z=par::defaultDouble) override { m_spin_z = spin_z; }
    
      void set_veldisp (const double veldisp=par::defaultDouble) override { m_veldisp = veldisp; }
    
      void set_vmax (const double vmax=par::defaultDouble) override { m_vmax = vmax; }
    
      void set_vmax_rad (const double vmax_rad=par::defaultDouble) override { m_vmax_rad = vmax_rad; }
    
      void set_radius (const double radius=par::defaultDouble) override { m_radius = radius; }
    
      void set_parent (const int parent=par::defaultInt) override { m_parent = parent; }
 
      void set_nsub (const int nsub=par::defaultInt) override { m_nsub = nsub; }
 
      void set_satellite (const std::shared_ptr<Object> satellite={}) override {
    m_satellites.push_back(satellite);
      }
 
      void set_satellites (const std::vector<std::shared_ptr<Object>> satellites={}) override {
    for (size_t ii = 0; ii<satellites.size(); ii++) m_satellites.push_back(satellites[ii]);
      }
    
 
 
        
      bool isSet_tot_mass () override
      { return (cbl::isSet(m_tot_mass)) ? true : false; }
        
      bool isSet_mass_estimate () override
      { return (cbl::isSet(m_mass_estimate)) ? true : false; }
        
      bool isSet_radius_estimate () override
      { return (cbl::isSet(m_radius_estimate)) ? true : false; }
        
      bool isSet_veldisp_estimate () override
      { return (cbl::isSet(m_veldisp_estimate)) ? true : false; }
        
      bool isSet_xcm () override
      { return (cbl::isSet(m_xcm)) ? true : false; }
        
      bool isSet_ycm () override
      { return (cbl::isSet(m_ycm)) ? true : false; }
        
      bool isSet_zcm () override
      { return (cbl::isSet(m_zcm)) ? true : false; }
        
      bool isSet_spin_x () override
      { return (cbl::isSet(m_spin_x)) ? true : false; }
        
      bool isSet_spin_y () override
      { return (cbl::isSet(m_spin_y)) ? true : false; }
        
      bool isSet_spin_z () override
      { return (cbl::isSet(m_spin_z)) ? true : false; }
        
      bool isSet_veldisp () override
      { return (cbl::isSet(m_veldisp)) ? true : false; }
        
      bool isSet_vmax () override
      { return (cbl::isSet(m_vmax)) ? true : false; }
        
      bool isSet_vmax_rad () override
      { return (cbl::isSet(m_vmax_rad)) ? true : false; }
        
      bool isSet_radius () override
      { return (cbl::isSet(m_radius)) ? true : false; }
        
      bool isSet_parent () override
      { return (cbl::isSet(m_parent)) ? true : false; }
        
      bool isSet_nsub () override
      { return (cbl::isSet(m_nsub)) ? true : false; }
    
  
    }; //class HostHalo
 
  } //namespace catalogue
  
} //namespace cbl
 
#endif //__HOSTHALO__