Package tethys.output

Class StreamExportParams

java.lang.Object
tethys.output.StreamExportParams
All Implemented Interfaces:
Serializable

public class StreamExportParams extends Object implements 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 Details Link icon

    • serialVersionUID Link icon

      public static final long serialVersionUID
      See Also:
    • longDataName Link icon

      public String longDataName
      Datablock long data name (used instead of datablock reference so this object is serialise.
    • exportDetections Link icon

      public boolean exportDetections
      Have selected export of detections.
    • exportLocalisations Link icon

      public boolean exportLocalisations
      Have selected export of localisations.
    • granularity Link icon

      public nilus.GranularityEnumType granularity
      Granularity type, binned, call, encounter, grouped.
    • binDurationS Link icon

      public double binDurationS
      Bin duration, seconds.
    • encounterGapS Link icon

      public double encounterGapS
      Minimum encounter gap, seconds
    • minBinCount Link icon

      public int minBinCount
      Minimum count for a bin to be retained.
    • minEncounterCount Link icon

      public int minEncounterCount
      Minimum count for an encounter to be retained.
    • separateChannels Link icon

      public boolean separateChannels
      Keep channels separate when using binned data.
  • Constructor Details Link icon

  • Method Details Link icon

    • setSpeciesSelection Link icon

      public void setSpeciesSelection(String callName, boolean sel)
      Set if a species or call type is selected.
      Parameters:
      callName -
      sel -
    • getSpeciesSelection Link icon

      public boolean getSpeciesSelection(String callName)
      Get if a species or call type is selected. Return true by default.
      Parameters:
      callName -
      Returns:
    • checkDescription Link icon

      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 Link icon

      public nilus.DescriptionType getDescription()
    • setDescription Link icon

      public void setDescription(nilus.DescriptionType description)
    • getDetections Link icon

      public nilus.Detections getDetections()
    • setDetections Link icon

      public void setDetections(nilus.Detections det)
    • reSerialize Link icon

      public void reSerialize()
    • getSpeciesSelection Link icon

      public HashMap<String,Boolean> getSpeciesSelection()
      Returns:
      the speciesSelection