i_measurement_point module

Define an object to keep several related measurements.

class IMeasurementPoint(name, df_data, instrument_factory, instruments_kw, position, color=None)[source]

Bases: ABC

Hold several related measurements.

In particular, gather Instrument which have the same position.

Parameters:

name (str)
df_data (DataFrame)
instrument_factory (InstrumentFactory)
instruments_kw (dict[str, dict[str, Any]])
position (float)
color (str | None, default: None)

instruments: Holds all Instrument instances at this location

add_instrument(*instruments)[source]

Add a new Instrument to instruments.

A priori, useful only for VirtualInstrument, when they rely on other Instrument objects to be fully initialized.

Parameters:: instruments (Instrument)
Return type:: None

remove_instrument(*instruments)[source]

Remove instruments from the list.

Parameters:: instruments (Instrument)
Return type:: None

get_instruments(instrument_class, instruments_to_ignore=())[source]

Get instruments which are (sub) classes of instrument_class.

An empty list is returned when current pick-up has no instrument of the desired instrument class.

Parameters:

instrument_class (ABCMeta)
instruments_to_ignore (Sequence[Instrument | str], default: ())

Return type:

list[Instrument]

get_instrument(*args, **kwargs)[source]

Get instrument which is (sub) class of instrument_class.

Raise an error if several instruments match the condition.

Return type:: Instrument | None

add_post_treater(post_treater, instrument_class=<class 'multipac_testbench.instruments.instrument.Instrument'>)[source]

Add post-treatment functions to instruments.

Parameters:

post_treater (Callable[[ndarray[tuple[Any, ...], dtype[double]]], ndarray[tuple[Any, ...], dtype[double]]])
instrument_class (ABCMeta, default: <class 'multipac_testbench.instruments.instrument.Instrument'>)

Return type:

None

remove_post_treater(post_treater=None, index=None, instrument_class=<class 'multipac_testbench.instruments.instrument.Instrument'>)[source]

Remove post-treatment function from instruments.

Parameters:

post_treater (Callable[[ndarray[tuple[Any, ...], dtype[double]]], ndarray[tuple[Any, ...], dtype[double]]] | None, default: None) – Post-treater to remove. Has priority over index.
index (int | None, default: None) – Index of post-treater to remove.
instrument_class (ABCMeta, default: <class 'multipac_testbench.instruments.instrument.Instrument'>) – Type of instruments concerned by removing.

Return type:

None

scatter_instruments_data(instrument_class_axes, xdata, instrument_multipactor_bands)[source]

Scatter data measured by desired instruments.

Parameters:

instrument_class_axes (dict[ABCMeta, Axes])
xdata (float)
instrument_multipactor_bands (Any)

Return type:

None

_abc_impl = <_abc._abc_data object at 0x7466cbdf3100>