Package qa.generator.clusters

Class StandardQACluster

java.lang.Object

qa.generator.clusters.StandardQACluster

All Implemented Interfaces:

QACluster

Direct Known Subclasses:

BeakedWhaleCluster, BlackFishCluster, DolphinClicksCluster, DolphinWhistlesCluster, HFBaleenCluster, LFBaleenCluster, PorpoiseCluster, RightWhaleCluster, SpermWhaleCluster

public abstract class StandardQACluster
extends Object
implements QACluster

Author:

dg50

Constructor Summary

Constructors

Constructor	Description
StandardQACluster(String clusterName, String version, QASequenceGenerator qaSequenceGenerator, StandardSoundGenerator qaSoundGenerator)

Method Summary

Modifier and Type	Method	Description
QADistribution	getDepthDistribution()	The depth distribution for the species cluster.
double[]	getFrequencyRange()
String	getName()
QASequenceGenerator	getSequenceGenerator()	The sequence generator can generate the precise times and source amplitudes for a sequence of (possibly) autocorrelated sounds, e.g.
QASoundGenerator	getSoundGenerator()	The sound generator can generate single sounds with the correct phase on each hydrophone
String	getVersion()
void	setSequenceGenerator(QASequenceGenerator qaSequenceGenerator)
void	setSoundGenerator(QASoundGenerator qaSoundGenerator)

Methods inherited from class java.lang.Object

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

Methods inherited from interface qa.generator.clusters.QACluster

getPrimaryDetectorType

Constructor Details

StandardQACluster

public StandardQACluster(String clusterName,
 String version,
 QASequenceGenerator qaSequenceGenerator,
 StandardSoundGenerator qaSoundGenerator)

Parameters:

clusterName - name of the cluster

qaSequenceGenerator - sound sequence generator

qaSoundGenerator - sound generator

Method Details

getName

public String getName()

Specified by:

getName in interface QACluster

Returns:

The name of the cluster.

getVersion

public String getVersion()

Specified by:

getVersion in interface QACluster

Returns:

Version number for this sound sequence.

getFrequencyRange

public double[] getFrequencyRange()

setSequenceGenerator

public void setSequenceGenerator(QASequenceGenerator qaSequenceGenerator)

Parameters:

qaSequenceGenerator - the qaSequenceGenerator to set

setSoundGenerator

public void setSoundGenerator(QASoundGenerator qaSoundGenerator)

Parameters:

qaSoundGenerator - the qaSoundGenerator to set

getSoundGenerator

public QASoundGenerator getSoundGenerator()

Description copied from interface: QACluster

The sound generator can generate single sounds with the correct phase on each hydrophone

Specified by:

getSoundGenerator in interface QACluster

Returns:

The sound generator

getSequenceGenerator

public QASequenceGenerator getSequenceGenerator()

Description copied from interface: QACluster

The sequence generator can generate the precise times and source amplitudes for a sequence of (possibly) autocorrelated sounds, e.g. click trains, totally random whistles, etc.

Specified by:

getSequenceGenerator in interface QACluster

Returns:

The sequence generator

getDepthDistribution

public QADistribution getDepthDistribution()

Description copied from interface: QACluster

The depth distribution for the species cluster. This can be null in which case 0 will be used. Remember that PAMGuard uses height, not depth, however, so that distributions that don't allow negative numbers (gamma) can be used, this will genuinely produce a positive number for a real animal depth and whatever uses this distribution will flip it's sign.
Depths will be generated independently for each sequence and will be constant within each sequence.

Specified by:

getDepthDistribution in interface QACluster

Returns:

the depth distribution