Class ExplanationMetadata.InputMetadata.Visualization (0.3.0)

publicstaticfinalclass ExplanationMetadata.InputMetadata.VisualizationextendsGeneratedMessageV3implementsExplanationMetadata.InputMetadata.VisualizationOrBuilder

Visualization configurations for image explanation.

Protobuf type google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.Visualization

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExplanationMetadata.InputMetadata.Visualization

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

CLIP_PERCENT_LOWERBOUND_FIELD_NUMBER

publicstaticfinalintCLIP_PERCENT_LOWERBOUND_FIELD_NUMBER
Field Value
Type Description
int

CLIP_PERCENT_UPPERBOUND_FIELD_NUMBER

publicstaticfinalintCLIP_PERCENT_UPPERBOUND_FIELD_NUMBER
Field Value
Type Description
int

COLOR_MAP_FIELD_NUMBER

publicstaticfinalintCOLOR_MAP_FIELD_NUMBER
Field Value
Type Description
int

OVERLAY_TYPE_FIELD_NUMBER

publicstaticfinalintOVERLAY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

POLARITY_FIELD_NUMBER

publicstaticfinalintPOLARITY_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

publicstaticfinalintTYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticExplanationMetadata.InputMetadata.VisualizationgetDefaultInstance()
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticExplanationMetadata.InputMetadata.Visualization.BuildernewBuilder()
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.Builder

newBuilder(ExplanationMetadata.InputMetadata.Visualization prototype)

publicstaticExplanationMetadata.InputMetadata.Visualization.BuildernewBuilder(ExplanationMetadata.InputMetadata.Visualizationprototype)
Parameter
Name Description
prototype ExplanationMetadata.InputMetadata.Visualization
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.Builder

parseDelimitedFrom(InputStream input)

publicstaticExplanationMetadata.InputMetadata.VisualizationparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticExplanationMetadata.InputMetadata.VisualizationparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticExplanationMetadata.InputMetadata.VisualizationparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticExplanationMetadata.InputMetadata.VisualizationparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticExplanationMetadata.InputMetadata.VisualizationparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticExplanationMetadata.InputMetadata.VisualizationparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticExplanationMetadata.InputMetadata.VisualizationparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticExplanationMetadata.InputMetadata.VisualizationparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticExplanationMetadata.InputMetadata.VisualizationparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticExplanationMetadata.InputMetadata.VisualizationparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticExplanationMetadata.InputMetadata.VisualizationparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticExplanationMetadata.InputMetadata.VisualizationparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<ExplanationMetadata.InputMetadata.Visualization>parser()
Returns
Type Description
Parser<Visualization>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getClipPercentLowerbound()

publicfloatgetClipPercentLowerbound()

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

float clip_percent_lowerbound = 5;

Returns
Type Description
float

The clipPercentLowerbound.

getClipPercentUpperbound()

publicfloatgetClipPercentUpperbound()

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.

float clip_percent_upperbound = 4;

Returns
Type Description
float

The clipPercentUpperbound.

getColorMap()

publicExplanationMetadata.InputMetadata.Visualization.ColorMapgetColorMap()

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.

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.Visualization.ColorMap color_map = 3;

Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.ColorMap

The colorMap.

getColorMapValue()

publicintgetColorMapValue()

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.

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.Visualization.ColorMap color_map = 3;

Returns
Type Description
int

The enum numeric value on the wire for colorMap.

getDefaultInstanceForType()

publicExplanationMetadata.InputMetadata.VisualizationgetDefaultInstanceForType()
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization

getOverlayType()

publicExplanationMetadata.InputMetadata.Visualization.OverlayTypegetOverlayType()

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.

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.Visualization.OverlayType overlay_type = 6;

Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.OverlayType

The overlayType.

getOverlayTypeValue()

publicintgetOverlayTypeValue()

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.

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.Visualization.OverlayType overlay_type = 6;

Returns
Type Description
int

The enum numeric value on the wire for overlayType.

getParserForType()

publicParser<ExplanationMetadata.InputMetadata.Visualization>getParserForType()
Returns
Type Description
Parser<Visualization>
Overrides

getPolarity()

publicExplanationMetadata.InputMetadata.Visualization.PolaritygetPolarity()

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

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.Visualization.Polarity polarity = 2;

Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.Polarity

The polarity.

getPolarityValue()

publicintgetPolarityValue()

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

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.Visualization.Polarity polarity = 2;

Returns
Type Description
int

The enum numeric value on the wire for polarity.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getType()

publicExplanationMetadata.InputMetadata.Visualization.TypegetType()

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.

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.Visualization.Type type = 1;

Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.Type

The type.

getTypeValue()

publicintgetTypeValue()

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.

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.Visualization.Type type = 1;

Returns
Type Description
int

The enum numeric value on the wire for type.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicExplanationMetadata.InputMetadata.Visualization.BuildernewBuilderForType()
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedExplanationMetadata.InputMetadata.Visualization.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicExplanationMetadata.InputMetadata.Visualization.BuildertoBuilder()
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.