|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectucar.jpeg.jj2000.j2k.wavelet.analysis.AnWTFilter
public abstract class AnWTFilter
This abstract class defines the methods of all analysis wavelet filters. Specialized abstract classes that work on particular data types (int, float) provide more specific method calls while retaining the generality of this one. See the AnWTFilterInt and AnWTFilterFloat classes. Implementations of analysis filters should inherit from one of those classes.
All analysis wavelet filters should follow the following conventions:
AnWTFilterInt
,
AnWTFilterFloat
Field Summary | |
---|---|
static char |
OPT_PREFIX
The prefix for wavelet filter options: 'F' |
Fields inherited from interface ucar.jpeg.jj2000.j2k.wavelet.WaveletFilter |
---|
WT_FILTER_FLOAT_CONVOL, WT_FILTER_FLOAT_LIFT, WT_FILTER_INT_LIFT |
Constructor Summary | |
---|---|
AnWTFilter()
|
Method Summary | |
---|---|
abstract void |
analyze_hpf(Object inSig,
int inOff,
int inLen,
int inStep,
Object lowSig,
int lowOff,
int lowStep,
Object highSig,
int highOff,
int highStep)
Filters the input signal by this analysis filter, decomposing it in a low-pass and a high-pass signal. |
abstract void |
analyze_lpf(Object inSig,
int inOff,
int inLen,
int inStep,
Object lowSig,
int lowOff,
int lowStep,
Object highSig,
int highOff,
int highStep)
Filters the input signal by this analysis filter, decomposing it in a low-pass and a high-pass signal. |
abstract int |
getFilterType()
Returns the type of filter used according to the FilterTypes interface. |
abstract float[] |
getHPSynthesisFilter()
Returns the time-reversed high-pass synthesis waveform of the filter, which is the high-pass filter. |
float[] |
getHPSynWaveForm(float[] in,
float[] out)
Returns the equivalent high-pass synthesis waveform of a cascade of filters, given the syhthesis waveform of the previous stage. |
abstract float[] |
getLPSynthesisFilter()
Returns the time-reversed low-pass synthesis waveform of the filter, which is the low-pass filter. |
float[] |
getLPSynWaveForm(float[] in,
float[] out)
Returns the equivalent low-pass synthesis waveform of a cascade of filters, given the syhthesis waveform of the previous stage. |
static String[][] |
getParameterInfo()
Returns the parameters that are used in this class and implementing classes. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface ucar.jpeg.jj2000.j2k.wavelet.WaveletFilter |
---|
getAnHighNegSupport, getAnHighPosSupport, getAnLowNegSupport, getAnLowPosSupport, getDataType, getImplType, getSynHighNegSupport, getSynHighPosSupport, getSynLowNegSupport, getSynLowPosSupport, isReversible, isSameAsFullWT |
Field Detail |
---|
public static final char OPT_PREFIX
Constructor Detail |
---|
public AnWTFilter()
Method Detail |
---|
public abstract void analyze_lpf(Object inSig, int inOff, int inLen, int inStep, Object lowSig, int lowOff, int lowStep, Object highSig, int highOff, int highStep)
The input signal resides in the inSig array. The index of the first sample to filter (i.e. that will generate the first low-pass output sample) is given by inOff. The number of samples to filter is given by inLen. This array must be of the same type as the one for which the particular implementation works with (which is returned by the getDataType() method).
The input signal can be interleaved with other signals in the same inSig array, and this is determined by the inStep argument. This means that the first sample of the input signal is inSig[inOff], the second is inSig[inOff+inStep], the third is inSig[inOff+2*inStep], and so on. Therefore if inStep is 1 there is no interleaving. This feature allows to filter columns of a 2-D signal, when it is stored in a line by line order in inSig, without having to copy the data, in this case the inStep argument should be the line width.
This method also allows to apply the analysis wavelet filter by parts in the input signal using an overlap and thus producing the same coefficients at the output. The tailOvrlp argument specifies how many samples in the input signal, before the first one to be filtered, can be used for overlap. Then, the filter instead of extending the input signal will use those samples to calculate the first output samples. The argument tailOvrlp can be 0 for no overlap, or some value that provides partial or full overlap. There should be enough samples in the input signal, before the first sample to be filtered, to support the overlap. The headOvrlp provides the same functionality but at the end of the input signal. The inStep argument also applies to samples used for overlap. This overlap feature can be used for line-based wavelet transforms (in which case it will only be used when filtering the columns) or for overlapping block-based wavelet transforms (in which case it will be used when filtering lines and columns).
The low-pass output signal is placed in the lowSig array. The lowOff and lowStep arguments are analogous to the inOff and inStep ones, but they apply to the lowSig array. The lowSig array must be long enough to hold the low-pass output signal.
The high-pass output signal is placed in the highSig array. The highOff and highStep arguments are analogous to the inOff and inStep ones, but they apply to the highSig array. The highSig array must be long enough to hold the high-pass output signal.
inSig
- This is the array that contains the input signal. It must
be of the correct type (e.g., it must be int[] if getDataType() returns
TYPE_INT).inOff
- This is the index in inSig of the first sample to filter.inLen
- This is the number of samples in the input signal to
filter.inStep
- This is the step, or interleave factor, of the input
signal samples in the inSig array. See above.tailOvrlp
- This is the number of samples in the input signal
before the first sample to filter that can be used for overlap. See
above.headOvrlp
- This is the number of samples in the input signal
after the last sample to filter that can be used for overlap. See
above.lowSig
- This is the array where the low-pass output signal is
placed. It must be of the same type as inSig and it should be long
enough to contain the output signal.lowOff
- This is the index in lowSig of the element where to put
the first low-pass output sample.lowStep
- This is the step, or interleave factor, of the low-pass
output samples in the lowSig array. See above.highSig
- This is the array where the high-pass output signal is
placed. It must be of the same type as inSig and it should be long
enough to contain the output signal.highOff
- This is the index in highSig of the element where to put
the first high-pass output sample.highStep
- This is the step, or interleave factor, of the
high-pass output samples in the highSig array. See above.WaveletFilter.getDataType()
public abstract void analyze_hpf(Object inSig, int inOff, int inLen, int inStep, Object lowSig, int lowOff, int lowStep, Object highSig, int highOff, int highStep)
The input signal resides in the inSig array. The index of the first sample to filter (i.e. that will generate the first high-pass output sample) is given by inOff. The number of samples to filter is given by inLen. This array must be of the same type as the one for which the particular implementation works with (which is returned by the getDataType() method).
The input signal can be interleaved with other signals in the same inSig array, and this is determined by the inStep argument. This means that the first sample of the input signal is inSig[inOff], the second is inSig[inOff+inStep], the third is inSig[inOff+2*inStep], and so on. Therefore if inStep is 1 there is no interleaving. This feature allows to filter columns of a 2-D signal, when it is stored in a line by line order in inSig, without having to copy the data, in this case the inStep argument should be the line width.
The low-pass output signal is placed in the lowSig array. The lowOff and lowStep arguments are analogous to the inOff and inStep ones, but they apply to the lowSig array. The lowSig array must be long enough to hold the low-pass output signal.
The high-pass output signal is placed in the highSig array. The highOff and highStep arguments are analogous to the inOff and inStep ones, but they apply to the highSig array. The highSig array must be long enough to hold the high-pass output signal.
inSig
- This is the array that contains the input signal. It must
be of the correct type (e.g., it must be int[] if getDataType() returns
TYPE_INT).inOff
- This is the index in inSig of the first sample to filter.inLen
- This is the number of samples in the input signal to
filter.inStep
- This is the step, or interleave factor, of the input
signal samples in the inSig array. See above.lowSig
- This is the array where the low-pass output signal is
placed. It must be of the same type as inSig and it should be long
enough to contain the output signal.lowOff
- This is the index in lowSig of the element where to put
the first low-pass output sample.lowStep
- This is the step, or interleave factor, of the low-pass
output samples in the lowSig array. See above.highSig
- This is the array where the high-pass output signal is
placed. It must be of the same type as inSig and it should be long
enough to contain the output signal.highOff
- This is the index in highSig of the element where to put
the first high-pass output sample.highStep
- This is the step, or interleave factor, of the
high-pass output samples in the highSig array. See above.WaveletFilter.getDataType()
public abstract float[] getLPSynthesisFilter()
The returned array may not be modified (i.e. a reference to the internal array may be returned by the implementation of this method).
public abstract float[] getHPSynthesisFilter()
The returned array may not be modified (i.e. a reference to the internal array may be returned by the implementation of this method).
public float[] getLPSynWaveForm(float[] in, float[] out)
The length of the low-pass synthesis filter is getSynLowNegSupport()+getSynLowPosSupport().
in
- The synthesis waveform of the previous stage.out
- If non-null this array is used to store the resulting
signal. It must be long enough, or an IndexOutOfBoundsException is
thrown.WaveletFilter.getSynLowNegSupport()
,
WaveletFilter.getSynLowPosSupport()
public float[] getHPSynWaveForm(float[] in, float[] out)
The length of the high-pass synthesis filter is getSynHighNegSupport()+getSynHighPosSupport().
in
- The synthesis waveform of the previous stage.out
- If non-null this array is used to store the resulting
signal. It must be long enough, or an IndexOutOfBoundsException is
thrown.WaveletFilter.getSynHighNegSupport()
,
WaveletFilter.getSynHighPosSupport()
public abstract int getFilterType()
FilterTypes
public static String[][] getParameterInfo()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |