LALSimIMRSEOBNRv5HMROM.c

Go to the documentation of this file.

 
/*
 * Copyright (C) 2022 Lorenzo Pompili
 * Copyright (C) 2019 Michael Puerrer, John Veitch, Roberto Cotesta, Sylvain Marsat
 * Copyright (C) 2014, 2015, 2016 Michael Puerrer, John Veitch
 *  Reduced Order Model for SEOBNR
 *
 *  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 with program; see the file COPYING. If not, write to the
 *  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 *  MA  02110-1301  USA
 */
 
#ifdef __GNUC__
#define UNUSED __attribute__ ((unused))
#else
#define UNUSED
#endif
 
#include <stdio.h>
#include <stdlib.h>
#include <math.h>
#include <complex.h>
#include <time.h>
#include <stdbool.h>
#include <alloca.h>
#include <string.h>
#include <libgen.h>
 
 
#include <gsl/gsl_errno.h>
#include <gsl/gsl_bspline.h>
#include <gsl/gsl_blas.h>
#include <gsl/gsl_min.h>
#include <gsl/gsl_spline.h>
#include <gsl/gsl_poly.h>
#include <lal/Units.h>
#include <lal/SeqFactories.h>
#include <lal/LALConstants.h>
#include <lal/XLALError.h>
#include <lal/FrequencySeries.h>
#include <lal/Date.h>
#include <lal/StringInput.h>
#include <lal/Sequence.h>
#include <lal/LALStdio.h>
#include <lal/FileIO.h>
#include <lal/LALSimSphHarmMode.h>
#include <lal/LALDatatypes.h>
#include <lal/LALSimInspiral.h>
#include <lal/AVFactories.h>
#include <lal/SphericalHarmonics.h>
#include "LALSimInspiralPNCoefficients.c"
 
#define NMODES 7
#define f_hyb_ini 0.003
#define f_hyb_end 0.004
 
#ifdef LAL_HDF5_ENABLED
#include <lal/H5FileIO.h>
static const char ROMDataHDF5[] = "SEOBNRv5HMROM_v1.0.hdf5";
static const INT4 ROMDataHDF5_VERSION_MAJOR = 1;
static const INT4 ROMDataHDF5_VERSION_MINOR = 0;
static const INT4 ROMDataHDF5_VERSION_MICRO = 0;
static const char ROM22DataHDF5[] = "SEOBNRv5ROM_v1.0.hdf5";
static const INT4 ROM22DataHDF5_VERSION_MAJOR = 1;
static const INT4 ROM22DataHDF5_VERSION_MINOR = 0;
static const INT4 ROM22DataHDF5_VERSION_MICRO = 0;
#endif
 
#include <lal/LALSimInspiral.h>
#include <lal/LALSimIMR.h>
 
#include "LALSimIMRSEOBNRROMUtilities.c"
 
#include <lal/LALConfig.h>
#ifdef LAL_PTHREAD_LOCK
#include <pthread.h>
#endif
 
 
 
#ifdef LAL_PTHREAD_LOCK
static pthread_once_t SEOBNRv5HMROM_is_initialized = PTHREAD_ONCE_INIT;
static pthread_once_t SEOBNRv5ROM_is_initialized = PTHREAD_ONCE_INIT;
#endif
 
 
/*************** mode array definitions ******************/
 
const char mode_array_v5hm[NMODES][3] =
{"22",
"33",
"21",
"44",
"55",
"32",
"43"};
 
const UINT4 lmModes_v5hm[NMODES][2] = {{2, 2}, {3, 3}, {2, 1}, {4, 4}, {5, 5}, {3, 2}, {4, 3}};
 
/*************** constant phase shifts ******************/
 
// const REAL8 const_phaseshift_lm_v5hm[NMODES] = {0.,-LAL_PI/2.,LAL_PI/2.,LAL_PI,LAL_PI/2.,0.,-LAL_PI/2.};
const REAL8 const_phaseshift_lm_v5hm[NMODES] = {0.,0.,0.,0.,0.,0.,0.};
 
/* This constant phaseshift is coming from the relations between the phase
* of the lm mode phi_lm and the orbital phase phi. At leading order phi_lm = -m*phi + c_lm
* where c_lm are these constant phaseshift. They can be derived from the PN expression of the modes
* see Blanchet, L. Living Rev. Relativ. (2014) 17: 2. https://doi.org/10.12942/lrr-2014-2 Eqs(327-329)
*/
 
/*************** constant factors used to define fmax for each mode ******************/
 
const REAL8 const_fmax_lm_v5hm[NMODES] = {1.7, 1.55, 1.7, 1.35, 1.25, 1.7, 1.7};
 
/*************** starting geometric frequency 22 mode non-hybridized ROM ***********************/
 
#define Mf_low_22 0.0004925491025543576
#define Mf_low_33 (Mf_low_22 * (3.0/2.0))
#define Mf_low_21 (Mf_low_22 * (1.0/2.0))
#define Mf_low_44 (Mf_low_22 * (4.0/2.0))
#define Mf_low_55 (Mf_low_22 * (5.0/2.0))
#define Mf_low_32 (Mf_low_22)
#define Mf_low_43 (Mf_low_22 * (3.0/2.0))
const REAL8 Mf_low_lm_v5hm[NMODES] = {Mf_low_22, Mf_low_33, Mf_low_21, Mf_low_44, Mf_low_55, Mf_low_32, Mf_low_43};
 
/*************** type definitions ******************/
 
typedef struct tagSEOBNRROMdataDS_coeff
{
  gsl_vector* c_real;
  gsl_vector* c_imag;
  gsl_vector* c_phase;
} SEOBNRROMdataDS_coeff;
 
struct tagSEOBNRROMdataDS_submodel
{
  gsl_vector* cvec_real;     // Flattened Re(c-mode) projection coefficients
  gsl_vector* cvec_imag;     // Flattened Im(c-mode) projection coefficients
  gsl_vector* cvec_phase;    // Flattened orbital phase projection coefficients
  gsl_matrix *Breal;         // Reduced SVD basis for Re(c-mode)
  gsl_matrix *Bimag;         // Reduced SVD basis for Im(c-mode)
  gsl_matrix *Bphase;        // Reduced SVD basis for orbital phase
  int nk_cmode;              // Number frequency points for c-mode
  int nk_phase;              // Number of frequency points for orbital phase
  gsl_vector *gCMode;        // Sparse frequency points for c-mode
  gsl_vector *gPhase;        // Sparse frequency points for orbital phase
  gsl_vector *qvec;          // B-spline knots in q
  gsl_vector *chi1vec;       // B-spline knots in chi1
  gsl_vector *chi2vec;       // B-spline knots in chi2
  int ncx, ncy, ncz;         // Number of points in q, chi1, chi2
  double q_bounds[2];        // [q_min, q_max]
  double chi1_bounds[2];     // [chi1_min, chi1_max]
  double chi2_bounds[2];     // [chi2_min, chi2_max]
};
typedef struct tagSEOBNRROMdataDS_submodel SEOBNRROMdataDS_submodel;
 
struct tagSEOBNRROMdataDS
{
  UINT4 setup;
  SEOBNRROMdataDS_submodel* highf;
  SEOBNRROMdataDS_submodel* lowf;
};
typedef struct tagSEOBNRROMdataDS SEOBNRROMdataDS;
 
static SEOBNRROMdataDS __lalsim_SEOBNRv5HMROMDS_data[NMODES];
static SEOBNRROMdataDS __lalsim_SEOBNRv5ROMDS_data[1];
 
typedef int (*load_dataPtr)(const char*, gsl_vector *, gsl_vector *, gsl_matrix *, gsl_matrix *, gsl_vector *);
 
typedef struct tagSplineData
{
  gsl_bspline_workspace *bwx;
  gsl_bspline_workspace *bwy;
  gsl_bspline_workspace *bwz;
} SplineData;
 
typedef struct tagAmpPhaseSplineData
{
  gsl_spline *spline_amp;
  gsl_spline *spline_phi;
  gsl_interp_accel *acc_amp;
  gsl_interp_accel *acc_phi;
  gsl_vector *f;
} AmpPhaseSplineData;
 
/**************** Internal functions **********************/
 
UNUSED static bool SEOBNRv5HMROM_IsSetup(UINT4, SEOBNRROMdataDS *romdataset);
UNUSED static void SEOBNRv5HMROM_Init_LALDATA(void);
UNUSED static void SEOBNRv5ROM_Init_LALDATA(void);
UNUSED static int SEOBNRv5HMROM_Init(const char dir[],UINT4, bool, SEOBNRROMdataDS *romdataset);
UNUSED static int SEOBNRROMdataDS_Init(SEOBNRROMdataDS *romdata, const char dir[], UINT4, bool);
UNUSED static void SEOBNRROMdataDS_Cleanup(SEOBNRROMdataDS *romdata);
 
UNUSED static int SEOBNRROMdataDS_Init_submodel(
  UNUSED SEOBNRROMdataDS_submodel **submodel,
  UNUSED const char dir[],
  UNUSED const char grp_name[],
  UNUSED UINT4 index_mode,
  UNUSED bool use_hm
);
UNUSED static void SEOBNRROMdataDS_Cleanup_submodel(SEOBNRROMdataDS_submodel *submodel);
UNUSED static void SplineData_Destroy(SplineData *splinedata);
UNUSED static void SplineData_Init(
  SplineData **splinedata,
  int ncx,                // Number of points in q  + 2
  int ncy,                // Number of points in chi1 + 2
  int ncz,                // Number of points in chi2 + 2
  const double *qvec,     // B-spline knots in q
  const double *chi1vec,  // B-spline knots in chi1
  const double *chi2vec   // B-spline knots in chi2
);
UNUSED static void AmpPhaseSplineData_Init(
  AmpPhaseSplineData ***data,
  const int num_modes
);
UNUSED static void AmpPhaseSplineData_Destroy(AmpPhaseSplineData **data, const int num_modes);
 
UNUSED static int TaylorF2Amplitude(
  const double q,      // Mass-ration m1/m2 >= 1
  const double chi1,   // Dimensionless aligned spin of body 1
  const double chi2,   // Dimensionless aligned spin of body 2
  const int l,         // First mode number l
  const int m,         // Second mode number m
  gsl_vector *Mfs,     // Input geometric frequencies
  gsl_vector **PNamp   // Output: TaylorF2 amplitude at frequencies Mfs
);
 
UNUSED static int TaylorF2Phasing(
  double Mtot,         // Total mass in solar masses
  double q,            // Mass-ration m1/m2 >= 1
  double chi1,         // Dimensionless aligned spin of body 1
  double chi2,         // Dimensionless aligned spin of body 2
  int l,               // First mode number l
  int m,               // Second mode number m
  gsl_vector *Mfs,     // Input geometric frequencies
  gsl_vector **PNphase // Output: TaylorF2 phase at frequencies Mfs
);
 
UNUSED static double GetDeltaphilm(int l, int m);
UNUSED static double GetModeAmpFactor(double eta, double delta, double chi1, double chi2, int l, int m, double v);
 
/* Build geom frequency grid suitable for waveform amp/phase interpolation */
UNUSED static int BuildInspiralGeomFrequencyGrid(
  gsl_vector** Mfreq,   /* Output: pointer to real vector */
  const double Mfmin,    /* Starting geometric frequency */
  const double Mfmax,    /* Ending geometric frequency */
  const double q,        /* Mass   ratio */
  const double acc);     /* Desired phase interpolation error for inspiral */
 
/**
 * Core function for computing the ROM waveform.
 * Interpolate projection coefficient data and evaluate coefficients at desired (q, chi).
 * Construct 1D splines for amplitude and phase.
 * Compute strain waveform from amplitude and phase.
*/
UNUSED static int SEOBNRv5HMROMCoreModes(
  SphHarmFrequencySeries **hlm_list, /**< Spherical modes frequency series for the waveform */
  REAL8 phiRef, /**< Orbital phase at reference time */
  REAL8 fRef, /**< Reference frequency (Hz); 0 defaults to fLow */
  REAL8 distance, /**< Distance of source (m) */
  REAL8 Mtot_sec, /**< Total mass in seconds **/
  REAL8 q, /**< Mass ratio **/
  REAL8 chi1, /**< Dimensionless aligned component spin 1 */
  REAL8 chi2, /**< Dimensionless aligned component spin 2 */
  const REAL8Sequence *freqs, /**< Frequency points at which to evaluate the waveform (Hz) */
  REAL8 deltaF,
  /**< If deltaF > 0, the frequency points given in freqs are uniformly spaced with
   * spacing deltaF. Otherwise, the frequency points are spaced non-uniformly.
   * Then we will use deltaF = 0 to create the frequency series we return. */
  INT4 nk_max, /**< truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1 */
  UINT4 nModes, /**< Number of modes to generate */
  REAL8 sign_odd_modes, /**< Sign of the odd-m modes, used when swapping the two bodies */
  SEOBNRROMdataDS *romdataset /**< Dataset for the 22 or HM ROM */
);
UNUSED static void SEOBNRROMdataDS_coeff_Init(SEOBNRROMdataDS_coeff **romdatacoeff, int nk_cmode, int nk_phase);
UNUSED static void SEOBNRROMdataDS_coeff_Cleanup(SEOBNRROMdataDS_coeff *romdatacoeff);
 
static size_t NextPow2(const size_t n);
static UINT8 Setup_EOBROM__std_mode_array_structure(LALValue *ModeArray, UINT4 nModes);
static INT8 Check_EOBROM_mode_array_structure(LALValue *ModeArray,UINT4 nModes);
static int SEOBROMComputehplushcrossFromhlm(
    COMPLEX16FrequencySeries
        *hplusFS, /**<< Output: frequency series for hplus, already created */
    COMPLEX16FrequencySeries
        *hcrossFS,   /**<< Output: frequency series for hplus, already created */
    LALValue *ModeArray, /**<< Input: ModeArray structure with the modes to include */
    SphHarmFrequencySeries
        *hlm,  /**<< Input: list with frequency series for each mode hlm */
    REAL8 inc,  /**<< Input: inclination */
    REAL8 phi   /**<< Input: phase */
);
 
static int TP_Spline_interpolation_3d(
  REAL8 q,                // Input: eta-value for which projection coefficients should be evaluated
  REAL8 chi1,               // Input: chi1-value for which projection coefficients should be evaluated
  REAL8 chi2,               // Input: chi2-value for which projection coefficients should be evaluated
  gsl_vector *cvec,         // Input: data for spline coefficients
  int nk,                   // number of SVD-modes == number of basis functions
  int nk_max,               // truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1
  int ncx,                  // Number of points in eta  + 2
  int ncy,                  // Number of points in chi1 + 2
  int ncz,                  // Number of points in chi2 + 2
  const double *qvec,     // B-spline knots in eta
  const double *chi1vec,    // B-spline knots in chi1
  const double *chi2vec,    // B-spline knots in chi2
  gsl_vector *c_out        // Output: interpolated projection coefficients
);
UNUSED static UINT8 SEOBNRv5HMROM_Select_HF_patch(REAL8 q, REAL8 chi1);
UNUSED static UINT8 SEOBNRv5HMROM_phase_sparse_grid(gsl_vector* phase_f, REAL8 q, REAL8 chi1,REAL8 chi2, const char* freq_range, INT4 nk_max, SEOBNRROMdataDS *romdataset);
UNUSED static UINT8 SEOBNRv5HMROM_cmode_sparse_grid(gsl_vector* creal_f, gsl_vector* cimag_f, REAL8 q, REAL8 chi1,REAL8 chi2, const char* freq_range, UINT8 nMode,INT4 nk_max,SEOBNRROMdataDS *romdataset);
UNUSED static UINT8 SEOBNRv5HMROM_phase_sparse_grid_hybrid(gsl_vector* freq, gsl_vector* phase, gsl_vector* freq_lo, gsl_vector* freq_hi, REAL8 q, REAL8 chi1,REAL8 chi2,INT4 nk_max, SEOBNRROMdataDS *romdataset);
UNUSED static UINT8 SEOBNRv5HMROM_cmode_sparse_grid_hybrid(gsl_vector* freq, gsl_vector* cmode_real, gsl_vector* cmode_imag, gsl_vector* freq_lo, gsl_vector* freq_hi, REAL8 q, REAL8 chi1,REAL8 chi2, UINT8 nMode,INT8 nk_max,SEOBNRROMdataDS *romdataset);
UNUSED static UINT8 SEOBNRv5HMROM_freq_phase_sparse_grid_hybrid(UNUSED gsl_vector** freq, UNUSED gsl_vector** phase, REAL8 q, REAL8 chi1,REAL8 chi2,INT4 nk_max,SEOBNRROMdataDS *romdataset);
UNUSED static UINT8 SEOBNRv5HMROM_freq_cmode_sparse_grid_hybrid(gsl_vector** freq_cmode, gsl_vector** cmode_real, gsl_vector** cmode_imag, REAL8 q, REAL8 chi1,REAL8 chi2, UINT8 nMode,INT8 nk_max, SEOBNRROMdataDS *romdataset);
UNUSED static UINT8 SEOBNRv5HMROM_approx_phi_lm(gsl_vector* freq_mode_lm, gsl_vector* phase_approx_lm, gsl_vector* freq_carrier_hyb, gsl_vector* phase_carrier_hyb, UINT4 nMode);
 
UNUSED static UINT8 SEOBNRv5HMROM_phase_sparse_grid_hybrid_output_align(
  gsl_vector **freq,     // Output: hybrid frequency array
  gsl_vector **phase,    // Output: hybrid phase
  REAL8* Deltat_align,   // Output: time alignment
  REAL8* Deltaphi_align, // Output: phase alignment
  gsl_vector *phase_lo,  // low frequency phase
  gsl_vector *phase_hi,  // high frequency phase
  gsl_vector *freq_lo,   // frequency array for low frequency phase
  gsl_vector *freq_hi,   // frequency array for high frequency phase
  double f_hyb_lo,       // start frequency of hybridization window
  double f_hyb_hi        // end frequency of hybridization window
);
 
UNUSED static UINT8 SEOBNRv5HMROM_phase_sparse_grid_hybrid_input_align(
  gsl_vector **freq,     // Output: hybrid frequency array
  gsl_vector **phase,    // Output: hybrid phase
  gsl_vector *phase_lo,  // low frequency phase
  gsl_vector *phase_hi,  // high frequency phase
  gsl_vector *freq_lo,   // frequency array for low frequency phase
  gsl_vector *freq_hi,   // frequency array for high frequency phase
  double f_hyb_lo,       // start frequency of hybridization window
  double f_hyb_hi,       // end frequency of hybridization window
  REAL8 Deltat_22_align, // Input: 22 time alignment
  REAL8 Deltaphi_22_align, // Input: 22 phase alignment
  INT4 modeM               // Input: m mode number
);
 
UNUSED static UINT8 SEOBNRv5HMROM_amplitude_sparse_grid_hybrid_general(
  gsl_vector **freq,     // Output: hybrid frequency array
  gsl_vector **amp,      // Output: hybrid amplitude
  gsl_vector *amp_lo,    // low frequency amplitude
  gsl_vector *amp_hi,    // high frequency amplitude
  gsl_vector *freq_lo,   // frequency array for low frequency amplitude
  gsl_vector *freq_hi,   // frequency array for high frequency amplitude
  double f_hyb_lo,       // start frequency of hybridization window
  double f_hyb_hi        // end frequency of hybridization window
);
 
UNUSED static int hybridize_ROM_with_PN_amplitude(
  gsl_spline **hyb_spline,                            /**< Output: spline */
  AmpPhaseSplineData *ampPhaseSplineData_for_mode,    /**< ROM spline data */
  gsl_vector *PN_freq,                                /**< PN frequency */
  gsl_vector *PN_amp,                                 /**< PN amplitude */
  double f_hyb_win_lo,                                /**< hybridization window start */
  double f_hyb_win_hi                                 /**< hybridization window end */
);
 
UNUSED static int hybridize_ROM_with_PN_phase_output_align(
  gsl_spline **hyb_spline,                            /**< Output: spline */
  REAL8* Deltat_align,                                /**< Output: time alignment */
  REAL8* Deltaphi_align,                              /**< Output: phase alignment */
  AmpPhaseSplineData *ampPhaseSplineData_for_mode,    /**< ROM spline data */
  gsl_vector *PN_freq,                                /**< PN frequency */
  gsl_vector *PN_phase,                               /**< PN phase */
  double f_hyb_win_lo,                                /**< hybridization window start */
  double f_hyb_win_hi                                 /**< hybridization window end */
);
 
UNUSED static int hybridize_ROM_with_PN_phase_input_align(
  gsl_spline **hyb_spline,                            /**< Output: spline */
  AmpPhaseSplineData *ampPhaseSplineData_for_mode,    /**< ROM spline data */
  gsl_vector *PN_freq,                                /**< PN frequency */
  gsl_vector *PN_phase,                               /**< PN phase */
  double f_hyb_win_lo,                                /**< hybridization window start */
  double f_hyb_win_hi,                                /**< hybridization window end */
  REAL8 Deltat_22_align,                              /**< Input: 22 time alignment */
  REAL8 Deltaphi_22_align,                            /**< Input: 22 phase alignment */
  INT4 modeM                                          /**< Input: m mode number */
);
 
UNUSED static int SEOBNRv5HMROMCoreModeAmpPhaseSplines(
  UNUSED AmpPhaseSplineData **ampPhaseSplineData, /**<< Output: amplitude and phase splines for the modes */
  UNUSED REAL8 q, /**< Mass ratio **/
  UNUSED REAL8 chi1, /**< Dimensionless aligned component spin 1 */
  UNUSED REAL8 chi2, /**< Dimensionless aligned component spin 2 */
  UNUSED INT4 nk_max, /**< truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1 (default). */
  UNUSED UINT4 nModes, /**<  Number of modes to generate */
  UNUSED SEOBNRROMdataDS *romdataset  /**< Dataset for the 22 or HM ROM */
);
 
UNUSED static int SEOBNRv5HMROMCoreModesHybridized(
  UNUSED SphHarmFrequencySeries **hlm_list, /**<< Output: Spherical modes frequency series for the waveform */
  UNUSED REAL8 phiRef,                      /**<< orbital reference phase */
  UNUSED REAL8 fRef,                        /**< Reference frequency (Hz); 0 defaults to fLow */
  UNUSED REAL8 distance,                    /**< Distance of source (m) */
  UNUSED REAL8 Mtot_sec,                    /**< Total mass in seconds **/
  UNUSED REAL8 q,                           /**< Mass ratio **/
  UNUSED REAL8 chi1,                        /**< Dimensionless aligned component spin 1 */
  UNUSED REAL8 chi2,                        /**< Dimensionless aligned component spin 2 */
  UNUSED const REAL8Sequence *freqs_in,     /**< Frequency points at which to evaluate the waveform (Hz) */
  UNUSED REAL8 deltaF,                      /**< Frequency points at which to evaluate the waveform (Hz) */
  UNUSED INT4 nk_max,                       /**< truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1. We
  *nk_max == -1 is the default setting */
  UNUSED UINT4 nModes,                      /**<  Number of modes to generate */
  REAL8 sign_odd_modes,                     /**<  Sign of the odd-m modes, used when swapping the two bodies */
  UNUSED SEOBNRROMdataDS *romdataset        /**<  Dataset for the 22 or HM ROM */
);
 
UNUSED static int SEOBNRv5ROMTimeFrequencySetup(
  gsl_spline **spline_phi,                      // phase spline
  gsl_interp_accel **acc_phi,                   // phase spline accelerator
  REAL8 *Mf_final,                              // ringdown frequency in Mf
  REAL8 *Mtot_sec,                              // total mass in seconds
  REAL8 m1SI,                                   // Mass of companion 1 (kg)
  REAL8 m2SI,                                   // Mass of companion 2 (kg)
  REAL8 chi1,                                   // Aligned spin of companion 1
  REAL8 chi2,                                   // Aligned spin of companion 2
  REAL8 Mf_start,                               // Starting geometric frequency
  REAL8 *Mf_ROM_min,                            // Lowest geometric frequency for ROM
  REAL8 *Mf_ROM_max                             // Highest geometric frequency for ROM
);
 
UNUSED static int spline_to_gsl_vectors(gsl_spline *s, gsl_vector **x, gsl_vector **y);
 
/********************* Definitions begin here ********************/
 
 
UNUSED static int spline_to_gsl_vectors(gsl_spline *s, gsl_vector **x, gsl_vector **y) {
  if ((*x) || (*y))
    XLAL_ERROR(XLAL_EFAULT);
 
  *x = gsl_vector_alloc(s->size);
  *y = gsl_vector_alloc(s->size);
  for (size_t i=0; i < s->size; i++) {
    gsl_vector_set(*x, i, s->x[i]);
    gsl_vector_set(*y, i, s->y[i]);
  }
 
  return(XLAL_SUCCESS);
}
 
 
/** Setup SEOBNRv5HMROM model using data files installed in $LAL_DATA_PATH
 */
UNUSED static void SEOBNRv5HMROM_Init_LALDATA(void)
{
  // Loop over all the available modes and check if they have already been initialized
  for(int i = 0; i < NMODES; i++) {
    if (SEOBNRv5HMROM_IsSetup(i,__lalsim_SEOBNRv5HMROMDS_data)) return;
  }
 
  // Expect ROM datafile in a directory listed in LAL_DATA_PATH,
#ifdef LAL_HDF5_ENABLED
#define datafile ROMDataHDF5
  char *path = XLAL_FILE_RESOLVE_PATH(datafile);
  if (path==NULL){
    XLAL_ERROR_VOID(XLAL_EIO, "Unable to resolve data file %s in $LAL_DATA_PATH\n", datafile);
  }
  char *dir = dirname(path);
 
  UINT4 ret = XLAL_SUCCESS;
  bool use_hm = true;
  for(int i = 0; i < NMODES; i++) {
    ret = SEOBNRv5HMROM_Init(dir, i, use_hm, __lalsim_SEOBNRv5HMROMDS_data);
    if(ret != XLAL_SUCCESS)
      XLAL_ERROR_VOID(XLAL_FAILURE, "Unable to find SEOBNRv5HMROM data \
      files in $LAL_DATA_PATH for the mode = %d\n", i);
  }
  XLALFree(path);
#else
  XLAL_ERROR_VOID(XLAL_EFAILED, "SEOBNRv5HMROM requires HDF5 support which is not enabled\n");
#endif
}
 
/** Setup SEOBNRv5ROM model using data files installed in $LAL_DATA_PATH
 */
UNUSED static void SEOBNRv5ROM_Init_LALDATA(void)
{
  // Loop over all the available modes and check if they have already been initialized
  for(int i = 0; i < 1; i++) {
    if (SEOBNRv5HMROM_IsSetup(i,__lalsim_SEOBNRv5ROMDS_data)) return;
  }
 
  // Expect ROM datafile in a directory listed in LAL_DATA_PATH,
#ifdef LAL_HDF5_ENABLED
#define datafile22 ROM22DataHDF5
  char *path = XLAL_FILE_RESOLVE_PATH(datafile22);
  if (path==NULL){
    XLAL_ERROR_VOID(XLAL_EIO, "Unable to resolve data file %s in $LAL_DATA_PATH\n", datafile22);
  }
  char *dir = dirname(path);
 
  UINT4 ret = XLAL_SUCCESS;
  bool use_hm = false;
  for(int i = 0; i < 1; i++) {
    ret = SEOBNRv5HMROM_Init(dir, i, use_hm, __lalsim_SEOBNRv5ROMDS_data);
    if(ret != XLAL_SUCCESS)
      XLAL_ERROR_VOID(XLAL_FAILURE, "Unable to find SEOBNRv5ROM data \
      files in $LAL_DATA_PATH for the mode = %d\n", i);
  }
  XLALFree(path);
#else
  XLAL_ERROR_VOID(XLAL_EFAILED, "SEOBNRv5ROM requires HDF5 support which is not enabled\n");
#endif
}
 
/** Helper function to check if the SEOBNRv5HMROM model has been initialised */
static bool SEOBNRv5HMROM_IsSetup(UINT4 index_mode,  SEOBNRROMdataDS *romdataset) {
  if(romdataset[index_mode].setup){
    return true;
  }
  else{
    return false;
  }
}
 
// Setup B-spline basis functions for given points
static void SplineData_Init(
  SplineData **splinedata,
  int ncx,                // Number of points in q  + 2
  int ncy,                // Number of points in chi1 + 2
  int ncz,                // Number of points in chi2 + 2
  const double *qvec,   // B-spline knots in q
  const double *chi1vec,  // B-spline knots in chi1
  const double *chi2vec   // B-spline knots in chi2
)
{
  if(!splinedata) exit(1);
  if(*splinedata) SplineData_Destroy(*splinedata);
 
  (*splinedata)=XLALCalloc(1,sizeof(SplineData));
 
  // Set up B-spline basis for desired knots
  const size_t nbreak_x = ncx-2;  // must have nbreak = n-2 for cubic splines
  const size_t nbreak_y = ncy-2;  // must have nbreak = n-2 for cubic splines
  const size_t nbreak_z = ncz-2;  // must have nbreak = n-2 for cubic splines
 
  // Allocate a cubic bspline workspace (k = 4)
  gsl_bspline_workspace *bwx = gsl_bspline_alloc(4, nbreak_x);
  gsl_bspline_workspace *bwy = gsl_bspline_alloc(4, nbreak_y);
  gsl_bspline_workspace *bwz = gsl_bspline_alloc(4, nbreak_z);
 
  // Set breakpoints (and thus knots by hand)
  gsl_vector *breakpts_x = gsl_vector_alloc(nbreak_x);
  gsl_vector *breakpts_y = gsl_vector_alloc(nbreak_y);
  gsl_vector *breakpts_z = gsl_vector_alloc(nbreak_z);
  for (UINT4 i=0; i<nbreak_x; i++)
    gsl_vector_set(breakpts_x, i, qvec[i]);
  for (UINT4 j=0; j<nbreak_y; j++)
    gsl_vector_set(breakpts_y, j, chi1vec[j]);
  for (UINT4 k=0; k<nbreak_z; k++)
    gsl_vector_set(breakpts_z, k, chi2vec[k]);
 
  gsl_bspline_knots(breakpts_x, bwx);
  gsl_bspline_knots(breakpts_y, bwy);
  gsl_bspline_knots(breakpts_z, bwz);
 
  gsl_vector_free(breakpts_x);
  gsl_vector_free(breakpts_y);
  gsl_vector_free(breakpts_z);
 
  (*splinedata)->bwx=bwx;
  (*splinedata)->bwy=bwy;
  (*splinedata)->bwz=bwz;
}
 
/* Destroy B-spline basis functions for given points */
static void SplineData_Destroy(SplineData *splinedata)
{
  if(!splinedata) return;
  if(splinedata->bwx) gsl_bspline_free(splinedata->bwx);
  if(splinedata->bwy) gsl_bspline_free(splinedata->bwy);
  if(splinedata->bwz) gsl_bspline_free(splinedata->bwz);
  XLALFree(splinedata);
}
 
// Allocate memory for an array of AmpPhaseSplineData structs to store all modes
static void AmpPhaseSplineData_Init(
  AmpPhaseSplineData ***data_array,
  const int num_modes
)
{
  if(*data_array != NULL) AmpPhaseSplineData_Destroy(*data_array, num_modes);
 
  *data_array = XLALCalloc(num_modes, sizeof(AmpPhaseSplineData));
 
  for (int i=0; i<num_modes; i++) {
    // The elements of the AmpPhaseSplineData structs will be allocated elsewhere.
    (*data_array)[i] = XLALCalloc(1, sizeof(AmpPhaseSplineData));
  }
}
 
static void AmpPhaseSplineData_Destroy(AmpPhaseSplineData **data_array, const int num_modes)
{
  if(!data_array) return;
 
  AmpPhaseSplineData* data = NULL;
  for (int i=0; i<num_modes; i++) {
     data = data_array[i];
    if (!data)
      continue;
    else {
      if (data->spline_amp) gsl_spline_free(data->spline_amp);
      if (data->spline_phi) gsl_spline_free(data->spline_phi);
      if (data->acc_amp) gsl_interp_accel_free(data->acc_amp);
      if (data->acc_phi) gsl_interp_accel_free(data->acc_phi);
      if (data->f) gsl_vector_free(data->f);
      XLALFree(data);
    }
  }
  XLALFree(data_array);
}
 
 
// Interpolate projection coefficients for either Re(c-mode), Im(c-mode) or orbital phase over the parameter space (q, chi).
// The multi-dimensional interpolation is carried out via a tensor product decomposition.
static int TP_Spline_interpolation_3d(
  REAL8 q,                  // Input: eta-value for which projection coefficients should be evaluated
  REAL8 chi1,               // Input: chi1-value for which projection coefficients should be evaluated
  REAL8 chi2,               // Input: chi2-value for which projection coefficients should be evaluated
  gsl_vector *cvec,         // Input: data for spline coefficients
  int nk,                   // number of SVD-modes == number of basis functions
  int nk_max,               // truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1
  int ncx,                  // Number of points in eta  + 2
  int ncy,                  // Number of points in chi1 + 2
  int ncz,                  // Number of points in chi2 + 2
  const double *qvec,       // B-spline knots in eta
  const double *chi1vec,    // B-spline knots in chi1
  const double *chi2vec,    // B-spline knots in chi2
  gsl_vector *c_out        // Output: interpolated projection coefficients
  ) {
  if (nk_max != -1) {
    if (nk_max > nk)
      XLAL_ERROR(XLAL_EDOM, "Truncation parameter nk_max %d must be smaller or equal to nk %d\n", nk_max, nk);
    else { // truncate SVD modes
      nk = nk_max;
    }
  }
 
  SplineData *splinedata=NULL;
  SplineData_Init(&splinedata, ncx, ncy, ncz, qvec, chi1vec, chi2vec);
 
  gsl_bspline_workspace *bwx=splinedata->bwx;
  gsl_bspline_workspace *bwy=splinedata->bwy;
  gsl_bspline_workspace *bwz=splinedata->bwz;
 
  int N = ncx*ncy*ncz;  // Size of the data matrix for one SVD-mode
  // Evaluate the TP spline for all SVD modes - amplitude
  for (int k=0; k<nk; k++) { // For each SVD mode
    gsl_vector v = gsl_vector_subvector(cvec, k*N, N).vector; // Pick out the coefficient matrix corresponding to the k-th SVD mode.
    REAL8 csum = Interpolate_Coefficent_Tensor(&v, q, chi1, chi2, ncy, ncz, bwx, bwy, bwz);
    gsl_vector_set(c_out, k, csum);
  }
  SplineData_Destroy(splinedata);
 
  return(0);
}
 
/** Setup SEOBNRv5HMROM mode using data files installed in dir
 */
static int SEOBNRv5HMROM_Init(const char dir[],UINT4 index_mode, bool use_hm, SEOBNRROMdataDS *romdataset) {
  if(romdataset[index_mode].setup) {
    XLALPrintError("Error: SEOBNRv5HMROM data was already set up!");
    XLAL_ERROR(XLAL_EFAILED);
  }
  SEOBNRROMdataDS_Init(&romdataset[index_mode], dir, index_mode, use_hm);
 
  if(romdataset[index_mode].setup) {
    return(XLAL_SUCCESS);
  }
  else {
    return(XLAL_EFAILED);
  }
  return(XLAL_SUCCESS);
}
 
/* Set up a new ROM mode, using data contained in dir */
int SEOBNRROMdataDS_Init(
  UNUSED SEOBNRROMdataDS *romdata,
  UNUSED const char dir[],
  UNUSED UINT4 index_mode,
  UNUSED bool use_hm
  )
{
  int ret = XLAL_FAILURE;
 
  /* Create storage for structures */
  if(romdata->setup) {
    XLALPrintError("WARNING: You tried to setup the SEOBNRv5HMROM model that was already initialised. Ignoring\n");
    return (XLAL_FAILURE);
  }
 
#ifdef LAL_HDF5_ENABLED
  // First, check we got the correct version number
  size_t size;
  if (use_hm == true){
    size = strlen(dir) + strlen(ROMDataHDF5) + 2;
  }
  else{
    size = strlen(dir) + strlen(ROM22DataHDF5) + 2;
  }
  char *path = XLALMalloc(size);
  if (use_hm == true){
    snprintf(path, size, "%s/%s", dir, ROMDataHDF5);
  }
  else{
    snprintf(path, size, "%s/%s", dir, ROM22DataHDF5);
  }
  LALH5File *file = XLALH5FileOpen(path, "r");
 
  XLALPrintInfo("ROM metadata\n============\n");
  if (use_hm == true){
    PrintInfoStringAttribute(file, "Email");
    PrintInfoStringAttribute(file, "Description");
    ret = ROM_check_version_number(file, ROMDataHDF5_VERSION_MAJOR,
                                  ROMDataHDF5_VERSION_MINOR,
                                  ROMDataHDF5_VERSION_MICRO);
    ret = ROM_check_canonical_file_basename(file,ROMDataHDF5,"CANONICAL_FILE_BASENAME");
  }
  else{
    PrintInfoStringAttribute(file, "Email");
    PrintInfoStringAttribute(file, "Description");
    ret = ROM_check_version_number(file, ROM22DataHDF5_VERSION_MAJOR,
                                  ROM22DataHDF5_VERSION_MINOR,
                                  ROM22DataHDF5_VERSION_MICRO);
    ret = ROM_check_canonical_file_basename(file,ROM22DataHDF5,"CANONICAL_FILE_BASENAME");
  }
 
  ret |= SEOBNRROMdataDS_Init_submodel(&(romdata)->highf, dir, "highf",index_mode,use_hm);
  if (ret==XLAL_SUCCESS) XLALPrintInfo("%s : submodel high freqs loaded sucessfully.\n", __func__);
 
  ret |= SEOBNRROMdataDS_Init_submodel(&(romdata)->lowf, dir, "lowf",index_mode,use_hm);
  if (ret==XLAL_SUCCESS) XLALPrintInfo("%s : submodel low freqs loaded sucessfully.\n", __func__);
 
 
  if(XLAL_SUCCESS==ret){
    romdata->setup=1;
  }
   else
     SEOBNRROMdataDS_Cleanup(romdata);
 
  XLALFree(path);
  XLALH5FileClose(file);
  ret = XLAL_SUCCESS;
 
#else
  XLAL_ERROR(XLAL_EFAILED, "HDF5 support not enabled");
#endif
 
  return (ret);
}
 
/* Deallocate contents of the given SEOBNRROMdataDS structure */
static void SEOBNRROMdataDS_Cleanup(SEOBNRROMdataDS *romdata) {
  SEOBNRROMdataDS_Cleanup_submodel((romdata)->highf);
  XLALFree((romdata)->highf);
  (romdata)->highf = NULL;
  SEOBNRROMdataDS_Cleanup_submodel((romdata)->lowf);
  XLALFree((romdata)->lowf);
  (romdata)->lowf = NULL;
  romdata->setup=0;
}
 
/* Deallocate contents of the given SEOBNRROMdataDS_submodel structure */
static void SEOBNRROMdataDS_Cleanup_submodel(SEOBNRROMdataDS_submodel *submodel) {
  if(submodel->cvec_real) gsl_vector_free(submodel->cvec_real);
  if(submodel->cvec_imag) gsl_vector_free(submodel->cvec_imag);
  if(submodel->cvec_phase) gsl_vector_free(submodel->cvec_phase);
  if(submodel->Breal) gsl_matrix_free(submodel->Breal);
  if(submodel->Bimag) gsl_matrix_free(submodel->Bimag);
  if(submodel->Bphase) gsl_matrix_free(submodel->Bphase);
  if(submodel->gCMode)   gsl_vector_free(submodel->gCMode);
  if(submodel->gPhase) gsl_vector_free(submodel->gPhase);
  if(submodel->qvec)  gsl_vector_free(submodel->qvec);
  if(submodel->chi1vec) gsl_vector_free(submodel->chi1vec);
  if(submodel->chi2vec) gsl_vector_free(submodel->chi2vec);
}
 
/* Set up a new ROM submodel, using data contained in dir */
UNUSED static int SEOBNRROMdataDS_Init_submodel(
  SEOBNRROMdataDS_submodel **submodel,
  UNUSED const char dir[],
  UNUSED const char grp_name[],
  UNUSED UINT4 index_mode,
  UNUSED bool use_hm
) {
  int ret = XLAL_FAILURE;
  if(!submodel) exit(1);
  /* Create storage for submodel structures */
  if (!*submodel)
    *submodel = XLALCalloc(1,sizeof(SEOBNRROMdataDS_submodel));
  else
    SEOBNRROMdataDS_Cleanup_submodel(*submodel);
 
#ifdef LAL_HDF5_ENABLED
  size_t size;
  if (use_hm == true){
    size = strlen(dir) + strlen(ROMDataHDF5) + 2;
  }
  else{
    size = strlen(dir) + strlen(ROM22DataHDF5) + 2;
  }
  char *path = XLALMalloc(size);
  if (use_hm == true){
    snprintf(path, size, "%s/%s", dir, ROMDataHDF5);
  }
  else{
    snprintf(path, size, "%s/%s", dir, ROM22DataHDF5);
  }
 
  LALH5File *file = XLALH5FileOpen(path, "r");
  LALH5File *sub = XLALH5GroupOpen(file, grp_name);
 
  // Read ROM coefficients
 
  //// c-modes coefficients
  char* path_to_dataset = concatenate_strings(3,"CF_modes/",mode_array_v5hm[index_mode],"/coeff_re_flattened");
  ReadHDF5RealVectorDataset(sub, path_to_dataset, & (*submodel)->cvec_real);
  free(path_to_dataset);
  path_to_dataset = concatenate_strings(3,"CF_modes/",mode_array_v5hm[index_mode],"/coeff_im_flattened");
  ReadHDF5RealVectorDataset(sub, path_to_dataset, & (*submodel)->cvec_imag);
  free(path_to_dataset);
  //// orbital phase coefficients
  //// They are used only in the 22 mode
  if(index_mode == 0){
    ReadHDF5RealVectorDataset(sub, "phase_carrier/coeff_flattened", & (*submodel)->cvec_phase);
  }
 
 
  // Read ROM basis functions
 
  //// c-modes basis
  path_to_dataset = concatenate_strings(3,"CF_modes/",mode_array_v5hm[index_mode],"/basis_re");
  ReadHDF5RealMatrixDataset(sub, path_to_dataset, & (*submodel)->Breal);
  free(path_to_dataset);
  path_to_dataset = concatenate_strings(3,"CF_modes/",mode_array_v5hm[index_mode],"/basis_im");
  ReadHDF5RealMatrixDataset(sub, path_to_dataset, & (*submodel)->Bimag);
  free(path_to_dataset);
  //// orbital phase basis
  //// Used only in the 22 mode
  if(index_mode == 0){
    ReadHDF5RealMatrixDataset(sub, "phase_carrier/basis", & (*submodel)->Bphase);
  }
  // Read sparse frequency points
 
  //// c-modes grid
  path_to_dataset = concatenate_strings(3,"CF_modes/",mode_array_v5hm[index_mode],"/MF_grid");
  ReadHDF5RealVectorDataset(sub, path_to_dataset, & (*submodel)->gCMode);
  free(path_to_dataset);
  //// orbital phase grid
  //// Used only in the 22 mode
  if(index_mode == 0){
    ReadHDF5RealVectorDataset(sub, "phase_carrier/MF_grid", & (*submodel)->gPhase);
  }
  // Read parameter space nodes
  ReadHDF5RealVectorDataset(sub, "qvec", & (*submodel)->qvec);
  ReadHDF5RealVectorDataset(sub, "chi1vec", & (*submodel)->chi1vec);
  ReadHDF5RealVectorDataset(sub, "chi2vec", & (*submodel)->chi2vec);
 
 
  // Initialize other members
  (*submodel)->nk_cmode = (*submodel)->gCMode->size;
  //// Used only in the 22 mode
  if(index_mode == 0){
    (*submodel)->nk_phase = (*submodel)->gPhase->size;
  }
  (*submodel)->ncx = (*submodel)->qvec->size + 2;
  (*submodel)->ncy = (*submodel)->chi1vec->size + 2;
  (*submodel)->ncz = (*submodel)->chi2vec->size + 2;
 
  // Domain of definition of submodel
  (*submodel)->q_bounds[0] = gsl_vector_get((*submodel)->qvec, 0);
  (*submodel)->q_bounds[1] = gsl_vector_get((*submodel)->qvec, (*submodel)->qvec->size - 1);
  (*submodel)->chi1_bounds[0] = gsl_vector_get((*submodel)->chi1vec, 0);
  (*submodel)->chi1_bounds[1] = gsl_vector_get((*submodel)->chi1vec, (*submodel)->chi1vec->size - 1);
  (*submodel)->chi2_bounds[0] = gsl_vector_get((*submodel)->chi2vec, 0);
  (*submodel)->chi2_bounds[1] = gsl_vector_get((*submodel)->chi2vec, (*submodel)->chi2vec->size - 1);
 
  XLALFree(path);
  XLALH5FileClose(file);
  XLALH5FileClose(sub);
  ret = XLAL_SUCCESS;
#else
  XLAL_ERROR(XLAL_EFAILED, "HDF5 support not enabled");
#endif
 
  return ret;
}
 
/* Create structure for internal use to store coefficients for orbital phase and real/imaginary part of co-orbital modes */
static void SEOBNRROMdataDS_coeff_Init(SEOBNRROMdataDS_coeff **romdatacoeff, int nk_cmode, int nk_phase) {
  if(!romdatacoeff) exit(1);
  /* Create storage for structures */
  if(!*romdatacoeff)
    *romdatacoeff=XLALCalloc(1,sizeof(SEOBNRROMdataDS_coeff));
  else
    SEOBNRROMdataDS_coeff_Cleanup(*romdatacoeff);
 
  (*romdatacoeff)->c_real = gsl_vector_alloc(nk_cmode);
  (*romdatacoeff)->c_imag = gsl_vector_alloc(nk_cmode);
  (*romdatacoeff)->c_phase = gsl_vector_alloc(nk_phase);
}
 
/* Deallocate contents of the given SEOBNRROMdataDS_coeff structure */
static void SEOBNRROMdataDS_coeff_Cleanup(SEOBNRROMdataDS_coeff *romdatacoeff) {
  if(romdatacoeff->c_real) gsl_vector_free(romdatacoeff->c_real);
  if(romdatacoeff->c_imag) gsl_vector_free(romdatacoeff->c_imag);
  if(romdatacoeff->c_phase) gsl_vector_free(romdatacoeff->c_phase);
  XLALFree(romdatacoeff);
}
/* Return the closest higher power of 2  */
// Note: NextPow(2^k) = 2^k for integer values k.
static size_t NextPow2(const size_t n) {
  return 1 << (size_t) ceil(log2(n));
}
/* This function returns the orbital phase in the sparse grid hybridized between LF and HF ROM */
UNUSED static UINT8 SEOBNRv5HMROM_phase_sparse_grid_hybrid(gsl_vector* freq, gsl_vector* phase, gsl_vector* freq_lo, gsl_vector* freq_hi, REAL8 q, REAL8 chi1,REAL8 chi2,INT4 nk_max, SEOBNRROMdataDS *romdataset){
 
  gsl_vector *phase_f_lo = gsl_vector_alloc(freq_lo->size);
  gsl_vector *phase_f_hi = gsl_vector_alloc(freq_hi->size);
 
  /* Get LF and HF orbital phase */
  UNUSED UINT8 retcode = SEOBNRv5HMROM_phase_sparse_grid(phase_f_lo,q,chi1,chi2, "LF",nk_max, romdataset);
  retcode = SEOBNRv5HMROM_phase_sparse_grid(phase_f_hi,q,chi1,chi2, "HF",nk_max, romdataset);
 
  /* Align LF and HF orbital phase */
  /* We will discard the constant and slope of the linear fit */
  REAL8 constant = 0.;
  REAL8 slope = 0.;
  retcode = align_wfs_window(freq_lo, freq_hi, phase_f_lo, phase_f_hi, &constant, &slope, f_hyb_ini, f_hyb_end);
 
  /* Blend LF and HF orbital phase together */
  retcode = blend_functions(freq,phase,freq_lo,phase_f_lo,freq_hi,phase_f_hi,f_hyb_ini, f_hyb_end);
 
  /* Cleanup */
  gsl_vector_free(phase_f_lo);
  gsl_vector_free(phase_f_hi);
 
  return XLAL_SUCCESS;
 
}
 
/* This function returns the frequency and orbital phase in a sparse grid. The frequency and orbital phase are hybridized between LF and HF ROM. */
UNUSED static UINT8 SEOBNRv5HMROM_freq_phase_sparse_grid_hybrid(UNUSED gsl_vector** freq, UNUSED gsl_vector** phase, REAL8 q, REAL8 chi1,REAL8 chi2, INT4 nk_max, SEOBNRROMdataDS *romdataset){
 
  /* We point to the data for computing the orbital phase. */
  /* These data are stored in the structures for all modes */
  /* We use the 22 mode (index 0) structure because the 22 mode will always be present */
  SEOBNRROMdataDS *romdata=&romdataset[0];
  if (!SEOBNRv5HMROM_IsSetup(0, romdataset)) {
    XLAL_ERROR(XLAL_EFAILED,
               "Error setting up SEOBNRv5ROM data - check your $LAL_DATA_PATH\n");
  }
 
  UNUSED UINT4 retcode=0;
 
  //We always need to glue two submodels together for this ROM
  SEOBNRROMdataDS_submodel *submodel_hi; // high frequency ROM
  SEOBNRROMdataDS_submodel *submodel_lo; // low frequency ROM
 
  /* Select ROM patches */
  //There is only one LF patch
  submodel_lo = romdata->lowf;
  //There is only one HF patch
  submodel_hi = romdata->highf;
 
  /* Compute hybridized orbital phase */
 
  INT8 i_max_LF = 0;
  INT8 i_min_HF = 0;
 
  // Get sparse frequency array for the LF orbital phase
  gsl_vector* freq_lo = gsl_vector_alloc(submodel_lo->nk_phase);
  for(unsigned int i = 0; i < freq_lo->size; i++){
    freq_lo->data[i] = submodel_lo->gPhase->data[i];
  }
  gsl_vector* freq_hi = gsl_vector_alloc(submodel_hi->nk_phase);
 
  //Compute prefactor for rescaling the frequency.
  //The HF ROM is build using freq/RD_freq, we need to compute RD_freq and undo the scaling
 
  REAL8 omegaQNM = Get_omegaQNM_SEOBNRv5(q,chi1,chi2,2,2);
  REAL8 inv_scaling = 1. / (2*LAL_PI/omegaQNM);
  for(unsigned int i = 0; i < freq_hi->size; i++){
    freq_hi->data[i] = inv_scaling*submodel_hi->gPhase->data[i];
  }
 
  //Initialize arrays for hybridized phase
  // Compute length of hybridized frequency array
  retcode = compute_i_max_LF_i_min_HF(&i_max_LF, &i_min_HF,freq_lo,freq_hi,f_hyb_ini);
  *freq = gsl_vector_alloc(i_max_LF + freq_hi->size - i_min_HF + 1);
 
  //It's important to initialize this function to 0
  *phase = gsl_vector_calloc((*freq)->size);
 
  // Fill the hybridized frequency array
  for(unsigned int i = 0; i <= i_max_LF;i++){
      (*freq)->data[i] = freq_lo->data[i];
  };
  for(unsigned int i = i_min_HF; i < freq_hi->size;i++){
      (*freq)->data[i_max_LF+i-i_min_HF+1] = freq_hi->data[i];
  };
 
  /* Get the hybridized orbital phase */
 
  retcode = SEOBNRv5HMROM_phase_sparse_grid_hybrid(*freq,*phase,freq_lo, freq_hi,q,chi1,chi2,nk_max,romdataset);
 
  /* Cleanup */
  gsl_vector_free(freq_lo);
  gsl_vector_free(freq_hi);
 
 
  return XLAL_SUCCESS;
 
}
 
// Convention for alignment quantities:
// phase_hi ~= phase_lo + Deltaphi_align + 2pi*f*Deltat_align
UNUSED static UINT8 SEOBNRv5HMROM_phase_sparse_grid_hybrid_output_align(
  gsl_vector **freq,     // Output: hybrid frequency array
  gsl_vector **phase,    // Output: hybrid phase
  REAL8* Deltat_align,   // Output: time alignment
  REAL8* Deltaphi_align, // Output: phase alignment
  gsl_vector *phase_lo,  // low frequency phase
  gsl_vector *phase_hi,  // high frequency phase
  gsl_vector *freq_lo,   // frequency array for low frequency phase
  gsl_vector *freq_hi,   // frequency array for high frequency phase
  double f_hyb_lo,       // start frequency of hybridization window
  double f_hyb_hi        // end frequency of hybridization window
){
  INT8 i_max_LF = 0;
  INT8 i_min_HF = 0;
 
  // Initialize arrays for hybridized phase
 
  // Find indices of f_hyb_lo in freq_lo and freq_hi s. t.
  // freq_lo[i_max_LF] < f_hyb_lo
  // freq_hi[i_min_HF] >= f_hyb_lo
  UINT4 retcode = compute_i_max_LF_i_min_HF(&i_max_LF, &i_min_HF, freq_lo, freq_hi, f_hyb_lo);
  if (retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  // Compute length of hybridized frequency array
  *freq = gsl_vector_alloc(i_max_LF + freq_hi->size - i_min_HF + 1);
 
  // Fill the hybridized frequency array
  for(unsigned int i=0; i <= i_max_LF; i++)
      (*freq)->data[i] = freq_lo->data[i];
  for(unsigned int i=i_min_HF; i < freq_hi->size; i++)
      (*freq)->data[i_max_LF+i-i_min_HF+1] = freq_hi->data[i];
 
  // Initialize phase array with zeros
  *phase = gsl_vector_calloc((*freq)->size);
 
  // Align low and high frequency phase over window [f_hyb_lo, f_hyb_hi]
  // Save phase and time shift from the linear fit of phase_hi - phase_lo
  REAL8 Deltat = 0.;
  REAL8 Deltaphi = 0.;
  retcode = align_wfs_window(freq_lo, freq_hi, phase_lo, phase_hi, &Deltat, &Deltaphi, f_hyb_lo, f_hyb_hi);
  if (retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  // Blend low and high frequency phase together
  retcode = blend_functions(*freq, *phase, freq_lo, phase_lo, freq_hi, phase_hi, f_hyb_lo, f_hyb_hi);
  if (retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  // We output the constant phase shift and time shift for phase_hi - phase_lo
  // Convention for alignment quantities:
  // phase_hi ~= phase_lo + Deltaphi_align + 2pi*f*Deltat_align
  *Deltat_align = Deltat;
  *Deltaphi_align = Deltaphi;
 
  return XLAL_SUCCESS;
}
 
// This is a general purpose function that hybridizes two phase arrays over frequency.
UNUSED static UINT8 SEOBNRv5HMROM_phase_sparse_grid_hybrid_input_align(
  gsl_vector **freq,     // Output: hybrid frequency array
  gsl_vector **phase,    // Output: hybrid phase
  gsl_vector *phase_lo,  // low frequency phase
  gsl_vector *phase_hi,  // high frequency phase
  gsl_vector *freq_lo,   // frequency array for low frequency phase
  gsl_vector *freq_hi,   // frequency array for high frequency phase
  double f_hyb_lo,       // start frequency of hybridization window
  double f_hyb_hi,       // end frequency of hybridization window
  REAL8 Deltat_22_align, // Input: 22 time alignment
  REAL8 Deltaphi_22_align, // Input: 22 phase alignment
  INT4 modeM               // Input: m mode number
){
  INT8 i_max_LF = 0;
  INT8 i_min_HF = 0;
 
  // Initialize arrays for hybridized phase
 
  // Find indices of f_hyb_lo in freq_lo and freq_hi s. t.
  // freq_lo[i_max_LF] < f_hyb_lo
  // freq_hi[i_min_HF] >= f_hyb_lo
  UINT4 retcode = compute_i_max_LF_i_min_HF(&i_max_LF, &i_min_HF, freq_lo, freq_hi, f_hyb_lo);
  if (retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  // Compute length of hybridized frequency array
  *freq = gsl_vector_alloc(i_max_LF + freq_hi->size - i_min_HF + 1);
 
  // Fill the hybridized frequency array
  for(unsigned int i=0; i <= i_max_LF; i++)
      (*freq)->data[i] = freq_lo->data[i];
  for(unsigned int i=i_min_HF; i < freq_hi->size; i++)
      (*freq)->data[i_max_LF+i-i_min_HF+1] = freq_hi->data[i];
 
  // Initialize phase array with zeros
  *phase = gsl_vector_calloc((*freq)->size);
 
  // Align low and high frequency phase over window [f_hyb_lo, f_hyb_hi]
  retcode = align_wfs_window_from_22(freq_lo, freq_hi, phase_lo, phase_hi, f_hyb_lo, f_hyb_hi, Deltat_22_align, Deltaphi_22_align, modeM);
  if (retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  // Blend low and high frequency phase together
  retcode = blend_functions(*freq, *phase, freq_lo, phase_lo, freq_hi, phase_hi, f_hyb_lo, f_hyb_hi);
  if (retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  return XLAL_SUCCESS;
}
 
// This is a general purpose function that hybridizes two amplitude arrays over frequency.
UNUSED static UINT8 SEOBNRv5HMROM_amplitude_sparse_grid_hybrid_general(
  gsl_vector **freq,     // Output: hybrid frequency array
  gsl_vector **amp,      // Output: hybrid amplitude
  gsl_vector *amp_lo,    // low frequency amplitude
  gsl_vector *amp_hi,    // high frequency amplitude
  gsl_vector *freq_lo,   // frequency array for low frequency amplitude
  gsl_vector *freq_hi,   // frequency array for high frequency amplitude
  double f_hyb_lo,       // start frequency of hybridization window
  double f_hyb_hi        // end frequency of hybridization window
){
  INT8 i_max_LF = 0;
  INT8 i_min_HF = 0;
 
  // Initialize arrays for hybridized phase
  // Find indices of f_hyb_lo in freq_lo and freq_hi s. t.
  // freq_lo[i_max_LF] < f_hyb_lo
  // freq_hi[i_min_HF] >= f_hyb_lo
  UINT4 retcode = compute_i_max_LF_i_min_HF(&i_max_LF, &i_min_HF, freq_lo, freq_hi, f_hyb_lo);
  if (retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  // Compute length of hybridized frequency array
  *freq = gsl_vector_alloc(i_max_LF + freq_hi->size - i_min_HF + 1);
 
  // Fill the hybridized frequency array
  for(unsigned int i=0; i <= i_max_LF; i++)
      (*freq)->data[i] = freq_lo->data[i];
  for(unsigned int i=i_min_HF; i < freq_hi->size; i++)
      (*freq)->data[i_max_LF+i-i_min_HF+1] = freq_hi->data[i];
 
  // Initialize phase array with zeros
  *amp = gsl_vector_calloc((*freq)->size);
 
  // Blend low and high frequency phase together
  retcode = blend_functions(*freq, *amp, freq_lo, amp_lo, freq_hi, amp_hi, f_hyb_lo, f_hyb_hi);
  if (retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  return XLAL_SUCCESS;
}
 
 
/* This function returns the frequency and approximate phase of nMode in a sparse grid hybridized between LF and HF ROM. */
/* Here we linearly extend the phase outside the regime where we have data */
/* The derivation of this approximate phase is in https://git.ligo.org/waveforms/reviews/SEOBNRv5HM_ROM/blob/master/documents/notes.pdf */
/* In this document this phase is the argument of the exponential in Eq.(22) */
UNUSED static UINT8 SEOBNRv5HMROM_approx_phi_lm(gsl_vector* freq_mode_lm, gsl_vector* phase_approx_lm, gsl_vector* freq_carrier_hyb, gsl_vector* phase_carrier_hyb, UINT4 nMode){
 
  UINT8 modeM = lmModes_v5hm[nMode][1];
 
  REAL8 f_max_carrier = freq_carrier_hyb->data[freq_carrier_hyb->size -1];
  REAL8 phase_carrier_at_f_max = phase_carrier_hyb->data[phase_carrier_hyb->size -1];
 
  gsl_interp_accel *acc = gsl_interp_accel_alloc ();
  gsl_spline *spline = gsl_spline_alloc (gsl_interp_cspline, phase_carrier_hyb->size);
 
  gsl_spline_init (spline, freq_carrier_hyb->data, phase_carrier_hyb->data, phase_carrier_hyb->size);
  REAL8 der_phase_carrier_at_f_max = gsl_spline_eval_deriv(spline, f_max_carrier, acc);
 
  /* Constant shift between modes */
  REAL8 const_phase_shift = const_phaseshift_lm_v5hm[nMode] + (1.-(REAL8)modeM)*LAL_PI/4.;
 
  for(unsigned int i = 0; i < freq_mode_lm->size; i++){
    if(freq_mode_lm->data[i]/(REAL8)modeM < f_max_carrier){
      /* Compute the approximate phase of lm mode from the carrier phase */
      phase_approx_lm->data[i] = (REAL8)modeM*gsl_spline_eval (spline, freq_mode_lm->data[i]/(REAL8)modeM, acc) + const_phase_shift;
    }
    else{
      /* Linear extrapolation for frequency at which we don't have data for the orbital phase */
      phase_approx_lm->data[i] = modeM*(phase_carrier_at_f_max + der_phase_carrier_at_f_max*(freq_mode_lm->data[i]/modeM-f_max_carrier)) + const_phase_shift;
    }
  }
 
  /* Cleanup */
  gsl_spline_free(spline);
  gsl_interp_accel_free(acc);
 
  return XLAL_SUCCESS;
}
 
/* This function returns the Re/Im part of c-modes in a sparse grid. Re/Im of c-modes are hybridized between LF and HF ROM. */
/* The derivation of the c-modes is in https://git.ligo.org/waveforms/reviews/SEOBNRv5HM_ROM/blob/master/documents/notes.pdf Eq. (22)*/
UNUSED static UINT8 SEOBNRv5HMROM_cmode_sparse_grid_hybrid(gsl_vector* freq, gsl_vector* cmode_real, gsl_vector* cmode_imag, gsl_vector* freq_lo, gsl_vector* freq_hi, REAL8 q, REAL8 chi1,REAL8 chi2, UINT8 nMode,INT8 nk_max,SEOBNRROMdataDS *romdataset){
 
  gsl_vector* real_f_lo = gsl_vector_alloc(freq_lo->size);
  gsl_vector* imag_f_lo = gsl_vector_alloc(freq_lo->size);
  gsl_vector* real_f_hi = gsl_vector_alloc(freq_hi->size);
  gsl_vector* imag_f_hi = gsl_vector_alloc(freq_hi->size);
 
  /* Generate LF and HF cmode */
  UNUSED UINT8 retcode = SEOBNRv5HMROM_cmode_sparse_grid(real_f_lo, imag_f_lo,q,chi1,chi2,"LF",nMode,nk_max,romdataset);
  retcode = SEOBNRv5HMROM_cmode_sparse_grid(real_f_hi, imag_f_hi,q,chi1,chi2,"HF",nMode,nk_max,romdataset);
 
  UINT8 modeM = lmModes_v5hm[nMode][1];
 
  /* Blend LF and HF cmode together */
  retcode = blend_functions(freq,cmode_real,freq_lo,real_f_lo,freq_hi,real_f_hi,f_hyb_ini*(REAL8)modeM,f_hyb_end*(REAL8)modeM);
  retcode = blend_functions(freq,cmode_imag,freq_lo,imag_f_lo,freq_hi,imag_f_hi,f_hyb_ini*(REAL8)modeM,f_hyb_end*(REAL8)modeM);
 
  /* Cleanup */
  gsl_vector_free(real_f_lo);
  gsl_vector_free(imag_f_lo);
  gsl_vector_free(real_f_hi);
  gsl_vector_free(imag_f_hi);
 
  return XLAL_SUCCESS;
 
}
 
/* This function returns the frequency and Re/Im part of c-modes in a sparse grid. The frequency and Re/Im of c-modes are hybridized between LF and HF ROM. */
UNUSED static UINT8 SEOBNRv5HMROM_freq_cmode_sparse_grid_hybrid(gsl_vector** freq_cmode, gsl_vector** cmode_real, gsl_vector** cmode_imag, REAL8 q, REAL8 chi1,REAL8 chi2, UINT8 nMode,INT8 nk_max, SEOBNRROMdataDS *romdataset){
 
  UINT8 modeL = lmModes_v5hm[nMode][0];
  UINT8 modeM = lmModes_v5hm[nMode][1];
 
  /* We point to the data for computing the cmode. */
  SEOBNRROMdataDS *romdata=&romdataset[nMode];
  if (!SEOBNRv5HMROM_IsSetup(nMode,romdataset)) {
    XLAL_ERROR(XLAL_EFAILED,
               "Error setting up SEOBNRv5ROM data - check your $LAL_DATA_PATH\n");
  }
 
  UNUSED UINT4 retcode=0;
 
  /* We always need to glue two submodels together for this ROM */
  SEOBNRROMdataDS_submodel *submodel_hi; // high frequency ROM
  SEOBNRROMdataDS_submodel *submodel_lo; // low frequency ROM
 
    /* Select ROM patches */
  //There is only one LF patch
  submodel_lo = romdata->lowf;
  //There is only one HF patch
  submodel_hi = romdata->highf;
 
  /* Compute hybridized Re/Im part c-mode */
 
  INT8 i_max_LF = 0;
  INT8 i_min_HF = 0;
 
  // Get sparse frequency array for the LF orbital phase
  gsl_vector* freq_lo = gsl_vector_alloc(submodel_lo->nk_cmode);
  gsl_vector* freq_hi = gsl_vector_alloc(submodel_hi->nk_cmode);
 
  for(unsigned int i = 0; i < freq_lo->size; i++){
    freq_lo->data[i] = submodel_lo->gCMode->data[i];
  }
 
  //Compute prefactor for rescaling the frequency.
  //The HF ROM is build using freq/RD_freq, we need to compute RD_freq and undo the scaling
  REAL8 omegaQNM = Get_omegaQNM_SEOBNRv5(q,chi1,chi2,modeL,modeM);
  REAL8 inv_scaling = 1. / (2*LAL_PI/omegaQNM);
  for(unsigned int i = 0; i < freq_hi->size; i++){
    freq_hi->data[i] = inv_scaling*submodel_hi->gCMode->data[i];
  }
 
  //Initialize arrays for Re/Im part c-mode
  // Compute length of hybridized frequency array
  retcode = compute_i_max_LF_i_min_HF(&i_max_LF, &i_min_HF,freq_lo,freq_hi,f_hyb_ini*(REAL8)modeM);
 
  *freq_cmode = gsl_vector_alloc(i_max_LF + freq_hi->size - i_min_HF + 1);
  // It's important to initialize this function to 0
 
  for(unsigned int i = 0; i <= i_max_LF;i++){
      (*freq_cmode)->data[i] = freq_lo->data[i];
  };
  for(unsigned int i = i_min_HF; i < freq_hi->size;i++){
      (*freq_cmode)->data[i_max_LF+i-i_min_HF+1] = freq_hi->data[i];
  };
 
  *cmode_real = gsl_vector_calloc((*freq_cmode)->size);
  *cmode_imag = gsl_vector_calloc((*freq_cmode)->size);
 
 
  // Generate the hybridized Re/Im part of c-mode
 
  retcode = SEOBNRv5HMROM_cmode_sparse_grid_hybrid(*freq_cmode,*cmode_real,*cmode_imag,freq_lo, freq_hi,q,chi1,chi2,nMode,nk_max,romdataset);
 
 
  /* Cleanup */
  gsl_vector_free(freq_lo);
  gsl_vector_free(freq_hi);
 
  return XLAL_SUCCESS;
}
 
 
 
/* This function returns the orbital phase in a sparse grid */
UNUSED static UINT8 SEOBNRv5HMROM_phase_sparse_grid(gsl_vector* phase_f, REAL8 q, REAL8 chi1,REAL8 chi2, const char* freq_range,INT4 nk_max, SEOBNRROMdataDS *romdataset){
 
  /* Loading the data for the 22 mode, the informations about orbital phase are stored here */
  SEOBNRROMdataDS *romdata=&romdataset[0];
  if (!SEOBNRv5HMROM_IsSetup(0,romdataset)) {
    XLAL_ERROR(XLAL_EFAILED,
               "Error setting up SEOBNRv5ROM data - check your $LAL_DATA_PATH\n");
  }
  /* Check whether you are asking for the LF or the HF ROM */
  SEOBNRROMdataDS_submodel *submodel;
  if(strcmp("LF",freq_range) == 0){
    // In the case of LF there is only one patch
    submodel = romdata->lowf;
  }
  else{
    submodel = romdata->highf;
  }
  /* Create and initialize the structure for interpolating the orbital phase */
  SEOBNRROMdataDS_coeff *romdata_coeff=NULL;
  SEOBNRROMdataDS_coeff_Init(&romdata_coeff, submodel->nk_cmode, submodel->nk_phase);
 
  /* Interpolating projection coefficients for orbital phase */
  UINT4 retcode=TP_Spline_interpolation_3d(
    q,                            // Input: q-value for which projection coefficients should be evaluated
    chi1,                         // Input: chi1-value for which projection coefficients should be evaluated
    chi2,                         // Input: chi2-value for which projection coefficients should be evaluated
    submodel->cvec_phase,         // Input: data for spline coefficients for amplitude
    submodel->nk_phase,           // number of SVD-modes == number of basis functions for amplitude
    nk_max,                       // truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1
    submodel->ncx,             // Number of points in q  + 2
    submodel->ncy,             // Number of points in chi1 + 2
    submodel->ncz,             // Number of points in chi2 + 2
    gsl_vector_const_ptr(submodel->qvec, 0),          // B-spline knots in q
    gsl_vector_const_ptr(submodel->chi1vec, 0),        // B-spline knots in chi1
    gsl_vector_const_ptr(submodel->chi2vec, 0),        // B-spline knots in chi2
    romdata_coeff->c_phase      // Output: interpolated projection coefficients for orbital phase
  );
 
  if(retcode!=0) {
    SEOBNRROMdataDS_coeff_Cleanup(romdata_coeff);
    XLAL_ERROR(retcode);
  }
 
  /* Project interpolation coefficients onto the basis */
  /* phase_pts = B_A^T . c_A */
  gsl_blas_dgemv(CblasTrans, 1.0, submodel->Bphase, romdata_coeff->c_phase, 0.0, phase_f);
 
  /* Cleanup */
  SEOBNRROMdataDS_coeff_Cleanup(romdata_coeff);
 
  return XLAL_SUCCESS;
}
 
/* This function returns the Re/Im part of c-modes in a sparse grid. */
UNUSED static UINT8 SEOBNRv5HMROM_cmode_sparse_grid(gsl_vector* creal_f, gsl_vector* cimag_f, REAL8 q, REAL8 chi1,REAL8 chi2, const char* freq_range,UINT8 nMode,INT4 nk_max, SEOBNRROMdataDS *romdataset){
 
  /* Loading the data for the lm mode */
  SEOBNRROMdataDS *romdata=&romdataset[nMode];
  if (!SEOBNRv5HMROM_IsSetup(nMode,romdataset)) {
    XLAL_ERROR(XLAL_EFAILED,
               "Error setting up SEOBNRv5ROM data - check your $LAL_DATA_PATH\n");
  }
  /* Check whether you are asking for the LF or the HF ROM */
  SEOBNRROMdataDS_submodel *submodel;
  if(strcmp("LF",freq_range) == 0){
    /* In the case of LF there is only one patch */
    submodel = romdata->lowf;
  }
  else{
    /* In the case of HF there is only one patch */
    submodel = romdata->highf;
  }
  /* Create and initialize the structure for interpolating the coorbital mode */
  SEOBNRROMdataDS_coeff *romdata_coeff=NULL;
  SEOBNRROMdataDS_coeff_Init(&romdata_coeff, submodel->nk_cmode, submodel->nk_cmode);
 
  /* Interpolating projection coefficients for Re(cmode) */
  UINT4 retcode=TP_Spline_interpolation_3d(
    q,                            // Input: eta-value for which projection coefficients should be evaluated
    chi1,                         // Input: chi1-value for which projection coefficients should be evaluated
    chi2,                         // Input: chi2-value for which projection coefficients should be evaluated
    submodel->cvec_real,         // Input: data for spline coefficients for amplitude
    submodel->nk_cmode,           // number of SVD-modes == number of basis functions for amplitude
    nk_max,                       // truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1
    submodel->ncx,             // Number of points in q  + 2
    submodel->ncy,             // Number of points in chi1 + 2
    submodel->ncz,             // Number of points in chi2 + 2
    gsl_vector_const_ptr(submodel->qvec, 0),          // B-spline knots in eta
    gsl_vector_const_ptr(submodel->chi1vec, 0),        // B-spline knots in chi1
    gsl_vector_const_ptr(submodel->chi2vec, 0),        // B-spline knots in chi2
    romdata_coeff->c_real      // Output: interpolated projection coefficients for Re(c-mode)
  );
 
  /* Interpolating projection coefficients for Im(cmode) */
  retcode=TP_Spline_interpolation_3d(
    q,                            // Input: eta-value for which projection coefficients should be evaluated
    chi1,                         // Input: chi1-value for which projection coefficients should be evaluated
    chi2,                         // Input: chi2-value for which projection coefficients should be evaluated
    submodel->cvec_imag,         // Input: data for spline coefficients for amplitude
    submodel->nk_cmode,           // number of SVD-modes == number of basis functions for amplitude
    nk_max,                       // truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1
    submodel->ncx,             // Number of points in q  + 2
    submodel->ncy,             // Number of points in chi1 + 2
    submodel->ncz,             // Number of points in chi2 + 2
    gsl_vector_const_ptr(submodel->qvec, 0),          // B-spline knots in eta
    gsl_vector_const_ptr(submodel->chi1vec, 0),        // B-spline knots in chi1
    gsl_vector_const_ptr(submodel->chi2vec, 0),        // B-spline knots in chi2
    romdata_coeff->c_imag      // Output: interpolated projection coefficients for Im(c-mode)
  );
 
  if(retcode!=0) {
    SEOBNRROMdataDS_coeff_Cleanup(romdata_coeff);
    XLAL_ERROR(retcode);
  }
 
  /* Project interpolation coefficients onto the basis */
  /* creal_pts = B_A^T . c_A */
  /* cimag_pts = B_A^T . c_A */
  gsl_blas_dgemv(CblasTrans, 1.0, submodel->Breal, romdata_coeff->c_real, 0.0, creal_f);
  gsl_blas_dgemv(CblasTrans, 1.0, submodel->Bimag, romdata_coeff->c_imag, 0.0, cimag_f);
 
  /* Cleanup */
  SEOBNRROMdataDS_coeff_Cleanup(romdata_coeff);
 
  return XLAL_SUCCESS;
}
 
 
/* Select high frequency ROM submodel */
UNUSED static UINT8 SEOBNRv5HMROM_Select_HF_patch(REAL8 q, REAL8 chi1){
  if ((q> 3.) && (chi1<=0.8)){
    return 0;
  }
  else if ((q> 3.) && (chi1>0.8)){
    return 1;
  }
  else if ((q<= 3.) && (chi1<=0.8)){
    return 2;
  }
  else if ((q<= 3.) && (chi1>0.8)){
    return 3;
  }
  else{
    XLAL_ERROR( XLAL_EDOM );
    XLALPrintError("XLAL Error - %s: SEOBNRv5HM not currently available in this region!\n",
                   __func__);
  }
}
 
 
/* Internal function to compute amplitudes and phases for each mode of the ROM and return these as gsl splines. */
UNUSED static int SEOBNRv5HMROMCoreModeAmpPhaseSplines(
  UNUSED AmpPhaseSplineData **ampPhaseSplineData, /**<< Output: amplitude and phase splines for the modes */
  UNUSED REAL8 q, /**< Mass ratio **/
  UNUSED REAL8 chi1, /**< Dimensionless aligned component spin 1 */
  UNUSED REAL8 chi2, /**< Dimensionless aligned component spin 2 */
  UNUSED INT4 nk_max, /**< truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1 (default). */
  UNUSED UINT4 nModes, /**<  Number of modes to generate */
  UNUSED SEOBNRROMdataDS *romdataset  /**< Dataset for the 22 or HM ROM */
)
{
  /* Check output structure */
  if(!ampPhaseSplineData)
    XLAL_ERROR(XLAL_EFAULT);
 
  /* 'Nudge' parameter values to allowed boundary values if close by */
  if (q < 1.0)     nudge(&q, 1.0, 1e-6);
  if (q > 100.0)    nudge(&q, 100.0, 1e-6);
 
  if ( chi1 < -0.998 - 1e-6 || chi2 < -0.998 - 1e-6 || chi1 > 0.998 + 1e-6|| chi2 > 0.998 + 1e-6) {
    XLALPrintError("XLAL Error - %s: chi1 or chi2 smaller than -0.998 or larger than 0.998!\n"
                   "SEOBNRv5HMROM is only available for spins in the range -0.998 <= a/M <= 0.998.\n",
                   __func__);
    XLAL_ERROR( XLAL_EDOM );
  }
 
  if (q<1.0 || q > 100.0) {
    XLALPrintError("XLAL Error - %s: q (%f) bigger than 100.0 or unphysical!\n"
                   "SEOBNRv5HMROM is only available for q in the range 1 <= q <= 100.\n",
                   __func__, q);
    XLAL_ERROR( XLAL_EDOM );
  }
 
  gsl_vector *freq_carrier_hyb = NULL;
  gsl_vector *phase_carrier_hyb = NULL;
 
  /* Compute the orbital phase, this is the same for every mode. */
  /* For this reason it's outside the for loop over modes below. */
  UNUSED int retcode = SEOBNRv5HMROM_freq_phase_sparse_grid_hybrid(
    &freq_carrier_hyb, &phase_carrier_hyb, q, chi1, chi2, nk_max,romdataset);
  if(retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  /* Put the phase into the right convention */
  for(unsigned int i=0; i < phase_carrier_hyb->size; i++) {
    phase_carrier_hyb->data[i] = -phase_carrier_hyb->data[i];
  }
 
  /* Looping over modes: compute complex mode and from that amplitude and phase */
  for(unsigned int nMode=0; nMode < nModes; nMode++){
 
    gsl_vector *freq_cmode_hyb = NULL;
    gsl_vector *cmode_real_hyb = NULL;
    gsl_vector *cmode_imag_hyb = NULL;
 
    UNUSED UINT4 modeL = lmModes_v5hm[nMode][0];
    UNUSED UINT4 modeM = lmModes_v5hm[nMode][1];
 
    /* Compute Re and Im c-modes */
    retcode = SEOBNRv5HMROM_freq_cmode_sparse_grid_hybrid(
      &freq_cmode_hyb, &cmode_real_hyb, &cmode_imag_hyb,
      q, chi1, chi2, nMode, nk_max, romdataset);
 
    gsl_vector *phase_approx_lm = gsl_vector_alloc(freq_cmode_hyb->size);
    /* Compute approximated phase from orbital phase */
    retcode = SEOBNRv5HMROM_approx_phi_lm(freq_cmode_hyb, phase_approx_lm,
      freq_carrier_hyb, phase_carrier_hyb, nMode);
 
    /* Compute the phase contribution coming from the cmode and unwrap it */
    COMPLEX16 complex_mode;
    gsl_vector *phase_cmode = gsl_vector_alloc(freq_cmode_hyb->size);
    for(unsigned int i=0; i < freq_cmode_hyb->size; i++) {
      complex_mode = cmode_real_hyb->data[i] + I*cmode_imag_hyb->data[i];
      phase_cmode->data[i] = carg(complex_mode);
    }
 
    /* Unwrap the phase contribution from the cmode */
    gsl_vector *unwrapped_phase_cmode = gsl_vector_alloc(freq_cmode_hyb->size);
    retcode = unwrap_phase(unwrapped_phase_cmode,phase_cmode);
 
    /* Reconstruct amplitude and phase */
    gsl_vector *reconstructed_phase = gsl_vector_alloc(freq_cmode_hyb->size);
    gsl_vector *reconstructed_amplitude = gsl_vector_alloc(freq_cmode_hyb->size);
    for(unsigned int i=0; i < freq_cmode_hyb->size; i++) {
        complex_mode = cmode_real_hyb->data[i] + I*cmode_imag_hyb->data[i];
        reconstructed_amplitude->data[i] = cabs(complex_mode);
        reconstructed_phase->data[i] = unwrapped_phase_cmode->data[i] - phase_approx_lm->data[i];
    }
 
    // Build amplitude and phase splines
    gsl_interp_accel *acc_amp = gsl_interp_accel_alloc();
    gsl_spline *spline_amp = gsl_spline_alloc (gsl_interp_cspline, reconstructed_amplitude->size);
    gsl_spline_init(spline_amp, freq_cmode_hyb->data, reconstructed_amplitude->data, reconstructed_amplitude->size);
 
    gsl_interp_accel *acc_phase = gsl_interp_accel_alloc();
    gsl_spline *spline_phase = gsl_spline_alloc (gsl_interp_cspline, reconstructed_phase->size);
    gsl_spline_init(spline_phase, freq_cmode_hyb->data, reconstructed_phase->data, reconstructed_phase->size);
 
    // Store amplitude and phase spline data for this mode.
    // We return this information. The caller is responsible for freeing it.
    ampPhaseSplineData[nMode]->spline_amp = spline_amp;
    ampPhaseSplineData[nMode]->spline_phi = spline_phase;
    ampPhaseSplineData[nMode]->acc_amp = acc_amp;
    ampPhaseSplineData[nMode]->acc_phi = acc_phase;
    ampPhaseSplineData[nMode]->f = freq_cmode_hyb;
 
    /* Cleanup inside of loop over modes */
    gsl_vector_free(cmode_real_hyb);
    gsl_vector_free(cmode_imag_hyb);
    gsl_vector_free(phase_approx_lm);
    gsl_vector_free(phase_cmode);
    gsl_vector_free(unwrapped_phase_cmode);
    gsl_vector_free(reconstructed_amplitude);
    gsl_vector_free(reconstructed_phase);
  }
 
  /* Cleanup outside of loop over modes */
  gsl_vector_free(freq_carrier_hyb);
  gsl_vector_free(phase_carrier_hyb);
 
  return(XLAL_SUCCESS);
}
 
 
/**
* Core function for computing the ROM modes.
* It rebuilds the modes starting from "orbital phase" and co-orbital modes.
* This function returns SphHarmFrequencySeries
*/
UNUSED static int SEOBNRv5HMROMCoreModes(
  UNUSED SphHarmFrequencySeries **hlm_list, /**<< Spherical modes frequency series for the waveform */
  UNUSED REAL8 phiRef, /**<< orbital reference phase */
  UNUSED REAL8 fRef, /**< Reference frequency (Hz); 0 defaults to fLow */
  UNUSED REAL8 distance, /**< Distance of source (m) */
  UNUSED REAL8 Mtot_sec, /**< Total mass in seconds **/
  UNUSED REAL8 q, /**< Mass ratio **/
  UNUSED REAL8 chi1, /**< Dimensionless aligned component spin 1 */
  UNUSED REAL8 chi2, /**< Dimensionless aligned component spin 2 */
  UNUSED const REAL8Sequence *freqs_in, /**< Frequency points at which to evaluate the waveform (Hz) */
  UNUSED REAL8 deltaF, /**< Frequency points at which to evaluate the waveform (Hz) */
  UNUSED INT4 nk_max, /**< truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1. We
  *nk_max == -1 is the default setting */
  UNUSED UINT4 nModes, /**<  Number of modes to generate */
  REAL8 sign_odd_modes, /**<  Sign of the odd-m modes, used when swapping the two bodies */
  UNUSED SEOBNRROMdataDS *romdataset  /**< Dataset for the 22 or HM ROM */
  )
{
  /* Check output structure */
  if(!hlm_list)
    XLAL_ERROR(XLAL_EFAULT);
 
  /* 'Nudge' parameter values to allowed boundary values if close by */
  if (q < 1.0)     nudge(&q, 1.0, 1e-6);
  if (q > 100.0)     nudge(&q, 100.0, 1e-6);
 
  if ( chi1 < -0.998 || chi2 < -0.998 || chi1 > 0.998 || chi2 > 0.998) {
    XLALPrintError("XLAL Error - %s: chi1 or chi2 smaller than -0.998 or larger than 0.998!\n"
                   "SEOBNRv5HMROM is only available for spins in the range -0.998 <= a/M <= 0.998.\n",
                   __func__);
    XLAL_ERROR( XLAL_EDOM );
  }
 
  if (q<1.0 || q > 100.0) {
    XLALPrintError("XLAL Error - %s: q (%f) bigger than 100.0 or unphysical!\n"
                   "SEOBNRv5HMROM is only available for q in the range 1 <= q <= 100.\n",
                   __func__, q);
    XLAL_ERROR( XLAL_EDOM );
  }
 
 
  // Get the splines for the amplitude and phase of the modes
  AmpPhaseSplineData **ampPhaseSplineData = NULL;
  AmpPhaseSplineData_Init(&ampPhaseSplineData, nModes);
  UNUSED int retcode = SEOBNRv5HMROMCoreModeAmpPhaseSplines(
    ampPhaseSplineData, q, chi1, chi2, nk_max, nModes,romdataset);
  if(retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
 
  /* Find frequency bounds */
  if (!freqs_in) XLAL_ERROR(XLAL_EFAULT);
  REAL8 fLow  = freqs_in->data[0];
  REAL8 fHigh = freqs_in->data[freqs_in->length - 1];
 
  UNUSED REAL8 fLow_geom = fLow * Mtot_sec;
  REAL8 fHigh_geom = fHigh * Mtot_sec;
  REAL8 deltaF_geom = deltaF * Mtot_sec;
  // The maximum available frequency is the one associated with the 55 mode
  REAL8 Mf_ROM_max = const_fmax_lm_v5hm[4] * Get_omegaQNM_SEOBNRv5(q, chi1, chi2, 5, 5) / (2.*LAL_PI);
 
  // Enforce allowed geometric frequency range
  if (fHigh_geom == 0)
    fHigh_geom = Mf_ROM_max;
  if (fLow_geom < Mf_low_22)
    XLAL_ERROR(XLAL_EDOM, "Starting frequency Mflow=%g is smaller than lowest frequency in ROM Mf=%g.\n", fLow_geom, Mf_low_22);
  if (fHigh_geom < Mf_low_22)
    XLAL_ERROR(XLAL_EDOM, "End frequency %g is smaller than ROM starting frequency %g!\n", fHigh_geom, Mf_low_22);
  if (fHigh_geom <= fLow_geom)
    XLAL_ERROR(XLAL_EDOM, "End frequency %g is smaller than (or equal to) starting frequency %g!\n", fHigh_geom, fLow_geom);
 
  /* Looping over cmodes */
  for(unsigned int nMode=0; nMode < nModes; nMode++){
    UNUSED UINT4 modeL = lmModes_v5hm[nMode][0];
    UNUSED UINT4 modeM = lmModes_v5hm[nMode][1];
 
    size_t npts = 0;
    LIGOTimeGPS tC = {0, 0};
    UINT4 offset = 0; // Index shift between freqs and the frequency series
    REAL8Sequence *freqs = NULL;
    // freqs contains uniform frequency grid with spacing deltaF; we start at frequency 0
    // I removed the if statement for the time being
    /* Set up output array with size closest power of 2 */
    npts = NextPow2(fHigh_geom / deltaF_geom) + 1;
    if (fHigh_geom < fHigh * Mtot_sec) /* Resize waveform if user wants f_max larger than cutoff frequency */
      npts = NextPow2(fHigh * Mtot_sec / deltaF_geom) + 1;
 
    XLALGPSAdd(&tC, -1. / deltaF);  /* coalesce at t=0 */
    COMPLEX16FrequencySeries *hlmtilde = XLALCreateCOMPLEX16FrequencySeries("hlmtilde: FD mode", &tC, 0.0, deltaF, &lalStrainUnit, npts);
 
 
    // Recreate freqs using only the lower and upper bounds
    // Use fLow, fHigh and deltaF rather than geometric frequencies for numerical accuracy
    double fHigh_temp = fHigh_geom / Mtot_sec;
    UINT4 iStart = (UINT4) ceil(fLow / deltaF);
    UINT4 iStop = (UINT4) ceil(fHigh_temp / deltaF);
    freqs = XLALCreateREAL8Sequence(iStop - iStart);
    if (!freqs) XLAL_ERROR(XLAL_EFUNC, "Frequency array allocation failed.");
    for (UINT4 i=iStart; i<iStop; i++)
      freqs->data[i-iStart] = i*deltaF_geom;
 
    offset = iStart;
 
 
    if (!hlmtilde)      {
        XLALDestroyREAL8Sequence(freqs);
        XLAL_ERROR(XLAL_EFUNC);
    }
 
    memset(hlmtilde->data->data, 0, npts * sizeof(COMPLEX16));
    XLALUnitMultiply(&(hlmtilde->sampleUnits), &(hlmtilde->sampleUnits), &lalSecondUnit);
    COMPLEX16 *hlmdata=hlmtilde->data->data;
 
    REAL8 Mtot = Mtot_sec / LAL_MTSUN_SI;
    // Correct overall amplitude to undo mass-dependent scaling used in ROM
    REAL8 amp0 = Mtot * Mtot_sec * LAL_MRSUN_SI / (distance);
 
    // ROM was build with t = 0 at t_peak^22 -1000. To agree with LAL convention, we undo this shift to get t_peak^22 = 0
    REAL8 t_corr = 1000.;
 
    // Shorthands for amplitude and phase splines for this mode
    gsl_spline *spline_amp = ampPhaseSplineData[nMode]->spline_amp;
    gsl_spline *spline_phase = ampPhaseSplineData[nMode]->spline_phi;
    gsl_interp_accel *acc_amp = ampPhaseSplineData[nMode]->acc_amp;
    gsl_interp_accel *acc_phase = ampPhaseSplineData[nMode]->acc_phi;
    // gsl_vector *freq_cmode_hyb = ampPhaseSplineData[nMode]->f;
 
    // Maximum frequency at which we have data for the ROM
    REAL8 Mf_max_mode = const_fmax_lm_v5hm[nMode] * Get_omegaQNM_SEOBNRv5(q, chi1, chi2, modeL, modeM) / (2.*LAL_PI);
 
    // Assemble modes from amplitude and phase
    for (UINT4 i=0; i<freqs->length; i++) { // loop over frequency points in sequence
      REAL8 f = freqs->data[i];
      if (f > Mf_max_mode) continue; // We're beyond the highest allowed frequency; since freqs may not be ordered, we'll just skip the current frequency and leave zero in the buffer
      if (f <= Mf_low_22 * modeM/2.) continue; // We're above the lowest allowed frequency; since freqs may not be ordered, we'll just skip the current frequency and leave zero in the buffer
      int j = i + offset; // shift index for frequency series if needed
      REAL8 A = gsl_spline_eval(spline_amp, f, acc_amp);
      REAL8 phase = gsl_spline_eval(spline_phase, f, acc_phase);
      hlmdata[j] = amp0*A * (cos(phase) + I*sin(phase));//cexp(I*phase);
      REAL8 phase_factor = -2.*LAL_PI*f*t_corr;
      COMPLEX16 t_factor = cos(phase_factor) + I*sin(phase_factor);
      hlmdata[j] *= t_factor;
      // We now return the (l,-m) mode that in the LAL convention has support for f > 0
      // We use the equation h(l,-m)(f) = (-1)^l h(l,m)*(-f) with f > 0
      hlmdata[j] = pow(-1.,modeL)*conj(hlmdata[j]);
      if(modeM%2 != 0){
        // This is changing the sign of the odd-m modes in the case m1 < m2,
        // if m1>m2 sign_odd_modes = 1 and nothing changes.
        hlmdata[j] = hlmdata[j]*sign_odd_modes;
      }
    }
    /* Save the mode (l,-m) in the SphHarmFrequencySeries structure */
    *hlm_list = XLALSphHarmFrequencySeriesAddMode(*hlm_list, hlmtilde, modeL, -modeM);
 
    /* Cleanup inside of loop over modes */
    XLALDestroyREAL8Sequence(freqs);
    XLALDestroyCOMPLEX16FrequencySeries(hlmtilde);
  }
 
  AmpPhaseSplineData_Destroy(ampPhaseSplineData, nModes);
 
  return(XLAL_SUCCESS);
}
 
 
/**
 * ModeArray is a structure which allows to select the modes to include
 * in the waveform.
 * This function will create a structure with the default modes for every model
 */
static UINT8 Setup_EOBROM__std_mode_array_structure(
    LALValue *ModeArray, UINT4 nModes)
{
 
  /* setup ModeArray */
 
      if (nModes == 7) {
        /* Adding all the modes of SEOBNRv5HM
        * i.e. [(2,2),(2,1),(3,3),(4,4),(5,5),(3,2),(4,3)]
        the relative -m modes are added automatically*/
        XLALSimInspiralModeArrayActivateMode(ModeArray, 2, -2);
        XLALSimInspiralModeArrayActivateMode(ModeArray, 2, -1);
        XLALSimInspiralModeArrayActivateMode(ModeArray, 3, -3);
        XLALSimInspiralModeArrayActivateMode(ModeArray, 4, -4);
        XLALSimInspiralModeArrayActivateMode(ModeArray, 5, -5);
        XLALSimInspiralModeArrayActivateMode(ModeArray, 3, -2);
        XLALSimInspiralModeArrayActivateMode(ModeArray, 4, -3);
      }
      else{
        /*All the other spin aligned model so far only have the 22 mode
        */
        XLALSimInspiralModeArrayActivateMode(ModeArray, 2, -2);
      }
 
 
    return XLAL_SUCCESS;
}
 
/**
 * ModeArray is a structure which allows to select the modes to include
 * in the waveform.
 * This function check if the selected modes are available
 */
static INT8 Check_EOBROM_mode_array_structure(
    LALValue *ModeArray, UINT4 nModes)
{
  INT4 flagTrue = 0;
  UINT4 modeL;
  INT4 modeM;
  const char *model_name;
  if (nModes == 1){
    model_name="SEOBNRv5_ROM";
  }
  else{
    model_name="SEOBNRv5HM_ROM";
  }
  /*Loop over all the possible modes
  *we only check -m modes, in the waveform both + and - m
  *modes will be included
  */
  for (UINT4 ELL = 2; ELL <= LAL_SIM_L_MAX_MODE_ARRAY; ELL++) {
    for (INT4 EMM = -ELL; EMM <= (INT4)ELL; EMM++) {
      if (XLALSimInspiralModeArrayIsModeActive(ModeArray, ELL, EMM) == 1) {
            for (UINT4 k = 0; k < nModes; k++) {
              modeL  = lmModes_v5hm[k][0];
              //lmModes_v5hm includes the modes in EOB convention for which hlm(f) is non 0 for f>0
              //for this reason we need the - sign here
              modeM = -lmModes_v5hm[k][1];
              if ((modeL == ELL)&&(modeM == EMM)) {
                flagTrue=1;
              }
              if ((modeL == ELL)&&(modeM == -EMM)) {
                flagTrue=2;
              }
            }
            /*For each active mode check if is available for the selected model
            */
            if (flagTrue == 0) {
              XLALPrintError ("Mode (%d,%d) is not available by the model %s\n", ELL,
                 EMM, model_name);
              return XLAL_FAILURE;
            }
            if (flagTrue == 2) {
              XLALPrintError ("Mode (%d,%d) is not available by the model %s.\n"
              "In this function you can only select (l,-|m|) modes that are directly modeled in the ROM.\n"
              "The (l,+|m|) mode will be automatically added to the waveform using symmetry arguments.\n", ELL,
                 EMM, model_name);
              return XLAL_FAILURE;
            }
            flagTrue = 0;
          }
      }
    }
 
    return XLAL_SUCCESS;
}
 
/**
 * This function combines the modes hlm frequencyseries with the sYlm to produce the
 * polarizations hplus, hcross.
 */
// NOTE: azimuthal angle of the observer entering the -2Ylm is pi/2-phi according to LAL conventions
static int SEOBROMComputehplushcrossFromhlm(
    COMPLEX16FrequencySeries
        *hplusFS, /**<< Output: frequency series for hplus, already created */
    COMPLEX16FrequencySeries
        *hcrossFS,   /**<< Output: frequency series for hplus, already created */
    LALValue *ModeArray, /**<< Input: ModeArray structure with the modes to include */
    SphHarmFrequencySeries
        *hlm,  /**<< Input: list with frequency series for each mode hlm */
    REAL8 inc,  /**<< Input: inclination */
    UNUSED REAL8 phi   /**<< Input: phase */
) {
  /* Loop over modes */
  SphHarmFrequencySeries *hlms_temp = hlm;
  while ( hlms_temp ) {
    if (XLALSimInspiralModeArrayIsModeActive(ModeArray, hlms_temp->l, hlms_temp->m) == 1) {
        /* Here we check if the mode generated is in the ModeArray structure */
        XLALSimAddModeFD(hplusFS, hcrossFS, hlms_temp->mode, inc, LAL_PI/2. - phi,
          hlms_temp->l, hlms_temp->m, 1);
      }
      hlms_temp = hlms_temp->next;
  }
 
  return XLAL_SUCCESS;
}
 
/*
 * Auxiliary function for TF2 phasing HM: phase constants for different modes
 */
static double GetDeltaphilm(int l, int m)
{
  if (l==2 && m==2) return 0.;
  else if (l==2 && m==1) return LAL_PI/2;
  else if (l==3 && m==3) return -LAL_PI/2;
  else if (l==4 && m==4) return LAL_PI;
  else if (l==5 && m==5) return LAL_PI/2;
  else if (l==3 && m==2) return 0;
  else if (l==4 && m==3) return -LAL_PI/2;
  else XLAL_ERROR(XLAL_EINVAL, "Mode indices (l,m) not recognized.");
}
/*
 * Auxiliary function for TF2 amplitude HM: mode amplitude factors
 * Leading Newtonian order + 0.5PN relative spin terms for 21
 * Here only the 21 has a 0.5PN spin contribution (important for 0-crossings)
 * The leading +-1 or +-i factor is supposed to be treated as a phase
 * (see GetDeltaphilm)
 * Reference: Eqs (4.17) of arXiv:0810.5336 [Phys.Rev.D79:104023,2009]
 * (reference for precessing modes, take iota=0)
 */
static double GetModeAmpFactor(double eta, double delta, double chi1, double chi2, int l, int m, double v)
{
  double chis = 1./2 * (chi1 + chi2);
  double chia = 1./2 * (chi1 - chi2);
  if (l==2 && m==2) return 1.;
  else if (l==2 && m==1) return v * (delta/3 - 1./2*v*(chia + delta*chis));
  else if (l==3 && m==3) return v * 3./4 * sqrt(15./14) * delta;
  else if (l==4 && m==4) return v*v * 8*sqrt(35.)/63 * (1 - 3*eta);
  else if (l==5 && m==5) return v*v*v * 625*sqrt(66.)/6336 * delta * (1 - 2*eta);
  else if (l==3 && m==2) return v*v * 9./8 *sqrt(5./7) * (8./27 * (-1 + 3*eta));
  else if (l==4 && m==3) return v*v*v * 8./9*sqrt(10./7)*81./320 * delta * (-1 + 2*eta);
  // LP: look at hybridized 32 and 43 modes to double check
  else XLAL_ERROR(XLAL_EINVAL, "Mode indices (l,m) not recognized.");
}
 
/*
 * Function computing the TaylorF2 phasing for the mode (l,m)
 * Arbitrary (set to 0) time and phase constants
 * The relative alignment between modes is consistent
 * We should evaluate XLALSimInspiralTaylorF2AlignedPhasing once for all modes;
 * however, this is presumably negligible for performance.
 * Reference for SPA scaling between modes:
 * Section III A 2) of arxiv:2003.12079 [Phys. Rev. D 101, 124040 (2020)]
 */
static int TaylorF2Phasing(
  double Mtot,         // Total mass in solar masses
  double q,            // Mass-ration m1/m2 >= 1
  double chi1,         // Dimensionless aligned spin of body 1
  double chi2,         // Dimensionless aligned spin of body 2
  int l,               // First mode number l
  int m,               // Second mode number m
  gsl_vector *Mfs,     // Input geometric frequencies
  gsl_vector **PNphase // Output: TaylorF2 phase at frequencies Mfs
) {
  XLAL_CHECK(PNphase != NULL, XLAL_EFAULT);
  XLAL_CHECK(*PNphase == NULL, XLAL_EFAULT);
  *PNphase = gsl_vector_alloc(Mfs->size);
 
  PNPhasingSeries *pn = NULL;
  LALDict *extraParams = XLALCreateDict();
  // Should we go for max order or set it explicitly?
  XLALSimInspiralWaveformParamsInsertPNSpinOrder(extraParams, LAL_SIM_INSPIRAL_SPIN_ORDER_35PN);
 
  double m1OverM = q / (1.0+q);
  double m2OverM = 1.0 / (1.0+q);
  double m1 = Mtot * m1OverM * LAL_MSUN_SI;
  double m2 = Mtot * m2OverM * LAL_MSUN_SI;
  // This function is a thin wrapper around XLALSimInspiralPNPhasing_F2
  XLALSimInspiralTaylorF2AlignedPhasing(&pn, m1, m2, chi1, chi2, extraParams);
 
  /* Constant phase for the mode (l,m) */
  double Deltaphilm = GetDeltaphilm(l, m);
 
  /* Note: we rescale the frequency (and v) according to the mode number m */
  for (size_t i=0; i < Mfs->size; i++) {
      const double Mf = gsl_vector_get(Mfs, i);
      const double Mf_m = 2./m * Mf;
      const double v = cbrt(LAL_PI * Mf_m);
      const double logv = log(v);
      const double v2 = v * v;
      const double v3 = v * v2;
      const double v4 = v * v3;
      const double v5 = v * v4;
      const double v6 = v * v5;
      const double v7 = v * v6;
      double phasing = 0.0;
 
      phasing += pn->v[7] * v7;
      phasing += (pn->v[6] + pn->vlogv[6] * logv) * v6;
      phasing += (pn->v[5] + pn->vlogv[5] * logv) * v5;
      phasing += pn->v[4] * v4;
      phasing += pn->v[3] * v3;
      phasing += pn->v[2] * v2;
      phasing += pn->v[1] * v;
      phasing += pn->v[0];
 
      /* Leading prefactor v^-5 */
      phasing /= v5;
 
      /* Rescaling by m/2 going from the 22 mode to the lm mode */
      phasing *= m/2.;
 
      /* Constant phase for the mode (l,m), and pi/4 from the SPA formula */
      phasing += Deltaphilm - LAL_PI/4.;
 
      gsl_vector_set(*PNphase, i, phasing);
  }
 
  XLALDestroyDict(extraParams);
  XLALFree(pn);
 
  return XLAL_SUCCESS;
}
 
/*
 * Function computing the TaylorF2 amplitude for the mode (l,m)
 * In geometric units.
 * Reference for SPA scaling between modes:
 * Section III A 2) of arxiv:2003.12079 [Phys. Rev. D 101, 124040 (2020)]
 */
static int TaylorF2Amplitude(
  const double q,      // Mass-ration m1/m2 >= 1
  const double chi1,   // Dimensionless aligned spin of body 1
  const double chi2,   // Dimensionless aligned spin of body 2
  const int l,         // First mode number l
  const int m,         // Second mode number m
  gsl_vector *Mfs,     // Input geometric frequencies
  gsl_vector **PNamp   // Output: TaylorF2 amplitude at frequencies Mfs
) {
 
  XLAL_CHECK(PNamp != NULL, XLAL_EFAULT);
  XLAL_CHECK(*PNamp == NULL, XLAL_EFAULT);
  *PNamp = gsl_vector_alloc(Mfs->size);
  double eta = q / ((1.+q)*(1.+q));
  // Modify delta to be tiny but nonzero for q=1 to avoid problems when hybridizing
  // with the ROM modes which do not vanish at q=1. This will make the modes
  // which should vanish exactly at q=1 about 15 orders of magnitude smaller than the (2,2) mode.
  double delta = (q-1. + DBL_EPSILON) / (1.+q);
  /* Prefactor of the Newtonian amplitude FD: A_N = G^2 M^2/r/c^5 pi sqrt(2nu/3) v^(-7/2) */
  /* Here in geometric units, simply pi sqrt(2nu/3) */
  double ampN = LAL_PI * sqrt(2*eta/3.);
 
  /* Note: we rescale the frequency (and v) according to the mode number m */
  for (size_t i=0; i < Mfs->size; i++) {
    const double Mf = gsl_vector_get(Mfs, i);
    const double Mf_m = 2./m * Mf;
    const double v = cbrt(LAL_PI * Mf_m);
    const double vm72 = pow(v, -7./2);
 
    /* Take into account 0.5PN (1PN for 22) amplitude of different modes */
    double mode_amp_factor = GetModeAmpFactor(eta, delta, chi1, chi2, l, m, v);
    double amp = ampN * vm72 * sqrt(2./m) * mode_amp_factor;
    gsl_vector_set(*PNamp, i, amp);
  }
 
  return XLAL_SUCCESS;
}
 
/* Build geom frequency grid suitable for waveform amp/phase interpolation */
/* Based on cubic spline error bound for leading-order power-law phase */
/* Reference: Section (5.1) of arXiv:1402.4146 [CQG 31 195010, 2014] */
static int BuildInspiralGeomFrequencyGrid(
  gsl_vector** Mfreq,    /* Output: pointer to real vector */
  const double Mfmin,    /* Starting geometric frequency */
  const double Mfmax,    /* Ending geometric frequency */
  const double q,        /* Mass ratio */
  const double acc)      /* Desired phase interpolation error for inspiral */
{
  /* Checks */
  if (*Mfreq != NULL)
    XLAL_ERROR(XLAL_EFAULT, "Input pointer for frequencies is not NULL.");
  if (!(Mfmin < Mfmax))
    XLAL_ERROR(XLAL_EINVAL, "Input Mf limits do not verify Mfmin < Mfmax.");
 
  double eta = q / ((1.+q) * (1.+q));
 
  /* Inspiral sampling */
  /* Dimensionless number so that DeltaMf = Lambda * Mf^(17/12) */
  /* Factor 3.8 tuned empirically */
  double Lambda = 3.8 * pow(acc * eta, 1./4) * pow(LAL_PI, 5./12);
 
  /* Number of samples with inspiral sampling */
  int N = 0;
  double Lambdatilde = 0.;
  N = 1 + ceil(12./5/Lambda * (pow(Mfmin, -5./12) - pow(Mfmax, -5./12)));
  /* Adjust a bit Lambda so that the last point at N_insp-1 is Mfmax */
  Lambdatilde = 12./5/(N-1) * (pow(Mfmin, -5./12) - pow(Mfmax, -5./12));
 
  /* Allocate output */
  *Mfreq = gsl_vector_alloc(N);
 
  /* Fill in values */
  double Mfmin_m512 = pow(Mfmin, -5./12);
  for (int i=0; i<N; i++) { /* includes Mfmin and Mfmax, will be readjusted */
    (*Mfreq)->data[i] = pow(Mfmin_m512 - 5./12*Lambdatilde*i, -12./5);
  }
 
  /* Eliminate rounding errors at both ends */
  (*Mfreq)->data[0] = Mfmin;
  (*Mfreq)->data[N-1] = Mfmax;
 
  return XLAL_SUCCESS;
}
 
UNUSED static int hybridize_ROM_with_PN_amplitude(
  gsl_spline **hyb_spline,                            /**< Output: spline */
  AmpPhaseSplineData *ampPhaseSplineData_for_mode,    /**< ROM spline data */
  gsl_vector *PN_freq,                                /**< PN frequency */
  gsl_vector *PN_amp,                                 /**< PN amplitude */
  double f_hyb_win_lo,                                /**< hybridization window start */
  double f_hyb_win_hi                                 /**< hybridization window end */
)
{
  gsl_vector *ROM_amp_f = NULL;
  gsl_vector *ROM_amp = NULL;
  spline_to_gsl_vectors(ampPhaseSplineData_for_mode->spline_amp, &ROM_amp_f, &ROM_amp);
 
  // Sanity checks
  if ( (gsl_vector_get(PN_freq, 0) > f_hyb_win_lo)
    || (gsl_vector_get(PN_freq, PN_freq->size - 1) < f_hyb_win_lo)
    || (gsl_vector_get(PN_freq, 0) > f_hyb_win_hi)
    || (gsl_vector_get(PN_freq, PN_freq->size - 1) < f_hyb_win_hi) )
    XLAL_ERROR(XLAL_EFUNC, "Hybridization window for amplitude is not contained in PN frequencies.");
  if ( (gsl_vector_get(ROM_amp_f, 0) > f_hyb_win_lo)
    || (gsl_vector_get(ROM_amp_f, ROM_amp_f->size - 1) < f_hyb_win_lo)
    || (gsl_vector_get(ROM_amp_f, 0) > f_hyb_win_hi)
    || (gsl_vector_get(ROM_amp_f, ROM_amp_f->size - 1) < f_hyb_win_hi) )
    XLAL_ERROR(XLAL_EFUNC, "Hybridization window for amplitude is not contained in ROM frequencies.");
 
  // Scale PN amplitude to match ROM amplitude
  gsl_spline *PN_amp_spline = gsl_spline_alloc(gsl_interp_cspline, PN_amp->size);
  gsl_spline_init(PN_amp_spline, PN_freq->data, PN_amp->data, PN_amp->size);
  gsl_interp_accel *acc_PN = gsl_interp_accel_alloc();
  gsl_interp_accel *acc_ROM = gsl_interp_accel_alloc();
  double PN_amp_i = gsl_spline_eval(PN_amp_spline, f_hyb_win_lo, acc_PN);
  double ROM_amp_i = gsl_spline_eval(ampPhaseSplineData_for_mode->spline_amp, f_hyb_win_lo, acc_ROM);
  double fac = ROM_amp_i / PN_amp_i;
  for (size_t i=0; i < PN_amp->size; i++) {
    double A = gsl_vector_get(PN_amp, i);
    gsl_vector_set(PN_amp, i, A * fac);
  }
  gsl_spline_free(PN_amp_spline);
  gsl_interp_accel_free(acc_PN);
  gsl_interp_accel_free(acc_ROM);
 
  gsl_vector *hyb_freq = NULL;
  gsl_vector *hyb_amp = NULL;
  SEOBNRv5HMROM_amplitude_sparse_grid_hybrid_general(
    &hyb_freq, &hyb_amp,
    PN_amp, ROM_amp,
    PN_freq, ROM_amp_f,
    f_hyb_win_lo, f_hyb_win_hi
  );
  // Make a spline from the hybridized data
  *hyb_spline = gsl_spline_alloc(gsl_interp_cspline, hyb_amp->size);
  gsl_spline_init(*hyb_spline, hyb_freq->data, hyb_amp->data, hyb_amp->size);
 
  gsl_vector_free(ROM_amp_f);
  gsl_vector_free(ROM_amp);
  gsl_vector_free(hyb_freq);
  gsl_vector_free(hyb_amp);
 
  return XLAL_SUCCESS;
}
 
UNUSED static int hybridize_ROM_with_PN_phase_output_align(
  gsl_spline **hyb_spline,                            /**< Output: spline */
  REAL8* Deltat_align,                                /**< Output: time alignment */
  REAL8* Deltaphi_align,                              /**< Output: phase alignment */
  AmpPhaseSplineData *ampPhaseSplineData_for_mode,    /**< ROM spline data */
  gsl_vector *PN_freq,                                /**< PN frequency */
  gsl_vector *PN_phase,                               /**< PN phase */
  double f_hyb_win_lo,                                /**< hybridization window start */
  double f_hyb_win_hi                                 /**< hybridization window end */
)
{
  gsl_vector *ROM_phi_f = NULL;
  gsl_vector *ROM_phi = NULL;
  spline_to_gsl_vectors(ampPhaseSplineData_for_mode->spline_phi, &ROM_phi_f, &ROM_phi);
 
  // Sanity checks
  if ( (gsl_vector_get(PN_freq, 0) > f_hyb_win_lo)
    || (gsl_vector_get(PN_freq, PN_freq->size - 1) < f_hyb_win_lo)
    || (gsl_vector_get(PN_freq, 0) > f_hyb_win_hi)
    || (gsl_vector_get(PN_freq, PN_freq->size - 1) < f_hyb_win_hi) )
    XLAL_ERROR(XLAL_EFUNC, "Hybridization window for phase is not contained in PN frequencies.");
  if ( (gsl_vector_get(ROM_phi_f, 0) > f_hyb_win_lo)
    || (gsl_vector_get(ROM_phi_f, ROM_phi_f->size - 1) < f_hyb_win_lo)
    || (gsl_vector_get(ROM_phi_f, 0) > f_hyb_win_hi)
    || (gsl_vector_get(ROM_phi_f, ROM_phi_f->size - 1) < f_hyb_win_hi) )
    XLAL_ERROR(XLAL_EFUNC, "Hybridization window for phase is not contained in ROM frequencies.");
 
  gsl_vector *hyb_freq = NULL;
  gsl_vector *hyb_phase = NULL;
  SEOBNRv5HMROM_phase_sparse_grid_hybrid_output_align(
    &hyb_freq, &hyb_phase, Deltat_align, Deltaphi_align,
    PN_phase, ROM_phi,
    PN_freq, ROM_phi_f,
    f_hyb_win_lo, f_hyb_win_hi
  );
 
  // Make a spline from the hybridized data
  *hyb_spline = gsl_spline_alloc(gsl_interp_cspline, hyb_phase->size);
  gsl_spline_init(*hyb_spline, hyb_freq->data, hyb_phase->data, hyb_phase->size);
 
  gsl_vector_free(ROM_phi_f);
  gsl_vector_free(ROM_phi);
  gsl_vector_free(hyb_freq);
  gsl_vector_free(hyb_phase);
 
  return XLAL_SUCCESS;
}
 
UNUSED static int hybridize_ROM_with_PN_phase_input_align(
  gsl_spline **hyb_spline,                            /**< Output: spline */
  AmpPhaseSplineData *ampPhaseSplineData_for_mode,    /**< ROM spline data */
  gsl_vector *PN_freq,                                /**< PN frequency */
  gsl_vector *PN_phase,                               /**< PN phase */
  double f_hyb_win_lo,                                /**< hybridization window start */
  double f_hyb_win_hi,                                /**< hybridization window end */
  REAL8 Deltat_22_align,                              /**< Input: 22 time alignment */
  REAL8 Deltaphi_22_align,                            /**< Input: 22 phase alignment */
  INT4 modeM                                          /**< Input: m mode number */
)
{
  gsl_vector *ROM_phi_f = NULL;
  gsl_vector *ROM_phi = NULL;
  spline_to_gsl_vectors(ampPhaseSplineData_for_mode->spline_phi, &ROM_phi_f, &ROM_phi);
 
  // Sanity checks
  if ( (gsl_vector_get(PN_freq, 0) > f_hyb_win_lo)
    || (gsl_vector_get(PN_freq, PN_freq->size - 1) < f_hyb_win_lo)
    || (gsl_vector_get(PN_freq, 0) > f_hyb_win_hi)
    || (gsl_vector_get(PN_freq, PN_freq->size - 1) < f_hyb_win_hi) )
    XLAL_ERROR(XLAL_EFUNC, "Hybridization window for phase is not contained in PN frequencies.");
  if ( (gsl_vector_get(ROM_phi_f, 0) > f_hyb_win_lo)
    || (gsl_vector_get(ROM_phi_f, ROM_phi_f->size - 1) < f_hyb_win_lo)
    || (gsl_vector_get(ROM_phi_f, 0) > f_hyb_win_hi)
    || (gsl_vector_get(ROM_phi_f, ROM_phi_f->size - 1) < f_hyb_win_hi) )
    XLAL_ERROR(XLAL_EFUNC, "Hybridization window for phase is not contained in ROM frequencies.");
 
  gsl_vector *hyb_freq = NULL;
  gsl_vector *hyb_phase = NULL;
  SEOBNRv5HMROM_phase_sparse_grid_hybrid_input_align(
    &hyb_freq, &hyb_phase,
    PN_phase, ROM_phi,
    PN_freq, ROM_phi_f,
    f_hyb_win_lo, f_hyb_win_hi,
    Deltat_22_align, Deltaphi_22_align, modeM
  );
 
  // Make a spline from the hybridized data
  *hyb_spline = gsl_spline_alloc(gsl_interp_cspline, hyb_phase->size);
  gsl_spline_init(*hyb_spline, hyb_freq->data, hyb_phase->data, hyb_phase->size);
 
  gsl_vector_free(ROM_phi_f);
  gsl_vector_free(ROM_phi);
  gsl_vector_free(hyb_freq);
  gsl_vector_free(hyb_phase);
 
  return XLAL_SUCCESS;
}
 
 
// Compute spherical harmonic modes similar to SEOBNRv5HMROMCoreModes() but here the ROM modes
// are hybridized with PN in the early inspiral.
UNUSED static int SEOBNRv5HMROMCoreModesHybridized(
  UNUSED SphHarmFrequencySeries **hlm_list, /**<< Output: Spherical modes frequency series for the waveform */
  UNUSED REAL8 phiRef,                      /**<< orbital reference phase */
  UNUSED REAL8 fRef,                        /**< Reference frequency (Hz); 0 defaults to fLow */
  UNUSED REAL8 distance,                    /**< Distance of source (m) */
  UNUSED REAL8 Mtot_sec,                    /**< Total mass in seconds **/
  UNUSED REAL8 q,                           /**< Mass ratio **/
  UNUSED REAL8 chi1,                        /**< Dimensionless aligned component spin 1 */
  UNUSED REAL8 chi2,                        /**< Dimensionless aligned component spin 2 */
  UNUSED const REAL8Sequence *freqs_in,     /**< Frequency points at which to evaluate the waveform (Hz) */
  UNUSED REAL8 deltaF,                      /**< Sampling frequency (Hz).
   * If deltaF > 0, the frequency points given in freqs are uniformly spaced with
   * spacing deltaF. Otherwise, the frequency points can be spaced non-uniformly.
   * Then we will use deltaF = 0 to create the frequency series we return. */
  UNUSED INT4 nk_max,                       /**< truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1. We
  *nk_max == -1 is the default setting */
  UNUSED UINT4 nModes,                      /**<  Number of modes to generate */
  REAL8 sign_odd_modes,                     /**<  Sign of the odd-m modes, used when swapping the two bodies */
  UNUSED SEOBNRROMdataDS *romdataset        /**< Dataset for the 22 or HM ROM */
)
{
  /* Find frequency bounds */
  if (!freqs_in) XLAL_ERROR(XLAL_EFAULT);
  REAL8 fLow  = freqs_in->data[0];
  REAL8 fHigh = freqs_in->data[freqs_in->length - 1];
 
  REAL8 fLow_geom = fLow * Mtot_sec;
  REAL8 fHigh_geom = fHigh * Mtot_sec;
  REAL8 deltaF_geom = deltaF * Mtot_sec;
 
    // The maximum available frequency is the one associated with the 55 mode
  REAL8 Mf_ROM_max = const_fmax_lm_v5hm[4] * Get_omegaQNM_SEOBNRv5(q, chi1, chi2, 5, 5) / (2.*LAL_PI);
 
  if (fHigh_geom == 0)
    fHigh_geom = Mf_ROM_max;
  // Enforce allowed geometric frequency range
  // ROM starting frequency
  // Note: Mf_low_55 is 5/2 times Mf_low_22 and about 1e-3; this is the shortest mode
  // (Could make a distinction of whether we just want the 22 mode or all the modes.)
  if (fLow_geom <= Mf_low_22)
      XLAL_PRINT_INFO("Starting frequency %g is smaller than (or equal to) ROM starting frequency for (2,2) mode %g!\nUsing hybridization with TaylorF2.\n", fLow_geom, Mf_low_22);
  if (fLow_geom <= Mf_low_55)
      XLAL_PRINT_INFO("Starting frequency %g is smaller than (or equal to) ROM starting frequency for (5,5) mode %g!\nUsing hybridization with TaylorF2.\n", fLow_geom, Mf_low_55);
  if (fLow_geom <= 0.0) {
    XLALPrintError("XLAL Error - %s: Starting frequency in REAL8Sequence must be positive.\n", __func__);
    XLAL_ERROR(XLAL_EFUNC);
  }
  // Get the splines for the amplitude and phase of the modes
  AmpPhaseSplineData **ampPhaseSplineData = NULL;
  AmpPhaseSplineData_Init(&ampPhaseSplineData, nModes);
  UNUSED int retcode = SEOBNRv5HMROMCoreModeAmpPhaseSplines(
    ampPhaseSplineData, q, chi1, chi2, nk_max, nModes,romdataset);
  if(retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  // Safety factors for defining the hybridization window
  // See the definition of f_hyb_win_lo and f_hyb_win_hi below.
  const double f_hyb_win_lo_fac = 1.01;  // Slightly above 1, so that f_hyb_win_lo will be slightly above Mf_low_lm_v5hm[k] to avoid issues with floating point comparisons
  const double f_hyb_win_hi_fac = 2.0;
  // Empirically this factor of 2 is a good choice for the length of the hybridization window with PN.
  // If the window is too short then there may be an abrupt change in the slope of the phase.
  // If the window is too wide then the linear fit will be thrown off by nonlinear contributions.
  // For hybridization we need the PN frequencies to contain [Mf_low_21 * f_hyb_win_lo_fac, Mf_low_55 * f_hyb_win_hi_fac] to be safe for all modes.
 
  /* Generate PN amplitudes and phases */
  double Mtot = Mtot_sec / LAL_MTSUN_SI;
 
  double PN_Mf_low = fmin(fLow_geom / 2.0, Mf_low_21); // Start at half of the starting frequency to avoid gsl interpolation errors in the (2,1) mode; at least starting frequency of the 22 mode.
  double PN_Mf_high = 1.1 * f_hyb_win_hi_fac * Mf_low_55; // to have some overlap with the shortest ROM mode
 
  gsl_vector *Mfs = NULL;
  const double acc = 1e-4; // Hardcoded spline interpolation accuracy target
  retcode = BuildInspiralGeomFrequencyGrid(&Mfs, PN_Mf_low, PN_Mf_high, q, acc);
  if(retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  // Arrays for storing amplitude and phase splines for each mode
  gsl_spline *hybrid_spline_amp[nModes];
  gsl_spline *hybrid_spline_phi[nModes];
  for (UINT4 i=0; i < nModes; i++) {
    hybrid_spline_amp[i] = NULL;
    hybrid_spline_phi[i] = NULL;
  }
 
  // Alignment constants, time and phase shift
  // Computed once for (2,-2), then propagated to other modes (with possible pi)
  REAL8 Deltat_22_align = 0.;
  REAL8 Deltaphi_22_align = 0.;
 
  // Loop over all modes, hybridize, and compute modes
  // For the amplitude hybridize_ROM_with_PN_amplitude() will make them continuous, but the slope will be wrong
  for (UINT4 k=0; k < nModes; k++) {
    double f_hyb_win_lo = Mf_low_lm_v5hm[k] * f_hyb_win_lo_fac;
    double f_hyb_win_hi = Mf_low_lm_v5hm[k] * f_hyb_win_hi_fac;
    if (k==0)
      XLALPrintInfo("%s : SEOBNRv5HM_ROM hybridization window for (2,2) mode: Mf in [%g, %g]\n",
      __func__, f_hyb_win_lo, f_hyb_win_hi);
    int modeL = lmModes_v5hm[k][0];
    int modeM = lmModes_v5hm[k][1];
 
    gsl_vector *PNamp = NULL;
    gsl_vector *PNphase = NULL;
 
    // We get q >= 1 which is consistent with the TF2 wrapper functions
    retcode |= TaylorF2Amplitude(q, chi1, chi2, modeL, modeM, Mfs, &PNamp);
    retcode |= TaylorF2Phasing(Mtot, q, chi1, chi2, modeL, modeM, Mfs, &PNphase);
    if(retcode != 0) {
       gsl_vector_free(PNamp);
       gsl_vector_free(PNphase);
       gsl_vector_free(Mfs);
       XLAL_ERROR(retcode);
    }
 
    // Hybridize phase
    // Distinguish (2,2) (time and phase alignment output) from others (input)
    // NOTE: sensitive to the ordering of the modes ! We check k=0 is (2,-2)
    // NOTE: convention in error message, (2,2) or (2,-2) ?
    if (k==0) {
      if (!(modeL==2 && modeM==2)) {
        XLALPrintError ("The first mode in the loop must be (2,2).\n");
        XLAL_ERROR(XLAL_EFUNC);
      }
      // Hybridize (2,-2) and output time and phase shift
      hybridize_ROM_with_PN_phase_output_align(
        &hybrid_spline_phi[k],
        &Deltat_22_align,
        &Deltaphi_22_align,
        ampPhaseSplineData[k],
        Mfs, PNphase,
        f_hyb_win_lo, f_hyb_win_hi
      );
    }
    else {
      // Hybridize with time and phase shift determined from (2,-2) as input
      hybridize_ROM_with_PN_phase_input_align(
        &hybrid_spline_phi[k],
        ampPhaseSplineData[k],
        Mfs, PNphase,
        f_hyb_win_lo, f_hyb_win_hi,
        Deltat_22_align, Deltaphi_22_align, modeM
      );
    }
 
    // Hybridize amplitude
    hybridize_ROM_with_PN_amplitude(
      &hybrid_spline_amp[k],
      ampPhaseSplineData[k],
      Mfs, PNamp,
      f_hyb_win_lo, f_hyb_win_hi
    );
 
    // Set up accelerators for spline evaluation in the loop below
    gsl_interp_accel *acc_amp = gsl_interp_accel_alloc();
    gsl_interp_accel *acc_phase = gsl_interp_accel_alloc();
 
    // Set up data structure for current mode for Nyquist or user specified frequency grids
    size_t npts = 0;
    LIGOTimeGPS tC = {0, 0};
    UINT4 offset = 0; // Index shift between freqs and the frequency series
    REAL8Sequence *freqs = NULL;
    COMPLEX16FrequencySeries *hlmtilde = NULL;
 
    if (deltaF > 0) {
      // uniform frequency grid with spacing deltaF; we start at frequency 0
 
      npts = NextPow2(fHigh_geom / deltaF_geom) + 1;
      if (fHigh_geom < fHigh * Mtot_sec) /* Resize waveform if user wants f_max larger than cutoff frequency */
        npts = NextPow2(fHigh * Mtot_sec / deltaF_geom) + 1;
      XLALGPSAdd(&tC, -1. / deltaF);  /* coalesce at t=0 */
 
      // Allocate space for the current mode
      hlmtilde = XLALCreateCOMPLEX16FrequencySeries(
        "hlmtilde: FD mode", &tC, 0.0, deltaF, &lalStrainUnit, npts);
 
      // Recreate freqs using only the lower and upper bounds
      // Use fLow, fHigh and deltaF rather than geometric frequencies for numerical accuracy
      double fHigh_temp = fHigh_geom / Mtot_sec;
      UINT4 iStart = (UINT4) ceil(fLow / deltaF);
      UINT4 iStop = (UINT4) ceil(fHigh_temp / deltaF);
      freqs = XLALCreateREAL8Sequence(iStop - iStart);
      if (!freqs) XLAL_ERROR(XLAL_EFUNC, "Frequency array allocation failed.");
      for (UINT4 i=iStart; i<iStop; i++)
        freqs->data[i-iStart] = i*deltaF_geom;
 
      offset = iStart;
    } else {
      // freqs contains frequencies with non-uniform spacing; we start at lowest given frequency
      npts = freqs_in->length;
 
      // Allocate space for the current mode
      hlmtilde = XLALCreateCOMPLEX16FrequencySeries(
        "hlmtilde: FD mode", &tC, fLow, deltaF, &lalStrainUnit, npts);
 
      freqs = XLALCreateREAL8Sequence(freqs_in->length);
      if (!freqs) XLAL_ERROR(XLAL_EFUNC, "Frequency array allocation failed.");
      for (UINT4 i=0; i<freqs_in->length; i++)
        freqs->data[i] = freqs_in->data[i] * Mtot_sec;
 
      offset = 0;
    }
 
    memset(hlmtilde->data->data, 0, npts * sizeof(COMPLEX16));
    COMPLEX16 *hlmdata=hlmtilde->data->data;
 
    // Correct overall amplitude to undo mass-dependent scaling used in ROM
    double amp0 = Mtot * Mtot_sec * LAL_MRSUN_SI / (distance);
 
    // The ROM was build with t = 0 at t_peak^22 -1000.
    // To agree with the LAL convention, we undo this shift to get t_peak^22 = 0.
    double t_corr = 1000.0;
 
    // Maximum frequency at which we have data for the ROM
    double Mf_max_mode = const_fmax_lm_v5hm[k] * Get_omegaQNM_SEOBNRv5(
      q, chi1, chi2, modeL, modeM) / (2.0*LAL_PI);
 
    // Loop over frequency points in sequence
    for (UINT4 i=0; i < freqs->length; i++) {
      double f = freqs->data[i];
      if (f > Mf_max_mode) continue; // We're beyond the highest allowed frequency; since freqs may not be ordered, we'll just skip the current frequency and leave zero in the buffer
      int j = i + offset; // shift index for frequency series if needed
 
      // Assemble mode from amplitude and phase
      REAL8 A = gsl_spline_eval(hybrid_spline_amp[k], f, acc_amp);
      REAL8 phase = gsl_spline_eval(hybrid_spline_phi[k], f, acc_phase);
      hlmdata[j] = amp0*A * (cos(phase) + I*sin(phase));
      REAL8 phase_factor = -2.0*LAL_PI * f * t_corr;
      COMPLEX16 t_factor = cos(phase_factor) + I*sin(phase_factor);
      hlmdata[j] *= t_factor;
      // We now return the (l,-m) mode that in the LAL convention has support for f > 0
      // We use the equation h(l,-m)(f) = (-1)^l h(l,m)*(-f) with f > 0
      hlmdata[j] = pow(-1.0, modeL) * conj(hlmdata[j]);
      if(modeM%2 != 0){
        // This is changing the sign of the odd-m modes in the case m1 < m2.
        // If m1>m2 sign_odd_modes = 1 and nothing changes
        hlmdata[j] = hlmdata[j] * sign_odd_modes;
      }
    }
    /* Save the mode (l,-m) in the SphHarmFrequencySeries structure */
    *hlm_list = XLALSphHarmFrequencySeriesAddMode(*hlm_list, hlmtilde, modeL, -modeM);
 
    // Cleanup
    XLALDestroyCOMPLEX16FrequencySeries(hlmtilde);
    gsl_interp_accel_free(acc_amp);
    gsl_interp_accel_free(acc_phase);
    gsl_vector_free(PNamp);
    gsl_vector_free(PNphase);
    XLALDestroyREAL8Sequence(freqs);
  }
 
  // Cleanup outside of loop
  gsl_vector_free(Mfs);
  AmpPhaseSplineData_Destroy(ampPhaseSplineData, nModes);
 
  for (UINT4 k=0; k < nModes; k++) {
    gsl_spline_free(hybrid_spline_amp[k]);
    gsl_spline_free(hybrid_spline_phi[k]);
  }
  return(XLAL_SUCCESS);
}
 
/**
 * @addtogroup LALSimIMRSEOBNRv5HMROM_c
 *
 * \author Lorenzo Pompili, Roberto Cotesta, Sylvain Marsat, Michael Puerrer 
 *
 * \brief C code for SEOBNRv5HM reduced order model * 
 *
 * This is a frequency domain model that approximates the time domain SEOBNRv5HM model described in ...
 *
 * The binary data HDF5 file (SEOBNRv5ROM_v1.0.hdf5) is available on the lalsuite-extra repository https://git.ligo.org/lscsoft/lalsuite-extra
 * Make sure the files are in your LAL_DATA_PATH.
 *
 * @note Parameter ranges:
 *   * 1 <= q <= 100
 *   * -0.998 <= chi_i <= 0.998
 *   * no limitations on f_low as the mode is hybridized with Taylor F2 at low frequencies
 *
 *  Aligned component spins chi1, chi2.
 *  Mass-ratio q = m1/m2 >= 1
 *
 *
 * @{
 */
/**
 * Compute waveform in LAL format for the SEOBNRv5HM_ROM model.
 *
 * Returns the plus and cross polarizations as a complex frequency series with
 * equal spacing deltaF and contains zeros from zero frequency to the starting
 * frequency fLow and zeros beyond the cutoff frequency in the ringdown.
 */
int XLALSimIMRSEOBNRv5HMROM(
  UNUSED struct tagCOMPLEX16FrequencySeries **hptilde, /**< Output: Frequency-domain waveform h+ */
  UNUSED struct tagCOMPLEX16FrequencySeries **hctilde, /**< Output: Frequency-domain waveform hx */
  UNUSED REAL8 phiRef,                                 /**< Phase at reference time */
  UNUSED REAL8 deltaF,                                 /**< Sampling frequency (Hz) */
  REAL8 fLow,                                          /**< Starting GW frequency (Hz) */
  UNUSED REAL8 fHigh,                                  /**< End frequency */
  UNUSED REAL8 fRef,                                   /**< Reference frequency (Hz); 0 defaults to fLow */
  UNUSED REAL8 distance,                               /**< Distance of source (m) */
  UNUSED REAL8 inclination,                            /**< Inclination of source (rad) */
  REAL8 m1SI,                                          /**< Mass of companion 1 (kg) */
  REAL8 m2SI,                                          /**< Mass of companion 2 (kg) */
  REAL8 chi1,                                          /**< Dimensionless aligned component spin 1 */
  REAL8 chi2,                                          /**< Dimensionless aligned component spin 2 */
  UNUSED INT4 nk_max,                                  /**< Truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1 */
  UNUSED UINT4 nModes,                                 /**< Number of modes to use. This should be 1 for SEOBNRv5_ROM and 7 for SEOBNRv5HM_ROM */
  bool use_hybridization,                              /**< Whether the ROM should be hybridized */
  LALDict *LALParams                                   /**<< Dictionary of additional wf parameters, here is used to pass ModeArray */
)
{
  REAL8 sign_odd_modes = 1.;
  /* Internally we need m1 > m2, so change around if this is not the case */
  if (m1SI < m2SI) {
    // Swap m1 and m2
    REAL8 m1temp = m1SI;
    REAL8 chi1temp = chi1;
    m1SI = m2SI;
    chi1 = chi2;
    m2SI = m1temp;
    chi2 = chi1temp;
    sign_odd_modes = -1.; // When we swap m1 with m2 odd-m modes should get - sign because they depend on dm
  }
 
  /* Get masses in terms of solar mass */
  REAL8 mass1 = m1SI / LAL_MSUN_SI;
  REAL8 mass2 = m2SI / LAL_MSUN_SI;
  REAL8 Mtot = mass1+mass2;
  REAL8 q = mass1/mass2;
  UNUSED REAL8 Mtot_sec = Mtot * LAL_MTSUN_SI;       /* Total mass in seconds */
 
  /* Select modes to include in the waveform */
  LALValue *ModeArray = XLALSimInspiralWaveformParamsLookupModeArray(LALParams);
  //ModeArray includes the modes chosen by the user
  if (ModeArray == NULL) {
    //If the user doesn't choose the modes, use the standard modes
    ModeArray = XLALSimInspiralCreateModeArray();
    Setup_EOBROM__std_mode_array_structure(ModeArray, nModes);
  }
  //Check that the modes chosen are available for the model
  if(Check_EOBROM_mode_array_structure(ModeArray, nModes) == XLAL_FAILURE){
    XLALPrintError ("Not available mode chosen.\n");
    XLAL_ERROR(XLAL_EFUNC);
  }
 
  // Use fLow, fHigh, deltaF to compute freqs sequence
  // Instead of building a full sequency we only transfer the boundaries and let
  // the internal core function do the rest (and properly take care of corner cases).
  REAL8Sequence *freqs = XLALCreateREAL8Sequence(2);
  freqs->data[0] = fLow;
  freqs->data[1] = fHigh;
 
  SEOBNRROMdataDS *romdataset;
 
  /* Load ROM data if not loaded already */
#ifdef LAL_PTHREAD_LOCK
  if (nModes == 1){
    romdataset=__lalsim_SEOBNRv5ROMDS_data;
    (void) pthread_once(&SEOBNRv5ROM_is_initialized, SEOBNRv5ROM_Init_LALDATA);
  }
  else{
    romdataset=__lalsim_SEOBNRv5HMROMDS_data;
    (void) pthread_once(&SEOBNRv5HMROM_is_initialized, SEOBNRv5HMROM_Init_LALDATA);
  }
#else
  if (nModes == 1){
    SEOBNRv5ROM_Init_LALDATA();
  }
  else{
    SEOBNRv5HMROM_Init_LALDATA();
  }
#endif
  SphHarmFrequencySeries *hlm = NULL;
 
  /* Generate modes */
  UINT8 retcode = 0;
  if (use_hybridization) {
    retcode = SEOBNRv5HMROMCoreModesHybridized(&hlm,
        phiRef, fRef, distance, Mtot_sec, q, chi1, chi2, freqs, deltaF, nk_max,
        nModes, sign_odd_modes, romdataset);
  }
  else {
    retcode = SEOBNRv5HMROMCoreModes(&hlm,
        phiRef, fRef, distance, Mtot_sec, q, chi1, chi2, freqs, deltaF, nk_max,
        nModes, sign_odd_modes, romdataset);
  }
  if(retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
 
  /* GPS time for output frequency series and modes */
  COMPLEX16FrequencySeries *hlm_for_hphc = XLALSphHarmFrequencySeriesGetMode(hlm, 2,-2);
  LIGOTimeGPS tGPS = hlm_for_hphc->epoch;
  size_t npts = hlm_for_hphc->data->length;
 
  /* Create output frequencyseries for hplus, hcross */
  UNUSED COMPLEX16FrequencySeries *hPlustilde = XLALCreateCOMPLEX16FrequencySeries("hptilde: FD waveform", &tGPS, 0.0, deltaF,&lalStrainUnit, npts);
  UNUSED COMPLEX16FrequencySeries *hCrosstilde = XLALCreateCOMPLEX16FrequencySeries("hctilde: FD waveform", &tGPS, 0.0, deltaF,&lalStrainUnit, npts);
  memset(hPlustilde->data->data, 0, npts * sizeof(COMPLEX16));
  memset(hCrosstilde->data->data, 0, npts * sizeof(COMPLEX16));
  XLALUnitMultiply(&hPlustilde->sampleUnits, &hPlustilde->sampleUnits, &lalSecondUnit);
  XLALUnitMultiply(&hCrosstilde->sampleUnits, &hCrosstilde->sampleUnits, &lalSecondUnit);
  retcode = SEOBROMComputehplushcrossFromhlm(hPlustilde,hCrosstilde,ModeArray,hlm,inclination,phiRef);
  if(retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  /* Point the output pointers to the relevant time series and return */
  (*hptilde) = hPlustilde;
  (*hctilde) = hCrosstilde;
 
  XLALDestroyREAL8Sequence(freqs);
  XLALDestroySphHarmFrequencySeries(hlm);
  XLALDestroyValue(ModeArray);
 
  // This is a debug enviromental variable, when activated is deleting the ROM dataset from memory
  const char* s = getenv("FREE_MEMORY_SEOBNRv5HMROM");
  if (s!=NULL){
    for(unsigned int index_mode = 0; index_mode < nModes;index_mode++){
      SEOBNRROMdataDS_Cleanup(&romdataset[index_mode]);
    }
  }
 
  return(XLAL_SUCCESS);
}
 
/**
* Compute waveform polarizations at user specified frequencies for the SEOBNRv5HM_ROM model
*
* This function is designed as an entry point for reduced order quadratures.
* Since ROQs are most effective for long waveforms the hybridized ROM is used.
*
*/
int XLALSimIMRSEOBNRv5HMROMFrequencySequence(
  UNUSED struct tagCOMPLEX16FrequencySeries **hptilde, /**< Output: Frequency-domain waveform h+ */
  UNUSED struct tagCOMPLEX16FrequencySeries **hctilde, /**< Output: Frequency-domain waveform hx */
  const REAL8Sequence *freqs,                          /**< Frequency points at which to evaluate the waveform (Hz) */
  UNUSED REAL8 phiRef,                                 /**< Phase at reference time */
  UNUSED REAL8 fRef,                                   /**< Reference frequency (Hz); 0 defaults to fLow */
  UNUSED REAL8 distance,                               /**< Distance of source (m) */
  UNUSED REAL8 inclination,                            /**< Inclination of source (rad) */
  REAL8 m1SI,                                          /**< Mass of companion 1 (kg) */
  REAL8 m2SI,                                          /**< Mass of companion 2 (kg) */
  REAL8 chi1,                                          /**< Dimensionless aligned component spin 1 */
  REAL8 chi2,                                          /**< Dimensionless aligned component spin 2 */
  UNUSED INT4 nk_max,                                  /**< Truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1 */
  UNUSED UINT4 nModes,                                 /**< Number of modes to use. This should be 1 for SEOBNRv5_ROM and 7 for SEOBNRv5HM_ROM */
  LALDict *LALParams                                   /**<< Dictionary of additional wf parameters, here is used to pass ModeArray */
)
{
  REAL8 sign_odd_modes = 1.;
  /* Internally we need m1 > m2, so change around if this is not the case */
  if (m1SI < m2SI) {
    // Swap m1 and m2
    REAL8 m1temp = m1SI;
    REAL8 chi1temp = chi1;
    m1SI = m2SI;
    chi1 = chi2;
    m2SI = m1temp;
    chi2 = chi1temp;
    sign_odd_modes = -1.; // When we swap m1 with m2 odd-m modes should get - sign because they depend on dm
  }
 
  /* Get masses in terms of solar mass */
  REAL8 mass1 = m1SI / LAL_MSUN_SI;
  REAL8 mass2 = m2SI / LAL_MSUN_SI;
  REAL8 Mtot = mass1+mass2;
  REAL8 q = mass1/mass2;
  UNUSED REAL8 Mtot_sec = Mtot * LAL_MTSUN_SI;       /* Total mass in seconds */
 
  /* Select modes to include in the waveform */
  LALValue *ModeArray = XLALSimInspiralWaveformParamsLookupModeArray(LALParams);
  //ModeArray includes the modes chosen by the user
  if (ModeArray == NULL) {
    //If the user doesn't choose the modes, use the standard modes
    ModeArray = XLALSimInspiralCreateModeArray();
    Setup_EOBROM__std_mode_array_structure(ModeArray, nModes);
  }
  //Check that the modes chosen are available for the model
  if(Check_EOBROM_mode_array_structure(ModeArray, nModes) == XLAL_FAILURE){
    XLALPrintError ("Not available mode chosen.\n");
    XLAL_ERROR(XLAL_EFUNC);
  }
 
  SEOBNRROMdataDS *romdataset;
 
  /* Load ROM data if not loaded already */
#ifdef LAL_PTHREAD_LOCK
  if (nModes == 1){
    romdataset=__lalsim_SEOBNRv5ROMDS_data;
    (void) pthread_once(&SEOBNRv5ROM_is_initialized, SEOBNRv5ROM_Init_LALDATA);
  }
  else{
    romdataset=__lalsim_SEOBNRv5HMROMDS_data;
    (void) pthread_once(&SEOBNRv5HMROM_is_initialized, SEOBNRv5HMROM_Init_LALDATA);
  }
#else
  if (nModes == 1){
    SEOBNRv5ROM_Init_LALDATA();
  }
  else{
    SEOBNRv5HMROM_Init_LALDATA();
  }
#endif
  SphHarmFrequencySeries *hlm = NULL;
 
  // Call the internal core function with deltaF = 0 to indicate that freqs is non-uniformly
  // spaced and we want the strain only at these frequencies
  // The FS interface is only implemented for the hybridized ROM
  double deltaF = 0.0;
 
  /* Generate modes */
  UINT8 retcode = 0;
  retcode = SEOBNRv5HMROMCoreModesHybridized(&hlm,
      phiRef, fRef, distance, Mtot_sec, q, chi1, chi2, freqs, deltaF, nk_max,
      nModes, sign_odd_modes, romdataset);
  if(retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
 
  /* GPS time for output frequency series and modes */
  COMPLEX16FrequencySeries *hlm_for_hphc = XLALSphHarmFrequencySeriesGetMode(hlm, 2,-2);
  LIGOTimeGPS tGPS = hlm_for_hphc->epoch;
  size_t npts = hlm_for_hphc->data->length;
 
  double fLow = freqs->data[0];
  /* Create output frequencyseries for hplus, hcross */
  UNUSED COMPLEX16FrequencySeries *hPlustilde = XLALCreateCOMPLEX16FrequencySeries(
    "hptilde: FD waveform", &tGPS, fLow, deltaF, &lalStrainUnit, npts);
  UNUSED COMPLEX16FrequencySeries *hCrosstilde = XLALCreateCOMPLEX16FrequencySeries(
    "hctilde: FD waveform", &tGPS, fLow, deltaF, &lalStrainUnit, npts);
  memset(hPlustilde->data->data, 0, npts * sizeof(COMPLEX16));
  memset(hCrosstilde->data->data, 0, npts * sizeof(COMPLEX16));
  XLALUnitDivide(&hPlustilde->sampleUnits, &hPlustilde->sampleUnits, &lalSecondUnit);
  XLALUnitDivide(&hCrosstilde->sampleUnits, &hCrosstilde->sampleUnits, &lalSecondUnit);
  retcode = SEOBROMComputehplushcrossFromhlm(hPlustilde, hCrosstilde, ModeArray, hlm, inclination, phiRef);
  if(retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  /* Point the output pointers to the relevant time series and return */
  (*hptilde) = hPlustilde;
  (*hctilde) = hCrosstilde;
 
  XLALDestroySphHarmFrequencySeries(hlm);
  XLALDestroyValue(ModeArray);
 
  // This is a debug enviromental variable; when activated it deletes the ROM dataset from memory.
  const char* s = getenv("FREE_MEMORY_SEOBNRv5HMROM");
  if (s!=NULL){
    for(unsigned int index_mode = 0; index_mode < nModes;index_mode++){
      SEOBNRROMdataDS_Cleanup(&romdataset[index_mode]);
    }
  }
 
  return(XLAL_SUCCESS);
}
 
/**
 * Compute modes in LAL format for the SEOBNRv5HM_ROM model.
 *
 * Returns hlm modes as a SphHarmFrequencySeries with
 * equal spacing deltaF and contains zeros from zero frequency to the starting
 * frequency fLow and zeros beyond the cutoff frequency in the ringdown.
 */
int XLALSimIMRSEOBNRv5HMROM_Modes(
  SphHarmFrequencySeries **hlm, /**< Output: Frequency-domain hlm */
  UNUSED REAL8 phiRef,          /**< Phase at reference time */
  UNUSED REAL8 deltaF,          /**< Sampling frequency (Hz) */
  REAL8 fLow,                   /**< Starting GW frequency (Hz) */
  UNUSED REAL8 fHigh,           /**< End frequency; 0 defaults to Mf=0.14 */
  REAL8 fRef,                   /**< Reference frequency unused here */
  REAL8 distance,               /**< Reference frequency (Hz); 0 defaults to fLow */
  REAL8 m1SI,                   /**< Mass of companion 1 (kg) */
  REAL8 m2SI,                   /**< Mass of companion 2 (kg) */
  REAL8 chi1,                   /**< Dimensionless aligned component spin 1 */
  REAL8 chi2,                   /**< Dimensionless aligned component spin 2 */
  UNUSED INT4 nk_max,           /**< Truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1 */
  UNUSED UINT4 nModes,          /**< Number of modes to use. This should be 1 for SEOBNRv5_ROM and 7 for SEOBNRv5HM_ROM */
  bool use_hybridization        /**< Whether the ROM should be hybridized */
)
{
  REAL8 sign_odd_modes = 1.;
  /* Internally we need m1 > m2, so change around if this is not the case */
  if (m1SI < m2SI) {
    // Swap m1 and m2
    REAL8 m1temp = m1SI;
    REAL8 chi1temp = chi1;
    m1SI = m2SI;
    chi1 = chi2;
    m2SI = m1temp;
    chi2 = chi1temp;
    sign_odd_modes = -1.; // When we swap m1 with m2 odd-m modes should get - sign because they depend on dm
  }
  /* Check if the number of modes makes sense */
 
  if(nModes >7){
    XLAL_PRINT_ERROR("Requested number of modes not available. Set nModes = 0 to get all the available modes.\n");
    XLAL_ERROR(XLAL_EDOM);
  }
 
  /* Get masses in terms of solar mass */
  REAL8 mass1 = m1SI / LAL_MSUN_SI;
  REAL8 mass2 = m2SI / LAL_MSUN_SI;
  REAL8 Mtot = mass1+mass2;
  REAL8 q = mass1/mass2;
  UNUSED REAL8 Mtot_sec = Mtot * LAL_MTSUN_SI;       /* Total mass in seconds */
 
  if(fRef==0.0)
    fRef=fLow;
 
  // Use fLow, fHigh, deltaF to compute freqs sequence
  // Instead of building a full sequency we only transfer the boundaries and let
  // the internal core function do the rest (and properly take care of corner cases).
  REAL8Sequence *freqs = XLALCreateREAL8Sequence(2);
  freqs->data[0] = fLow;
  freqs->data[1] = fHigh;
 
  SEOBNRROMdataDS *romdataset;
 
  /* Load ROM data if not loaded already */
#ifdef LAL_PTHREAD_LOCK
  if (nModes == 1){
    romdataset=__lalsim_SEOBNRv5ROMDS_data;
    (void) pthread_once(&SEOBNRv5ROM_is_initialized, SEOBNRv5ROM_Init_LALDATA);
  }
  else{
    romdataset=__lalsim_SEOBNRv5HMROMDS_data;
    (void) pthread_once(&SEOBNRv5HMROM_is_initialized, SEOBNRv5HMROM_Init_LALDATA);
  }
#else
  if (nModes == 1){
    SEOBNRv5ROM_Init_LALDATA();
  }
  else{
    SEOBNRv5HMROM_Init_LALDATA();
  }
#endif
 
  /* Generate modes */
  UNUSED UINT8 retcode;
 
  if (use_hybridization) {
    if(nModes == 0) // Return all modes by default
      retcode = SEOBNRv5HMROMCoreModesHybridized(hlm, phiRef, fRef, distance,
                                  Mtot_sec, q, chi1, chi2, freqs,
                                  deltaF, nk_max, 7, sign_odd_modes, romdataset);
    else
      retcode = SEOBNRv5HMROMCoreModesHybridized(hlm, phiRef, fRef, distance,
                                  Mtot_sec, q, chi1, chi2, freqs,
                                  deltaF, nk_max, nModes, sign_odd_modes, romdataset);
  }
  else { // No hybridization
    if(nModes == 0) // Return all modes by default
      retcode = SEOBNRv5HMROMCoreModes(hlm, phiRef, fRef, distance,
                                  Mtot_sec, q, chi1, chi2, freqs,
                                  deltaF, nk_max, 7, sign_odd_modes, romdataset);
    else
      retcode = SEOBNRv5HMROMCoreModes(hlm, phiRef, fRef, distance,
                                  Mtot_sec, q, chi1, chi2, freqs,
                                  deltaF, nk_max, nModes, sign_odd_modes, romdataset);
}
 
  XLALDestroyREAL8Sequence(freqs);
 
  return(XLAL_SUCCESS);
}
 
/**
* Compute waveform modes at user specified frequencies for the SEOBNRv5HM_ROM model
*
* This is a convenience function. It uses the hybridized ROM.
*
*/
int XLALSimIMRSEOBNRv5HMROMFrequencySequence_Modes(
  SphHarmFrequencySeries **hlm,                        /**< Output: Frequency-domain hlm */
  const REAL8Sequence *freqs,                          /**< Frequency points at which to evaluate the waveform (Hz) */
  UNUSED REAL8 phiRef,                                 /**< Phase at reference time */
  UNUSED REAL8 fRef,                                   /**< Reference frequency (Hz); 0 defaults to fLow */
  UNUSED REAL8 distance,                               /**< Distance of source (m) */
  UNUSED REAL8 inclination,                            /**< Inclination of source (rad) */
  REAL8 m1SI,                                          /**< Mass of companion 1 (kg) */
  REAL8 m2SI,                                          /**< Mass of companion 2 (kg) */
  REAL8 chi1,                                          /**< Dimensionless aligned component spin 1 */
  REAL8 chi2,                                          /**< Dimensionless aligned component spin 2 */
  UNUSED INT4 nk_max,                                  /**< Truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1 */
  UNUSED UINT4 nModes,                                 /**< Number of modes to use. This should be 1 for SEOBNRv5_ROM and 7 for SEOBNRv5HM_ROM */
  LALDict *LALParams                                   /**<< Dictionary of additional wf parameters, here is used to pass ModeArray */
)
{
  REAL8 sign_odd_modes = 1.;
  /* Internally we need m1 > m2, so change around if this is not the case */
  if (m1SI < m2SI) {
    // Swap m1 and m2
    REAL8 m1temp = m1SI;
    REAL8 chi1temp = chi1;
    m1SI = m2SI;
    chi1 = chi2;
    m2SI = m1temp;
    chi2 = chi1temp;
    sign_odd_modes = -1.; // When we swap m1 with m2 odd-m modes should get - sign because they depend on dm
  }
 
  /* Get masses in terms of solar mass */
  REAL8 mass1 = m1SI / LAL_MSUN_SI;
  REAL8 mass2 = m2SI / LAL_MSUN_SI;
  REAL8 Mtot = mass1+mass2;
  REAL8 q = mass1/mass2;
  UNUSED REAL8 Mtot_sec = Mtot * LAL_MTSUN_SI;       /* Total mass in seconds */
 
  /* Select modes to include in the waveform */
  LALValue *ModeArray = XLALSimInspiralWaveformParamsLookupModeArray(LALParams);
  //ModeArray includes the modes chosen by the user
  if (ModeArray == NULL) {
    //If the user doesn't choose the modes, use the standard modes
    ModeArray = XLALSimInspiralCreateModeArray();
    Setup_EOBROM__std_mode_array_structure(ModeArray, nModes);
  }
  //Check that the modes chosen are available for the model
  if(Check_EOBROM_mode_array_structure(ModeArray, nModes) == XLAL_FAILURE){
    XLALPrintError ("Not available mode chosen.\n");
    XLAL_ERROR(XLAL_EFUNC);
  }
 
  SEOBNRROMdataDS *romdataset;
 
  /* Load ROM data if not loaded already */
#ifdef LAL_PTHREAD_LOCK
  if (nModes == 1){
    romdataset=__lalsim_SEOBNRv5ROMDS_data;
    (void) pthread_once(&SEOBNRv5ROM_is_initialized, SEOBNRv5ROM_Init_LALDATA);
  }
  else{
    romdataset=__lalsim_SEOBNRv5HMROMDS_data;
    (void) pthread_once(&SEOBNRv5HMROM_is_initialized, SEOBNRv5HMROM_Init_LALDATA);
  }
#else
  if (nModes == 1){
    SEOBNRv5ROM_Init_LALDATA();
  }
  else{
    SEOBNRv5HMROM_Init_LALDATA();
  }
#endif
 
  // Call the internal core function with deltaF = 0 to indicate that freqs is non-uniformly
  // spaced and we want the modes only at these frequencies
  // The FS interface is only implemented for the hybridized ROM
  double deltaF = 0.0;
 
  /* Generate modes */
  UINT8 retcode = 0;
  retcode = SEOBNRv5HMROMCoreModesHybridized(hlm,
      phiRef, fRef, distance, Mtot_sec, q, chi1, chi2, freqs, deltaF, nk_max,
      nModes, sign_odd_modes, romdataset);
  if(retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  XLALDestroyValue(ModeArray);
 
  // This is a debug enviromental variable; when activated it deletes the ROM dataset from memory.
  const char* s = getenv("FREE_MEMORY_SEOBNRv5HMROM");
  if (s!=NULL){
    for(unsigned int index_mode = 0; index_mode < nModes;index_mode++){
      SEOBNRROMdataDS_Cleanup(&romdataset[index_mode]);
    }
  }
 
  return(retcode);
}
 
// Auxiliary function to perform setup of phase spline for t(f) and f(t) functions
static int SEOBNRv5ROMTimeFrequencySetup(
  gsl_spline **spline_phi,                      // phase spline
  gsl_interp_accel **acc_phi,                   // phase spline accelerator
  REAL8 *Mf_final,                              // ringdown frequency in Mf
  REAL8 *Mtot_sec,                              // total mass in seconds
  REAL8 m1SI,                                   // Mass of companion 1 (kg)
  REAL8 m2SI,                                   // Mass of companion 2 (kg)
  REAL8 chi1,                                   // Aligned spin of companion 1
  REAL8 chi2,                                   // Aligned spin of companion 2
  REAL8 Mf_start,                               // Starting geometric frequency
  REAL8 *Mf_ROM_min,                            // Lowest geometric frequency for ROM
  REAL8 *Mf_ROM_max                             // Highest geometric frequency for ROM
)
{
  /* Get masses in terms of solar mass */
  double mass1 = m1SI / LAL_MSUN_SI;
  double mass2 = m2SI / LAL_MSUN_SI;
  double Mtot = mass1 + mass2;
  double q = mass1 / mass2;
  double eta = mass1 * mass2 / (Mtot*Mtot);    /* Symmetric mass-ratio */
  *Mtot_sec = Mtot * LAL_MTSUN_SI; /* Total mass in seconds */
 
  /* 'Nudge' parameter values to allowed boundary values if close by */
  if (q < 1.0)     nudge(&q, 1.0, 1e-6);
  if (q > 100.0)     nudge(&q, 100.0, 1e-6);
 
  if ( chi1 < -0.998 || chi2 < -0.998 || chi1 > 0.998 || chi2 > 0.998) {
    XLALPrintError("XLAL Error - %s: chi1 or chi2 smaller than -0.998 or larger than 0.998!\n"
                   "SEOBNRv5HMROM is only available for spins in the range -0.998 <= a/M <= 0.998.\n",
                   __func__);
    XLAL_ERROR( XLAL_EDOM );
  }
 
  if (q<1.0 || q > 100.0) {
    XLALPrintError("XLAL Error - %s: q (%f) bigger than 100.0 or unphysical!\n"
                   "SEOBNRv5HMROM is only available for q in the range 1 <= q <= 100.\n",
                   __func__, q);
    XLAL_ERROR( XLAL_EDOM );
  }
 
  SEOBNRROMdataDS *romdataset;
 
  /* Load ROM data if not loaded already */
#ifdef LAL_PTHREAD_LOCK
  romdataset=__lalsim_SEOBNRv5ROMDS_data;
  (void) pthread_once(&SEOBNRv5ROM_is_initialized, SEOBNRv5ROM_Init_LALDATA);
#else
  SEOBNRv5ROM_Init_LALDATA();
#endif
 
  UINT4 nModes = 1; /* 22 mode only */
  UINT4 nk_max = -1; /* Default value */
  // Get the splines for the amplitude and phase of the modes
  AmpPhaseSplineData **ampPhaseSplineData = NULL;
  AmpPhaseSplineData_Init(&ampPhaseSplineData, nModes);
  UNUSED int retcode = SEOBNRv5HMROMCoreModeAmpPhaseSplines(
    ampPhaseSplineData, q, chi1, chi2, nk_max, nModes,romdataset);
  if(retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  // Setup hybridized phase splines as in SEOBNRv5HMROMCoreModesHybridized
 
  // Safety factors for defining the hybridization window
  const double f_hyb_win_lo_fac = 1.01;
  const double f_hyb_win_hi_fac = 2.0;
 
  /* Generate PN phases */
  double PN_Mf_low = fmin(Mf_start / 2.0, Mf_low_21); // Start at half of the starting frequency to avoid gsl interpolation errors in the (2,1) mode; at least starting frequency of the 22 mode.
  double PN_Mf_high = 1.1 * f_hyb_win_hi_fac * Mf_low_55; // to have some overlap with the shortest ROM mode
 
  gsl_vector *Mfs = NULL;
  const double acc = 1e-4; // Hardcoded spline interpolation accuracy target
  retcode = BuildInspiralGeomFrequencyGrid(&Mfs, PN_Mf_low, PN_Mf_high, q, acc);
  if(retcode != XLAL_SUCCESS) XLAL_ERROR(retcode);
 
  // Arrays for storing phase spline for each mode
  gsl_spline *hybrid_spline_phi[nModes];
  for (UINT4 i=0; i < nModes; i++) {
    hybrid_spline_phi[i] = NULL;
  }
 
  // Alignment constants, time and phase shift
  // Computed once for (2,-2), then propagated to other modes (with possible pi)
  REAL8 Deltat_22_align = 0.;
  REAL8 Deltaphi_22_align = 0.;
 
  // Loop over all modes and hybridize
  for (UINT4 k=0; k < nModes; k++) {
    double f_hyb_win_lo = Mf_low_lm_v5hm[k] * f_hyb_win_lo_fac;
    double f_hyb_win_hi = Mf_low_lm_v5hm[k] * f_hyb_win_hi_fac;
    if (k==0)
      XLALPrintInfo("%s : SEOBNRv5HM_ROM hybridization window for (2,2) mode: Mf in [%g, %g]\n",
      __func__, f_hyb_win_lo, f_hyb_win_hi);
    int modeL = lmModes_v5hm[k][0];
    int modeM = lmModes_v5hm[k][1];
 
    gsl_vector *PNphase = NULL;
 
    // We get q >= 1 which is consistent with the TF2 wrapper functions
    retcode |= TaylorF2Phasing(Mtot, q, chi1, chi2, modeL, modeM, Mfs, &PNphase);
    if(retcode != 0) {
       gsl_vector_free(PNphase);
       gsl_vector_free(Mfs);
       XLAL_ERROR(retcode);
    }
 
    // Hybridize phase
    if (!(modeL==2 && modeM==2)) {
      XLALPrintError ("Only the (2,2) mode is used.\n");
      XLAL_ERROR(XLAL_EFUNC);
    }
    // Hybridize (2,-2) and output time and phase shift
    hybridize_ROM_with_PN_phase_output_align(
      &hybrid_spline_phi[k],
      &Deltat_22_align,
      &Deltaphi_22_align,
      ampPhaseSplineData[k],
      Mfs, PNphase,
      f_hyb_win_lo, f_hyb_win_hi
    );
  }
 
  *spline_phi = hybrid_spline_phi[0];
  *acc_phi = ampPhaseSplineData[0]->acc_phi;
 
  // lowest allowed geometric frequency for ROM
  *Mf_ROM_min = Mf_low_22;
  // highest allowed geometric frequency for ROM is the one associated with the 55 mode
  *Mf_ROM_max = const_fmax_lm_v5hm[4] * Get_omegaQNM_SEOBNRv5(q, chi1, chi2, 5, 5) / (2.*LAL_PI);
 
  // Get SEOBNRv5_ROM ringdown frequency for 22 mode
  *Mf_final = SEOBNRROM_Ringdown_Mf_From_Mtot_Eta(*Mtot_sec, eta, chi1, chi2,
                                                  SEOBNRv5_ROM);
 
  return(XLAL_SUCCESS);
}
 
/**
 * Compute the 'time' elapsed in the ROM waveform from a given starting frequency until the ringdown.
 * Analogous of XLALSimIMRSEOBNRv4ROMTimeOfFrequency from LALSimIMRSEOBNRv4ROM.c
 *
 * The notion of elapsed 'time' (in seconds) is defined here as the difference of the
 * frequency derivative of the frequency domain phase between the ringdown frequency
 * and the starting frequency ('frequency' argument). This notion of time is similar to the
 * chirp time, but it includes both the inspiral and the merger ringdown part of SEOBNRv5_ROM.
 *
 * The SEOBNRv5_ROM ringdown frequency can be obtained by calling XLALSimInspiralGetFinalFreq().
 *
 */
int XLALSimIMRSEOBNRv5ROMTimeOfFrequency(
  REAL8 *t,         /**< Output: time (s) elapsed from starting frequency to ringdown */
  REAL8 frequency,  /**< Starting frequency (Hz) */
  REAL8 m1SI,       /**< Mass of companion 1 (kg) */
  REAL8 m2SI,       /**< Mass of companion 2 (kg) */
  REAL8 chi1,       /**< Dimensionless aligned component spin 1 */
  REAL8 chi2        /**< Dimensionless aligned component spin 2 */
)
{
  /* Internally we need m1 > m2, so change around if this is not the case */
  if (m1SI < m2SI) {
    // Swap m1 and m2
    double m1temp = m1SI;
    double chi1temp = chi1;
    m1SI = m2SI;
    chi1 = chi2;
    m2SI = m1temp;
    chi2 = chi1temp;
  }
 
  // Set up phase spline
  gsl_spline *spline_phi;
  gsl_interp_accel *acc_phi;
  double Mf_final, Mtot_sec;
  double Mf_ROM_min, Mf_ROM_max;
  double Mf = frequency * (m1SI + m2SI) * LAL_MTSUN_SI / LAL_MSUN_SI;
 
  int ret = SEOBNRv5ROMTimeFrequencySetup(&spline_phi, &acc_phi, &Mf_final,
                                          &Mtot_sec, m1SI, m2SI, chi1, chi2, Mf, 
                                          &Mf_ROM_min, &Mf_ROM_max);
  if(ret != 0)
    XLAL_ERROR(ret);
 
  // Time correction is t(f_final) = 1/(2pi) dphi/df (f_final)
  double t_corr = gsl_spline_eval_deriv(spline_phi, Mf_final, acc_phi) / (2*LAL_PI); // t_corr / M
  //XLAL_PRINT_INFO("t_corr[s] = %g\n", t_corr * Mtot_sec);
 
  if (Mf > Mf_ROM_max || Mf > Mf_final) {
    gsl_spline_free(spline_phi);
    gsl_interp_accel_free(acc_phi);
    XLAL_ERROR(XLAL_EDOM, "Frequency %g Hz (Mf=%g) is outside allowed range.\n"
               "Min / max / final Mf values are %g, %g, %g\n", frequency, Mf, Mf_ROM_min, Mf_ROM_max, Mf_final);
   }
 
  // Compute time relative to origin at merger
  double time_M = gsl_spline_eval_deriv(spline_phi, frequency * Mtot_sec, acc_phi) / (2*LAL_PI) - t_corr;
  // Add a minus factor to match SEOBNRv4_ROM conventions
  *t = -1. * time_M * Mtot_sec;
 
  gsl_spline_free(spline_phi);
  gsl_interp_accel_free(acc_phi);
 
  return(XLAL_SUCCESS);
}
 
/** @} */