org.jscience.mathematics.wavelet
Class DiscreteFunction

java.lang.Object
  extended by org.jscience.mathematics.wavelet.MultiscaleFunction
      extended by org.jscience.mathematics.wavelet.DiscreteFunction
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
SparseDiscreteFunction

public class DiscreteFunction
extends MultiscaleFunction
implements java.lang.Cloneable

This class is used to be able to mix the wavelet and other type of functions such as given signals.


Constructor Summary
protected DiscreteFunction()
          Creates a new DiscreteFunction object.
  DiscreteFunction(double[] v)
          Creates a new DiscreteFunction object.
 
Method Summary
 java.lang.Object clone()
          Return a copy of this object
 int dimension()
          Tells you how many samples you'll get from this function
 int dimension(int jfin)
          Tells you how many samples you'll get from this function (will not depend on the parameter)
 boolean equals(java.lang.Object a)
          Check if another object is equal to this DiscreteFunction object
 double[] evaluate()
          Return as an array the sampled values of the function
 double[] evaluate(int j1)
          Return as an array the sampled values of the function
 int getFilterType()
          This method is used to compute how the number of scaling functions changes from on scale to the other.
 double mass(double a, double b, int jfin)
          Compute the mass (integral)
 double norm()
          Compute the L2 norm of the signal
 double norm(int j)
          Compute the L2 norm of the function
 void normalize()
          Makes the L2 norm of the internal array equal to 1.
 void setData(double[] v)
          DOCUMENT ME!
 java.lang.String toString()
          Return a String representation of the object
 
Methods inherited from class org.jscience.mathematics.wavelet.MultiscaleFunction
mass
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DiscreteFunction

protected DiscreteFunction()
Creates a new DiscreteFunction object.


DiscreteFunction

public DiscreteFunction(double[] v)
Creates a new DiscreteFunction object.

Parameters:
v - DOCUMENT ME!
Method Detail

toString

public java.lang.String toString()
Return a String representation of the object

Specified by:
toString in class MultiscaleFunction
Returns:
DOCUMENT ME!

normalize

public void normalize()
Makes the L2 norm of the internal array equal to 1.


setData

public void setData(double[] v)
DOCUMENT ME!

Parameters:
v - DOCUMENT ME!

evaluate

public double[] evaluate()
Return as an array the sampled values of the function

Returns:
DOCUMENT ME!

equals

public boolean equals(java.lang.Object a)
Check if another object is equal to this DiscreteFunction object

Specified by:
equals in class MultiscaleFunction
Parameters:
a - DOCUMENT ME!
Returns:
DOCUMENT ME!

evaluate

public double[] evaluate(int j1)
Return as an array the sampled values of the function

Specified by:
evaluate in class MultiscaleFunction
Parameters:
j1 - number of iterations (doesn't do anything)
Returns:
DOCUMENT ME!

mass

public double mass(double a,
                   double b,
                   int jfin)
Compute the mass (integral)

Overrides:
mass in class MultiscaleFunction
Parameters:
a - left boundary of the interval
b - right boundary of the interval
jfin - number of iterations to consider (precision)
Returns:
DOCUMENT ME!

norm

public double norm()
Compute the L2 norm of the signal

Returns:
DOCUMENT ME!

norm

public double norm(int j)
Compute the L2 norm of the function

Parameters:
j - number of iterations
Returns:
DOCUMENT ME!

clone

public java.lang.Object clone()
Return a copy of this object

Overrides:
clone in class MultiscaleFunction
Returns:
DOCUMENT ME!

dimension

public int dimension(int jfin)
Tells you how many samples you'll get from this function (will not depend on the parameter)

Specified by:
dimension in class MultiscaleFunction
Parameters:
jfin - DOCUMENT ME!
Returns:
DOCUMENT ME!

dimension

public int dimension()
Tells you how many samples you'll get from this function

Specified by:
dimension in class MultiscaleFunction
Returns:
DOCUMENT ME!

getFilterType

public int getFilterType()
This method is used to compute how the number of scaling functions changes from on scale to the other. Basically, if you have k scaling function and a Filter of type t, you'll have 2k+t scaling functions at the next scale (dyadic case). Notice that this method assumes that one is working with the dyadic grid while the method "previousDimension" define in the interface "Filter" doesn't.

Specified by:
getFilterType in class MultiscaleFunction
Returns:
DOCUMENT ME!