Class ImageSummary

java.lang.Object

org.tensorflow.op.RawOp

org.tensorflow.op.summary.ImageSummary

All Implemented Interfaces:

Shaped, Op, Operand<TString>

@Operator(group="summary")
public final class ImageSummary
extends RawOp
implements Operand<TString>

Outputs a Summary protocol buffer with images. The summary has up to max_images summary values containing images. The images are built from tensor which must be 4-D with shape [batch_size, height, width, channels] and where channels can be:

• 1: tensor is interpreted as Grayscale.
• 3: tensor is interpreted as RGB.
• 4: tensor is interpreted as RGBA.

The images have the same number of channels as the input tensor. For float input, the values are normalized one image at a time to fit in the range [0, 255]. uint8 values are unchanged. The op uses two different normalization algorithms:

• If the input values are all positive, they are rescaled so the largest one is 255.

• If any input value is negative, the values are shifted so input value 0.0 is at 127. They are then rescaled so that either the smallest value is 0, or the largest one is 255.

The tag argument is a scalar Tensor of type string. It is used to build the tag of the summary values:

• If max_images is 1, the summary value tag is 'tag/image'.
• If max_images is greater than 1, the summary value tags are generated sequentially as 'tag/image/0', 'tag/image/1', etc.

The bad_color argument is the color to use in the generated images for non-finite input values. It is a uint8 1-D tensor of length channels. Each element must be in the range [0, 255] (It represents the value of a pixel in the output image). Non-finite values in the input tensor are replaced by this tensor in the output image. The default value is the color red.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImageSummary.Inputs
static class	ImageSummary.Options	Optional attributes for ImageSummary

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OP_NAME	The name of this op, as known by TensorFlow core engine

Fields inherited from class RawOp

operation

Constructor Summary

Constructors

Constructor	Description
ImageSummary(Operation operation)

Method Summary

Modifier and Type	Method	Description
Output<TString>	asOutput()	Returns the symbolic handle of the tensor.
static ImageSummary.Options	badColor(Tensor badColor)	Sets the badColor option.
static ImageSummary	create(Scope scope, Operand<TString> tag, Operand<? extends TNumber> tensor, ImageSummary.Options... options)	Factory method to create a class wrapping a new ImageSummary operation.
static ImageSummary.Options	maxImages(Long maxImages)	Sets the maxImages option.
Output<TString>	summary()	Gets summary.

Methods inherited from class RawOp

equals, hashCode, op, toString

Methods inherited from class Object

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

Methods inherited from interface Op

env, op

Methods inherited from interface Operand

asTensor, shape, type

Methods inherited from interface Shaped

rank, size

Field Details

OP_NAME

public static final String OP_NAME

The name of this op, as known by TensorFlow core engine

See Also:

• Constant Field Values

Constructor Details

ImageSummary

public ImageSummary(Operation operation)

Method Details

create

@Endpoint(describeByClass=true)
public static ImageSummary create(Scope scope,
 Operand<TString> tag,
 Operand<? extends TNumber> tensor,
 ImageSummary.Options... options)

Factory method to create a class wrapping a new ImageSummary operation.

Parameters:

scope - current scope

tag - Scalar. Used to build the tag attribute of the summary values.

tensor - 4-D of shape [batch_size, height, width, channels] where channels is 1, 3, or 4.

options - carries optional attribute values

Returns:

a new instance of ImageSummary

maxImages

public static ImageSummary.Options maxImages(Long maxImages)

Sets the maxImages option.

Parameters:

maxImages - Max number of batch elements to generate images for.

Returns:

this Options instance.

badColor

public static ImageSummary.Options badColor(Tensor badColor)

Sets the badColor option.

Parameters:

badColor - Color to use for pixels with non-finite values.

Returns:

this Options instance.

summary

public Output<TString> summary()

Gets summary. Scalar. Serialized Summary protocol buffer.

Returns:

summary.

asOutput

public Output<TString> asOutput()

Description copied from interface: Operand

Returns the symbolic handle of the tensor.

Inputs to TensorFlow operations are outputs of another TensorFlow operation. This method is used to obtain a symbolic handle that represents the computation of the input.

Specified by:

asOutput in interface Operand<TString>

See Also:

• OperationBuilder.addInput(Output)