weka.dl4j.interpretability

Class AbstractCNNSaliencyMapWrapper

java.lang.Object

weka.dl4j.interpretability.AbstractCNNSaliencyMapWrapper

All Implemented Interfaces:

java.io.Serializable, weka.core.OptionHandler

Direct Known Subclasses:

WekaScoreCAM

public abstract class AbstractCNNSaliencyMapWrapper
extends java.lang.Object
implements java.io.Serializable, weka.core.OptionHandler

WEKA Wrapper for a Saliency Map Generator (e.g., ScoreCAM). Provides the WEKA handles and getters/setters to control the generator from the command line/GUI.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractCNNSaliencyMapWrapper()

Method Summary

Modifier and Type	Method and Description
abstract java.awt.image.BufferedImage	generateHeatmapToImage() Generates heatmaps, returning a human-viewable heatmap summary.
int	getBatchSize()
java.lang.String[]	getClassMap()
CustomModelSetup	getCustomModelSetup()
Dl4jMlpClassifier	getDl4jMlpClassifier()
boolean	getNormalizeHeatmap()
java.lang.String[]	getOptions() Gets the current settings of the Classifier.
java.io.File	getOutputFile()
ProgressManager	getProgressManager()
java.lang.String	getTargetClassIDs()
int[]	getTargetClassIDsAsInt()
java.util.Enumeration<weka.core.Option>	listOptions() Returns an enumeration describing the available options.
abstract void	processImage(java.io.File imageFile) Main processing entrypoint.
void	saveResult(java.awt.image.BufferedImage completeCompositeImage) Save the supplied composite image to a file.
void	setBatchSize(int batchSize)
void	setClassMap(java.lang.String[] classMap)
void	setCustomModelSetup(CustomModelSetup customModelSetup)
void	setDl4jMlpClassifier(Dl4jMlpClassifier dl4jMlpClassifier)
void	setNormalizeHeatmap(boolean normalizeHeatmap)
void	setOptions(java.lang.String[] options) Parses a given list of options.
void	setOutputFile(java.io.File outputFileLocation)
void	setTargetClassIDs(java.lang.String targetClassIDs)
void	setTargetClassIDsAsInt(int[] targetClassIDs)

Methods inherited from class java.lang.Object

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

Methods inherited from interface weka.core.OptionHandler

makeCopy

Constructor Detail

AbstractCNNSaliencyMapWrapper

public AbstractCNNSaliencyMapWrapper()

Method Detail

processImage

public abstract void processImage(java.io.File imageFile)

Main processing entrypoint. Takes an image as input, and performs the necessary processing on it. Note that this is performed separately to the actual saliency map generation. This method should only perform the expensive one-time processing on an image.

Parameters:

imageFile - Image to process heatmap for.

generateHeatmapToImage

public abstract java.awt.image.BufferedImage generateHeatmapToImage()

Generates heatmaps, returning a human-viewable heatmap summary.

Returns:

Human-viewable heatmap summary.

saveResult

public void saveResult(java.awt.image.BufferedImage completeCompositeImage)

Save the supplied composite image to a file.

Parameters:

completeCompositeImage - Image to save.

getClassMap

@ProgrammaticProperty
public java.lang.String[] getClassMap()

setClassMap

public void setClassMap(java.lang.String[] classMap)

getDl4jMlpClassifier

@ProgrammaticProperty
public Dl4jMlpClassifier getDl4jMlpClassifier()

setDl4jMlpClassifier

public void setDl4jMlpClassifier(Dl4jMlpClassifier dl4jMlpClassifier)

getCustomModelSetup

@ProgrammaticProperty
public CustomModelSetup getCustomModelSetup()

setCustomModelSetup

public void setCustomModelSetup(CustomModelSetup customModelSetup)

getBatchSize

@OptionMetadata(displayName="Batch size",
                description="The mini batch size to use for map generation",
                commandLineParamName="bs",
                commandLineParamSynopsis="-bs <int>",
                displayOrder=1)
public int getBatchSize()

setBatchSize

public void setBatchSize(int batchSize)

getTargetClassIDs

@OptionMetadata(displayName="Target Classes",
                description="Output class to generate saliency maps for; default is -1 (use the highest probability class). This only needs to be set if wanting to use a non-default class from the *command line*; if using the *GUI*, the \'View Saliency Map\' window contains the interface for setting this.",
                commandLineParamName="target-classes",
                commandLineParamSynopsis="-target-classes <int,int,...>",
                displayOrder=2)
 @ProgrammaticProperty
public java.lang.String getTargetClassIDs()

setTargetClassIDs

public void setTargetClassIDs(java.lang.String targetClassIDs)

getTargetClassIDsAsInt

public int[] getTargetClassIDsAsInt()

setTargetClassIDsAsInt

public void setTargetClassIDsAsInt(int[] targetClassIDs)

getOutputFile

@OptionMetadata(displayName="Output file location",
                description="File for the saliency map to be saved in",
                commandLineParamName="output",
                commandLineParamSynopsis="-output <file location>",
                displayOrder=3)
 @ProgrammaticProperty
public java.io.File getOutputFile()

setOutputFile

public void setOutputFile(java.io.File outputFileLocation)

getNormalizeHeatmap

@OptionMetadata(displayName="Normalize heatmap",
                description="When generating the heatmap, should the values be normalized to be in [0, 1]",
                commandLineParamName="normalize",
                commandLineParamSynopsis="-normalize",
                commandLineParamIsFlag=true)
 @ProgrammaticProperty
public boolean getNormalizeHeatmap()

setNormalizeHeatmap

public void setNormalizeHeatmap(boolean normalizeHeatmap)

getProgressManager

public ProgressManager getProgressManager()

listOptions

public java.util.Enumeration<weka.core.Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Returns:

an enumeration of all the available options.

getOptions

public java.lang.String[] getOptions()

Gets the current settings of the Classifier.

Specified by:

getOptions in interface weka.core.OptionHandler

Returns:

an array of strings suitable for passing to setOptions

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses a given list of options.

Specified by:

setOptions in interface weka.core.OptionHandler

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported