
AXIS(3LO)            Linop Reference Manual             AXIS(3LO)

NAME
     Axis - class to describe an axis of a <type>space.

SYNOPSIS
     #include <Axis.h>

DESCRIPTION
     The class Axis contains  a  description  of  an  axis  in  a
     <type>space. The description includes the initial coordinate
     of the data along the axis (origin), the number  of  samples
     along  this  axis  (length),  the  increment between samples
     (delta), a label for this axis (name), and flags to indicate
     wildcarding  for  origin, delta and length (wildo, wildd and
     wildl). An Axis can be constructed  from  either  the  above
     information, or from a SepAxis *.

PUBLIC VARIABLES
     float origin
     float delta
     int length
     char * name
     int wildo
     int wildd
     int wildl

PUBLIC OPERATIONS
     Axis(float origin,float delta,int length,const char *name,
          int wildo=,int wildd=,int wildl=)
          Construct an  Axis  given  a  value  for  each  of  its
          members. The label (name) is copied.

     Axis(SepAxis *)
          Construct an Axis which matches the SepAxis.

     SepAxis * sepaxis() const
          Return a pointer to a new SepAxis object, which matches
          the Axis.

     Axis()
     Axis(const Axis &)
     Axis& operator=(const Axis &)
     ~Axis()

     int operator==(const Axis &) const
          Check if two Axis have the same values  for  all  their
          members that are not wildcarded.

     friend ostream& operator<<(ostream&, const Axis&)
          Print the Axis.

     Axis wild() const
          Return an Axis with  name,  origin,  delta  and  length

AXIS(3LO)            Linop Reference Manual             AXIS(3LO)

          equal to zero.  Serves as a zero Axis.

     int iswild() const
          Check if the Axis is a wild axis.  That is, name,  ori-
          gin, delta and length are zero.

     int subaxis(Axis & a) const
          Check if the Axis is a sub-axis of a. For Axis x to  be
          a  sub-axis  of Axis y, x must: () have the same label
          as y  (2) have every sample of x have the same position
          as some sample of y.

     float max() const
          Return origin + delta * length.

     int index(float) const
          Get the integer index of  the  closest  sample  to  the
          float parameter.

     float value(int) const
          Return the float position of the sample numbered by the
          int parameter.

SEE ALSO
     Axislist, <type>space, SepAxis

