org.tensorflow.op.image

Class EncodeJpeg

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.image.EncodeJpeg

All Implemented Interfaces:

Op, Operand<String>

@Operator(group="image")
public final class EncodeJpeg
extends PrimitiveOp
implements Operand<String>

JPEG-encode an image.

`image` is a 3-D uint8 Tensor of shape `[height, width, channels]`.

The attr `format` can be used to override the color format of the encoded output. Values can be:

• `''`: Use a default format based on the number of channels in the image.
• `grayscale`: Output a grayscale JPEG image. The `channels` dimension of `image` must be 1.
• `rgb`: Output an RGB JPEG image. The `channels` dimension of `image` must be 3.

If `format` is not specified or is the empty string, a default format is picked in function of the number of channels in `image`:

• 1: Output a grayscale image.
• 3: Output an RGB image.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
Output<String>	asOutput() Returns the symbolic handle of a tensor.
static EncodeJpeg.Options	chromaDownsampling(Boolean chromaDownsampling)
Output<String>	contents() 0-D.
static EncodeJpeg	create(Scope scope, Operand<UInt8> image, EncodeJpeg.Options... options) Factory method to create a class wrapping a new EncodeJpeg operation.
static EncodeJpeg.Options	densityUnit(String densityUnit)
static EncodeJpeg.Options	format(String format)
static EncodeJpeg.Options	optimizeSize(Boolean optimizeSize)
static EncodeJpeg.Options	progressive(Boolean progressive)
static EncodeJpeg.Options	quality(Long quality)
static EncodeJpeg.Options	xDensity(Long xDensity)
static EncodeJpeg.Options	xmpMetadata(String xmpMetadata)
static EncodeJpeg.Options	yDensity(Long yDensity)

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, op, toString

Methods inherited from class java.lang.Object

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

Method Detail

create

public static EncodeJpeg create(Scope scope,
                                Operand<UInt8> image,
                                EncodeJpeg.Options... options)

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

Parameters:

scope - current scope

image - 3-D with shape `[height, width, channels]`.

options - carries optional attributes values

Returns:

a new instance of EncodeJpeg

format

public static EncodeJpeg.Options format(String format)

Parameters:

format - Per pixel image format.

quality

public static EncodeJpeg.Options quality(Long quality)

Parameters:

quality - Quality of the compression from 0 to 100 (higher is better and slower).

progressive

public static EncodeJpeg.Options progressive(Boolean progressive)

Parameters:

progressive - If True, create a JPEG that loads progressively (coarse to fine).

optimizeSize

public static EncodeJpeg.Options optimizeSize(Boolean optimizeSize)

Parameters:

optimizeSize - If True, spend CPU/RAM to reduce size with no quality change.

chromaDownsampling

public static EncodeJpeg.Options chromaDownsampling(Boolean chromaDownsampling)

Parameters:

chromaDownsampling - See http://en.wikipedia.org/wiki/Chroma_subsampling.

densityUnit

public static EncodeJpeg.Options densityUnit(String densityUnit)

Parameters:

densityUnit - Unit used to specify `x_density` and `y_density`: pixels per inch (`'in'`) or centimeter (`'cm'`).

xDensity

public static EncodeJpeg.Options xDensity(Long xDensity)

Parameters:

xDensity - Horizontal pixels per density unit.

yDensity

public static EncodeJpeg.Options yDensity(Long yDensity)

Parameters:

yDensity - Vertical pixels per density unit.

xmpMetadata

public static EncodeJpeg.Options xmpMetadata(String xmpMetadata)

Parameters:

xmpMetadata - If not empty, embed this XMP metadata in the image header.

contents

public Output<String> contents()

0-D. JPEG-encoded image.

asOutput

public Output<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<String>

See Also:

OperationBuilder.addInput(Output)