Skip to content

SPICE_DATA::get_bintable_data

Martin Wiesmann edited this page Aug 27, 2024 · 7 revisions

Source code: SPICE_DATA::get_bintable_data

Class: SPICE_DATA

Description

This method returns the content of one or more columns found in the binary extension table. The provided TTYPES are expanded, i.e. all instances of a TTYPE are returned, except if the window tag is included in the TTYPE. Or if EXTENSION_INDEX is provided. TTYPES that are not in the binary table are silently ignored. When requesting the data of only one TTYPE, one can set the keyword VALUES_ONLY to receive the data only as an array, instead of the structure.

Syntax

data = spice_object->get_bintable_data( [ttypes] [, /values_only] [, extension=extension] )

Return Value

array of structure of type:
{wcsn:'', tform:'', ttype:'', tdim:'', tunit:'', tunit_desc:'', tdmin:'', tdmax:'', tdesc:'', tag:'', bin_extension_name:'', data_extension_name:'', data_extension_index:-1, values:ptr_new()}
or the data only, i.e. an array of numbers.

Arguments

ttypes

One or more column TTYPES (e.g. 'MIRRPOS') as a scalar string or string array. If not provided, all columns will be returned.

OPTIONAL INPUTS:

extension

An integer or string, giving the index or name of the extension that the resulting TTYPES must belong to.

Keywords

values_only

If set then only the values in the binary table extension is returned as an array, not the default output structure with metadata. This keyword is ignored if more than one TTYPE have been provided. If the desired TTYPE does not exist, a !NULL is returned.

Clone this wiki locally