ImageSummary

public final class ImageSummary

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 Classes

class ImageSummary.Options Optional attributes for ImageSummary

Constants

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

Public Methods

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

Inherited Methods

From class org.tensorflow.op.RawOp

final boolean	equals(Object obj)
final int	hashCode()
Operation	op() Return this unit of computation as a single `Operation`.
final String	toString()

From class java.lang.Object

boolean	equals(Object arg0)
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface org.tensorflow.op.Op

abstract ExecutionEnvironment	env() Return the execution environment this op was created in.
abstract Operation	op() Return this unit of computation as a single `Operation`.

From interface org.tensorflow.Operand

abstract Output<TString>	asOutput() Returns the symbolic handle of the tensor.
abstract TString	asTensor() Returns the tensor at this operand.
abstract Shape	shape() Returns the (possibly partially known) shape of the tensor referred to by the `Output` of this operand.
abstract Class<TString>	type() Returns the tensor type of this operand

From interface org.tensorflow.ndarray.Shaped

abstract int	rank()
abstract Shape	shape()
abstract long	size() Computes and returns the total size of this container, in number of values.

Constants

public static final String OP_NAME

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

Constant Value: "ImageSummary"

Public Methods

public Output<TString> asOutput ()

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.

public static ImageSummary.Options badColor (Tensor badColor)

Parameters

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

public static ImageSummary create (Scope scope, Operand<TString> tag, Operand<? extends TNumber> tensor, 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 attributes values

Returns

a new instance of ImageSummary

public static ImageSummary.Options maxImages (Long maxImages)

Parameters

maxImages	Max number of batch elements to generate images for.

public Output<TString> summary ()

Scalar. Serialized `Summary` protocol buffer.