Index (LSSS API version 1.0.0)

A B C D E F G H I K L M N O P R S T U V W X Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

add(Consumer<T>, Collection<? extends Observable<? extends T>>) - Method in interface no.marec.lsss.api.util.observing.SubscriptionRegistry: Subscribes an observer to several observables and adds the subscription to this registry.
add(Observable<T>, Consumer<? super T>) - Method in interface no.marec.lsss.api.util.observing.SubscriptionRegistry: Subscribes an observer to an observable and adds the subscription to this registry.
addEchogramOverlay(ModuleRegistry.RelativePosition, String, String, String, Function<EchogramOverlayAccess, EchogramOverlay>) - Method in interface no.marec.lsss.api.modules.ModuleRegistry: Adds an echogram overlay.
addFunction(String, String, String, String, boolean, EchogramPlotFunctionEvaluation) - Method in interface no.marec.lsss.api.modules.EchogramPlot: Adds a new echogram plot function.
addMapOverlay(ModuleRegistry.RelativePosition, String, String, String, Function<MapOverlayAccess, MapOverlay>) - Method in interface no.marec.lsss.api.modules.ModuleRegistry: Adds a map overlay.
addModules(ModuleRegistry) - Method in interface no.marec.lsss.api.LsssPlugin: Add the modules and overlays provided by this plugin.
addPoint(double, double) - Method in interface no.marec.lsss.api.util.LineStripBuilder: Adds a point to the current line strip.
addPoint(Point2D) - Method in interface no.marec.lsss.api.util.LineStripBuilder: Adds a point to the current line strip.
addViewModule(ModuleRegistry.ViewModuleLocation, ModuleRegistry.RelativePosition, String, String, String, Function<ViewModuleAccess, ViewModule>) - Method in interface no.marec.lsss.api.modules.ModuleRegistry: Adds a view module.
After(String) - Constructor for record class no.marec.lsss.api.modules.ModuleRegistry.RelativePosition.After: Creates an instance of a After record class.
ApiVersion - Record Class in no.marec.lsss.api: The versioning of the LSSS API.
ApiVersion(int, int) - Constructor for record class no.marec.lsss.api.ApiVersion: Creates an instance of a ApiVersion record class.
AsyncHandle - Interface in no.marec.lsss.api.util: A handle given to an async task.

B

BaseConfigParameter<T> - Interface in no.marec.lsss.api.util.parameters: Base type for configuration parameters.
Before(String) - Constructor for record class no.marec.lsss.api.modules.ModuleRegistry.RelativePosition.Before: Creates an instance of a Before record class.
begin() - Method in interface no.marec.lsss.api.data.PingRange: Returns the start of this range, inclusively.
begin() - Method in interface no.marec.lsss.api.util.FloatRange: Returns the start of this range, inclusively.
BELOW_ECHOGRAM - Enum constant in enum class no.marec.lsss.api.modules.ModuleRegistry.ViewModuleLocation: Below the echogram.
booleanParameter(String, String, boolean, String) - Method in interface no.marec.lsss.api.internal.InternalParameterFactory
booleanParameter(String, String, boolean, String) - Static method in class no.marec.lsss.api.util.parameters.ParameterFactory: Returns a new parameter for boolean values.
BOTTOM - Enum constant in enum class no.marec.lsss.api.modules.ModuleRegistry.ViewModuleLocation: The bottom row.
BroadbandChannelData - Interface in no.marec.lsss.api.data: Broadband sample data.
button(String, String, String) - Method in interface no.marec.lsss.api.internal.InternalParameterFactory
button(String, String, String) - Static method in class no.marec.lsss.api.util.parameters.ParameterFactory: Returns a parameter rendered as a clickable button.

C

canBeUsed() - Method in interface no.marec.lsss.api.internal.Restricted
changed() - Method in interface no.marec.lsss.api.regions.Regions: Returns an observable for regions that are modified.
channel() - Method in interface no.marec.lsss.api.echogram.EchogramData: Returns the channel displayed in the echogram.
ChannelConfiguration - Interface in no.marec.lsss.api.data: Configuration for a channel.
ChannelData - Interface in no.marec.lsss.api.data: The sample data on one channel in one Ping.
ChannelInterpretation - Interface in no.marec.lsss.api.regions: The species assignments on a single channel.
coalescingInModuleThread(Consumer<T>) - Method in interface no.marec.lsss.api.modules.LsssModuleAccess: Wraps an observer in a new observer that delegates to this module's thread.
coalescingObserver(LsssAccess, Runnable) - Method in interface no.marec.lsss.api.internal.InternalObjectFactory
coalescingObserver(LsssAccess, Runnable) - Static method in class no.marec.lsss.api.util.ObjectFactory: Returns a coalescing observer.
computeDisplayData() - Method in interface no.marec.lsss.api.modules.LsssOverlay: Returns the data to be displayed by this overlay.
ConfigParameter<T> - Interface in no.marec.lsss.api.util.parameters: A configuration parameter.
createPlugin(LsssAccess) - Method in interface no.marec.lsss.api.LsssPluginLoader: Returns a new plugin instance.
createSchool(Map<PingIndex, List<FloatRange>>) - Method in interface no.marec.lsss.api.regions.Regions: Creates a new school.
CURRENT_MAJOR_VERSION - Static variable in record class no.marec.lsss.api.ApiVersion: The current major version of the LSSS API.
CURRENT_MINOR_VERSION - Static variable in record class no.marec.lsss.api.ApiVersion: The current minor version of the LSSS API.
currentlyLoadedPings() - Method in interface no.marec.lsss.api.echogram.EchogramData: Returns the pings that have so far been loaded.

D

DataConfig - Interface in no.marec.lsss.api.config: Configuration unit for data used by an LSSS plugin.
Default() - Constructor for record class no.marec.lsss.api.modules.ModuleRegistry.RelativePosition.Default: Creates an instance of a Default record class.
deleted() - Method in interface no.marec.lsss.api.regions.Regions: Returns an observable for regions that are deleted.
depth() - Method in interface no.marec.lsss.api.util.Mouseover: Returns an observable for mouse depth.
depthRanges(Region, Ping, int) - Method in interface no.marec.lsss.api.regions.Regions: Gets the effective depth intervals for a region.
depthToContainingSampleIndex(float) - Method in interface no.marec.lsss.api.data.ChannelData: Computes the index of the sample that contains a given depth.
depthToY(double, Instant) - Method in interface no.marec.lsss.api.echogram.EchogramDepthTransform: Returns the y-coordinate corresponding to a depth.
depthToY(double, PingIndex) - Method in interface no.marec.lsss.api.echogram.EchogramDepthTransform: Returns the y-coordinate corresponding to a depth.
Developing a plugin - Search tag in package no.marec.lsss.api: Section
DevStartLsssMain - Class in no.marec.lsss.api.util.development: Main class for starting LSSS during plugin development.
devUtils() - Method in interface no.marec.lsss.api.internal.InternalLsss
DevUtils - Interface in no.marec.lsss.api.internal: This is an implementation detail and is not part of the LSSS API.
DoNotImplement - Annotation Interface in no.marec.lsss.api: Annotation on types that must not be implemented when developing an LSSS plugin.
draw(Graphics2D) - Method in interface no.marec.lsss.api.modules.LsssOverlayDisplayData: For painting graphics, but not text.
drawText(Graphics2D) - Method in interface no.marec.lsss.api.modules.LsssOverlayDisplayData: For painting text.
drawText(Graphics2D, String, int, int) - Method in interface no.marec.lsss.api.internal.InternalLsssUtils
drawText(Graphics2D, String, int, int) - Static method in class no.marec.lsss.api.util.LsssUtils: Draws text at the specified location.

E

echogram() - Method in interface no.marec.lsss.api.LsssAccess: Returns the data displayed in the echogram.
echogramArea() - Method in interface no.marec.lsss.api.modules.EchogramOverlayAccess: Returns an observable for changes to the displayed area in the echogram.
EchogramData - Interface in no.marec.lsss.api.echogram: The ping data displayed in the echogram.
echogramDepthTransform() - Method in interface no.marec.lsss.api.modules.EchogramOverlayAccess: Returns the transformation between depth and the echogram y-axis.
EchogramDepthTransform - Interface in no.marec.lsss.api.echogram: Converts between depth and echogram image y-coordinate.
EchogramOverlay - Interface in no.marec.lsss.api.modules: An echogram provided by an LSSS plugin.
EchogramOverlayAccess - Interface in no.marec.lsss.api.modules: Access to the actual echogram overlay.
echogramPingTransform() - Method in interface no.marec.lsss.api.modules.EchogramOverlayAccess: Returns the transformation between pings and the echogram x-axis.
EchogramPingTransform - Interface in no.marec.lsss.api.echogram: Converts between time and echogram image x-coordinate.
echogramPlot() - Method in interface no.marec.lsss.api.LsssAccess: Returns access to the echogram plot module.
EchogramPlot - Interface in no.marec.lsss.api.modules: Access to the echogram plot module.
EchogramPlotFunction - Interface in no.marec.lsss.api.modules: The function created by EchogramPlot.addFunction(String, String, String, String, boolean, EchogramPlotFunctionEvaluation).
EchogramPlotFunctionEvaluation - Interface in no.marec.lsss.api.modules: The echogram plot function evaluation.
end() - Method in interface no.marec.lsss.api.data.PingRange: Returns the end of this range, exclusively.
end() - Method in interface no.marec.lsss.api.util.FloatRange: Returns the end of this range, exclusively.
endLineStrip() - Method in interface no.marec.lsss.api.util.LineStripBuilder: Ends the current line strip.
equals(Object) - Method in record class no.marec.lsss.api.ApiVersion: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class no.marec.lsss.api.modules.ModuleRegistry.RelativePosition.After: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class no.marec.lsss.api.modules.ModuleRegistry.RelativePosition.Before: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class no.marec.lsss.api.modules.ModuleRegistry.RelativePosition.Default: Indicates whether some other object is "equal to" this one.
evaluate(Ping, int) - Method in interface no.marec.lsss.api.modules.EchogramPlotFunctionEvaluation: Computes the resulting value.
extendFloatableModuleMenu(JPopupMenu) - Method in interface no.marec.lsss.api.modules.ViewModule.Gui: Optionally extend the view module menu.

F

finishedEditingInterpretations() - Method in interface no.marec.lsss.api.regions.Regions: Should be called after editing one or more Interpretation.
floatParameter(String, String, float, String, String) - Method in interface no.marec.lsss.api.internal.InternalParameterFactory
floatParameter(String, String, float, String, String) - Static method in class no.marec.lsss.api.util.parameters.ParameterFactory: Returns a new parameter for float values.
floatRange(float, float) - Method in interface no.marec.lsss.api.internal.InternalObjectFactory
floatRange(float, float) - Static method in class no.marec.lsss.api.util.ObjectFactory: Returns a new float range.
FloatRange - Interface in no.marec.lsss.api.util: A half-open interval of float value.
forOptionalValues() - Method in interface no.marec.lsss.api.util.parameters.ValueConstraint: Converts this ValueConstraint<T> to ValueConstraint<Optional<T>>.
frozen() - Method in interface no.marec.lsss.api.util.Mouseover: Returns an observable for whether the mouse position is frozen or not.

G

geoLocation() - Method in interface no.marec.lsss.api.util.Mouseover: Returns an observable for mouse geo location.
GeoPoint - Class in no.marec.lsss.api.util: A geographical point represented as a Point2D.
GeoPoint() - Constructor for class no.marec.lsss.api.util.GeoPoint: Creates a new point located at (0°N, 0°E).
GeoPoint(double, double) - Constructor for class no.marec.lsss.api.util.GeoPoint: Creates a new point at the specified location.
geoToPix(double, double) - Method in interface no.marec.lsss.api.util.GeoTransform: Converts geographical coordinates to image coordinates.
geoToPix(GeoPoint) - Method in interface no.marec.lsss.api.util.GeoTransform: Converts geographical coordinates to image coordinates.
geoTransform() - Method in interface no.marec.lsss.api.modules.MapOverlayAccess: Returns the transformation between geographical coordinates and image coordinates.
GeoTransform - Interface in no.marec.lsss.api.util: Converts between geographical coordinates and image coordinates.
getAllowedValues() - Method in interface no.marec.lsss.api.util.parameters.ValueConstraint: Returns the list of allowed values, if available.
getAllowedValuesDescription(ValueStringifier<T>) - Method in interface no.marec.lsss.api.util.parameters.ValueConstraint: Returns a description of the allowed values.
getAssignments() - Method in interface no.marec.lsss.api.regions.ChannelInterpretation: Returns an immutable map from species id to assignment.
getBounds() - Method in interface no.marec.lsss.api.modules.LsssOverlayAccess: Returns the bounds in pixels of the overlaid module.
getBroadbandChannelData(int) - Method in interface no.marec.lsss.api.data.Ping: Returns the BroadbandChannelData on the specified channel, if available.
getChannelConfigurations() - Method in interface no.marec.lsss.api.data.PingConfiguration: Returns the configuration for all available channels.
getChannelId() - Method in interface no.marec.lsss.api.data.ChannelConfiguration: Returns the ID of this channel.
getChannelInterpretation(int) - Method in interface no.marec.lsss.api.regions.Interpretation: Returns interpretation on the specified channel.
getClosestPingIndex(Instant) - Method in interface no.marec.lsss.api.data.PingDataset: Finds the ping index closest to a specified time.
getCompatibleApiVersion() - Method in interface no.marec.lsss.api.LsssPluginLoader: Returns The version of the LSSS API that was used when developing the plugin.
getComponent() - Method in interface no.marec.lsss.api.util.GuiHolder.Gui: Returns the top component of this gui.
getConfig() - Method in interface no.marec.lsss.api.modules.LsssModule: Returns the configuration of this module.
getContainingPingIndex(Instant) - Method in interface no.marec.lsss.api.data.PingDataset: Finds the ping index containing a specified time.
getDataConfigs() - Method in interface no.marec.lsss.api.LsssPlugin: Returns data configurations provided by this plugin.
getDescription() - Method in interface no.marec.lsss.api.config.DataConfig: Returns a description of this configuration unit.
getDisplayLabel() - Method in interface no.marec.lsss.api.util.parameters.ObjectParameterValue: Returns the label.
getFrequency() - Method in interface no.marec.lsss.api.data.SvChannelData: Returns the frequency in Hz.
getGeographicalPosition() - Method in interface no.marec.lsss.api.data.PingIndex: Returns the geographical coordinates of this ping.
getGui() - Method in class no.marec.lsss.api.util.GuiHolder: Returns the GUI.
getGuiHolder() - Method in interface no.marec.lsss.api.modules.ViewModule: Returns a holder for this module's GUI.
getHeight() - Method in interface no.marec.lsss.api.modules.LsssOverlayAccess: Returns the height in pixels of the overlaid module.
getHelpResourceDir() - Method in interface no.marec.lsss.api.LsssPlugin: Returns the resource directory of optional help pages.
getIconResource() - Method in interface no.marec.lsss.api.LsssPluginLoader: Returns the resource name of an optional icon in SVG format.
getId() - Method in interface no.marec.lsss.api.config.DataConfig: Returns the id of this configuration unit.
getId() - Method in interface no.marec.lsss.api.LsssPluginLoader: Returns the ID of this plugin.
getId() - Method in interface no.marec.lsss.api.modules.EchogramPlotFunction: Returns the ID of this function.
getId() - Method in interface no.marec.lsss.api.regions.Region: Returns the ID of this region.
getInstant() - Method in interface no.marec.lsss.api.data.PingIndex: Returns the time of this ping.
getInterpretation() - Method in interface no.marec.lsss.api.regions.Region: Returns the interpretation of this region.
getLabel() - Method in interface no.marec.lsss.api.config.DataConfig: Returns the display label of this configuration unit.
getLabel() - Method in interface no.marec.lsss.api.LsssPluginLoader: Returns the display label of this plugin.
getLabels() - Method in interface no.marec.lsss.api.regions.Region: Returns the labels assigned to this region.
getLatitude() - Method in class no.marec.lsss.api.util.GeoPoint: Returns the latitude (y-coordinate) of this point.
getLongitude() - Method in class no.marec.lsss.api.util.GeoPoint: Returns the longitude (x-coordinate) of this point.
getMaxDepth() - Method in interface no.marec.lsss.api.data.ChannelData: Returns the end depth of the last sample.
getMechanicalAlongAngle(int) - Method in interface no.marec.lsss.api.data.SvChannelData: Returns the alongship angle for a given sample.
getMechanicalAthwartAngle(int) - Method in interface no.marec.lsss.api.data.SvChannelData: Returns the athwartship angle for a given sample.
getMinDepth() - Method in interface no.marec.lsss.api.data.ChannelData: Returns the start depth of the first sample.
getMousePosition() - Method in interface no.marec.lsss.api.modules.LsssOverlayAccess: Returns an observable for the mouse position in the overlaid module.
getNominalFrequency() - Method in interface no.marec.lsss.api.data.ChannelConfiguration: Returns the nominal frequency in Hz of this channel.
getParameters() - Method in interface no.marec.lsss.api.config.DataConfig: Returns the configuration parameters of this configuration unit.
getParameters() - Method in interface no.marec.lsss.api.modules.ModuleConfig: Returns the configuration parameters of the module.
getPing(PingIndex) - Method in interface no.marec.lsss.api.data.PingDataset: Returns the ping for a given ping index.
getPingConfiguration() - Method in interface no.marec.lsss.api.data.PingDataset: Returns the ping configuration for this dataset.
getPingIndex() - Method in interface no.marec.lsss.api.data.Ping: Returns the ping index for this ping.
getPingIndex(long) - Method in interface no.marec.lsss.api.data.PingDataset: Finds the ping index with a specified ping number.
getPingNumber() - Method in interface no.marec.lsss.api.data.PingIndex: Returns the ping number of this ping.
getPopupMenu(Point) - Method in interface no.marec.lsss.api.modules.LsssOverlay: An optional popup menu specific for this overlay.
getRestSpecies() - Method in interface no.marec.lsss.api.regions.Interpretation: Returns an immutable set of the rest species.
getSampleCount() - Method in interface no.marec.lsss.api.data.ChannelData: Returns the number of samples.
getSampleDistance() - Method in interface no.marec.lsss.api.data.ChannelData: Returns the distance between samples.
getStartFrequency() - Method in interface no.marec.lsss.api.data.BroadbandChannelData: Returns the start frequency in Hz of the sweep.
getStopFrequency() - Method in interface no.marec.lsss.api.data.BroadbandChannelData: Returns the stop frequency in Hz of the sweep.
getSv() - Method in interface no.marec.lsss.api.data.SvChannelData: Returns the sample data as sv.
getSvChannelData(int) - Method in interface no.marec.lsss.api.data.Ping: Returns the SvChannelData on the specified channel.
getTooltip() - Method in interface no.marec.lsss.api.util.parameters.ObjectParameterValue: Returns the tooltip.
getToolTipText(Point) - Method in interface no.marec.lsss.api.modules.LsssOverlay: An optional tooltip specific for this overlay.
getTotalPingRange() - Method in interface no.marec.lsss.api.data.PingDataset: Returns the range of all pings in the dataset.
getValue() - Method in interface no.marec.lsss.api.util.observing.ObservableValue: Returns the current value.
getVesselDistance() - Method in interface no.marec.lsss.api.data.PingIndex: Returns the vessel distance in nautical miles of this ping.
getWidth() - Method in interface no.marec.lsss.api.modules.LsssOverlayAccess: Returns the width in pixels of the overlaid module.
gt(T) - Static method in class no.marec.lsss.api.util.parameters.ValueConstraints
gte(T) - Static method in class no.marec.lsss.api.util.parameters.ValueConstraints
gteLt(T, T) - Static method in class no.marec.lsss.api.util.parameters.ValueConstraints
gteLte(T, T) - Static method in class no.marec.lsss.api.util.parameters.ValueConstraints
gtLt(T, T) - Static method in class no.marec.lsss.api.util.parameters.ValueConstraints
gtLte(T, T) - Static method in class no.marec.lsss.api.util.parameters.ValueConstraints
GuiHolder<T> - Class in no.marec.lsss.api.util: A class for helping to enforce that a gui is only accessed in the event dispatch thread.
GuiHolder(Supplier<T>) - Constructor for class no.marec.lsss.api.util.GuiHolder: Creates a new GUI holder.
GuiHolder.Gui - Interface in no.marec.lsss.api.util: The GUI that should normally only be accessed in the event dispatch thread.

H

hashCode() - Method in record class no.marec.lsss.api.ApiVersion: Returns a hash code value for this object.
hashCode() - Method in record class no.marec.lsss.api.modules.ModuleRegistry.RelativePosition.After: Returns a hash code value for this object.
hashCode() - Method in record class no.marec.lsss.api.modules.ModuleRegistry.RelativePosition.Before: Returns a hash code value for this object.
hashCode() - Method in record class no.marec.lsss.api.modules.ModuleRegistry.RelativePosition.Default: Returns a hash code value for this object.
header(String) - Method in interface no.marec.lsss.api.internal.InternalParameterFactory
header(String) - Static method in class no.marec.lsss.api.util.parameters.ParameterFactory: Returns a parameter rendered as a header.

I

inModuleThread(Consumer<T>) - Method in interface no.marec.lsss.api.modules.LsssModuleAccess: Wraps an observer in a new observer that delegates to this module's thread.
INSTANCE - Static variable in interface no.marec.lsss.api.internal.InternalLsss
instantToX(Instant) - Method in interface no.marec.lsss.api.echogram.EchogramPingTransform: Returns the x-coordinate corresponding to a time.
InternalLsss - Interface in no.marec.lsss.api.internal: This is an implementation detail and is not part of the LSSS API.
InternalLsssUtils - Interface in no.marec.lsss.api.internal: This is an implementation detail and is not part of the LSSS API.
InternalObjectFactory - Interface in no.marec.lsss.api.internal: This is an implementation detail and is not part of the LSSS API.
InternalParameterFactory - Interface in no.marec.lsss.api.internal: This is an implementation detail and is not part of the LSSS API.
Interpretation - Interface in no.marec.lsss.api.regions: The assignment to species for a Region.
interpretationChanged() - Method in interface no.marec.lsss.api.regions.Regions: Returns an observable for changed interpretation.
intersects(Rectangle2D) - Method in interface no.marec.lsss.api.modules.LsssOverlayDisplayData: Tests if this overlay intersects with a rectangle.
intParameter(String, String, int, String, String) - Method in interface no.marec.lsss.api.internal.InternalParameterFactory
intParameter(String, String, int, String, String) - Static method in class no.marec.lsss.api.util.parameters.ParameterFactory: Returns a new parameter for int values.
isCancelled() - Method in interface no.marec.lsss.api.util.AsyncHandle: Returns true if cancelled.
isEmpty() - Method in interface no.marec.lsss.api.util.LineStripBuilder: Tests if any line strips have been added.
isValid(T) - Method in interface no.marec.lsss.api.util.parameters.ValueConstraint: Tests if a value is allowed.

K

keyPressed(KeyEvent) - Method in interface no.marec.lsss.api.modules.LsssOverlay: Called when this overlay is active and a key has been pressed.
keyReleased(KeyEvent) - Method in interface no.marec.lsss.api.modules.LsssOverlay: Called when this overlay is active and a key has been released.
keyTyped(KeyEvent) - Method in interface no.marec.lsss.api.modules.LsssOverlay: Called when this overlay is active and a key has been typed.
kHz() - Method in interface no.marec.lsss.api.util.Mouseover: Returns an observable for mouse frequency in kHz.

L

labelsChanged() - Method in interface no.marec.lsss.api.regions.Regions: Returns an observable for regions with modified labels.
lineSeparator() - Method in interface no.marec.lsss.api.internal.InternalParameterFactory
lineSeparator() - Static method in class no.marec.lsss.api.util.parameters.ParameterFactory: Returns a parameter rendered as a horizontal line.
lineStripBuilder(Path2D, Rectangle2D) - Static method in class no.marec.lsss.api.util.ObjectFactory: Returns a new line strip builder.
LineStripBuilder - Interface in no.marec.lsss.api.util: Builds multiple line strips by adding points.
lineStripIntersectsRectangle(Path2D, Rectangle2D) - Method in interface no.marec.lsss.api.internal.InternalLsssUtils
lineStripIntersectsRectangle(Path2D, Rectangle2D) - Static method in class no.marec.lsss.api.util.LsssUtils: Test for intersection between line strips and a rectangle.
listItem(ValueConstraint<T>, ValueStringifier<T>) - Static method in class no.marec.lsss.api.util.parameters.ValueConstraints
Location of plugins - Search tag in package no.marec.lsss.api: Section
logSvToSv(double) - Static method in class no.marec.lsss.api.util.LsssUtils: Converts sv from a logarithmic value to a linear value.
LsssAccess - Interface in no.marec.lsss.api: Access to LSSS functionality.
LsssModule - Interface in no.marec.lsss.api.modules: The base type for modules provided by an LSSS plugin.
LsssModuleAccess - Interface in no.marec.lsss.api.modules: Access to the actual module.
LsssOverlay - Interface in no.marec.lsss.api.modules: An overlay on the echogram or the map.
LsssOverlayAccess - Interface in no.marec.lsss.api.modules: Access to the actual overlay.
LsssOverlayDisplayData - Interface in no.marec.lsss.api.modules: The data to be displayed by a LsssOverlay.
LsssPlugin - Interface in no.marec.lsss.api: A plugin for adding new functionality to LSSS.
LsssPluginLoader - Interface in no.marec.lsss.api: Used with ServiceLoader.
lsssUtils() - Method in interface no.marec.lsss.api.internal.InternalLsss
LsssUtils - Class in no.marec.lsss.api.util: Various utility functions.
lt(T) - Static method in class no.marec.lsss.api.util.parameters.ValueConstraints
lte(T) - Static method in class no.marec.lsss.api.util.parameters.ValueConstraints

M

main(String[]) - Static method in class no.marec.lsss.api.util.development.DevStartLsssMain: Starts LSSS.
major() - Method in record class no.marec.lsss.api.ApiVersion: Returns the value of the major record component.
mapArea() - Method in interface no.marec.lsss.api.modules.MapOverlayAccess: Returns an observable for changes to the displayed area in the map.
MapOverlay - Interface in no.marec.lsss.api.modules: A map provided by an LSSS plugin.
MapOverlayAccess - Interface in no.marec.lsss.api.modules: Access to the actual map overlay.
maxLength(int) - Static method in class no.marec.lsss.api.util.parameters.ValueConstraints
minor() - Method in record class no.marec.lsss.api.ApiVersion: Returns the value of the minor record component.
ModuleConfig - Interface in no.marec.lsss.api.modules: The configuration of a LsssModule.
ModuleRegistry - Interface in no.marec.lsss.api.modules: For registering modules and overlays.
ModuleRegistry.RelativePosition - Interface in no.marec.lsss.api.modules: The requested positioning of a module relative to another.
ModuleRegistry.RelativePosition.After - Record Class in no.marec.lsss.api.modules: Place after the referenced module.
ModuleRegistry.RelativePosition.Before - Record Class in no.marec.lsss.api.modules: Place before the referenced module.
ModuleRegistry.RelativePosition.Default - Record Class in no.marec.lsss.api.modules: The default location.
ModuleRegistry.ViewModuleLocation - Enum Class in no.marec.lsss.api.modules: The possible locations of a view module.
mouseClicked(MouseEvent) - Method in interface no.marec.lsss.api.modules.LsssOverlay: Called when this overlay is active and a mouse button has been clicked.
mouseDragged(MouseEvent) - Method in interface no.marec.lsss.api.modules.LsssOverlay: Called when this overlay is active and the mouse button has been dragged.
mouseEntered(MouseEvent) - Method in interface no.marec.lsss.api.modules.LsssOverlay: Called when this overlay is active and the mouse enters the overlaid component.
mouseExited(MouseEvent) - Method in interface no.marec.lsss.api.modules.LsssOverlay: Called when this overlay is active and the mouse exits the overlaid component.
mouseMoved(MouseEvent) - Method in interface no.marec.lsss.api.modules.LsssOverlay: Called when this overlay is active and the mouse button has been moved.
mouseover() - Method in interface no.marec.lsss.api.LsssAccess: Returns a collection of observables for mouse movement.
Mouseover - Interface in no.marec.lsss.api.util: Various observables connected to mouse position.
mousePressed(MouseEvent) - Method in interface no.marec.lsss.api.modules.LsssOverlay: Called when this overlay is active and a mouse button has been pressed.
mouseReleased(MouseEvent) - Method in interface no.marec.lsss.api.modules.LsssOverlay: Called when this overlay is active and a mouse button has been released.

N

newLineStripBuilder(Path2D, Rectangle2D) - Method in interface no.marec.lsss.api.internal.InternalObjectFactory
newlyLoadedPings() - Method in interface no.marec.lsss.api.echogram.EchogramData: Returns the an observable for newly loaded pings.
no.marec.lsss.api - package no.marec.lsss.api: The LSSS API allows developing plugins that extend the functionality of LSSS.
no.marec.lsss.api.config - package no.marec.lsss.api.config: Configurations provided by an LSSS plugin.
no.marec.lsss.api.data - package no.marec.lsss.api.data: For accessing the pings in echosounder data.
no.marec.lsss.api.echogram - package no.marec.lsss.api.echogram: For accessing the echosounder data displayed in the echogram.
no.marec.lsss.api.internal - package no.marec.lsss.api.internal: This package contains implementation details and is not part of the LSSS API.
no.marec.lsss.api.modules - package no.marec.lsss.api.modules: Interfaces for the modules provided by an LSSS plugin.
no.marec.lsss.api.regions - package no.marec.lsss.api.regions: For accessing regions, and interpretation.
no.marec.lsss.api.util - package no.marec.lsss.api.util: Various utilities.
no.marec.lsss.api.util.development - package no.marec.lsss.api.util.development: Utilities for use during plugin development.
no.marec.lsss.api.util.observing - package no.marec.lsss.api.util.observing: Functionality for subscribing to notifications and observing values.
no.marec.lsss.api.util.parameters - package no.marec.lsss.api.util.parameters: Configuration parameters.
none() - Static method in class no.marec.lsss.api.util.parameters.ValueConstraints

O

objectFactory() - Method in interface no.marec.lsss.api.internal.InternalLsss
ObjectFactory - Class in no.marec.lsss.api.util: For creating new instances of objects represented in the LSSS API by interfaces.
objectParameter(String, String, T, List<T>, String) - Static method in class no.marec.lsss.api.util.parameters.ParameterFactory: Returns a new parameter for selection among a list of values.
ObjectParameterValue - Interface in no.marec.lsss.api.util.parameters: Used when displaying a list of allowed values for a parameter.
Observable<T> - Interface in no.marec.lsss.api.util.observing: Interface for classes that can be observed.
observableProperty(T) - Method in interface no.marec.lsss.api.internal.InternalObjectFactory
observableProperty(T) - Static method in class no.marec.lsss.api.util.ObjectFactory: Returns a new observable property.
ObservableProperty<T> - Interface in no.marec.lsss.api.util.observing: A mutable value container.
ObservableValue<T> - Interface in no.marec.lsss.api.util.observing: A value container that emits notifications when the value changes.
of(Function<T, String>, Function<ValueStringifier<T>, String>) - Static method in class no.marec.lsss.api.util.parameters.ValueConstraints
ofValues(List<T>) - Static method in class no.marec.lsss.api.util.parameters.ValueConstraints
onActivate() - Method in interface no.marec.lsss.api.modules.LsssOverlay: Called when this overlay becomes the active overlay.
onDeactivate() - Method in interface no.marec.lsss.api.modules.LsssOverlay: Called when this overlay no longer is the active overlay.
onDisable() - Method in interface no.marec.lsss.api.modules.LsssModule: Called when the module becomes disabled.
onEnable(SubscriptionRegistry) - Method in interface no.marec.lsss.api.modules.LsssModule: Called when the module becomes enabled.
optionalFloatParameter(String, String, Optional<Float>, String, String) - Method in interface no.marec.lsss.api.internal.InternalParameterFactory
optionalFloatParameter(String, String, Optional<Float>, String, String) - Static method in class no.marec.lsss.api.util.parameters.ParameterFactory: Returns a new parameter for optional float values.
optionalIntParameter(String, String, Optional<Integer>, String, String) - Method in interface no.marec.lsss.api.internal.InternalParameterFactory
optionalIntParameter(String, String, Optional<Integer>, String, String) - Static method in class no.marec.lsss.api.util.parameters.ParameterFactory: Returns a new parameter for optional int values.

P

parameterFactory() - Method in interface no.marec.lsss.api.internal.InternalLsss
ParameterFactory - Class in no.marec.lsss.api.util.parameters: Factory for creating instances of ConfigParameter.
physicalDepthToDepth(float) - Method in interface no.marec.lsss.api.data.PingDataset: Converts a physical depth to echogram depth.
Ping - Interface in no.marec.lsss.api.data: A ping with sample data on the different channels.
PingConfiguration - Interface in no.marec.lsss.api.data: Configuration for the pings in a PingDataset.
pingDataset() - Method in interface no.marec.lsss.api.LsssAccess: Returns the echosounder data.
PingDataset - Interface in no.marec.lsss.api.data: A dataset consisting of a sequence of Ping.
pingIndex() - Method in interface no.marec.lsss.api.util.Mouseover: Returns an observable for mouse ping index.
PingIndex - Interface in no.marec.lsss.api.data: An index into a PingDataset for a Ping.
pingRange() - Method in interface no.marec.lsss.api.echogram.EchogramData: Returns the ping range displayed in the echogram.
pingRange() - Method in interface no.marec.lsss.api.regions.RegionChangeEvent: Returns the ping range containing the changes.
pingRange(PingIndex, PingIndex) - Method in interface no.marec.lsss.api.internal.InternalObjectFactory
pingRange(PingIndex, PingIndex) - Static method in class no.marec.lsss.api.util.ObjectFactory: Returns a new ping range.
PingRange - Interface in no.marec.lsss.api.data: A half-open interval of PingIndexes.
pixToGeo(double, double) - Method in interface no.marec.lsss.api.util.GeoTransform: Converts image coordinates to geographical coordinates.
pixToGeo(Point2D) - Method in interface no.marec.lsss.api.util.GeoTransform: Converts image coordinates to geographical coordinates.

R

recompute() - Method in interface no.marec.lsss.api.modules.LsssOverlayAccess: Triggers a new computation of this overlay's LsssOverlayDisplayData.
refId() - Method in record class no.marec.lsss.api.modules.ModuleRegistry.RelativePosition.After: Returns the value of the refId record component.
refId() - Method in record class no.marec.lsss.api.modules.ModuleRegistry.RelativePosition.Before: Returns the value of the refId record component.
Region - Interface in no.marec.lsss.api.regions: A region is a part of the echogram interpretation.
RegionChangeEvent - Interface in no.marec.lsss.api.regions: An event indicating that some regions have changed.
regions() - Method in interface no.marec.lsss.api.LsssAccess: Returns access to regions and interpretation.
regions() - Method in interface no.marec.lsss.api.regions.RegionChangeEvent: Returns the regions that are changed.
Regions - Interface in no.marec.lsss.api.regions: A collection of Regions.
reloadData() - Method in interface no.marec.lsss.api.LsssAccess: Returns an observable for when data should be reloaded.
removeFunction(EchogramPlotFunction) - Method in interface no.marec.lsss.api.modules.EchogramPlot: Removes a previously added function.
removeGui() - Method in class no.marec.lsss.api.util.GuiHolder: Removes the current gui.
repaint() - Method in interface no.marec.lsss.api.modules.LsssOverlayAccess: Triggers a repaint of the overlaid module.
Restricted - Interface in no.marec.lsss.api.internal: This is an implementation detail and is not part of the LSSS API.
RIGHT - Enum constant in enum class no.marec.lsss.api.modules.ModuleRegistry.ViewModuleLocation: The right-hand edge.
runCancellableTask(String, Consumer<AsyncHandle>) - Method in interface no.marec.lsss.api.LsssAccess: Runs a task and shows a dialog with a cancel button after a while.

S

selected() - Method in interface no.marec.lsss.api.modules.EchogramPlotFunction: Returns an observable property for whether this function is selected.
selected() - Method in interface no.marec.lsss.api.regions.Regions: Returns an observable for the selected regions.
selectionParameter(String, String, T, List<T>, String) - Method in interface no.marec.lsss.api.internal.InternalParameterFactory
setAssignments(Map<Integer, Float>) - Method in interface no.marec.lsss.api.regions.ChannelInterpretation: Sets the species assignments.
setConstraint(ValueConstraint<T>) - Method in interface no.marec.lsss.api.util.parameters.ConfigParameter: Set a constraint on the values accepted by this parameter.
setCursor(Cursor) - Method in interface no.marec.lsss.api.modules.LsssOverlayAccess: Sets the cursor to be displayed.
setLabels(Set<String>) - Method in interface no.marec.lsss.api.regions.Region: Sets the labels assigned to this region.
setLatitude(double) - Method in class no.marec.lsss.api.util.GeoPoint: Sets the latitude (y-coordinate) of this point.
setLongitude(double) - Method in class no.marec.lsss.api.util.GeoPoint: Sets the longitude (x-coordinate) of this point.
setRestSpecies(Set<Integer>) - Method in interface no.marec.lsss.api.regions.Interpretation: Sets the rest species.
setSelected(Collection<? extends Region>) - Method in interface no.marec.lsss.api.regions.Regions: Replaces the selected regions.
setup() - Method in interface no.marec.lsss.api.LsssPlugin: Called after all modules are created.
setValue(T) - Method in interface no.marec.lsss.api.util.observing.ObservableProperty: Sets the value.
spaceSeparator() - Method in interface no.marec.lsss.api.internal.InternalParameterFactory
spaceSeparator() - Static method in class no.marec.lsss.api.util.parameters.ParameterFactory: Returns a parameter rendered as a vertical space.
startLsss(String[]) - Method in interface no.marec.lsss.api.internal.DevUtils
stringify(T) - Method in interface no.marec.lsss.api.util.parameters.ValueStringifier: Returns the string representation of a value.
stringParameter(String, String, String, String) - Method in interface no.marec.lsss.api.internal.InternalParameterFactory
stringParameter(String, String, String, String) - Static method in class no.marec.lsss.api.util.parameters.ParameterFactory: Returns a new parameter for string values.
subsampledPingIndices() - Method in interface no.marec.lsss.api.echogram.EchogramData: Returns the ping indices to be displayed in the echogram.
subscribe(Consumer<? super T>) - Method in interface no.marec.lsss.api.util.observing.Observable: Registers an observer.
Subscription - Interface in no.marec.lsss.api.util.observing: A subscription returned from Observable.subscribe(java.util.function.Consumer).
SubscriptionRegistry - Interface in no.marec.lsss.api.util.observing: A collection of Subscriptions that can be unsubscribed later.
surveyDirectoryParameter(LsssAccess, String, String) - Method in interface no.marec.lsss.api.internal.InternalParameterFactory
surveyDirectoryParameter(LsssAccess, String, String) - Static method in class no.marec.lsss.api.util.parameters.ParameterFactory: Returns a new survey directory parameter.
SvChannelData - Interface in no.marec.lsss.api.data: Sample data containing sv and angles.
svToLogSv(double) - Static method in class no.marec.lsss.api.util.LsssUtils: Converts sv from a linear value to a logarithmic value.

T

The @DoNotImplement annotation - Search tag in package no.marec.lsss.api: Section
toString() - Method in record class no.marec.lsss.api.ApiVersion: Returns a string representation of this record class.
toString() - Method in record class no.marec.lsss.api.modules.ModuleRegistry.RelativePosition.After: Returns a string representation of this record class.
toString() - Method in record class no.marec.lsss.api.modules.ModuleRegistry.RelativePosition.Before: Returns a string representation of this record class.
toString() - Method in record class no.marec.lsss.api.modules.ModuleRegistry.RelativePosition.Default: Returns a string representation of this record class.
toString() - Method in interface no.marec.lsss.api.util.parameters.ObjectParameterValue: Returns the string representation of this value.

U

unsubscribe() - Method in interface no.marec.lsss.api.util.observing.Subscription: Cancels this subscription.

V

validate(T) - Method in interface no.marec.lsss.api.util.parameters.ValueConstraint: Checks if a value is valid.
ValueConstraint<T> - Interface in no.marec.lsss.api.util.parameters: For constraining the set of allowed values.
ValueConstraints - Class in no.marec.lsss.api.util.parameters: Utility class for creating instances of ValueConstraint.
valueOf(String) - Static method in enum class no.marec.lsss.api.modules.ModuleRegistry.ViewModuleLocation: Returns the enum constant of this class with the specified name.
values() - Static method in enum class no.marec.lsss.api.modules.ModuleRegistry.ViewModuleLocation: Returns an array containing the constants of this enum class, in the order they are declared.
ValueStringifier<T> - Interface in no.marec.lsss.api.util.parameters: Converts values to string.
ViewModule - Interface in no.marec.lsss.api.modules: A view module provided by an LSSS plugin.
ViewModule.Gui - Interface in no.marec.lsss.api.modules: The GUI created by this view module.
ViewModuleAccess - Interface in no.marec.lsss.api.modules: Access to the actual view module.
VoidConfigParameter - Interface in no.marec.lsss.api.util.parameters: Configuration parameters without a value.

W

withExtraValidation(ValueConstraint<T>) - Method in interface no.marec.lsss.api.util.parameters.ValueConstraint: Creates a new composite constraint.
withGui(Consumer<T>) - Method in class no.marec.lsss.api.util.GuiHolder: Accesses the GUI later in the event dispatch thread.

X

xToContainingSubsampledPingIndex(double) - Method in interface no.marec.lsss.api.echogram.EchogramPingTransform: Returns the subsampled ping index containing an x-coordinate.
xToInstant(double) - Method in interface no.marec.lsss.api.echogram.EchogramPingTransform: Returns the time corresponding to an x-coordinate.

Y

yToDepth(double, Instant) - Method in interface no.marec.lsss.api.echogram.EchogramDepthTransform: Returns the depth corresponding to a y-coordinate.
yToDepth(double, PingIndex) - Method in interface no.marec.lsss.api.echogram.EchogramDepthTransform: Returns the depth corresponding to a y-coordinate.

A B C D E F G H I K L M N O P R S T U V W X Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form