com.google.api.services.language.v2.model

Class XPSVisualization

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.language.v2.model.XPSVisualization

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class XPSVisualization
extends com.google.api.client.json.GenericJson

Visualization configurations for image explanation.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Natural Language API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
XPSVisualization()

Method Summary

Modifier and Type	Method and Description
XPSVisualization	clone()
Float	getClipPercentLowerbound() Excludes attributions below the specified percentile, from the highlighted areas.
Float	getClipPercentUpperbound() Excludes attributions above the specified percentile from the highlighted areas.
String	getColorMap() The color scheme used for the highlighted areas.
String	getOverlayType() How the original image is displayed in the visualization.
String	getPolarity() Whether to only highlight pixels with positive contributions, negative or both.
String	getType() Type of the image visualization.
XPSVisualization	set(String fieldName, Object value)
XPSVisualization	setClipPercentLowerbound(Float clipPercentLowerbound) Excludes attributions below the specified percentile, from the highlighted areas.
XPSVisualization	setClipPercentUpperbound(Float clipPercentUpperbound) Excludes attributions above the specified percentile from the highlighted areas.
XPSVisualization	setColorMap(String colorMap) The color scheme used for the highlighted areas.
XPSVisualization	setOverlayType(String overlayType) How the original image is displayed in the visualization.
XPSVisualization	setPolarity(String polarity) Whether to only highlight pixels with positive contributions, negative or both.
XPSVisualization	setType(String type) Type of the image visualization.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

XPSVisualization

public XPSVisualization()

Method Detail

getClipPercentLowerbound

public Float getClipPercentLowerbound()

Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.

Returns:

value or null for none

setClipPercentLowerbound

public XPSVisualization setClipPercentLowerbound(Float clipPercentLowerbound)

Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.

Parameters:

clipPercentLowerbound - clipPercentLowerbound or null for none

getClipPercentUpperbound

public Float getClipPercentUpperbound()

Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.

Returns:

value or null for none

setClipPercentUpperbound

public XPSVisualization setClipPercentUpperbound(Float clipPercentUpperbound)

Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.

Parameters:

clipPercentUpperbound - clipPercentUpperbound or null for none

getColorMap

public String getColorMap()

The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.

Returns:

value or null for none

setColorMap

public XPSVisualization setColorMap(String colorMap)

The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.

Parameters:

colorMap - colorMap or null for none

getOverlayType

public String getOverlayType()

How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.

Returns:

value or null for none

setOverlayType

public XPSVisualization setOverlayType(String overlayType)

How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.

Parameters:

overlayType - overlayType or null for none

getPolarity

public String getPolarity()

Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.

Returns:

value or null for none

setPolarity

public XPSVisualization setPolarity(String polarity)

Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.

Parameters:

polarity - polarity or null for none

getType

public String getType()

Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.

Returns:

value or null for none

setType

public XPSVisualization setType(String type)

Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.

Parameters:

type - type or null for none

set

public XPSVisualization set(String fieldName,
                            Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public XPSVisualization clone()

Overrides:

clone in class com.google.api.client.json.GenericJson