Package org.tensorflow.op.summary

Class ImageSummary

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.summary.ImageSummary

All Implemented Interfaces:

Op, Operand<java.lang.String>

@Operator(group="summary")
public final class ImageSummary
extends PrimitiveOp
implements Operand<java.lang.String>

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.Options	Optional attributes for ImageSummary

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method	Description
Output<java.lang.String>	asOutput()	Returns the symbolic handle of a tensor.
static ImageSummary.Options	badColor(Tensor<?> badColor)
static <T extends java.lang.Number> ImageSummary	create(Scope scope, Operand<java.lang.String> tag, Operand<T> tensor, ImageSummary.Options... options)	Factory method to create a class to wrap a new ImageSummary operation to the graph.
static ImageSummary.Options	maxImages(java.lang.Long maxImages)
Output<java.lang.String>	summary()	Scalar.

Methods inherited from class java.lang.Object

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

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, toString

Method Detail

create

public static <T extends java.lang.Number> ImageSummary create(Scope scope,
                                                               Operand<java.lang.String> tag,
                                                               Operand<T> tensor,
                                                               ImageSummary.Options... options)

Factory method to create a class to wrap a new ImageSummary operation to the graph.

Parameters:

scope - current graph 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 attributes values

Returns:

a new instance of ImageSummary

maxImages

public static ImageSummary.Options maxImages(java.lang.Long maxImages)

Parameters:

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

badColor

public static ImageSummary.Options badColor(Tensor<?> badColor)

Parameters:

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

summary

public Output<java.lang.String> summary()

Scalar. Serialized `Summary` protocol buffer.

asOutput

public Output<java.lang.String> asOutput()

Description copied from interface: Operand

Returns the symbolic handle of a 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<java.lang.String>

See Also:

OperationBuilder.addInput(Output)