idstools.compute.magnetics¶

This module provides compute functions and classes for magnetics ids data

refer data dictionary.

Module Contents¶

class idstools.compute.magnetics.MagneticsCompute(ids: object)[source]¶

This class provides compute functions for magnetics ids.

ids¶

The magnetics IDS (Integrated Data Structure) object containing magnetic measurement data including field probes, flux loops, Rogowski coils, and shunt measurements.

Type:¶

object

Initialization MagneticsCompute object.

Parameters:¶

ids: object¶

magnetics ids object

ids¶

get_b_field_probe_values(probe_type='b_field_pol_probe', select=':')[source]¶

Retrieve B-field probe values from the IDS object.

Parameters:¶

probe_typestr, optional

The type of probe to retrieve values for. Default is “b_field_pol_probe”.

selectstr, optional

A selection string to filter the probes. Default is “:”.

Returns:¶

list of dict or None

A list of dictionaries containing probe information, or None if no probes are found.

Notes:¶

If the specified probe type is not found in the IDS object, a warning is logged. If no probes are found after filtering, a warning is logged and None is returned.

get_b_field_probes(probe_type='b_field_pol_probe', select=':')[source]¶

Retrieve probe information and organize it into a dictionary.

This method calls get_probes_values to get a list of probe data, then extracts relevant information

Returns:¶

A dictionary containing probe information.

Return type:¶

dict

get_flux_loops(select=':')[source]¶

Retrieve flux loop data and organize it into a dictionary.

Parameters: select (str): A selection string to filter the flux loop values. Default is “:”.

Returns: dict: flux loop data

None: If no flux loop data is found.

get_fluxloop_values(select=':')[source]¶

Retrieve flux loop values from the IDS (Integrated Data Structure).

Parameters: select (str): A string to select a subset of the flux loop arrays. Default is “:” which selects all.

Returns: list: A list of dictionaries containing flux loop information.

If no flux loops are found or if the flux loop information is empty, a warning is logged and None is returned.

get_rogowski_coil_values(select=':')[source]¶

Retrieve values from Rogowski coils.

This method extracts information from Rogowski coils stored in the IDS (Integrated Data Structure). It allows for optional selection of specific coils using a slice notation.

Parameters:¶

select=':'¶

A slice notation string to select specific Rogowski coils. Defaults to “:”.

Returns:¶

A list of dictionaries containing Rogowski coil information. Returns None if no Rogowski coils are found or if the selection is empty.

Return type:¶

list[dict] or None

Raises:¶

AttributeError – If the IDS object does not have the expected attributes.

get_rogowski_coils(select=':')[source]¶

Retrieve Rogowski coil data and organize it into a dictionary.

Parameters: select (str): A selection string to filter the Rogowski coil data. Default is “:”.

Returns: dict or None: Rogowski coil data

Returns None if no data is available.

get_shunt_values(select=':')[source]¶

Retrieve shunt values from the IDS object and return them as a list of dictionaries.

Parameters: select (str): A string representing the selection slice. Default is “:”.

Returns: list: A list of dictionaries containing shunt information. If no shunts are found or if the shunts list is empty, a warning is logged and None is returned.

get_shunts(select=':')[source]¶

Retrieve shunt data and organize it into a dictionary.

Parameters: select (str): A selection string to filter the shunt data. Default is “:”.

Returns: dict: shunt data

If no shunt data is found, returns None.

idstools.compute.magnetics.logger¶