InstantaneousFrequency (Jipes 0.9.17 API)

java.lang.Object
- com.tagtraum.jipes.audio.InstantaneousFrequency

All Implemented Interfaces:

SignalProcessor<LinearFrequencySpectrum,InstantaneousFrequencySpectrum>
```
public class InstantaneousFrequency
extends Object
implements SignalProcessor<LinearFrequencySpectrum,InstantaneousFrequencySpectrum>
```
Combines subsequent LinearFrequencySpectrums into a InstantaneousFrequencySpectrum, potentially providing better frequency resolution.

Author:

Hendrik Schreiber

Constructor Summary

Constructors
Constructor and Description

InstantaneousFrequency()

InstantaneousFrequency(Object id)

Constructors
Constructor and Description
`InstantaneousFrequency()`
`InstantaneousFrequency(Object id)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<O2> SignalProcessor<InstantaneousFrequencySpectrum,O2>`	`connectTo(SignalProcessor<InstantaneousFrequencySpectrum,O2> signalProcessor)` Connects this processor to another processor to forward processed data to.
`<O2> SignalProcessor<InstantaneousFrequencySpectrum,O2>`	`disconnectFrom(SignalProcessor<InstantaneousFrequencySpectrum,O2> signalProcessor)` Disconnects a child processor.
`boolean`	`equals(Object o)`
`void`	`flush()` Asks to complete all pending operations.
`SignalProcessor<InstantaneousFrequencySpectrum,?>[]`	`getConnectedProcessors()` Lists all connected processors.
`Object`	`getId()` Arbitrary object to identify a processor.
`InstantaneousFrequencySpectrum`	`getOutput()` First calls `SignalProcessor.flush()`, then returns the pending output, should there be any.
`int`	`hashCode()`
`void`	`process(LinearFrequencySpectrum spectrum)` Asks this processor to work on the provided data and pipe the output to the connected processors' own `SignalProcessor.process(Object)` method. Implementing methods must not modify or hold on to the provided data.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InstantaneousFrequency
```
public InstantaneousFrequency()
```
  - InstantaneousFrequency
```
public InstantaneousFrequency(Object id)
```
- Method Detail
  - process
```
public void process(LinearFrequencySpectrum spectrum)
             throws IOException
```
    Description copied from interface: SignalProcessor
    
    Asks this processor to work on the provided data and pipe the output to the connected processors' own SignalProcessor.process(Object) method.
    Implementing methods must not modify or hold on to the provided data. In other words: the provided object does not belong to you, its values are only guaranteed to be stable for the duration of the call.
    If you need to hold on to data, create a copy of the provided data via a copy constructor or the Object.clone() method.
    It is the responsibility of implementing classes to call the SignalProcessor.process(Object) method of any connected processors. To manage connected processors classes may want to use a SignalProcessorSupport instance.
    
    Specified by:
    
    process in interface SignalProcessor<LinearFrequencySpectrum,InstantaneousFrequencySpectrum>
    
    Parameters:
    
    spectrum - data to process
    
    Throws:
    
    IOException - if a processing error occurs
    
    See Also:
    
    SignalProcessor.getConnectedProcessors()
  - flush
```
public void flush()
           throws IOException
```
    Description copied from interface: SignalProcessor
    
    Asks to complete all pending operations. This method may be called multiple times without any adverse effects. It's the implementation's responsibility to call its kids' SignalProcessor.flush() method.
    
    Specified by:
    
    flush in interface SignalProcessor<LinearFrequencySpectrum,InstantaneousFrequencySpectrum>
    
    Throws:
    
    IOException - if a processing error occurs
  - getOutput
```
public InstantaneousFrequencySpectrum getOutput()
                                         throws IOException
```
    Description copied from interface: SignalProcessor
    
    First calls SignalProcessor.flush(), then returns the pending output, should there be any. Note that this call may only succeed once to preserve memory.
    
    Specified by:
    
    getOutput in interface SignalProcessor<LinearFrequencySpectrum,InstantaneousFrequencySpectrum>
    
    Returns:
    
    output, if available. If not, null is returned
    
    Throws:
    
    IOException - if a processing error occurs
  - getId
```
public Object getId()
```
    Description copied from interface: SignalProcessor
    
    Arbitrary object to identify a processor. This is useful for associating with results provided by SignalProcessor.getOutput().
    
    Specified by:
    
    getId in interface SignalProcessor<LinearFrequencySpectrum,InstantaneousFrequencySpectrum>
    
    Returns:
    
    arbitrary non-null object. If this method returns null, potential results will not be associated with an identifier and potentially dropped
    
    See Also:
    
    SignalPump.pump()
  - connectTo
```
public <O2> SignalProcessor<InstantaneousFrequencySpectrum,O2> connectTo(SignalProcessor<InstantaneousFrequencySpectrum,O2> signalProcessor)
```
    Description copied from interface: SignalProcessor
    
    Connects this processor to another processor to forward processed data to. This method returns its parameter and therefore encourages method chaining to build processing chains/pipelines.
    
    Specified by:
    
    connectTo in interface SignalProcessor<LinearFrequencySpectrum,InstantaneousFrequencySpectrum>
    
    Type Parameters:
    
    O2 - output type of the processor we want to connect to
    
    Parameters:
    
    signalProcessor - processor
    
    Returns:
    
    the just added processor
    
    See Also:
    
    SignalProcessor.disconnectFrom(SignalProcessor), SignalProcessor.getConnectedProcessors(), SignalPipeline
  - disconnectFrom
```
public <O2> SignalProcessor<InstantaneousFrequencySpectrum,O2> disconnectFrom(SignalProcessor<InstantaneousFrequencySpectrum,O2> signalProcessor)
```
    Description copied from interface: SignalProcessor
    
    Disconnects a child processor.
    
    Specified by:
    
    disconnectFrom in interface SignalProcessor<LinearFrequencySpectrum,InstantaneousFrequencySpectrum>
    
    Type Parameters:
    
    O2 - output type of the processor we want to disconnect from
    
    Parameters:
    
    signalProcessor - processor
    
    Returns:
    
    the processor, if it was indeed removed
    
    See Also:
    
    SignalProcessor.connectTo(SignalProcessor), SignalProcessor.getConnectedProcessors()
  - getConnectedProcessors
```
public SignalProcessor<InstantaneousFrequencySpectrum,?>[] getConnectedProcessors()
```
    Description copied from interface: SignalProcessor
    
    Lists all connected processors.
    
    Specified by:
    
    getConnectedProcessors in interface SignalProcessor<LinearFrequencySpectrum,InstantaneousFrequencySpectrum>
    
    Returns:
    
    array of registered processors, never null
    
    See Also:
    
    SignalProcessor.disconnectFrom(SignalProcessor), SignalProcessor.connectTo(SignalProcessor)
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class InstantaneousFrequency

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstantaneousFrequency

InstantaneousFrequency

Method Detail

process

flush

getOutput

getId

connectTo

disconnectFrom

getConnectedProcessors

equals

hashCode

toString