Package gpl

Class GPLParameters

java.lang.Object

gpl.GPLParameters

All Implemented Interfaces:

Serializable, Cloneable, ManagedParameters

public class GPLParameters
extends Object
implements Serializable, Cloneable, ManagedParameters

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GPLParameters.ConnectType

Field Summary

Fields

Modifier and Type	Field	Description
double	backgroundTimeSecs	Time constant for background whitener and also for blocking of data.
PamBlockParams	blockParams	Params controlling blocking of data
GPLParameters.ConnectType	connectType	Type of contour connector: 4 = sides only, 8 = sides and diagonals.
double	contourCut	cut in HT.
ContourMerge	contourMerge	What to do with multiple contour patches within a single 'detection'
String	description	Generic description for this parameter set used by the default parameters list.
String	fftSourceName	Data source name (FFT or beam former data)
String	importFile	Name of a file settings were imported from.
boolean	keepNullContours	Keep GPL detections even if they don't have any detected contours.
double	maxCallLengthSeconds	Used to select a peak from the detector.
double	maxFreq	As minFreq above.
double	minCallLengthSeconds	Used to select a peak from the detector.
int	minContourArea	Min contour area to be kept.
double	minFreq	Minimum frequency for analysis.
int	minPeakGap	Minimum gap between peaks in the detector.
double	noise_ceiling	This is possibly better thought of as a 'low threshold', final detector finds regions that go above this, but only accepts them as detections if at least a bin goes above the higher 'thresh' value.
int	sequenceMap	Channel / sequence map for processing (might replace this with full detection grouping ?)
static final long	serialVersionUID
double	thresh	See above.
double	white_fac_x	Whitening factor for first whitening over backgroundTimeSecs duration of data.
double	xp1	This is nu1 in H et al.
double	xp2	This is nu2 in H et al.

Constructor Summary

Constructors

Constructor	Description
GPLParameters()
GPLParameters(String name, double minFreq, double maxFreq, double backgroundTimeSecs, double white_fac_x, double xp1, double xp2, double noise_ceiling, double thresh, int minPeakGap, double minCallLengthSeconds, double maxCallLengthSeconds)

Method Summary

Modifier and Type	Method	Description
GPLParameters	clone()
PamParameterSet	getParameterSet()	Get a set of data that describes all of the parameters in a class

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

public static final long serialVersionUID

See Also:

• Constant Field Values

description

public String description

Generic description for this parameter set used by the default parameters list. .

importFile

public String importFile

Name of a file settings were imported from. Easiest to keep this separate from the freeform text.

fftSourceName

public String fftSourceName

Data source name (FFT or beam former data)

sequenceMap

public int sequenceMap

Channel / sequence map for processing (might replace this with full detection grouping ?)

minFreq

public double minFreq

Minimum frequency for analysis. Currently used both in whitener and contour detector. If allowing multiple bands, may have to separate this for the different bands.

maxFreq

public double maxFreq

As minFreq above.

backgroundTimeSecs

public double backgroundTimeSecs

Time constant for background whitener and also for blocking of data.

white_fac_x

public double white_fac_x

Whitening factor for first whitening over backgroundTimeSecs duration of data. Used in Base3xWhitener and is a scaling factor used to increase the mean subtracted from the spectrogram, i.e. if X is the spectrogram and mu is the mean value of the spectrogram, then the white spectrogram is X-white_fac_x*mu. In Matlab code this is the 'fac' passed to whiten_matrix in GPL_whiten.
So far as I can see, this doesn't appear in H et al. If it did, it would scale the mu term in equations 17 and 18.

xp1

public double xp1

This is nu1 in H et al. eq 6. Used as xp1 in Matlab GPL_Quiet. This is the scale factor that will emphasise tonal signals.
Note that in code the spec is raised to this power to calculate bas, but then it all get's squared again to make baseline0, so this is nu1, not 2nu1.

xp2

public double xp2

This is nu2 in H et al. eq 6. Used as xp1 in Matlab GPL_Quiet. This is the scale factor that will emphasise broad band transients.
Note that in code the spec is raised to this power to calculate bas, but then it all get's squared again to make baseline0, so this is nu1, not 2nu1.

noise_ceiling

public double noise_ceiling

This is possibly better thought of as a 'low threshold', final detector finds regions that go above this, but only accepts them as detections if at least a bin goes above the higher 'thresh' value.

thresh

public double thresh

See above. Main detection threshold .

minPeakGap

public int minPeakGap

Minimum gap between peaks in the detector.

minCallLengthSeconds

public double minCallLengthSeconds

Used to select a peak from the detector. Would this be better used on individual contours ?

maxCallLengthSeconds

public double maxCallLengthSeconds

Used to select a peak from the detector. Would this be better used on individual contours ?

contourCut

public double contourCut

cut in HT. Threshold for contour detection.

connectType

public GPLParameters.ConnectType connectType

Type of contour connector: 4 = sides only, 8 = sides and diagonals.

minContourArea

public int minContourArea

Min contour area to be kept. fixed value of 10 in HT

contourMerge

public ContourMerge contourMerge

What to do with multiple contour patches within a single 'detection'

blockParams

public PamBlockParams blockParams

Params controlling blocking of data

keepNullContours

public boolean keepNullContours

Keep GPL detections even if they don't have any detected contours.

Constructor Details

GPLParameters

public GPLParameters(String name,
 double minFreq,
 double maxFreq,
 double backgroundTimeSecs,
 double white_fac_x,
 double xp1,
 double xp2,
 double noise_ceiling,
 double thresh,
 int minPeakGap,
 double minCallLengthSeconds,
 double maxCallLengthSeconds)

GPLParameters

public GPLParameters()

Method Details

clone

public GPLParameters clone()

Overrides:

clone in class Object

getParameterSet

public PamParameterSet getParameterSet()

Description copied from interface: ManagedParameters

Get a set of data that describes all of the parameters in a class

Specified by:

getParameterSet in interface ManagedParameters

Returns:

description of the parameters in a class.