org.openimaj.audio.analysis

Class EffectiveSoundPressure

java.lang.Object

org.openimaj.audio.Audio

org.openimaj.audio.AudioStream

org.openimaj.audio.processor.AudioProcessor

org.openimaj.audio.processor.FixedSizeSampleAudioProcessor

org.openimaj.audio.analysis.EffectiveSoundPressure

All Implemented Interfaces:

Iterable<SampleChunk>

public class EffectiveSoundPressure
extends FixedSizeSampleAudioProcessor

Calculate the effective sound pressure by calculating the RMS of samples over a temporal window. This will sum across all channels in the sample chunk.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Field Summary

Fields inherited from class org.openimaj.audio.Audio

format

Constructor Summary

Constructors

Constructor and Description
EffectiveSoundPressure() Default constructor
EffectiveSoundPressure(AudioStream stream, int windowSizeMillis, int overlapMillis) Construct with given stream and window parameters.
EffectiveSoundPressure(int windowSizeSamples, int overlapSamples) Contstructor for ad-hoc processing.

Method Summary

Modifier and Type	Method and Description
double	getEffectiveSoundPressure()
SampleChunk	process(SampleChunk sample) Function that takes a sample chunk and processes the chunk.

Methods inherited from class org.openimaj.audio.processor.FixedSizeSampleAudioProcessor

getWindowSize, getWindowStep, isOverlapping, nextSampleChunk, setWindowSize, setWindowStep

Methods inherited from class org.openimaj.audio.processor.AudioProcessor

getLength, getUnderlyingStream, process, processingComplete, reset, setUnderlyingStream

Methods inherited from class org.openimaj.audio.AudioStream

iterator, seek

Methods inherited from class org.openimaj.audio.Audio

getFormat, setFormat

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

EffectiveSoundPressure

public EffectiveSoundPressure()

Default constructor

EffectiveSoundPressure

public EffectiveSoundPressure(int windowSizeSamples,
                              int overlapSamples)

Contstructor for ad-hoc processing. Note that the window and overlap size is given in samples (not in milliseconds as the other constructor).

Parameters:

windowSizeSamples - Size of the processing window in samples

overlapSamples - The overlap of the windows in samples

EffectiveSoundPressure

public EffectiveSoundPressure(AudioStream stream,
                              int windowSizeMillis,
                              int overlapMillis)

Construct with given stream and window parameters. Note that the window parameters are given in milliseconds and converted into a number of samples by the method.

Parameters:

stream - The audio stream

windowSizeMillis - The window size in milliseconds

overlapMillis - The overlap between windows in milliseconds

Method Detail

process

public SampleChunk process(SampleChunk sample)
                    throws Exception

Function that takes a sample chunk and processes the chunk. It should also return a sample chunk containing the processed data. If wished, the chunk may be side-affected and the input chunk returned. It should not be assumed that the input chunk will be side-affected, but it must be noted that it is possible that it could be. This process function may also return null. If null is returned it means that the rest of the audio stream is not required to be processed by this processing function. Whether the rest of the sample chunks are copied or ignored is up to the caller. The default operation of the FixedSizeSampleAudioProcessor is simply to change the shape of the sample chunk. You may override this method to process the samples directly.

Overrides:

process in class FixedSizeSampleAudioProcessor

Parameters:

sample - The sample chunk to process.

Returns:

A sample chunk containing processed data.

Throws:

Exception - If the processing could not take place

See Also:

FixedSizeSampleAudioProcessor.process(org.openimaj.audio.SampleChunk)

getEffectiveSoundPressure

public double getEffectiveSoundPressure()

Returns:

The effective sound pressure