ctbutterfly.cpp
29.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
/***************************************************************************
* ctbutterfly - butterfly calculation tool *
* ----------------------------------------------------------------------- *
* copyright (C) 2014-2017 by Michael Mayer *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file ctbutterfly.cpp
* @brief Butterfly computation tool
* @author Michael Mayer
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <cstdio>
#include <fstream>
#include "ctbutterfly.hpp"
#include "GTools.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_GET_PARAMETERS "ctbutterfly::get_parameters()"
#define G_SAVE "ctbutterfly::save()"
#define G_CHECK_MODEL "ctbutterfly::check_model()"
/* __ Debug definitions __________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
ctbutterfly::ctbutterfly(void) : ctlikelihood(CTBUTTERFLY_NAME, VERSION)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Observations constructor
*
* param[in] obs Observation container.
*
* This method creates an instance of the class by copying an existing
* observations container.
***************************************************************************/
ctbutterfly::ctbutterfly(const GObservations& obs) :
ctlikelihood(CTBUTTERFLY_NAME, VERSION, obs)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Command line constructor
*
* @param[in] argc Number of arguments in command line.
* @param[in] argv Array of command line arguments.
***************************************************************************/
ctbutterfly::ctbutterfly(int argc, char *argv[]) :
ctlikelihood(CTBUTTERFLY_NAME, VERSION, argc, argv)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] app Application.
***************************************************************************/
ctbutterfly::ctbutterfly(const ctbutterfly& app) : ctlikelihood(app)
{
// Initialise members
init_members();
// Copy members
copy_members(app);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
ctbutterfly::~ctbutterfly(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] app Application.
* @return Application.
***************************************************************************/
ctbutterfly& ctbutterfly::operator=(const ctbutterfly& app)
{
// Execute only if object is not identical
if (this != &app) {
// Copy base class members
this->ctlikelihood::operator=(app);
// Free members
free_members();
// Initialise members
init_members();
// Copy members
copy_members(app);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear ctbutterfly tool
*
* Clears ctbutterfly tool.
***************************************************************************/
void ctbutterfly::clear(void)
{
// Free members
free_members();
this->ctlikelihood::free_members();
this->ctobservation::free_members();
this->ctool::free_members();
// Clear base class (needed to conserve tool name and version)
this->GApplication::clear();
// Initialise members
this->ctool::init_members();
this->ctobservation::init_members();
this->ctlikelihood::init_members();
init_members();
// Write header into logger
log_header();
// Return
return;
}
/***********************************************************************//**
* @brief Computes the butterfly
*
* This method takes the spectral fit and its covariance matrix to compute
* the confidence band via Gaussian error propagation
***************************************************************************/
void ctbutterfly::run(void)
{
// If we're in debug mode then all output is also dumped on the screen
if (logDebug()) {
log.cout(true);
}
// Get task parameters
get_parameters();
// Set energy dispersion flag for all CTA observations and save old
// values in save_edisp vector
std::vector<bool> save_edisp;
save_edisp.assign(m_obs.size(), false);
for (int i = 0; i < m_obs.size(); ++i) {
GCTAObservation* obs = dynamic_cast<GCTAObservation*>(m_obs[i]);
if (obs != NULL) {
save_edisp[i] = obs->response()->apply_edisp();
obs->response()->apply_edisp(m_apply_edisp);
}
}
// Write input observation container into logger
log_observations(NORMAL, m_obs, "Input observation");
// If fit is selected then do maximum likelihood fit
if (m_fit) {
// Write header into logger
log_header1(TERSE, "Compute best-fit likelihood");
// Optimize and compute errors
m_obs.optimize(m_opt);
m_obs.errors(m_opt);
// Get covariance matrix.
GObservations::likelihood likelihood = m_obs.function();
if (m_method == "GAUSSIAN") {
m_covariance = likelihood.curvature()->invert();
}
else {
m_covariance = likelihood.covariance();
}
// Write optimizer, optimised model and covariance matrix into logger
log_string(NORMAL, m_opt.print(m_chatter));
log_string(NORMAL, m_obs.models().print(m_chatter));
log_string(EXPLICIT, m_covariance.print(m_chatter));
} // endif: fit selected
// Get model instance for further computations
GModels models = m_obs.models();
// If no fit is selected and no covariance matrix has been specified
// then compute now the covariance matrix
if (!m_fit && m_covariance.size() == 0) {
// Write header into logger
log_header1(TERSE, "Compute covariance matrix");
// Evaluate curvature matrix at the actual parameters
GOptimizerPars pars = models.pars();
GObservations::likelihood likelihood = m_obs.function();
likelihood.eval(pars);
// Get covariance matrix.
if (m_method == "GAUSSIAN") {
m_covariance = likelihood.curvature()->invert();
}
else {
m_covariance = likelihood.covariance();
}
// Write covariance matrix into logger
log_string(EXPLICIT, m_covariance.print(m_chatter));
} // endif: covariance computation needed
// Compute butterfly depending on selected method
if (m_method == "GAUSSIAN") {
gaussian_error_propagation(models);
}
else {
ellipsoid_boundary(models);
}
// Write header into logger
log_header1(TERSE, "Results");
// Show results
for (int k = 0; k < m_ebounds.size(); ++k) {
// Write results into logger
log_value(NORMAL, "Intensity at "+gammalib::str(m_energies[k])+" MeV",
gammalib::str(m_intensities[k])+" ("+
gammalib::str(m_min_intensities[k])+", "+
gammalib::str(m_max_intensities[k])+") ph/cm2/s/MeV");
} //endfor: loop over energy bin
// Restore energy dispersion flag for all CTA observations
for (int i = 0; i < m_obs.size(); ++i) {
GCTAObservation* obs = dynamic_cast<GCTAObservation*>(m_obs[i]);
if (obs != NULL) {
obs->response()->apply_edisp(save_edisp[i]);
}
}
// Return
return;
}
/***********************************************************************//**
* @brief Save butterfly diagram
*
* Saves the butterfly diagram into an ascii file using a column separated
* value (CSV) format with blanks as separators.
***************************************************************************/
void ctbutterfly::save(void)
{
// Write header into logger
log_header1(TERSE, "Save Butterfly diagram");
// Get output filename
m_outfile = (*this)["outfile"].filename();
// Save only if filename is non-empty
if (!m_outfile.is_empty()) {
// Log butterfly diagram file name
log_value(NORMAL, "Butterfly file", m_outfile.url());
// Create CSV table with 4 columns
GCsv table(m_energies.size(), 4);
// Fill CSV table
for (int i = 0; i < m_energies.size(); ++i) {
table.real(i, 0, m_energies[i]);
table.real(i, 1, m_intensities[i]);
table.real(i, 2, m_min_intensities[i]);
table.real(i, 3, m_max_intensities[i]);
}
// Save CSV table
table.save(m_outfile.url(), " ", clobber());
}
// Return
return;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void ctbutterfly::init_members(void)
{
// Initialise members
m_srcname.clear();
m_method.clear();
m_confidence = 0.68;
m_max_iter = 50;
m_apply_edisp = false;
m_fit = false;
m_chatter = static_cast<GChatter>(2);
m_ebounds.clear();
m_outfile.clear();
// Initialise protected members
m_covariance.clear();
m_energies.clear();
m_intensities.clear();
m_min_intensities.clear();
m_max_intensities.clear();
// Set optimizer parameters
m_opt.max_iter(m_max_iter);
m_opt.max_stalls(10);
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] app Application.
***************************************************************************/
void ctbutterfly::copy_members(const ctbutterfly& app)
{
// Copy attributes
m_srcname = app.m_srcname;
m_method = app.m_method;
m_confidence = app.m_confidence;
m_max_iter = app.m_max_iter;
m_apply_edisp = app.m_apply_edisp;
m_fit = app.m_fit;
m_chatter = app.m_chatter;
m_ebounds = app.m_ebounds;
m_outfile = app.m_outfile;
// Copy protected members
m_covariance = app.m_covariance;
m_energies = app.m_energies;
m_intensities = app.m_intensities;
m_min_intensities = app.m_min_intensities;
m_max_intensities = app.m_max_intensities;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void ctbutterfly::free_members(void)
{
// Return
return;
}
/***********************************************************************//**
* @brief Get application parameters
*
* @exception GException::feature_not_implemented
* Loading of covariance matrix is not yet implemented.
*
* Get all task parameters from parameter file or (if required) by querying
* the user. Most parameters are only required if no observation exists so
* far in the observation container. In this case, a single CTA observation
* will be added to the container, using the definition provided in the
* parameter file.
***************************************************************************/
void ctbutterfly::get_parameters(void)
{
// Setup observations from "inobs" parameter
setup_observations(m_obs);
// Setup models from "inmodel" parameter
setup_models(m_obs, (*this)["srcname"].string());
// Get name of test source
m_srcname = (*this)["srcname"].string();
// Create energy boundaries from user parameters
m_ebounds = create_ebounds();
// Get matrix file name and load if possible
std::string matrixfilename = (*this)["matrix"].filename();
if (matrixfilename != "NONE") {
std::string msg = "Loading of matrix from file not implemented yet. "
"Use filename = \"NONE\" to induce a recomputation of "
"the matrix internally.";
throw GException::feature_not_implemented(G_GET_PARAMETERS, msg);
// m_covariance.load(matrixfilename);
}
// Get remaining parameters
m_apply_edisp = (*this)["edisp"].boolean();
m_method = (*this)["method"].string();
m_confidence = (*this)["confidence"].real();
m_fit = (*this)["fit"].boolean();
m_chatter = static_cast<GChatter>((*this)["chatter"].integer());
// Check model name and type
check_model();
// Optionally read ahead parameters so that they get correctly
// dumped into the log file
if (read_ahead()) {
m_outfile = (*this)["outfile"].filename();
}
// Write parameters into logger
log_parameters(TERSE);
// Return
return;
}
/***********************************************************************//**
* @brief Compute butterfly using the ellipsoid boundary method
***************************************************************************/
void ctbutterfly::ellipsoid_boundary(GModels& models)
{
// Write header into logger
log_header1(TERSE, "Prepare butterfly computation");
// Find parameter indices. We do this by the memory location of the
// model parameters.
GModelSky* skymodel = dynamic_cast<GModelSky*>(models[m_srcname]);
GModelPar* par_prefactor = &(*skymodel)["Prefactor"];
GModelPar* par_index = &(*skymodel)["Index"];
int inx_prefactor = -1;
int inx_index = -1;
for (int i = 0; i < models.npars(); ++i) {
if (models.pars()[i] == par_prefactor) {
inx_prefactor = i;
}
if (models.pars()[i] == par_index) {
inx_index = i;
}
}
// Store model values
double prefactor_mean = (*skymodel)["Prefactor"].value();
double index_mean = (*skymodel)["Index"].value();
double pivot_mean = (*skymodel)["PivotEnergy"].value();
double prefactor_scale = (*skymodel)["Prefactor"].scale();
double index_scale = (*skymodel)["Index"].scale();
GEnergy pivot(pivot_mean, "MeV");
// Write parameter indices into logger
log_value(NORMAL, "Prefactor", gammalib::str(prefactor_mean)+
" ph/cm2/s/MeV ("+
gammalib::str(inx_prefactor)+")");
log_value(NORMAL, "Index", gammalib::str(index_mean)+
" ("+gammalib::str(inx_index)+")");
log_value(NORMAL, "Pivot energy", pivot.print());
// Extract covariance elements
double cov_pp = m_covariance(inx_prefactor,inx_prefactor);
double cov_pg = m_covariance(inx_prefactor,inx_index);
double cov_gg = m_covariance(inx_index,inx_index);
// Compute eigenvectors and eigenvalues
double lambda1;
double lambda2;
GVector vector1(2);
GVector vector2(2);
eigenvectors(cov_pp, cov_pg, cov_pg, cov_gg,
&lambda1, &lambda2, &vector1, &vector2);
// Write eigenvectors and eigenvalues into logger
log_value(NORMAL, "Eigenvalue 1", lambda1);
log_value(NORMAL, "Eigenvalue 2", lambda2);
log_value(NORMAL, "Eigenvector 1", vector1.print());
log_value(NORMAL, "Eigenvector 2", vector2.print());
// Confidence scaling, calculated from a Chi-Sqr.
// distribution with 2 dof
double scale = std::sqrt( -2. * std::log(1.-m_confidence) );
// Write confidence level information into logger
log_value(NORMAL, "Confidence level", m_confidence);
log_value(NORMAL, "Corresponding scaling", scale);
// Compute minor and major axes of error ellipse
double major = scale*std::sqrt(lambda1);
double minor = scale*std::sqrt(lambda2);
// Write header into logger
log_header1(TERSE, "Generate butterfly");
// Initialise result arrays
m_energies.assign(m_ebounds.size(), 0.0);
m_intensities.assign(m_ebounds.size(), 0.0);
m_min_intensities.assign(m_ebounds.size(), 1e30);
m_max_intensities.assign(m_ebounds.size(), 0.0);
// Walk around the error ellipse
int nt = 360;
double dt = gammalib::twopi/double(nt);
double t = 0.0;
for (int i = 0; i < nt; ++i, t += dt) {
// Pre-compute sin and cosine
double sin_t = std::sin(t);
double cos_t = std::cos(t);
// Compute prefactor and index
double prefactor = (major * cos_t * vector1[0] +
minor * sin_t * vector2[0]) * prefactor_scale +
prefactor_mean;
double index = (major * cos_t * vector1[1] +
minor * sin_t * vector2[1]) * index_scale +
index_mean;
// Write prefactor and index into logger
log_value(EXPLICIT, "Angle "+gammalib::str(t*gammalib::rad2deg),
gammalib::str(prefactor)+" ph/cm2/s/MeV; "+
gammalib::str(index));
// Setup power law model
GModelSpectralPlaw plaw(prefactor, index, pivot);
// Evaluate power law at each energy and extract minimum and
// maximum intensity
for (int k = 0; k < m_ebounds.size(); ++k) {
// Get the energy of current bin
GTime time;
GEnergy energy = m_ebounds.elogmean(k);
// Evaluate power law
double intensity = plaw.eval(energy, time);
// Get extremes
if (intensity < m_min_intensities[k]) {
m_min_intensities[k] = intensity;
}
if (intensity > m_max_intensities[k]) {
m_max_intensities[k] = intensity;
}
} // endfor: looped over all energies
} // endfor: looped over all angles
// Setup power law model for mean prefactor and index
GModelSpectralPlaw plaw(prefactor_mean, index_mean, pivot);
// Compute energy and intensity vectors for mean power law
for (int k = 0; k < m_ebounds.size(); ++k) {
// Get the energy of current bin
GTime time;
GEnergy energy = m_ebounds.elogmean(k);
// Evaluate power law
double intensity = plaw.eval(energy, time);
// Store results
m_energies[k] = energy.MeV();
m_intensities[k] = intensity;
} // endfor: looped over energies
// Return
return;
}
/***********************************************************************//**
* @brief Compute butterfly using Gaussian error propagation
*
* Computes the butterfly diagram using Gaussian error propagation. This
* works for any kind of model.
***************************************************************************/
void ctbutterfly::gaussian_error_propagation(GModels& models)
{
// Write header into logger
log_header1(TERSE, "Prepare butterfly computation");
// Confidence scaling
double scale = gammalib::erfinv(m_confidence) * gammalib::sqrt_two;
// Write confidence level information into logger
log_value(NORMAL, "Confidence level", m_confidence);
log_value(NORMAL, "Corresponding scaling", scale);
// Write header into logger
log_header1(TERSE, "Generate butterfly");
// Initialise result arrays
m_energies.clear();
m_intensities.clear();
m_min_intensities.clear();
m_max_intensities.clear();
// Initialise dummy time to evaluate spectral model
GTime time = GTime();
// Initialise vector of gradients
GVector grad = GVector(m_obs.models().npars());
// Loop over energy bins
for (int i = 0; i < m_ebounds.size(); ++i) {
// Initialise number of gradients
int num_gradient = 0;
// Get the mean logarithmic energy of current bin
GEnergy energy = m_ebounds.elogmean(i);
// Initialise model flux value
double model_flux = 0.0;
// Loop over models
for (int j = 0; j < models.size(); ++j) {
// Check wether model is a skymodel
GModelSky* skymodel = dynamic_cast<GModelSky*>(models[j]);
// Yes ...
if (skymodel != NULL) {
// Set flux value of source of interest, evaluate gradients
if (skymodel->name() == m_srcname) {
// Get spectral component of model
GModelSpectral *spectral = skymodel->spectral();
// Get model flux
model_flux = spectral->eval(energy, time, true);
// Loop over all model parameters
for (int k = 0; k < skymodel->size(); ++k) {
// Set gradient if we deal with spectral component
bool parIsSpectral = false;
for (int l = 0; l < spectral->size(); ++l) {
if ((&((*spectral)[l])) == (&((*skymodel)[k]))) {
grad[num_gradient] = (*spectral)[l].gradient();
num_gradient++;
parIsSpectral = true;
break;
}
} // endfor: looped over spectral parameters
// If parameter is spatial or temporal, count up
if (!parIsSpectral) {
num_gradient++;
}
} // endfor: looped over all model parameters
} // endif: model was source of interest
else {
num_gradient += skymodel->size();
}
} // endif: model was sky model
// Skip other models (e.g. GModelData instances)
else {
num_gradient += models[j]->size();
}
} // endfor: Looped over models
// Multiply covariance to the gradient vector
GVector vector = m_covariance * grad;
// Get the error from the scalar product
double error = std::sqrt(grad * vector);
// Multiply with confidence scaling
error *= scale;
// Store flux, value and energy for saving
m_intensities.push_back(model_flux);
m_energies.push_back(energy.MeV());
m_min_intensities.push_back(model_flux-error);
m_max_intensities.push_back(model_flux+error);
} // endfor: Looped over energy bins
// Return
return;
}
/***********************************************************************//**
* @brief Check if sky model is valid
*
* @exception GException::invalid_value
* Did not find a valid model
*
* Checks whether the specified sky model exists and whether it is a power
* law.
***************************************************************************/
void ctbutterfly::check_model(void)
{
// Continue only if source model exists
if (m_obs.models().contains(m_srcname)) {
// Get relevant model and parameter for upper limit computation.
GModels& models = const_cast<GModels&>(m_obs.models());
GModelSky* model = dynamic_cast<GModelSky*>(models[m_srcname]);
if (model == NULL) {
std::string msg = "Source \""+m_srcname+"\" is not a sky model. "
"Please specify the name of a sky model for "
"butterfly computation.";
throw GException::invalid_value(G_CHECK_MODEL, msg);
}
// Check that the spectral model is a power law for the "ENVELOPE"
// method
if (m_method == "ENVELOPE") {
if (model->spectral()->type() != "PowerLaw") {
std::string msg = "\""+model->spectral()->type()+"\" cannot be "
"used as spectral model for an butterfly "
"computation with method=ENVELOPE. Please "
"specify a power law model or switch to "
"method=GAUSSIAN.";
throw GException::invalid_value(G_CHECK_MODEL, msg);
}
}
} // endif: source model existed
// Otherwise throw an exception
else {
std::string msg = "Source \""+m_srcname+"\" not found in model "
"container. Please add a source with that name "
"or check for possible typos.";
throw GException::invalid_value(G_CHECK_MODEL, msg);
}
// Return
return;
}
/***********************************************************************//**
* @brief Compute normalized eigenvectors and eigenvalues
*
* @param[in] a Covariance matrix element (0,0)
* @param[in] b Covariance matrix element (0,1)
* @param[in] c Covariance matrix element (1,0)
* @param[in] d Covariance matrix element (1,1)
* @param[out] lambda1 First eigenavlue
* @param[out] lambda2 Second eigenavlue
* @param[out] vector1 First eigenvector (normalized)
* @param[out] vector2 Second eigenvector (normalized)
*
* Computes the eigenvalues and eigenvectors for a 2x2 matrix. See
* http://www.math.harvard.edu/archive/21b_fall_04/exhibits/2dmatrices/index.html
***************************************************************************/
void ctbutterfly::eigenvectors(const double& a,
const double& b,
const double& c,
const double& d,
double* lambda1,
double* lambda2,
GVector* vector1,
GVector* vector2)
{
// Compute trace and determinant
double trace = a + d;
double det = a*d - b*c;
// Compute eigenvalues
double arg1 = 0.5*trace;
double arg2 = std::sqrt(0.25*trace*trace - det);
*lambda1 = arg1 + arg2;
*lambda2 = arg1 - arg2;
// Compute eigenvectors
if (c != 0.0) {
(*vector1)[0] = *lambda1 - det;
(*vector1)[1] = c;
(*vector2)[0] = *lambda2 - det;
(*vector2)[1] = c;
}
else if (b != 0.0) {
(*vector1)[0] = b;
(*vector1)[1] = *lambda1 - a;
(*vector2)[0] = b;
(*vector2)[1] = *lambda2 - a;
}
else {
(*vector1)[0] = 1.0;
(*vector1)[1] = 0.0;
(*vector2)[0] = 0.0;
(*vector2)[1] = 1.0;
}
// Normalize eigenvectors
*vector1 /= norm(*vector1);
*vector2 /= norm(*vector2);
// Return
return;
}