@@ -14,8 +14,7 @@ namespace fast {
1414 * Multi-channel images and 3D images are supported. In this case an SSIM value is calculated per channel, and the
1515 * final SSIM value is the average of all channel SSIM values.
1616 *
17- * No image cropping is performed when calculating SSIM, out of bounds pixels are handled using mirrored repeat.
18- * Note that other SSIM implementations may crop the image which can result in different SSIM values.
17+ * No image cropping is performed when calculating SSIM, out of bounds pixels in the Gaussian window are handled using mirrored repeat.
1918 *
2019 * Inputs:
2120 * - 0: Image
@@ -36,8 +35,8 @@ class FAST_EXPORT StructuralSimilarityIndexMeasure : public ProcessObject {
3635 * @brief Create instance
3736 * @param maxValue Maximum possible intensity value
3837 * @param minValue Minimum possible intensity value
39- * @param windowSize Size of Gaussian window
40- * @param stdDev Standard deviation of Gaussian window
38+ * @param windowSize Size of Gaussian window (in pixels) for each dimension
39+ * @param stdDev Standard deviation of Gaussian window (in pixels) for each dimension
4140 * @param k1 Algorithm constant
4241 * @param k2 Algorithm constant
4342 * @return instance
@@ -55,7 +54,15 @@ class FAST_EXPORT StructuralSimilarityIndexMeasure : public ProcessObject {
5554 * @return
5655 */
5756 float get () const ;
57+ /* *
58+ * @brief Set standard deviation of Gaussian window
59+ * @param stdDev Standard deviation for each dimension
60+ */
5861 void setStandardDeviation (Vector3f stdDev);
62+ /* *
63+ * @brief Set size (in pixels) of Gaussian window
64+ * @param size Size for each dimension
65+ */
5966 void setWindowSize (Vector3i size);
6067 private:
6168 StructuralSimilarityIndexMeasure () {};
0 commit comments