Package tethys.output
Class StreamExportParams
java.lang.Object
tethys.output.StreamExportParams
- All Implemented Interfaces:
Serializable
Parameters controlling export of a single stream.
Starts just with a boolean 'selected', but may grow.
These all contain data names rather than references to a Datablock so that
they can be serialised. However, created with TethysControl and datablock
so that some stuff canbe automatically initialised.
- Author:
- dg50
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptiondouble
Bin duration, seconds.double
Minimum encounter gap, secondsboolean
Have selected export of detections.boolean
Have selected export of localisations.nilus.GranularityEnumType
Granularity type, binned, call, encounter, grouped.Datablock long data name (used instead of datablock reference so this object is serialise.int
Minimum count for a bin to be retained.int
Minimum count for an encounter to be retained.boolean
Keep channels separate when using binned data.static final long
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Used to get the description data back in again if it's changes as PAMGuard updates.nilus.DescriptionType
nilus.Detections
boolean
getSpeciesSelection
(String callName) Get if a species or call type is selected.void
void
setDescription
(nilus.DescriptionType description) void
setDetections
(nilus.Detections det) void
setSpeciesSelection
(String callName, boolean sel) Set if a species or call type is selected.
-
Field Details
-
serialVersionUID
public static final long serialVersionUID- See Also:
-
longDataName
Datablock long data name (used instead of datablock reference so this object is serialise. -
exportDetections
public boolean exportDetectionsHave selected export of detections. -
exportLocalisations
public boolean exportLocalisationsHave selected export of localisations. -
granularity
public nilus.GranularityEnumType granularityGranularity type, binned, call, encounter, grouped. -
binDurationS
public double binDurationSBin duration, seconds. -
encounterGapS
public double encounterGapSMinimum encounter gap, seconds -
minBinCount
public int minBinCountMinimum count for a bin to be retained. -
minEncounterCount
public int minEncounterCountMinimum count for an encounter to be retained. -
separateChannels
public boolean separateChannelsKeep channels separate when using binned data.
-
-
Constructor Details
-
Method Details
-
setSpeciesSelection
Set if a species or call type is selected.- Parameters:
callName
-sel
-
-
getSpeciesSelection
Get if a species or call type is selected. Return true by default.- Parameters:
callName
-- Returns:
-
checkDescription
public void checkDescription()Used to get the description data back in again if it's changes as PAMGuard updates. This object can't store references to the TethysControl or the datablock since they aren't serializable. Normally, the description is auto filled at constructoin, but once serialized, this can no longer happen, so can call this function to sort it all out. -
getDescription
public nilus.DescriptionType getDescription() -
setDescription
public void setDescription(nilus.DescriptionType description) -
getDetections
public nilus.Detections getDetections() -
setDetections
public void setDetections(nilus.Detections det) -
reSerialize
public void reSerialize() -
getSpeciesSelection
- Returns:
- the speciesSelection
-