SEAScope.cmds package¶

Submodules¶

SEAScope.cmds.add_collection module¶

SEAScope.cmds.add_collection.deserialize(buf)[source]¶

Deserialize response sent by SEAScope after executing the addCollection command.

Parameters:

buf (bytearray) – The buffer which contains the result of the addCollection command serialized with FlatBuffers

Returns:

The result of the addCollection command. The dict contains two keys:

ok : a bool representing the success (True) or failure (False) of the command execution
msg : a str providing details in case of failure

Return type:

dict

SEAScope.cmds.add_collection.serialize(builder, collection_obj)[source]¶

Parameters:

builder (flatbuffers.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
collection_obj (dict) – Dictionary which contains information about the collection to add.

The dict must satisfy the requirements of the SEAScope.types.collection.serialize() method

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.add_granule module¶

This module handles the serialization of the addGranule command

SEAScope.cmds.add_granule.deserialize(buf)[source]¶: Not implemented

SEAScope.cmds.add_granule.serialize(builder, cmd_obj)[source]¶

Serialize a addGranule command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
cmd_obj (dict) – The granule information provided as a dict with three keys:
- data : a dict which describes and contains the granule data.
  
  The dict must satisfy the requirements of the SEAScope.types.granule_data.serialize() method
- metadata : a dict which contains the metadata of the granule.
  
  The dict must satisfy the requirements of the SEAScope.types.granule_data.serialize() method
- id : a dict which contains the information for identifying the granule in SEAScope.
  
  The dict must satisfy the requirements of the SEAScope.types.renderable_id.serialize() method

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.add_variable module¶

This module handles the serialization of the addVariable command

SEAScope.cmds.add_variable.deserialize(buf)[source]¶

Deserialize response sent by SEAScope after executing the addVariable command.

Parameters:

buf (bytearray) – The buffer which contains the result of the addVariable command serialized with FlatBuffers

Returns:

The result of the addVariable command. The dict contains two keys:

ok : a bool representing the success (True) or failure (False) of the command execution
msg : a str providing details in case of failure

Return type:

dict

SEAScope.cmds.add_variable.serialize(builder, target, var_obj)[source]¶

Serialize a addVariable command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
target (dict) – The identifier that must be used for the new variable. The dict must satisfy the requirements of the SEAScope.types.renderable_id.serialize() method
var_obj (dict) – The parameters of the variable to add. The dict must satisfy the requirements of the SEAScope.types.variable.serialize() method

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.get_catalogues module¶

This module handles the serialization of the getCatalogues command and the deserialization of the result sent by SEAScope

SEAScope.cmds.get_catalogues.deserialize(buf)[source]¶

Deserialize the response that SEAScope sends after executing the getCatalogues command

Parameters:

buf (bytearray) – The buffer which contains the result of the getCatalogues command serialized with FlatBuffers

Returns:

The sources and collections (including variables) currently available in SEAScope. The dict contains two keys:

sources : a list of dict generated by the SEAScope.types.source.deserialize() method
collections : a list of dict generated by the SEAScope.types.collection.deserialize() method

Return type:

dict

SEAScope.cmds.get_catalogues.serialize(builder)[source]¶

Serialize a getCatalogues command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.get_current_datetime module¶

This module handles the serialization of the getCurrentDatetime command and the deserialization of the result sent by SEAScope

SEAScope.cmds.get_current_datetime.deserialize(buf)[source]¶

Deserialize the response that SEAScope sends after executing the getCurrentDatetime command

Parameters:: buf (bytearray) – The buffer which contains the result of the getCurrentDatetime command serialized with FlatBuffers
Returns:: Current datetime selected in SEAScope timeline, expressed in seconds since 1970-01-01T00:00:00Z
Return type:: int

SEAScope.cmds.get_current_datetime.serialize(builder)[source]¶

Serialize a getCurrentDatetime command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.get_data_always_visible_mode module¶

This module handles the serialization of the getDataAlwaysVisibleMode command and the deserialization of the result sent by SEAScope

SEAScope.cmds.get_data_always_visible_mode.deserialize(buf)[source]¶

Deserialize the response that SEAScope sends after executing the getDataAlwaysVisibleMode command

Parameters:: buf (bytearray) – The buffer which contains the result of the getDataAlwaysVisibleMode command serialized with FlatBuffers
Returns:: True if the data always visible mode is active in SEAScope, False otherwise
Return type:: bool

SEAScope.cmds.get_data_always_visible_mode.serialize(builder)[source]¶

Serialize a getDataAlwaysVisibleMode command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.get_extraction module¶

This module handles the serialization of the getExtraction command and the deserialization of the result sent by SEAScope

SEAScope.cmds.get_extraction.deserialize(buf)[source]¶

Deserialize the response that SEAScope sends after executing the getExtraction command

Parameters:

buf (bytearray) – The buffer which contains the result of the getExtraction command serialized with FlatBuffers

Returns:

The result contains the data extracted by SEAScope from every granule currently rendered as a raster or as a trajectory.

Each dict is the result of the SEAScope.types.extraction.deserialize() method (see source code for more details)

Return type:

list of dict

SEAScope.cmds.get_extraction.serialize(builder)[source]¶

Serialize a getExtraction command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.get_nearest_mode module¶

This module handles the serialization of the getNearestMode command and the deserialization of the result sent by SEAScope

SEAScope.cmds.get_nearest_mode.deserialize(buf)[source]¶

Deserialize the response that SEAScope sends after executing the getNearestMode command

Parameters:: buf (bytearray) – The buffer which contains the result of the getNearestMode command serialized with FlatBuffers
Returns:: True if the nearest mode is active in SEAScope, False otherwise
Return type:: bool

SEAScope.cmds.get_nearest_mode.serialize(builder)[source]¶

Serialize a getNearestMode command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.get_rendering module¶

This module handles the serialization of the getRendering command and the deserialization of the result sent by SEAScope

SEAScope.cmds.get_rendering.deserialize(buf)[source]¶

Deserialize the response that SEAScope sends after executing the getRendering command

Parameters:: buf (bytearray) – The buffer which contains the result of the getRendering command serialized with FlatBuffers
Returns:: The rendering configuration used by SEAScope for the target. The dict is generated by the SEAScope.types.rendering_cfg.deserialize() method (see source code for more details)
Return type:: dict

SEAScope.cmds.get_rendering.serialize(builder, rid)[source]¶

Serialize a getRendering command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
rid (dict) – The target of the rendering configuration SEAScope must look for. The value must satisfy the requirements of the SEAScope.types.renderable_id.serialize() method

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.get_timespan module¶

This module handles the serialization of the getTimespan command and the deserialization of the result sent by SEAScope

SEAScope.cmds.get_timespan.deserialize(buf)[source]¶

Deserialize the response that SEAScope sends after executing the getTimespan command

Parameters:: buf (bytearray) – The buffer which contains the result of the getTimespan command serialized with FlatBuffers
Returns:: The timespan currently selected in SEAScope. The dict is generated by the SEAScope.types.timespan.deserialize() method (see source code for more details)
Return type:: dict

SEAScope.cmds.get_timespan.serialize(builder)[source]¶

Serialize a getTimespan command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.get_timestep module¶

This module handles the serialization of the getTimestep command and the deserialization of the result sent by SEAScope

SEAScope.cmds.get_timestep.deserialize(buf)[source]¶

Deserialize the response that SEAScope sends after executing the getTimestep command

Parameters:: buf (bytearray) – The buffer which contains the result of the getTimestep command serialized with FlatBuffers
Returns:: The timestep currently selected in SEAScope. The dict is generated by the SEAScope.types.timestep.deserialize() method (see source code for more details)
Return type:: dict

SEAScope.cmds.get_timestep.serialize(builder)[source]¶

Serialize a getTimestep command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.get_variable_identifier module¶

This module handles the serialization of the getVariableIdentifier command and the deserialization of the result sent by SEAScope

SEAScope.cmds.get_variable_identifier.deserialize(buf)[source]¶

Deserialize the response that SEAScope sends after executing the getVariableIdentifier command

Parameters:: buf (bytearray) – The buffer which contains the result of the getVariableIdentifier command serialized with FlatBuffers
Returns:: The identifier found by SEAScope, which is the result produced by the SEAScope.types.renderable_id.deserialize() method (see source code for more details)
Return type:: dict

SEAScope.cmds.get_variable_identifier.serialize(builder, collection_label, variable_label)[source]¶

Serialize a getVariableIdentifier command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
collection_label (str) – Label of the collection that contains the target variable
variable_label (str) – Label of the target variable

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.list_timespans module¶

This module handles the serialization of the listTimespans command and the deserialization of the results sent by SEAScope

SEAScope.cmds.list_timespans.deserialize(buf)[source]¶

Deserialize the response that SEAScope sends after executing the listTimespans command

Parameters:: buf (bytearray) – The buffer which contains the result of the listTimespans command serialized with FlatBuffers
Returns:: The timespans found by SEAScope. Each dict is the result of the SEAScope.types.timespan.deserialize() method (see source code for more details)
Return type:: list of dict

SEAScope.cmds.list_timespans.serialize(builder)[source]¶

Serialize a listTimespans command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.list_timesteps module¶

This module handles the serialization of the listTimesteps command and the deserialization of the results sent by SEAScope

SEAScope.cmds.list_timesteps.deserialize(buf)[source]¶

Deserialize the response that SEAScope sends after executing the listTimesteps command

Parameters:: buf (bytearray) – The buffer which contains the result of the listTimesteps command serialized with FlatBuffers
Returns:: The timesteps found by SEAScope. Each dict is the result of the SEAScope.types.timestep.deserialize() method (see source code for more details)
Return type:: list of dict

SEAScope.cmds.list_timesteps.serialize(builder)[source]¶

Serialize a listTimesteps command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.list_visible_data module¶

This module handles the serialization of the listVisibleData command and the deserialization of the results sent by SEAScope

SEAScope.cmds.list_visible_data.deserialize(buf)[source]¶

Deserialize the response that SEAScope sends after executing the listVisibleData command

Parameters:

buf (bytearray) – The buffer which contains the result of the listVisibleData command serialized with FlatBuffers

Returns:

The identifiers of the granules currently rendered by SEAScope.

Each dict is the result of the SEAScope.types.renderable_id.deserialize() method (see source code for more details)

Return type:

list of dict

SEAScope.cmds.list_visible_data.serialize(builder)[source]¶

Serialize a listVisibleData command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.look_at module¶

This module handles the serialization of the lookAt command

SEAScope.cmds.look_at.deserialize()[source]¶: Not implemented

SEAScope.cmds.look_at.serialize(builder, lon, lat)[source]¶

Serialize a lookAt command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
lon (float) – The longitude to look at
lat (float) – The latitude to look at

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.reset_camera module¶

This module handles the serialization of the resetCamera command

SEAScope.cmds.reset_camera.deserialize()[source]¶: Not implemented

SEAScope.cmds.reset_camera.serialize(builder)[source]¶

Serialize a resetCamera command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.search_granules module¶

This module handles the serialization of the searchGranules command and the deserialization of the results sent by SEAScope

SEAScope.cmds.search_granules.deserialize(buf)[source]¶

Deserialize the response that SEAScope sends after executing the searchGranules command

Parameters:: buf (bytearray) – The buffer which contains the result of the searchGranules command serialized with FlatBuffers
Returns:: The metadata of the granules found by SEAScope. Each dict is the result of the SEAScope.types.granule_metadata.deserialize() method (see source code for more details)
Return type:: list of dict

SEAScope.cmds.search_granules.serialize(builder, search_obj)[source]¶

Serialize a searchGranules command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
search_obj (dict) –
- collections : a list of dict which tells SEAScope the collections it must consider during the search. The dict values must satisfy the requirements of the SEAScope.types.collection_id.serialize() method
- current : an int which acts in the same way as the current datetime of the timeline. Expressed in seconds since 1970-01-01T00:00:00Z
  
  If a collection has the mustBeCurrent flag set to True, then SEAScope will only return the granules for this collection if current belongs to [granule.start, granule.stop[
- start : an int which is the lower time bound used by SEAScope when searching for granules, expressed in seconds since 1970-01-01T00:00:00Z.
  
  In interactive usage of SEAScope, this has the currentDatetime - pastOffset value
- stop : an int which is the upper bound used by SEAScope when searching for granules, expressed in seconds since 1970-01-01T00:00:00Z.
  
  In interactive usage of SEAScope, this has the currentDatetime + futureOffset value
- zoom : a float that tells SEAScope at which altitude the camera should be during the search. It has an effect on the resolution of the granules returned in the results.

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.select_variable module¶

This module handles the serialization of the selectVariable command

SEAScope.cmds.select_variable.deserialize()[source]¶: Not implemented

SEAScope.cmds.select_variable.serialize(builder, target, selected, exclusive)[source]¶

Serialize a setTimestep command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
target (dict) – A dict which identifies the variable to select/unselect. It must satisfy the requirements of the SEAScope.types.renderable_id.serialize() method
selected (bool) – New selection state for the variable (True = selected)
exclusive (bool) – When set to True, this flag tells SEAScope to unselect all the variables that were previously selected (exclusive selection)

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.select_variable_by_label module¶

This module handles the serialization of the selectVariableByLabel command

SEAScope.cmds.select_variable_by_label.deserialize()[source]¶: Not implemented

SEAScope.cmds.select_variable_by_label.serialize(builder, collection_label, variable_label, selected, exclusive)[source]¶

Serialize a selectVariableByLabel command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
collection_label (str) – Label of the collection that contains the target variable
variable_label (str) – Label of the target variable
selected (bool) – New selection state for the variable (True = selected)
exclusive (bool) – When set to True, this flag tells SEAScope to unselect all the variables that were previously selected (exclusive selection)

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.set_altitude module¶

This module handles the serialization of the setAltitude command

SEAScope.cmds.set_altitude.deserialize()[source]¶: Not implemented

SEAScope.cmds.set_altitude.serialize(builder, altitude)[source]¶

Serialize a setAltitude command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
altitude (float) – Distance between the surface of the Earth and the camera in SEAScope, expressed in meters

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.set_current_datetime module¶

This module handles the serialization of the setCurrentDatetime command

SEAScope.cmds.set_current_datetime.deserialize()[source]¶

SEAScope.cmds.set_current_datetime.serialize(builder, timestamp)[source]¶

Serialize a setCurentDatetime command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
timestamp (int) – New value for the current datetime in SEAScope, in seconds since 1970-01-01T00:00:00Z

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.set_data_always_visible_mode module¶

This module handles the serialization of the setDataAlwaysVisibleMode command

SEAScope.cmds.set_data_always_visible_mode.deserialize()[source]¶: Not implemented

SEAScope.cmds.set_data_always_visible_mode.serialize(builder, active)[source]¶

Serialize a setDataAlwaysVisibleMode command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
active (bool) – If this value is True, then SEAScope will activate the “data always visible” mode of the timeline

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.set_nearest_mode module¶

This module handles the serialization of the setNearestMode command

SEAScope.cmds.set_nearest_mode.deserialize()[source]¶: Not implemented

SEAScope.cmds.set_nearest_mode.serialize(builder, active)[source]¶

Serialize a setTimestep command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
active (bool) – If this value is True, then SEAScope will activate the “nearest” mode of the timeline

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.set_rendering module¶

This module handles the serialization of the setRendering command

SEAScope.cmds.set_rendering.deserialize()[source]¶: Not implemented

SEAScope.cmds.set_rendering.serialize(builder, rcfg)[source]¶

Serialize a setRendering command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
rcfg (dict) – The rendering configuration to set in SEAScope. The dict must satisfy the requirements of the SEAScope.types.rendering_cfg.serialize() method

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.set_timespan module¶

This module handles the serialization of the setTimespan command

SEAScope.cmds.set_timespan.deserialize()[source]¶: Not implemented

SEAScope.cmds.set_timespan.serialize(builder, label)[source]¶

Serialize a setTimespan command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
label (str) – The label of the timespan to select in SEAScope

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.set_timestep module¶

This module handles the serialization of the setTimestep command

SEAScope.cmds.set_timestep.deserialize()[source]¶: Not implemented

SEAScope.cmds.set_timestep.serialize(builder, label)[source]¶

Serialize a setTimestep command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created
label (str) – The label of the timestep to select in SEAScope

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.zoom_in module¶

This module handles the serialization of the zoom in command

SEAScope.cmds.zoom_in.deserialize()[source]¶: Not implemented

SEAScope.cmds.zoom_in.serialize(builder)[source]¶

Serialize a zoom in command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds.zoom_out module¶

This module handles the serialization of the zoom out command

SEAScope.cmds.zoom_out.deserialize()[source]¶: Not implemented

SEAScope.cmds.zoom_out.serialize(builder)[source]¶

Serialize a zoom out command using FlatBuffers.

Parameters:

builder (flatbuffers.builder.Builder) – The FlatBuffers builder instance which serializes data. If this parameter is None, then a new builder will be created

Returns:

A tuple which contains two elements:

the flatbuffers.builder.Builder instance which has been used to serialize data
an int which is the address/offset of the serialized object in the builder buffer

Return type:

tuple(flatbuffers.builder.Builder, int)

SEAScope.cmds package¶

Submodules¶

SEAScope.cmds.add_collection module¶

SEAScope.cmds.add_granule module¶

SEAScope.cmds.add_variable module¶

SEAScope.cmds.get_catalogues module¶

SEAScope.cmds.get_current_datetime module¶

SEAScope.cmds.get_data_always_visible_mode module¶

SEAScope.cmds.get_extraction module¶

SEAScope.cmds.get_nearest_mode module¶

SEAScope.cmds.get_rendering module¶

SEAScope.cmds.get_timespan module¶

SEAScope.cmds.get_timestep module¶

SEAScope.cmds.get_variable_identifier module¶

SEAScope.cmds.list_timespans module¶

SEAScope.cmds.list_timesteps module¶

SEAScope.cmds.list_visible_data module¶

SEAScope.cmds.look_at module¶

SEAScope.cmds.reset_camera module¶

SEAScope.cmds.search_granules module¶

SEAScope.cmds.select_variable module¶

SEAScope.cmds.select_variable_by_label module¶

SEAScope.cmds.set_altitude module¶

SEAScope.cmds.set_current_datetime module¶

SEAScope.cmds.set_data_always_visible_mode module¶

SEAScope.cmds.set_nearest_mode module¶

SEAScope.cmds.set_rendering module¶

SEAScope.cmds.set_timespan module¶

SEAScope.cmds.set_timestep module¶

SEAScope.cmds.zoom_in module¶

SEAScope.cmds.zoom_out module¶

Module contents¶

Table of Contents

This Page