File template

All file objects, whether input or output, inherit from the abstract class File and all of its methods.

class tradssat.tmpl.File(file)[source]

Parent class for all file objects.

get_value(var, sect=None, subsect=None, cond=None)[source]
Parameters:
  • var –
  • sect –
  • subsect –
  • cond –
Returns:
Return type:

np.ndarray
get_var_size(var, sect=None)[source]

Returns the size of a variable.

Parameters:
  • var (str) – The name of the variable.
  • sect (str) – The name of the section in which this variable appears (optional; for ambiguous cases where a file has several variables with the same code).
Returns:

The size of the variable.
Return type:

int
classmethod matches_file(file)[source]

Checks whether a given file can be read by this class. Must be implemented in subclasses.

Parameters:file (str) – The file to be read.
Returns:True if the file matches; False otherwise.
Return type:bool