Package rawDeepLearningClassifier.dlClassification.dummyClassifier

Class DummyClassifier

java.lang.Object

rawDeepLearningClassifier.dlClassification.dummyClassifier.DummyClassifier

All Implemented Interfaces:

DLClassiferModel

public class DummyClassifier
extends Object
implements DLClassiferModel

Classifier which returns a random results. Used for debugging and testing.

Author:

Jamie Macaulay

Constructor Summary

Constructors

Constructor	Description
DummyClassifier()

Method Summary

Modifier and Type	Method	Description
void	closeModel()	Called whenever PAMGuard stops.
ArrayList<Class>	getAllowedDataTypes()	Get the allowed data types for the model.The can be null in which case only data units with raw data are allowed.
DLClassName[]	getClassNames()	Get the number of output classes.
DLControl	getDLControl()	Reference to the dlControl
Serializable	getDLModelSettings()	A settings object that can be saved.
DLStatus	getModelStatus()	Check whether a model has been selected and can be loaded successfully.
DLCLassiferModelUI	getModelUI()	Get any UI components for the model.
String	getName()	Get the name of the model.
int	getNumClasses()	Get the number of output classes.
boolean	isModelType(URI uri)	Check whether a URI is compatible with a classification framework
void	prepModel()	Prepare the model.
ArrayList<? extends PredictionResult>	runModel(ArrayList<? extends PamDataUnit> rawDataUnit)	Run the deep learning model on a list of grouped raw data units and return a corresponding list of model results.
DLStatus	setModel(URI model)	Set and load the model.

Methods inherited from class java.lang.Object

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

Constructor Details

DummyClassifier

public DummyClassifier()

Method Details

prepModel

public void prepModel()

Description copied from interface: DLClassiferModel

Prepare the model. This is called on PAMGuard start up and before processing in viewer mode.

Specified by:

prepModel in interface DLClassiferModel

closeModel

public void closeModel()

Description copied from interface: DLClassiferModel

Called whenever PAMGuard stops.

Specified by:

closeModel in interface DLClassiferModel

getName

public String getName()

Description copied from interface: DLClassiferModel

Get the name of the model.

Specified by:

getName in interface DLClassiferModel

Returns:

the name of the model.

getModelUI

public DLCLassiferModelUI getModelUI()

Description copied from interface: DLClassiferModel

Get any UI components for the model. Can be null.

Specified by:

getModelUI in interface DLClassiferModel

Returns:

UI components for the model.

getDLModelSettings

public Serializable getDLModelSettings()

Description copied from interface: DLClassiferModel

A settings object that can be saved.

Specified by:

getDLModelSettings in interface DLClassiferModel

Returns:

the settings object.

getNumClasses

public int getNumClasses()

Description copied from interface: DLClassiferModel

Get the number of output classes.

Specified by:

getNumClasses in interface DLClassiferModel

Returns:

the number of output classes.

getClassNames

public DLClassName[] getClassNames()

Description copied from interface: DLClassiferModel

Get the number of output classes.

Specified by:

getClassNames in interface DLClassiferModel

Returns:

the number of output classes.

runModel

public ArrayList<? extends PredictionResult> runModel(ArrayList<? extends PamDataUnit> rawDataUnit)

Description copied from interface: DLClassiferModel

Run the deep learning model on a list of grouped raw data units and return a corresponding list of model results.

Note the reason we use list is that often it is more efficient to get a model to predict a stacked group of inputs rather than one at a time.

Specified by:

runModel in interface DLClassiferModel

Returns:

the deep learning model.

getDLControl

public DLControl getDLControl()

Description copied from interface: DLClassiferModel

Reference to the dlControl

Specified by:

getDLControl in interface DLClassiferModel

Returns:

reference to the DL control.

getModelStatus

public DLStatus getModelStatus()

Description copied from interface: DLClassiferModel

Check whether a model has been selected and can be loaded successfully.

Specified by:

getModelStatus in interface DLClassiferModel

isModelType

public boolean isModelType(URI uri)

Description copied from interface: DLClassiferModel

Check whether a URI is compatible with a classification framework

Specified by:

isModelType in interface DLClassiferModel

Parameters:

uri - - the URI to the model

Returns:

true if the model is compatible.

setModel

public DLStatus setModel(URI model)

Description copied from interface: DLClassiferModel

Set and load the model.

Specified by:

setModel in interface DLClassiferModel

Returns:

the status of the model e.g. if there has been an error loading

getAllowedDataTypes

public ArrayList<Class> getAllowedDataTypes()

Description copied from interface: DLClassiferModel

Get the allowed data types for the model.The can be null in which case only data units with raw data are allowed.

Specified by:

getAllowedDataTypes in interface DLClassiferModel

Returns:

a list of the allowed data types.