BaseComponentEstimator

class pyirf.interpolation.BaseComponentEstimator(grid_points)[source]

Bases: object

Base class for all Estimators working on specific IRF components.

While usable, it is encouraged to use the actual class for the respective IRF component as it ensures further checks and if necessary e.g. unit handling.

Methods Summary

__call__(target_point)

Inter-/ Extrapolation as needed and sanity checking of the target point

Methods Documentation

__call__(target_point)[source]

Inter-/ Extrapolation as needed and sanity checking of the target point

Parameters:
target_point: np.ndarray, shape=(1, n_dims)

Target for inter-/extrapolation

Returns:
Interpolated or, if necessary extrapolated, result.
Raises:
TypeError:

When target_point is not an np.ndarray

ValueError:

When more then one target_point is given

ValueError:

When target_point and grid_points have miss-matching dimensions

ValueError:

When target_point is outside of the grids convex hull but extrapolator is None

Warning:

When target_points need extrapolation