pyrex.ray_tracing.SpecializedRayTracer

class pyrex.ray_tracing.SpecializedRayTracer(from_point, to_point, ice_model=<pyrex.ice_model.AntarcticIce object>, dz=1)

Class for calculating the ray-trace solutions between points.

Calculations in this class require the index of refraction of the ice to be of the form n(z)=n0-k*exp(a*z). However this restriction allows for most of the integrations to be performed analytically. Most properties are lazily evaluated to save on computation time. If any attributes of the class instance are changed, the lazily-evaluated properties will be cleared.

Parameters

from_pointarray_like

Vector starting point of the ray path.

to_pointarray_like

Vector ending point of the ray path.

ice_modeloptional

The ice model used for the ray tracer.

dzfloat, optional

The z-step (m) to be used for integration of the ray path attributes.

See also

pyrex.internal_functions.LazyMutableClass

Class with lazy properties which may depend on other class attributes.

SpecializedRayTracePath

Class for representing a single ray-trace solution between points.

Notes

Even more attributes than those listed are available for the class, but are mainly for internal use. These attributes can be found by exploring the source code.

The requirement that the ice model go as n(z)=n0-k*exp(a*z) is implemented by requiring the ice model to inherit from AntarcticIce. Obviously this is not fool-proof, but likely the ray tracing will obviously fail if the index follows a very different functional form.

Attributes

from_pointndarray

The starting point of the ray path.

to_pointndarray

The ending point of the ray path.

ice

The ice model used for the ray tracer.

dzfloat

The z-step (m) to be used for integration of the ray path attributes.

solution_class

Class for representing a single ray-trace solution between points.

exists

expected_solutions

solutions

Methods

angle_search(true_r, r_function, min_angle, …)	Calculates the angle where r_function (angle) == true_r.
solution_class	alias of pyrex.ray_tracing.SpecializedRayTracePath