DecodeImage

public final class DecodeImage

Function for decode_bmp, decode_gif, decode_jpeg, and decode_png.

Detects whether an image is a BMP, GIF, JPEG, or PNG, and performs the appropriate operation to convert the input bytes string into a Tensor of type dtype.

NOTE: decode_gif returns a 4-D array [num_frames, height, width, 3], as opposed to decode_bmp, decode_jpeg and decode_png, which return 3-D arrays [height, width, num_channels]. Make sure to take this into account when constructing your graph if you are intermixing GIF files with BMP, JPEG, and/or PNG files. Alternately, set the expand_animations argument of this function to False, in which case the op will return 3-dimensional tensors and will truncate animated GIF files to the first frame.

NOTE: If the first frame of an animated GIF does not occupy the entire canvas (maximum frame width x maximum frame height), then it fills the unoccupied areas (in the first frame) with zeros (black). For frames after the first frame that does not occupy the entire canvas, it uses the previous frame to fill the unoccupied areas.

Nested Classes

class

DecodeImage.Options

Optional attributes for DecodeImage

Constants

String

OP_NAME

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

Public Methods

Output<T>	asOutput() Returns the symbolic handle of the tensor.
static DecodeImage.Options	channels(Long channels)
static <T extends TNumber> DecodeImage<T>	create(Scope scope, Operand<TString> contents, Class<T> dtype, Options... options) Factory method to create a class wrapping a new DecodeImage operation.
static DecodeImage<TUint8>	create(Scope scope, Operand<TString> contents, Options... options) Factory method to create a class wrapping a new DecodeImage operation using default output types.
static DecodeImage.Options	expandAnimations(Boolean expandAnimations)
Output<T>	image() 3-D with shape `[height, width, channels]` or 4-D with shape `[frame, height, width, channels]`..

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<T>	asOutput() Returns the symbolic handle of the tensor.
abstract T	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<T>	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: "DecodeImage"

Public Methods

public Output<T> 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 DecodeImage.Options channels (Long channels)

Parameters

channels	Number of color channels for the decoded image.

public static DecodeImage<T> create (Scope scope, Operand<TString> contents, Class<T> dtype, Options... options)

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

Parameters

scope	current scope
contents	0-D. The encoded image bytes.
dtype	The desired DType of the returned Tensor.
options	carries optional attributes values

Returns

• a new instance of DecodeImage

public static DecodeImage<TUint8> create (Scope scope, Operand<TString> contents, Options... options)

Factory method to create a class wrapping a new DecodeImage operation using default output types.

Parameters

scope	current scope
contents	0-D. The encoded image bytes.
options	carries optional attributes values

Returns

• a new instance of DecodeImage

public static DecodeImage.Options expandAnimations (Boolean expandAnimations)

Parameters

expandAnimations	Controls the output shape of the returned op. If True, the returned op will produce a 3-D tensor for PNG, JPEG, and BMP files; and a 4-D tensor for all GIFs, whether animated or not. If, False, the returned op will produce a 3-D tensor for all file types and will truncate animated GIFs to the first frame.

public Output<T> image ()

3-D with shape `[height, width, channels]` or 4-D with shape `[frame, height, width, channels]`..