Class AnWTFilterIntLift5x3

  • All Implemented Interfaces:
    WaveletFilter

    public class AnWTFilterIntLift5x3
    extends AnWTFilterInt
    This class inherits from the analysis wavelet filter definition for int data. It implements the forward wavelet transform specifically for the 5x3 filter. The implementation is based on the lifting scheme.

    See the AnWTFilter class for details such as normalization, how to split odd-length signals, etc. In particular, this method assumes that the low-pass coefficient is computed first.

    See Also:
    AnWTFilter, AnWTFilterInt
    • Constructor Detail

      • AnWTFilterIntLift5x3

        public AnWTFilterIntLift5x3()
    • Method Detail

      • analyze_lpf

        public void analyze_lpf​(int[] inSig,
                                int inOff,
                                int inLen,
                                int inStep,
                                int[] lowSig,
                                int lowOff,
                                int lowStep,
                                int[] highSig,
                                int highOff,
                                int highStep)
        An implementation of the analyze_lpf() method that works on int data, for the forward 5x3 wavelet transform using the lifting scheme. See the general description of the analyze_lpf() method in the AnWTFilter class for more details.

        The coefficients of the first lifting step are [-1/2 1 -1/2].

        The coefficients of the second lifting step are [1/4 1 1/4].

        Specified by:
        analyze_lpf in class AnWTFilterInt
        Parameters:
        inSig - This is the array that contains the input signal.
        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.
        lowSig - This is the array where the low-pass output signal is placed.
        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.
        highSig - This is the array where the high-pass output signal is placed.
        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 Also:
        AnWTFilter.analyze_lpf(java.lang.Object, int, int, int, java.lang.Object, int, int, java.lang.Object, int, int)
      • analyze_hpf

        public void analyze_hpf​(int[] inSig,
                                int inOff,
                                int inLen,
                                int inStep,
                                int[] lowSig,
                                int lowOff,
                                int lowStep,
                                int[] highSig,
                                int highOff,
                                int highStep)
        An implementation of the analyze_hpf() method that works on int data, for the forward 5x3 wavelet transform using the lifting scheme. See the general description of the analyze_hpf() method in the AnWTFilter class for more details.

        The coefficients of the first lifting step are [-1/2 1 -1/2].

        The coefficients of the second lifting step are [1/4 1 1/4].

        Specified by:
        analyze_hpf in class AnWTFilterInt
        Parameters:
        inSig - This is the array that contains the input signal.
        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.
        lowSig - This is the array where the low-pass output signal is placed.
        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.
        highSig - This is the array where the high-pass output signal is placed.
        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 Also:
        AnWTFilter.analyze_hpf(java.lang.Object, int, int, int, java.lang.Object, int, int, java.lang.Object, int, int)
      • getAnLowNegSupport

        public int getAnLowNegSupport()
        Returns the negative support of the low-pass analysis filter. That is the number of taps of the filter in the negative direction.
        Returns:
        2
      • getAnLowPosSupport

        public int getAnLowPosSupport()
        Returns the positive support of the low-pass analysis filter. That is the number of taps of the filter in the negative direction.
        Returns:
        The number of taps of the low-pass analysis filter in the positive direction
      • getAnHighNegSupport

        public int getAnHighNegSupport()
        Returns the negative support of the high-pass analysis filter. That is the number of taps of the filter in the negative direction.
        Returns:
        The number of taps of the high-pass analysis filter in the negative direction
      • getAnHighPosSupport

        public int getAnHighPosSupport()
        Returns the positive support of the high-pass analysis filter. That is the number of taps of the filter in the negative direction.
        Returns:
        The number of taps of the high-pass analysis filter in the positive direction
      • getSynLowNegSupport

        public int getSynLowNegSupport()
        Returns the negative support of the low-pass synthesis filter. That is the number of taps of the filter in the negative direction.

        A MORE PRECISE DEFINITION IS NEEDED

        Returns:
        The number of taps of the low-pass synthesis filter in the negative direction
      • getSynLowPosSupport

        public int getSynLowPosSupport()
        Returns the positive support of the low-pass synthesis filter. That is the number of taps of the filter in the negative direction.

        A MORE PRECISE DEFINITION IS NEEDED

        Returns:
        The number of taps of the low-pass synthesis filter in the positive direction
      • getSynHighNegSupport

        public int getSynHighNegSupport()
        Returns the negative support of the high-pass synthesis filter. That is the number of taps of the filter in the negative direction.

        A MORE PRECISE DEFINITION IS NEEDED

        Returns:
        The number of taps of the high-pass synthesis filter in the negative direction
      • getSynHighPosSupport

        public int getSynHighPosSupport()
        Returns the positive support of the high-pass synthesis filter. That is the number of taps of the filter in the negative direction.

        A MORE PRECISE DEFINITION IS NEEDED

        Returns:
        The number of taps of the high-pass synthesis filter in the positive direction
      • getLPSynthesisFilter

        public float[] getLPSynthesisFilter()
        Returns the time-reversed low-pass synthesis waveform of the filter, which is the low-pass filter. This is the time-reversed impulse response of the low-pass synthesis filter. It is used to calculate the L2-norm of the synthesis basis functions for a particular subband (also called energy weight).

        The returned array may not be modified (i.e. a reference to the internal array may be returned by the implementation of this method).

        Specified by:
        getLPSynthesisFilter in class AnWTFilter
        Returns:
        The time-reversed low-pass synthesis waveform of the filter.
      • getHPSynthesisFilter

        public float[] getHPSynthesisFilter()
        Returns the time-reversed high-pass synthesis waveform of the filter, which is the high-pass filter. This is the time-reversed impulse response of the high-pass synthesis filter. It is used to calculate the L2-norm of the synthesis basis functions for a particular subband (also called energy weight).

        The returned array may not be modified (i.e. a reference to the internal array may be returned by the implementation of this method).

        Specified by:
        getHPSynthesisFilter in class AnWTFilter
        Returns:
        The time-reversed high-pass synthesis waveform of the filter.
      • getImplType

        public int getImplType()
        Returns the implementation type of this filter, as defined in this class, such as WT_FILTER_INT_LIFT, WT_FILTER_FLOAT_LIFT, WT_FILTER_FLOAT_CONVOL.
        Returns:
        WT_FILTER_INT_LIFT.
      • isReversible

        public boolean isReversible()
        Returns the reversibility of the filter. A filter is considered reversible if it is suitable for lossless coding.
        Returns:
        true since the 5x3 is reversible, provided the appropriate rounding is performed.
      • isSameAsFullWT

        public boolean isSameAsFullWT​(int tailOvrlp,
                                      int headOvrlp,
                                      int inLen)
        Returns true if the wavelet filter computes or uses the same "inner" subband coefficient as the full frame wavelet transform, and false otherwise. In particular, for block based transforms with reduced overlap, this method should return false. The term "inner" indicates that this applies only with respect to the coefficient that are not affected by image boundaries processings such as symmetric extension, since there is not reference method for this.

        The result depends on the length of the allowed overlap when compared to the overlap required by the wavelet filter. It also depends on how overlap processing is implemented in the wavelet filter.

        Parameters:
        tailOvrlp - This is the number of samples in the input signal before the first sample to filter that can be used for overlap.
        headOvrlp - This is the number of samples in the input signal after the last sample to filter that can be used for overlap.
        inLen - This is the lenght of the input signal to filter.The required number of samples in the input signal after the last sample depends on the length of the input signal.
        Returns:
        true if both overlaps are greater than 2, and correct processing is applied in the analyze() method.
      • equals

        public boolean equals​(Object obj)
        Tests if the 'obj' object is the same filter as this one. Two filters are the same if the same filter code should be output for both filters by the encodeFilterCode() method.

        Currently the implementation of this method only tests if 'obj' is also of the class AnWTFilterIntLift5x3.

        Overrides:
        equals in class Object
        Parameters:
        obj - The object against which to test inequality.
      • getFilterType

        public int getFilterType()
        Returns the type of filter used according to the FilterTypes interface (W5x3).
        Specified by:
        getFilterType in class AnWTFilter
        Returns:
        The filter type.
        See Also:
        FilterTypes