Dataclasses

These classes store information returned from reading a CDF file.

class cdflib.dataclasses.ADRInfo(scope: int, next_adr_loc: int, attribute_number: int, num_gr_entry: int, max_gr_entry: int, num_z_entry: int, max_z_entry: int, first_z_entry: int, first_gr_entry: int, name: str)

Parameters:

• scope (int) –

• next_adr_loc (int) –

• attribute_number (int) –

• num_gr_entry (int) –

• max_gr_entry (int) –

• num_z_entry (int) –

• max_z_entry (int) –

• first_z_entry (int) –

• first_gr_entry (int) –

• name (str) –

class cdflib.dataclasses.AEDR(entry: str | numpy.ndarray, data_type: int, num_elements: int, next_aedr: int, entry_num: int, num_strings: int | None = None)

Parameters:

• entry (str | ndarray) –

• data_type (int) –

• num_elements (int) –

• next_aedr (int) –

• entry_num (int) –

• num_strings (int | None) –

class cdflib.dataclasses.AttData(Item_Size, Data_Type, Num_Items, Data)

Attribute data.

Parameters:

• Item_Size (int) –

• Data_Type (str) –

• Num_Items (int) –

• Data (Number | str | ndarray) –

Data: Number | str | ndarray

Data as a scalar value, a numpy array or a string.

Data_Type: str

CDF data type.

Item_Size: int

Number of bytes for each entry value.

Num_Items: int

Number of values extracted.

class cdflib.dataclasses.CDFInfo(CDF, Version, Encoding, Majority, rVariables, zVariables, Attributes, Copyright, Checksum, Num_rdim, rDim_sizes, Compressed, LeapSecondUpdate=None)

CDF information.

Parameters:

• CDF (str | Path) –

• Version (str) –

• Encoding (int) –

• Majority (str) –

• rVariables (List[str]) –

• zVariables (List[str]) –

• Attributes (List[Dict[str, str]]) –

• Copyright (str) –

• Checksum (bool) –

• Num_rdim (int) –

• rDim_sizes (List[int]) –

• Compressed (bool) –

• LeapSecondUpdate (int | None) –

Attributes: List[Dict[str, str]]

List of dictionary objects that map attribute_name to scope.

CDF: str | Path

Path to the CDF.

Checksum: bool

Checksum indicator.

Compressed: bool

If CDF is compressed at file level.

Encoding: int

Endianness of the CDF.

LeapSecondUpdate: int | None = None

Last updated leap second table.

Majority: str

Row/column majority.

Num_rdim: int

Number of dimensions for rVariables.

Version: str

CDF version.

rDim_sizes: List[int]

Dimensional sizes for rVariables.

rVariables: List[str]

zVariable names.

zVariables: List[str]

rVariable names.

class cdflib.dataclasses.CDRInfo(encoding: int, copyright_: str, version: str, majority: int, format_: bool, md5: bool, post25: bool)

Parameters:

• encoding (int) –

• copyright_ (str) –

• version (str) –

• majority (int) –

• format_ (bool) –

• md5 (bool) –

• post25 (bool) –

class cdflib.dataclasses.GDRInfo(first_zvariable: int, first_rvariable: int, first_adr: int, num_zvariables: int, num_rvariables: int, num_attributes: int, rvariables_num_dims: int, rvariables_dim_sizes: List[int], eof: int, leapsecond_updated: int | None = None)

Parameters:

• first_zvariable (int) –

• first_rvariable (int) –

• first_adr (int) –

• num_zvariables (int) –

• num_rvariables (int) –

• num_attributes (int) –

• rvariables_num_dims (int) –

• rvariables_dim_sizes (List[int]) –

• eof (int) –

• leapsecond_updated (int | None) –

class cdflib.dataclasses.VDR(data_type: int, section_type: int, next_vdr_location: int, variable_number: int, head_vxr: int, last_vxr: int, max_rec: int, name: str, num_dims: int, dim_sizes: List[int], compression_bool: bool, compression_level: int, blocking_factor: int, dim_vary: List[int] | List[bool], record_vary: int, num_elements: int, sparse: int, pad: str | numpy.ndarray | NoneType = None)

Parameters:

• data_type (int) –

• section_type (int) –

• next_vdr_location (int) –

• variable_number (int) –

• head_vxr (int) –

• last_vxr (int) –

• max_rec (int) –

• name (str) –

• num_dims (int) –

• dim_sizes (List[int]) –

• compression_bool (bool) –

• compression_level (int) –

• blocking_factor (int) –

• dim_vary (List[int] | List[bool]) –

• record_vary (int) –

• num_elements (int) –

• sparse (int) –

• pad (str | ndarray | None) –

class cdflib.dataclasses.VDRInfo(Variable, Num, Var_Type, Data_Type, Data_Type_Description, Num_Elements, Num_Dims, Dim_Sizes, Sparse, Last_Rec, Rec_Vary, Dim_Vary, Compress, Pad=None, Block_Factor=None)

Variable data record info.

Parameters:

• Variable (str) –

• Num (int) –

• Var_Type (str) –

• Data_Type (int) –

• Data_Type_Description (str) –

• Num_Elements (int) –

• Num_Dims (int) –

• Dim_Sizes (List[int]) –

• Sparse (str) –

• Last_Rec (int) –

• Rec_Vary (int) –

• Dim_Vary (List[int] | List[bool]) –

• Compress (int) –

• Pad (str | ndarray | None) –

• Block_Factor (int | None) –

Block_Factor: int | None = None

Blocking factor (if variable is compressed).

Data_Type: int

Variable CDF data type.

Dim_Sizes: List[int]

Shape of the variable record.

Dim_Vary: List[int] | List[bool]

a doc

Last_Rec: int

Maximum written variable number (0-based).

Num: int

Variable number.

Num_Dims: int

Dimensionality of variable record.

Num_Elements: int

Number of elements of the variable.

Pad: str | ndarray | None = None

Padded value (if set).

Rec_Vary: int

Record variance.

Var_Type: str

zVariable or rVariable.

Type:

Variable type

Variable: str

Name of the variable.