Class ExplanationMetadata.InputMetadata.Visualization (3.43.0)

public static final class ExplanationMetadata.InputMetadata.Visualization extends GeneratedMessageV3 implements ExplanationMetadata.InputMetadata.VisualizationOrBuilder

Visualization configurations for image explanation.

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

Inheritance

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

Static Fields

CLIP_PERCENT_LOWERBOUND_FIELD_NUMBER

public static final int CLIP_PERCENT_LOWERBOUND_FIELD_NUMBER
Field Value
Type Description
int

CLIP_PERCENT_UPPERBOUND_FIELD_NUMBER

public static final int CLIP_PERCENT_UPPERBOUND_FIELD_NUMBER
Field Value
Type Description
int

COLOR_MAP_FIELD_NUMBER

public static final int COLOR_MAP_FIELD_NUMBER
Field Value
Type Description
int

OVERLAY_TYPE_FIELD_NUMBER

public static final int OVERLAY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

POLARITY_FIELD_NUMBER

public static final int POLARITY_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExplanationMetadata.InputMetadata.Visualization getDefaultInstance()
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ExplanationMetadata.InputMetadata.Visualization.Builder newBuilder()
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.Builder

newBuilder(ExplanationMetadata.InputMetadata.Visualization prototype)

public static ExplanationMetadata.InputMetadata.Visualization.Builder newBuilder(ExplanationMetadata.InputMetadata.Visualization prototype)
Parameter
Name Description
prototype ExplanationMetadata.InputMetadata.Visualization
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.Builder

parseDelimitedFrom(InputStream input)

public static ExplanationMetadata.InputMetadata.Visualization parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.InputMetadata.Visualization parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExplanationMetadata.InputMetadata.Visualization parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.InputMetadata.Visualization parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExplanationMetadata.InputMetadata.Visualization parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.InputMetadata.Visualization parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExplanationMetadata.InputMetadata.Visualization parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.InputMetadata.Visualization parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExplanationMetadata.InputMetadata.Visualization parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.InputMetadata.Visualization parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExplanationMetadata.InputMetadata.Visualization parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.InputMetadata.Visualization parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getClipPercentLowerbound()

public float getClipPercentLowerbound()

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()

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.

float clip_percent_upperbound = 4;

Returns
Type Description
float

The clipPercentUpperbound.

getColorMap()

public ExplanationMetadata.InputMetadata.Visualization.ColorMap 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.

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

Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.ColorMap

The colorMap.

getColorMapValue()

public int getColorMapValue()

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.aiplatform.v1.ExplanationMetadata.InputMetadata.Visualization.ColorMap color_map = 3;

Returns
Type Description
int

The enum numeric value on the wire for colorMap.

getDefaultInstanceForType()

public ExplanationMetadata.InputMetadata.Visualization getDefaultInstanceForType()
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization

getOverlayType()

public ExplanationMetadata.InputMetadata.Visualization.OverlayType 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.

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

Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.OverlayType

The overlayType.

getOverlayTypeValue()

public int getOverlayTypeValue()

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.aiplatform.v1.ExplanationMetadata.InputMetadata.Visualization.OverlayType overlay_type = 6;

Returns
Type Description
int

The enum numeric value on the wire for overlayType.

getParserForType()

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

getPolarity()

public ExplanationMetadata.InputMetadata.Visualization.Polarity getPolarity()

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

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

Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.Polarity

The polarity.

getPolarityValue()

public int getPolarityValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for polarity.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getType()

public ExplanationMetadata.InputMetadata.Visualization.Type 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.

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

Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.Type

The type.

getTypeValue()

public int getTypeValue()

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.aiplatform.v1.ExplanationMetadata.InputMetadata.Visualization.Type type = 1;

Returns
Type Description
int

The enum numeric value on the wire for type.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExplanationMetadata.InputMetadata.Visualization.Builder newBuilderForType()
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExplanationMetadata.InputMetadata.Visualization.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExplanationMetadata.InputMetadata.Visualization.Builder toBuilder()
Returns
Type Description
ExplanationMetadata.InputMetadata.Visualization.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException