pyissm.model.classes.radaroverlay

class pyissm.model.classes.radaroverlay(other=None)

Bases: manage_state

Radar overlay parameters class for ISSM.

This class encapsulates parameters for radar overlay functionality in the ISSM (Ice Sheet System Model) framework. It stores radar power data and corresponding coordinates for visualization and analysis purposes, allowing integration of radar observations with ice sheet model results.

Parameters:

other (any, optional) – Any other class object that contains common fields to inherit from. If values in other differ from default values, they will override the default values.

pwr

Radar power image (matrix).

Type:

ndarray, default=nan

x

Corresponding x coordinates [m].

Type:

ndarray, default=nan

y

Corresponding y coordinates [m].

Type:

ndarray, default=nan

__init__(self, other=None)

Initializes the radaroverlay parameters, optionally inheriting from another instance.

__repr__(self)

Returns a detailed string representation of the radaroverlay parameters.

__str__(self)

Returns a short string identifying the class.

Examples

md.radaroverlay = pyissm.model.classes.radaroverlay() md.radaroverlay.pwr = radar_power_matrix md.radaroverlay.x = x_coordinates md.radaroverlay.y = y_coordinates

__init__(other=None)

Initialize the instance with optional field inheritance.

Parameters:

other (object, optional) – Another instance to inherit field values from. If provided, any fields in the current instance that differ from the default values and exist in ‘other’ will be replaced with the values from ‘other’.

Notes

The inheritance process:

  1. Iterates through all attributes of the current instance

  2. Checks if the same attribute exists in the ‘other’ instance

  3. Compares field values using _fields_equal()

  4. If different, replaces the current value with the ‘other’ value

This enables the common ISSM pattern where classes can inherit configurations from existing instances while maintaining their default values for unspecified fields.

Methods

__init__([other])

Initialize the instance with optional field inheritance.

check_consistency(md, solution, analyses)

Check consistency of the [radaroverlay.radaroverlay] parameters.

issm_enum_string()

Default ISSM C++ enum string used during marshalling.
check_consistency(md, solution, analyses)

Check consistency of the [radaroverlay.radaroverlay] parameters.

Parameters:

  • md (pyissm.model.Model) – The model object to check.

  • solution (str) – The solution name to check.

  • analyses (list of str) – List of analyses to check consistency for.

Returns:

md – The model object with any consistency errors noted.

Return type:

pyissm.model.Model