KameleonVolumeToFieldlinesTask

Inherits Task

This task class traces field lines from volume data. It takes a task file which specifies a folder with .cdf files, as well as a file that lists seed points from which the tracing starts. For the outputs, specify an outputFolder for where the field lines data will be saved and the OutputType parameter to be either Osfls which is an OpenSpace specific binary format for field lines, or Json for a readable version of the same data. Some knowledge of the data might be needed, especially if coloring the field lines according to some data parameter like temperature or density. These parameters needs to be specified in the ScalarVars and match the name in the input data. For the magnitude of a vector parameter, such as magnetic stength or velocity, there are specified in MagntitudeVars.

Members

Name	Documentation	Type	Description	Optional
Input	The folder to the cdf files to extract data from.	Directory	Value of type ‘Directory’	No
OutputFolder	The folder to write the files to.	Directory	Value of type ‘Directory’	No
OutputType	Output type	String	In list { Json, Osfls }	No
Seedpoints	A path to folder with text files with seedpoints. The format of points: x1 y1 z1 x2 y2 z2 … Seedpoints are expressed in the native coordinate system of the model. Filename must match date and time for CDF file.	Directory	Value of type ‘Directory’	No
TracingVar	The name of the kameleon variable to use for tracing, like b, or u.	String	Value of type ‘String’	No
MagnitudeVars	A list of vector field variables. Must be in groups of 3, for example “bx, by, bz”, “ux, uy, uz”.	Table	Table parameters	Yes
ManualTimeOffset	If data sets parameter start_time differ from start of run, elapsed_time_in_seconds might be in relation to start of run. ManualTimeOffset will be added to trigger time.	Double	Value of type ‘Double’	Yes
NthSeedpoint	Choose to only include every nth seedpoint from each file.	Integer	Value of type ‘Integer’	Yes
NthTimeStep	Choose to decrease cadence and only use every nth time step / input file.	Integer	Value of type ‘Integer’	Yes
ScalarVars	A list of scalar variables to extract along the fieldlines like temperature or density.	Table	Table parameters	Yes

Inherited members from Task

Name	Documentation	Type	Description	Optional
Type	This key specifies the type of Task that gets created. It has to be one of the valid Tasks that are available for creation (see the FactoryDocumentation for a list of possible Tasks), which depends on the configration of the application	String	A valid Task created by a factory	No

Table parameters for MagnitudeVars

A list of vector field variables. Must be in groups of 3, for example “bx, by, bz”, “ux, uy, uz”.

• Optional: Yes

Name	Documentation	Type	Description	Optional
*		String	Value of type ‘String’	Yes

Table parameters for ScalarVars

A list of scalar variables to extract along the fieldlines like temperature or density.

• Optional: Yes

Name	Documentation	Type	Description	Optional
*		String	Value of type ‘String’	Yes