com.esri.arcgis.geoprocessing.tools.conversiontools
Class RasterToVideo

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.conversiontools.RasterToVideo

All Implemented Interfaces:

GPTool

public class RasterToVideo
extends AbstractGPTool

Creates a video file from a set of images. The Raster To Video tool is contained in the Conversion Tools tool box.

Usage tips:

• Keeping in mind that the images are read alphabetically, you can insert images in the folder of images such as a title image for your video. For example, if the folder of images has images with names image_1.bmp, image_2.bmp, and image_20.bmp, you can add an image named _image_1.bmp. Since the tool reads the images in an alphabetical order,_image_1.bmp will appear before image_1.bmp in the output video.
• The resolution (width x height) of the output video is based on the resolution of the first image in the folder of images supplied to the tool. If the first image has a smaller or larger resolution than the others, the rest of the images will be stretched to fit the resolution of the first image. So try to keep the resolution of the images in the folder consistent.
• Since AVI and QuickTime formats are supported on Windows only, this tool will not work on a non-Windows platform.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

RasterToVideo()
Creates the Raster To Video tool with defaults.

RasterToVideo(Object inputFolder, Object outVideoFile)
Creates the Raster To Video tool with the required parameters.

Method Summary

String	getCodec() Returns the Codec parameter of this tool .
String	getDurationMethod() Returns the Output Duration Method parameter of this tool .
String	getImageFormat() Returns the Image Format parameter of this tool .
Object	getInputFolder() Returns the Input Folder parameter of this tool .
Object	getOutVideoFile() Returns the Output Video File parameter of this tool .
int	getQuality() Returns the Quality parameter of this tool .
double	getTime() Returns the Frame Rate or Time parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setCodec(String codec) Sets the Codec parameter of this tool .
void	setDurationMethod(String durationMethod) Sets the Output Duration Method parameter of this tool .
void	setImageFormat(String imageFormat) Sets the Image Format parameter of this tool .
void	setInputFolder(Object inputFolder) Sets the Input Folder parameter of this tool .
void	setOutVideoFile(Object outVideoFile) Sets the Output Video File parameter of this tool .
void	setQuality(int quality) Sets the Quality parameter of this tool .
void	setTime(double time) Sets the Frame Rate or Time parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RasterToVideo

public RasterToVideo()

Creates the Raster To Video tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

RasterToVideo

public RasterToVideo(Object inputFolder,
                     Object outVideoFile)

Creates the Raster To Video tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inputFolder - the folder containing the images. The images in the folder should be of the same type (BMP or JPEG).

outVideoFile - the output video file (*.avi or *.mov).

Method Detail

getInputFolder

public Object getInputFolder()

Returns the Input Folder parameter of this tool . This parameter is the folder containing the images. The images in the folder should be of the same type (BMP or JPEG). This is a required parameter.

Returns:

the Input Folder

setInputFolder

public void setInputFolder(Object inputFolder)

Sets the Input Folder parameter of this tool . This parameter is the folder containing the images. The images in the folder should be of the same type (BMP or JPEG). This is a required parameter.

Parameters:

inputFolder - the folder containing the images. The images in the folder should be of the same type (BMP or JPEG).

getOutVideoFile

public Object getOutVideoFile()

Returns the Output Video File parameter of this tool . This parameter is the output video file (*.avi or *.mov). This is a required parameter.

Returns:

the Output Video File

setOutVideoFile

public void setOutVideoFile(Object outVideoFile)

Sets the Output Video File parameter of this tool . This parameter is the output video file (*.avi or *.mov). This is a required parameter.

Parameters:

outVideoFile - the output video file (*.avi or *.mov).

getImageFormat

public String getImageFormat()

Returns the Image Format parameter of this tool . This is an optional parameter.

Returns:

the Image Format

setImageFormat

public void setImageFormat(String imageFormat)

Sets the Image Format parameter of this tool . This is an optional parameter.

Parameters:

imageFormat - null

getCodec

public String getCodec()

Returns the Codec parameter of this tool . This parameter is the codec used for compressing the frames while writing the video file. The list of codecs can vary on different machines. This is an optional parameter.

Returns:

the Codec

setCodec

public void setCodec(String codec)

Sets the Codec parameter of this tool . This parameter is the codec used for compressing the frames while writing the video file. The list of codecs can vary on different machines. This is an optional parameter.

Parameters:

codec - the codec used for compressing the frames while writing the video file. The list of codecs can vary on different machines.

getDurationMethod

public String getDurationMethod()

Returns the Output Duration Method parameter of this tool . This parameter is the method (FRAME_RATE or TIME) used for defining the output video duration. This is an optional parameter.

Returns:

the Output Duration Method

setDurationMethod

public void setDurationMethod(String durationMethod)

Sets the Output Duration Method parameter of this tool . This parameter is the method (FRAME_RATE or TIME) used for defining the output video duration. This is an optional parameter.

Parameters:

durationMethod - the method (FRAME_RATE or TIME) used for defining the output video duration.

getTime

public double getTime()

Returns the Frame Rate or Time parameter of this tool . This parameter is duration of the video to be output. This is an optional parameter.

Returns:

the Frame Rate or Time

setTime

public void setTime(double time)

Sets the Frame Rate or Time parameter of this tool . This parameter is duration of the video to be output. This is an optional parameter.

Parameters:

time - duration of the video to be output.

getQuality

public int getQuality()

Returns the Quality parameter of this tool . This parameter is the quality of the output video. The video can be exported at different qualities ranging from 1 to 100. The default value is 100. This is an optional parameter.

Returns:

the Quality

setQuality

public void setQuality(int quality)

Sets the Quality parameter of this tool . This parameter is the quality of the output video. The video can be exported at different qualities ranging from 1 to 100. The default value is 100. This is an optional parameter.

Parameters:

quality - the quality of the output video. The video can be exported at different qualities ranging from 1 to 100. The default value is 100.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias