dataobjs.hpp

Go to the documentation of this file.

// Triumvirate: Three-Point Clustering Measurements in LSS
//
// Copyright (C) 2023 Mike S Wang & Naonori S Sugiyama [GPL-3.0-or-later]
//
// This file is part of the Triumvirate program. See the COPYRIGHT
// and LICENCE files at the top-level directory of this distribution
// for details of copyright and licensing.
//
// 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 3 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, see <https://www.gnu.org/licenses/>.

 
#ifndef TRIUMVIRATE_INCLUDE_DATAOBJS_HPP_INCLUDED_
#define TRIUMVIRATE_INCLUDE_DATAOBJS_HPP_INCLUDED_
 
#include <algorithm>
#include <cmath>
#include <complex>
#include <vector>
 
#include "monitor.hpp"
#include "parameters.hpp"
 
namespace trv {
 
// ***********************************************************************
// Binning schemes
// ***********************************************************************

class Binning {
 public:
  std::string space;                
  std::string scheme;               
  double bin_min;                   
  double bin_max;                   
  int num_bins;                     
  std::vector<double> bin_edges;    
  std::vector<double> bin_centres;  
  std::vector<double> bin_widths;   

  explicit Binning(std::string space, std::string scheme);

  explicit Binning(trv::ParameterSet& params);

  void set_bins(double coord_min, double coord_max, int nbin);

  void set_bins();

  void set_bins(double boxsize_max, int ngrid_min);

  void set_bins(std::vector<double> bin_edges);
 
 private:
  // CAVEAT: Discretionary choices.
  int nbin_pad = 5;                 
  double dbin_pad_fourier = 1.e-3;  
  double dbin_pad_config = 10.;     

  void compute_binning();
};
 
 
// ***********************************************************************
// Mesh grids
// ***********************************************************************

struct BinnedVectors {
  int count = 0;                    
  int num_bins = 0;                 
  std::vector<int> indices;         
  std::vector<double> lower_edges;  
  std::vector<double> upper_edges;  
  std::vector<double> vecx;         
  std::vector<double> vecy;         
  std::vector<double> vecz;         
};
 
 
// ***********************************************************************
// Line of sight
// ***********************************************************************

struct LineOfSight {
  double pos[3];  
};
 
// ***********************************************************************
// Clustering statistics
// ***********************************************************************
 
// -----------------------------------------------------------------------
// Two-point statistics
// -----------------------------------------------------------------------

struct PowspecMeasurements {
  int dim = 0;               
  std::vector<double> kbin;  
  std::vector<double> keff;  
  std::vector<int> nmodes;   
  std::vector< std::complex<double> > pk_raw;
  std::vector< std::complex<double> > pk_shot;
};

struct TwoPCFMeasurements {
  int dim = 0;               
  std::vector<double> rbin;  
  std::vector<double> reff;  
  std::vector<int> npairs;   
  std::vector< std::complex<double> > xi;
};

struct TwoPCFWindowMeasurements {
  int dim = 0;               
  std::vector<double> rbin;  
  std::vector<double> reff;  
  std::vector<int> npairs;   
  std::vector< std::complex<double> > xi;
};
 
 
// -----------------------------------------------------------------------
// Three-point statistics
// -----------------------------------------------------------------------

struct BispecMeasurements {
  int dim = 0;                 
  std::vector<double> k1_bin;  
  std::vector<double> k2_bin;  
  std::vector<double> k1_eff;  
  std::vector<double> k2_eff;  
  std::vector<int> nmodes_1;   
  std::vector<int> nmodes_2;   
  std::vector< std::complex<double> > bk_raw;
  std::vector< std::complex<double> > bk_shot;
};

struct ThreePCFMeasurements {
  int dim = 0;                 
  std::vector<double> r1_bin;  
  std::vector<double> r2_bin;  
  std::vector<double> r1_eff;  
  std::vector<double> r2_eff;  
  std::vector<int> npairs_1;
  std::vector<int> npairs_2;
  std::vector< std::complex<double> > zeta_raw;
  std::vector< std::complex<double> > zeta_shot;
};

struct ThreePCFWindowMeasurements {
  int dim = 0;                 
  std::vector<double> r1_bin;  
  std::vector<double> r2_bin;  
  std::vector<double> r1_eff;  
  std::vector<double> r2_eff;  
  std::vector<int> npairs_1;
  std::vector<int> npairs_2;
  std::vector< std::complex<double> > zeta_raw;
  std::vector< std::complex<double> > zeta_shot;
};
 
}  // namespace trv
 
#endif  // !TRIUMVIRATE_INCLUDE_DATAOBJS_HPP_INCLUDED_