XINA Struct Export

This page is a Work In Progress

The XINA Struct Export utility processes archive files to produce data products for XINA's Export Tasks. There are 2 suppported archive file formats: xbin and xpf. If the archive file is in the xpf format, processing is delegated to a mission specific tool. See the Struct Extract Interface that describes the interface the tool must implement.

Arguments

Name	Req	Description	Default
task	✓	task ID
conf	✓	JSON confconfiguration file path
temp	✓	temp directory path for storing temporary files during execution
import	✓	import directory path (for file outputs)
log	✓	log file path
out	✓	[TBD] the ouptut directory path
post	✓	post directory path (for post-import outputs)
cancellation		Path to the cancellation file for detecting cancel requests
extract		Path to the struct_extract app. Only used if the archive format is xpf.
pkt_models		[TBD] models to use packet time by default
plot	✓	Path to app that generates plot PDFs
python	✓	Path to the Python executable used by the plot app
host		tunnel host	"localhost"
port		tunnel port	41746

JSON Configuration

IDs filter

Name	Type	Req	Description	Default
originmodel	utf8text	✓	originpath groupof model to export data from
slicelabel	utf8text		TBDThe REMOVEtext slicethat lengthwill inbe minutesused to name the files and final zip file. The format will be like 2024_06_12_00_00_00_2024_06_12_00_20_00_profile_label	60
tprofile	utf8text		TBDThe REMOVEname sliceof timethe barrierProfile (seeif below)the export was generated from one
start	instant(us)	✓	Start time of data to export
end	instant(us)	✓	End time of data to export
rawids	utf8text	Mnemonic✓	CSV torange exportlist withof nomn_ids conversione.g. "1,2-10,100" or ext_id formatted string e.g. "@[1,4-8,12,100-200]sci;@[2,3]raw"
engueid		Mnemonic IDs to export with engineering conversion
sci		Mnemonic IDs to export with science conversion
dis		Mnemonic IDs to export with discrete labels conversion
event_uuidUUID		Event UUID forof interval thatif the export was requested for.for an interval. The event's start and end time will be used instead of start and end.
joinauto_confs	list(struct_auto_conf)		If[TBD true,if the mnemonic data will be "joined" such that there will be a mnemonic per column and one timestamp per rowrequired]
fillplot_conf		If truestruct_plot_conf, empty cells will be filled with the previous value. Only applicable when join is true.
columns		Defines the columns that will be output e.g. various timestamp formats, units
plot		The plot configuration used to generate the plot PDFsPDF. See plot format.	One mnemonic per plot, one plot per page, sorted by mn_id in ascending order.
filterdata_conf	struct_data_conf	The✓	See definitions to apply. Can either be a list of filter IDs or filter expressions. Exact format TBD.struct_data_conf
disable_filter	boolean		If true, does not apply the filters defined in data_conf.	false
copy	boolean		[TBD REMOVE]
multi	boolean		[TBD REMOVEREMOVE] Has extract process all archives at once. This was added for performance reasons since loading the mnem def is slow.
grt		If true, and the model supports it, use ground receipt time instead of packet time
label		The text that will be used to name the files and final zip file.
batch		TBD REMOVE
copy		TBD REMOVE
profile		The name of the profile.

Operation

Extract data from archive files to produce Export Task products:

• Full resolution mnemonic data with a configurable format
• Mnemonic Statistics
• Configurable Plots of data
• Limit Report
• Events