class CoordMapping

Overview

Mapping of a coordinate to another. It supports analytic and grid-point-based mapping in subclasses. Here in this root CoordMapping class only the invariant unity mapping (or no mapping) is defined.

Class methods

CoordMapping.new

Constructor. One or more arguments can be needed in subclasses

Methods

map(x,y,z,...)

Maps data point(s)

ARGUMENTS

RETURN VALUE

map_grid(x,y,z,...)

Same as map but for a regular grid.

ARGUMENTS

inverse_map(p,q,r,...)

Inversely maps data point(s).

ARGUMENTS

RETURN VALUE

inverse

Returns the inverse mapping.

RETURN VALUE

inversion_rigorous?

Whether the inversion is rigorous (analytical)

RETURN VALUE

class LinearCoordMapping < CoordMapping

Overview

Linear coordinate mapping expressed as offset + factor*x, where offset is a vector (NVect) and factor is a matrix (NMatrix).

Methods listed below are only those newly defined or those whose arguments are changed.

Class methods

LinearCoordMapping.new(offset=nil, factor=nil)

Constructor. If one of offset and factor is not specified (nil), a zero vector / a unit matrix is used (at least one of them must be given).

ARGUMENTS

Methods

offset

Returns the internally stored offset.

factor

Returns the internally stored factor.