A set of parameters for /visualize/video. More...

Inheritance diagram for kinetica.VisualizeVideoRequest:

Collaboration diagram for kinetica.VisualizeVideoRequest:

Classes
struct	Projection
	Spatial Reference System (i.e. More...

struct	StyleOptions
	Styling options for the image. More...

Public Member Functions
	VisualizeVideoRequest ()
	Constructs a VisualizeVideoRequest object with default parameters. More...

	VisualizeVideoRequest (IList< string > table_names, IList< string > world_table_names, IList< IList< string >> track_ids, string x_column_name, string y_column_name, double min_x, double max_x, double min_y, double max_y, int width, int height, string projection, long bg_color, IList< IList< double >> time_intervals, string video_style, string session_key, IDictionary< string, IList< string >> style_options, IDictionary< string, string > options=null)
	Constructs a VisualizeVideoRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
IList< string >	table_names `[get, set]`
	Names of the tables containing the data for various layers of the resulting video. More...

IList< string >	world_table_names = new List<string>() `[get, set]`
	Optional name of the tables containing the data for the entire track when the contains only part of the track data, but the entire track has to be rendered. More...

IList< IList< string > >	track_ids = new List<string>() `[get, set]`
	Tracks from the to be rendered. More...

string	x_column_name = new List<IList<string>>() `[get, set]`
	Name of the column containing the x coordinates. More...

string	y_column_name `[get, set]`
	Name of the column containing the y coordinates. More...

double	min_x `[get, set]`
	Lower bound for the x values. More...

double	max_x `[get, set]`
	Upper bound for the x values. More...

double	min_y `[get, set]`
	Lower bound for the y values. More...

double	max_y `[get, set]`
	Upper bound for the y values. More...

int	width `[get, set]`
	Width of the generated image. More...

int	height `[get, set]`
	Height of the generated image. More...

string	projection `[get, set]`
	Spatial Reference System (i.e. More...

long	bg_color = Projection.PLATE_CARREE `[get, set]`
	Background color of the generated image. More...

IList< IList< double > >	time_intervals `[get, set]`

string	video_style = new List<IList<double>>() `[get, set]`

string	session_key `[get, set]`
	User Provided session key that is later used to retrieve the generated video from the WMS. More...

IDictionary< string, IList < string > >	style_options `[get, set]`
	Styling options for the image. More...

IDictionary< string, string >	options = new Dictionary<string, IList<string>>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema	SchemaFromType (System.Type t, KineticaType ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for /visualize/video.

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 (<member name="bg_color">, <member name="width">, <member name="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 <member name="session_key"> 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://<hostname/ipAddress>:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=0
and the last frame could be retrieved with:
http://<hostname/ipAddress>:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=19
The response payload provides, among other things, the number of frames which were created.

Definition at line 47 of file VisualizeVideo.cs.

Constructor & Destructor Documentation

kinetica.VisualizeVideoRequest.VisualizeVideoRequest ( )

inline

Constructs a VisualizeVideoRequest object with default parameters.

Definition at line 399 of file VisualizeVideo.cs.

kinetica.VisualizeVideoRequest.VisualizeVideoRequest	(	IList< string >	table_names,
		IList< string >	world_table_names,
		IList< IList< string >>	track_ids,
		string	x_column_name,
		string	y_column_name,
		double	min_x,
		double	max_x,
		double	min_y,
		double	max_y,
		int	width,
		int	height,
		string	projection,
		long	bg_color,
		IList< IList< double >>	time_intervals,
		string	video_style,
		string	session_key,
		IDictionary< string, IList< string >>	style_options,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a VisualizeVideoRequest object with the specified parameters.

Parameters

table_names	Names of the tables containing the data for various layers of the resulting video.
world_table_names	Optional name of the tables containing the data for the entire track when the 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
track_ids	Tracks from the to be rendered.
x_column_name	Name of the column containing the x coordinates.
y_column_name	Name of the column containing the y coordinates.
min_x	Lower bound for the x values.
max_x	Upper bound for the x values.
min_y	Lower bound for the y values.
max_y	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). Values: EPSG:4326, PLATE_CARREE, 900913, EPSG:900913, 102100, EPSG:102100, 3857, EPSG:3857, WEB_MERCATOR.
bg_color	Background color of the generated image.
time_intervals
video_style
session_key	User Provided session key that is later used to retrieve the generated video from the WMS.
style_options	Styling options for the image. do_points Rasterize point data toggle. Values: true, false. do_shapes Rasterize shapes toggle. Values: true, false. do_tracks Rasterize tracks toggle. Values: true, false. pointcolors RGB color value in hex for the points. pointsizes Size of points. pointshapes Shape of the point. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE. 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. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE. trackheadcolors Color of track head markers. trackheadsizes Size of track head markers. trackheadshapes Shape of track head markers. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
options	Optional parameters.

Definition at line 528 of file VisualizeVideo.cs.

Property Documentation

long kinetica.VisualizeVideoRequest.bg_color = Projection.PLATE_CARREE

getset

Background color of the generated image.

Definition at line 292 of file VisualizeVideo.cs.

int kinetica.VisualizeVideoRequest.height

getset

Height of the generated image.

Definition at line 283 of file VisualizeVideo.cs.

double kinetica.VisualizeVideoRequest.max_x

getset

Upper bound for the x values.

Definition at line 271 of file VisualizeVideo.cs.

double kinetica.VisualizeVideoRequest.max_y

getset

Upper bound for the y values.

Definition at line 277 of file VisualizeVideo.cs.

double kinetica.VisualizeVideoRequest.min_x

getset

Lower bound for the x values.

Definition at line 268 of file VisualizeVideo.cs.

double kinetica.VisualizeVideoRequest.min_y

getset

Lower bound for the y values.

Definition at line 274 of file VisualizeVideo.cs.

IDictionary<string, string> kinetica.VisualizeVideoRequest.options = new Dictionary<string, IList<string>>()

getset

Optional parameters.

Definition at line 394 of file VisualizeVideo.cs.

string kinetica.VisualizeVideoRequest.projection

getset

Spatial Reference System (i.e.

EPSG Code). Values: EPSG:4326, PLATE_CARREE, 900913, EPSG:900913, 102100, EPSG:102100, 3857, EPSG:3857, WEB_MERCATOR.

Definition at line 289 of file VisualizeVideo.cs.

string kinetica.VisualizeVideoRequest.session_key

getset

User Provided session key that is later used to retrieve the generated video from the WMS.

Definition at line 298 of file VisualizeVideo.cs.

IDictionary<string, IList<string> > kinetica.VisualizeVideoRequest.style_options

getset

Styling options for the image.

do_points Rasterize point data toggle. Values: true, false.
do_shapes Rasterize shapes toggle. Values: true, false.
do_tracks Rasterize tracks toggle. Values: true, false.
pointcolors RGB color value in hex for the points.
pointsizes Size of points.
pointshapes Shape of the point. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
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. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.
trackheadcolors Color of track head markers.
trackheadsizes Size of track head markers.
trackheadshapes Shape of track head markers. Values: none, circle, square, diamond, hollowcircle, hollowsquare, hollowdiamond, SYMBOLCODE.

Definition at line 391 of file VisualizeVideo.cs.

IList<string> kinetica.VisualizeVideoRequest.table_names

getset

Names of the tables containing the data for various layers of the resulting video.

Definition at line 244 of file VisualizeVideo.cs.

IList<IList<double> > kinetica.VisualizeVideoRequest.time_intervals

getset

Definition at line 293 of file VisualizeVideo.cs.

IList<IList<string> > kinetica.VisualizeVideoRequest.track_ids = new List<string>()

getset

Tracks from the to be rendered.

Definition at line 257 of file VisualizeVideo.cs.

string kinetica.VisualizeVideoRequest.video_style = new List<IList<double>>()

getset

Definition at line 294 of file VisualizeVideo.cs.

int kinetica.VisualizeVideoRequest.width

getset

Width of the generated image.

Definition at line 280 of file VisualizeVideo.cs.

IList<string> kinetica.VisualizeVideoRequest.world_table_names = new List<string>()

getset

Optional name of the tables containing the data for the entire track when the 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

Definition at line 252 of file VisualizeVideo.cs.

string kinetica.VisualizeVideoRequest.x_column_name = new List<IList<string>>()

getset

Name of the column containing the x coordinates.

Definition at line 261 of file VisualizeVideo.cs.

string kinetica.VisualizeVideoRequest.y_column_name

getset

Name of the column containing the y coordinates.

Definition at line 265 of file VisualizeVideo.cs.

The documentation for this class was generated from the following file:

Kinetica/Protocol/VisualizeVideo.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation