GiciAnalysis
Class ImageCompareSA

java.lang.Object
  extended by GiciAnalysis.ImageCompareSA

public class ImageCompareSA
extends java.lang.Object

This class receives two images and calculates its difference information (MSE and PSNR).

Version:
1.0
Author:
Group on Interactive Coding of Images (GICI)

Field Summary
(package private)  boolean[] equal
          Equality for each image component.
(package private)  long[] imagePixels
          Number of pixels encoded for the current mask.
(package private)  float[] mae
          Mean Absolute Error (MAE) for each image component.
(package private)  float[] me
          Mean Error (ME) for each image component.
(package private)  float[] mse
          Mean Squared Error (MSE) for each image component.
(package private)  float[] pae
          Peak Absolute Error (MAE) for each image component.
(package private)  float[] psnr
          Peak Signal to Noise Ratio (PSNR) for each image component.
(package private)  float[] rmse
          Root Mean Squared Error (MSE) for each image component.
(package private)  float[] snr
          Signal to Noise Ratio (PSNR) for each image component.
(package private)  boolean totalEQUAL
          Global equality of the image.
(package private)  float totalMAE
          Global Mean Absolute Error (MSE) of the image.
(package private)  float totalME
          Global Mean Error (MSE) of the image.
(package private)  float totalMSE
          Global Mean Squared Error (MSE) of the image.
(package private)  float totalPAE
          Global Peak Absolute Error (MSE) of the image.
(package private)  float totalPSNR
          Global Peak Signal to Noise Ratio (PSNR) of the image.
(package private)  float totalRMSE
          Global Root Mean Squared Error (MSE) of the image.
(package private)  float totalSNR
          Global Signal to Noise Ratio (PSNR) of the image.
 
Constructor Summary
ImageCompareSA(float[][][] image1, float[][][] image2, int[] pixelBitDepth, byte[][][] mask)
          Constructor that does all the operations to compare images.
 
Method Summary
 boolean[] getEQUAL()
           
 float[] getMAE()
           
 float[] getME()
           
 float[] getMSE()
           
 float[] getPAE()
           
 float[] getPSNR()
           
 float[] getRMSE()
           
 float[] getSNR()
           
 boolean getTotalEQUAL()
           
 float getTotalMAE()
           
 float getTotalME()
           
 float getTotalMSE()
           
 float getTotalPAE()
           
 float getTotalPSNR()
           
 float getTotalRMSE()
           
 float getTotalSNR()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mae

float[] mae
Mean Absolute Error (MAE) for each image component.

Only positive values allowed.


totalMAE

float totalMAE
Global Mean Absolute Error (MSE) of the image.

Only positive values allowed.


pae

float[] pae
Peak Absolute Error (MAE) for each image component.

Only positive values allowed.


totalPAE

float totalPAE
Global Peak Absolute Error (MSE) of the image.

Only positive values allowed.


mse

float[] mse
Mean Squared Error (MSE) for each image component.

Only positive values allowed.


totalMSE

float totalMSE
Global Mean Squared Error (MSE) of the image.

Only positive values allowed.


rmse

float[] rmse
Root Mean Squared Error (MSE) for each image component.

Only positive values allowed.


totalRMSE

float totalRMSE
Global Root Mean Squared Error (MSE) of the image.

Only positive values allowed.


me

float[] me
Mean Error (ME) for each image component.

All values allowed.


totalME

float totalME
Global Mean Error (MSE) of the image.

Only positive values allowed.


snr

float[] snr
Signal to Noise Ratio (PSNR) for each image component.

Only positive values allowed.


totalSNR

float totalSNR
Global Signal to Noise Ratio (PSNR) of the image.

Only positive values allowed.


psnr

float[] psnr
Peak Signal to Noise Ratio (PSNR) for each image component.

Only positive values allowed.


totalPSNR

float totalPSNR
Global Peak Signal to Noise Ratio (PSNR) of the image.

Only positive values allowed.


equal

boolean[] equal
Equality for each image component.

True or false.


totalEQUAL

boolean totalEQUAL
Global equality of the image.

True or false.


imagePixels

long[] imagePixels
Number of pixels encoded for the current mask.

Only positive values allowed.

Constructor Detail

ImageCompareSA

public ImageCompareSA(float[][][] image1,
                      float[][][] image2,
                      int[] pixelBitDepth,
                      byte[][][] mask)
               throws WarningException
Constructor that does all the operations to compare images.

Parameters:
image1 - a 3D float array of image samples (index are [z][y][x])
image2 - a 3D float array of image samples (index are [z][y][x])
pixelBitDepth - number of bits for the specified image sample type (for each component)
Throws:
WarningException - when image sizes are not the same
Method Detail

getMAE

public float[] getMAE()
Returns:
mae definition in this class

getTotalMAE

public float getTotalMAE()
Returns:
totalMAE definition in this class

getPAE

public float[] getPAE()
Returns:
pae definition in this class

getTotalPAE

public float getTotalPAE()
Returns:
totalPAE definition in this class

getMSE

public float[] getMSE()
Returns:
mse definition in this class

getTotalMSE

public float getTotalMSE()
Returns:
totalMSE definition in this class

getRMSE

public float[] getRMSE()
Returns:
rmse definition in this class

getTotalRMSE

public float getTotalRMSE()
Returns:
totalRMSE definition in this class

getME

public float[] getME()
Returns:
me definition in this class

getTotalME

public float getTotalME()
Returns:
totalME definition in this class

getSNR

public float[] getSNR()
Returns:
snr definition in this class

getTotalSNR

public float getTotalSNR()
Returns:
totalSNR definition in this class

getPSNR

public float[] getPSNR()
Returns:
psnr definition in this class

getTotalPSNR

public float getTotalPSNR()
Returns:
totalPSNR definition in this class

getEQUAL

public boolean[] getEQUAL()
Returns:
equal definition in this class

getTotalEQUAL

public boolean getTotalEQUAL()
Returns:
totalEQUAL definition in this class


TER - Copyright (C) 2006
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.

Group on Interactive Coding of Images (GICI) - UAB (Spain)