public class VisualizeVideoRequest extends Object implements org.apache.avro.generic.IndexedRecord
GPUdb.visualizeVideo(VisualizeVideoRequest).
Creates raster images of data in the given table based on provided input
parameters. Numerous parameters are required to call this function. Some of
the important parameters are the attributes of the generated images (bgColor, width, height), the collection of table names on
which this function is to be applied, for which shapes (point, polygon,
tracks) the images are to be created and a user specified session key. This
session key is later used to fetch the generated images. The operation is
synchronous, meaning that a response will not be returned until the images
for all the frames of the video are fully available.
Once the request has been processed then the generated video frames are
available for download via WMS using STYLES=cached. In this request the
LAYERS parameter should be populated with the session key passed in sessionKey of the visualize video request and the FRAME parameter indicates
which 0-based frame of the video should be returned. All other WMS
parameters are ignored for this mode.
For instance, if a 20 frame video with the session key 'MY-SESSION-KEY' was generated, the first frame could be retrieved with the URL:
http://
and the last frame could be retrieved with:
http://
The response payload provides, among other things, the number of frames which were created.
| Modifier and Type | Class and Description |
|---|---|
static class |
VisualizeVideoRequest.Projection
Spatial Reference System (i.e.
|
static class |
VisualizeVideoRequest.StyleOptions
Styling options for the image.
|
| Constructor and Description |
|---|
VisualizeVideoRequest()
Constructs a VisualizeVideoRequest object with default parameters.
|
VisualizeVideoRequest(List<String> tableNames,
List<String> worldTableNames,
List<List<String>> trackIds,
String xColumnName,
String yColumnName,
double minX,
double maxX,
double minY,
double maxY,
int width,
int height,
String projection,
long bgColor,
List<List<Double>> timeIntervals,
String videoStyle,
String sessionKey,
Map<String,List<String>> styleOptions,
Map<String,String> options)
Constructs a VisualizeVideoRequest object with the specified parameters.
|
public VisualizeVideoRequest()
public VisualizeVideoRequest(List<String> tableNames, List<String> worldTableNames, List<List<String>> trackIds, String xColumnName, String yColumnName, double minX, double maxX, double minY, double maxY, int width, int height, String projection, long bgColor, List<List<Double>> timeIntervals, String videoStyle, String sessionKey, Map<String,List<String>> styleOptions, Map<String,String> options)
tableNames - Names of the tables containing the data for various
layers of the resulting video.worldTableNames - Optional name of the tables containing the data
for the entire track when the tableNames
contains only part of the track data, but the
entire track has to be rendered. The number of
tables should match the number of tables in the
tableNamestrackIds - Tracks from the tableNames to be rendered.xColumnName - Name of the column containing the x coordinates.yColumnName - Name of the column containing the y coordinates.minX - Lower bound for the x values.maxX - Upper bound for the x values.minY - Lower bound for the y values.maxY - Upper bound for the y values.width - Width of the generated image.height - Height of the generated image.projection - Spatial Reference System (i.e. EPSG Code).
Supported values:
The default value is PLATE_CARREE.bgColor - Background color of the generated image.timeIntervals - videoStyle - sessionKey - User Provided session key that is later used to
retrieve the generated video from the WMS.styleOptions - Styling options for the image.
DO_POINTS: Rasterize point data toggle.
Supported values:
The default value is TRUE.
DO_SHAPES: Rasterize shapes toggle.
Supported values:
The default value is TRUE.
DO_TRACKS: Rasterize tracks toggle.
Supported values:
The default value is TRUE.
POINTCOLORS: RGB color value in hex for the
points.
POINTSIZES: Size of points.
POINTSHAPES: Shape of the point.
Supported values:
SHAPELINEWIDTHS: Width of the lines.
SHAPELINECOLORS: RGB color values in hex for the
line.
SHAPEFILLCOLORS: RGB color values in hex for the
fill color of the shapes. Use '-1' for no fill.
TRACKLINEWIDTHS: Width of the track lines. '0'
implies do not draw track lines.
TRACKLINECOLORS: RGB color values for the track
lines.
TRACKMARKERSIZES: Size of the track point markers.
TRACKMARKERCOLORS: Color of the track point
markers.
TRACKMARKERSHAPES: Shape of track point markers.
Supported values:
The default value is NONE.
TRACKHEADCOLORS: Color of track head markers.
TRACKHEADSIZES: Size of track head markers.
TRACKHEADSHAPES: Shape of track head markers.
Supported values:
The default value is CIRCLE.
options - Optional parameters.public static org.apache.avro.Schema getClassSchema()
public List<String> getTableNames()
public VisualizeVideoRequest setTableNames(List<String> tableNames)
tableNames - Names of the tables containing the data for various
layers of the resulting video.this to mimic the builder pattern.public List<String> getWorldTableNames()
tableNames contains only part of the
track data, but the entire track has to be rendered. The number
of tables should match the number of tables in the tableNamespublic VisualizeVideoRequest setWorldTableNames(List<String> worldTableNames)
worldTableNames - Optional name of the tables containing the data
for the entire track when the tableNames
contains only part of the track data, but the
entire track has to be rendered. The number of
tables should match the number of tables in the
tableNamesthis to mimic the builder pattern.public List<List<String>> getTrackIds()
tableNames to be rendered.public VisualizeVideoRequest setTrackIds(List<List<String>> trackIds)
trackIds - Tracks from the tableNames to be rendered.this to mimic the builder pattern.public String getXColumnName()
public VisualizeVideoRequest setXColumnName(String xColumnName)
xColumnName - Name of the column containing the x coordinates.this to mimic the builder pattern.public String getYColumnName()
public VisualizeVideoRequest setYColumnName(String yColumnName)
yColumnName - Name of the column containing the y coordinates.this to mimic the builder pattern.public double getMinX()
public VisualizeVideoRequest setMinX(double minX)
minX - Lower bound for the x values.this to mimic the builder pattern.public double getMaxX()
public VisualizeVideoRequest setMaxX(double maxX)
maxX - Upper bound for the x values.this to mimic the builder pattern.public double getMinY()
public VisualizeVideoRequest setMinY(double minY)
minY - Lower bound for the y values.this to mimic the builder pattern.public double getMaxY()
public VisualizeVideoRequest setMaxY(double maxY)
maxY - Upper bound for the y values.this to mimic the builder pattern.public int getWidth()
public VisualizeVideoRequest setWidth(int width)
width - Width of the generated image.this to mimic the builder pattern.public int getHeight()
public VisualizeVideoRequest setHeight(int height)
height - Height of the generated image.this to mimic the builder pattern.public String getProjection()
PLATE_CARREE.public VisualizeVideoRequest setProjection(String projection)
projection - Spatial Reference System (i.e. EPSG Code).
Supported values:
The default value is PLATE_CARREE.this to mimic the builder pattern.public long getBgColor()
public VisualizeVideoRequest setBgColor(long bgColor)
bgColor - Background color of the generated image.this to mimic the builder pattern.public VisualizeVideoRequest setTimeIntervals(List<List<Double>> timeIntervals)
timeIntervals - this to mimic the builder pattern.public String getVideoStyle()
public VisualizeVideoRequest setVideoStyle(String videoStyle)
videoStyle - this to mimic the builder pattern.public String getSessionKey()
public VisualizeVideoRequest setSessionKey(String sessionKey)
sessionKey - User Provided session key that is later used to
retrieve the generated video from the WMS.this to mimic the builder pattern.public Map<String,List<String>> getStyleOptions()
DO_POINTS: Rasterize point data toggle.
Supported values:
The default value is TRUE.
DO_SHAPES: Rasterize shapes toggle.
Supported values:
The default value is TRUE.
DO_TRACKS: Rasterize tracks toggle.
Supported values:
The default value is TRUE.
POINTCOLORS: RGB color value in hex for the points.
POINTSIZES: Size of points.
POINTSHAPES: Shape of the point.
Supported values:
SHAPELINEWIDTHS: Width of the lines.
SHAPELINECOLORS: RGB color values in hex for the line.
SHAPEFILLCOLORS: RGB color values in hex for the fill color of
the shapes. Use '-1' for no fill.
TRACKLINEWIDTHS: Width of the track lines. '0' implies do not
draw track lines.
TRACKLINECOLORS: RGB color values for the track lines.
TRACKMARKERSIZES: Size of the track point markers.
TRACKMARKERCOLORS: Color of the track point markers.
TRACKMARKERSHAPES: Shape of track point markers.
Supported values:
The default value is NONE.
TRACKHEADCOLORS: Color of track head markers.
TRACKHEADSIZES: Size of track head markers.
TRACKHEADSHAPES: Shape of track head markers.
Supported values:
The default value is CIRCLE.
public VisualizeVideoRequest setStyleOptions(Map<String,List<String>> styleOptions)
styleOptions - Styling options for the image.
DO_POINTS: Rasterize point data toggle.
Supported values:
The default value is TRUE.
DO_SHAPES: Rasterize shapes toggle.
Supported values:
The default value is TRUE.
DO_TRACKS: Rasterize tracks toggle.
Supported values:
The default value is TRUE.
POINTCOLORS: RGB color value in hex for the
points.
POINTSIZES: Size of points.
POINTSHAPES: Shape of the point.
Supported values:
SHAPELINEWIDTHS: Width of the lines.
SHAPELINECOLORS: RGB color values in hex for the
line.
SHAPEFILLCOLORS: RGB color values in hex for the
fill color of the shapes. Use '-1' for no fill.
TRACKLINEWIDTHS: Width of the track lines. '0'
implies do not draw track lines.
TRACKLINECOLORS: RGB color values for the track
lines.
TRACKMARKERSIZES: Size of the track point markers.
TRACKMARKERCOLORS: Color of the track point
markers.
TRACKMARKERSHAPES: Shape of track point markers.
Supported values:
The default value is NONE.
TRACKHEADCOLORS: Color of track head markers.
TRACKHEADSIZES: Size of track head markers.
TRACKHEADSHAPES: Shape of track head markers.
Supported values:
The default value is CIRCLE.
this to mimic the builder pattern.public VisualizeVideoRequest setOptions(Map<String,String> options)
options - Optional parameters.this to mimic the builder pattern.public org.apache.avro.Schema getSchema()
getSchema in interface org.apache.avro.generic.GenericContainerpublic Object get(int index)
get in interface org.apache.avro.generic.IndexedRecordindex - the position of the field to getIndexOutOfBoundsExceptionpublic void put(int index,
Object value)
put in interface org.apache.avro.generic.IndexedRecordindex - the position of the field to setvalue - the value to setIndexOutOfBoundsExceptionCopyright © 2017. All rights reserved.