PeakSignalToNoiseRatio.h
1 /*
2  * Medical Image Registration ToolKit (MIRTK)
3  *
4  * Copyright 2016 Imperial College London
5  * Copyright 2016 Andreas Schuh
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19 
20 #ifndef MIRTK_PeakSignalToNoiseRatio_H
21 #define MIRTK_PeakSignalToNoiseRatio_H
22 
23 #include "mirtk/SumOfSquaredIntensityDifferences.h"
24 
25 
26 namespace mirtk {
27 
28 
29 /**
30  * Peak signal to noise ratio of two registered images
31  */
33 {
34  mirtkEnergyTermMacro(PeakSignalToNoiseRatio, EM_PSNR);
35 
36  // ---------------------------------------------------------------------------
37  // Construction/Destruction
38 public:
39 
40  /// Constructor
41  PeakSignalToNoiseRatio(const char * = "");
42 
43  /// Copy constructor
45 
46  /// Assignment operator
48 
49  /// Destructor
51 
52  // ---------------------------------------------------------------------------
53  // Evaluation
54 protected:
55 
56  /// Evaluate similarity of images
57  virtual double Evaluate();
58 
59  // ---------------------------------------------------------------------------
60  // Debugging
61 public:
62 
63  /// Return unweighted and unnormalized raw energy term value
64  /// \remarks Use for progress reporting only.
65  virtual double RawValue(double) const;
66 
67 };
68 
69 
70 } // namespace mirtk
71 
72 #endif // MIRTK_PeakSignalToNoiseRatio_H
PeakSignalToNoiseRatio & operator=(const PeakSignalToNoiseRatio &)
Assignment operator.
Definition: IOConfig.h:41
virtual double Evaluate()
Evaluate similarity of images.
~PeakSignalToNoiseRatio()
Destructor.
PeakSignalToNoiseRatio(const char *="")
Constructor.
Peak signal-to-noise ratio.
Definition: EnergyMeasure.h:53