Skip to content

variable

Classes:

  • NNJAVariable –

    A class to represent a variable in a NNJADataset.

NNJAVariable 

NNJAVariable(variable_metadata, full_id, dim_val=None)

A class to represent a variable in a NNJADataset.

Many datasets in the NNJA archive have a large number of variables, and the parquet metadata doesn't provide enough flexibility to organize and describe them. We've organized variables into four categories, referenced by the 'category' attribute: - "primary data": The main data variables in the dataset that most users will use (e.g. brightness temperature, precipitation, radiance). - "primary descriptors": key descriptor variables that are useful for most users (e.g., time, latitude, longitude, satellite ID). - "secondary data": Additional data variables that are included for completeness, but contain little useful information for most users (e.g., data quality flags, variables that are null for most observations, etc.). - "secondary descriptors": Additional descriptor variables that are included for completeness, but contain little useful information for most users (e.g. processing station, scan number, etc.).

Additionally some variables have a 'dimension' attribute, which is used to represent additional information about the variable that can be used to subset the data (e.g., 'channel' for a satellite with many channels, or pressure level for some soundings). Because the data is based on parquet files, we can provide some additional subsetting features by using the 'dimension' attribute.

Attributes:

  • id (str) –

    The fully expanded variable ID, corresponding to the parquet column name.

  • base_id (str) –

    The original variable ID; same as id unless the variable has a dimension

  • description (str) –

    Description of the variable.

  • category (str) –

    Category of the variable.

  • dimension (optional) –

    Dimension of the variable, if available.

  • extra_metadata (dict) –

    Additional metadata for the variable.

Parameters:

  • variable_metadata (dict) –

    Metadata for the variable.

  • full_id (str) –

    The fully expanded variable ID (e.g., 'brightness_temp_00007', or "lat").

  • dim_val (Optional[Union[float, int]], default: None ) –

    The value of the dimension for this variable, if applicable.

Methods:

  • __repr__ –

    Provide a string representation of the variable.

  • info –

    Provide a summary of the variable.

is_code_or_flag_table property 

is_code_or_flag_table

Return True if the variable is associated with a code or flag table.

__repr__ 

__repr__()

Provide a string representation of the variable.

info 

info()

Provide a summary of the variable.