LatticePADMVector.h

Classes

LatticePADMVector -- Class to draw a single vector map of a slice from an AIPS++ Lattice. (full description)

template <class T> class LatticePADMVector : public LatticePADisplayMethod<T>

Interface

Public Members
LatticePADMVector(const uInt xAxis, const uInt yAxis, const uInt mAxis, const IPosition fixedPos, LatticePADisplayData<T>* arDat)
LatticePADMVector(const uInt xAxis, const uInt yAxis, LatticePADisplayData<T>* arDat)
virtual ~LatticePADMVector()
virtual uInt dataDrawSelf(WorldCanvas *wCanvas, const Vector<Double> &blc, const Vector<Double> &trc, const IPosition &start, const IPosition &shape, const IPosition &stride, const Bool usePixelEdges = False)
Private Members
Matrix<Float> getAmplitude(const Matrix<T>& data) const

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

The purpose of this class is to draw "vector" maps of data that are "lattice"-based. The "PADM" refers to PrincipalAxesDisplayMethod, meaning that one or more instances of this class are used to actually draw slices of a Lattice along its main axes.

Synopsis

This is a helper class for the LatticeAsVector class. One or more instances of this class are created by a single LatticeAsVector object, each being responsible for drawing a different slice of the data.

Example

This class should only be used by the LatticeAsVector class to setup a number of views of an AIPS++ Image or Array. As such, this example simply outlines how this class is used by LatticeAsVector, in, for example, a support function for a constructor: 
    void LatticeAsVector::setupElements(IPosition fixedPos) {
      if (nPixelAxes > 2) {
        nImages = dataLattice()->shape()(zAxisNum);
        DDelement.resize(nImages);
        for (uInt index = 0; index < nImages; index++) {
          fixedPos(zAxisNum) = index;
          DDelement[index] = (LatticePADisplayMethod<Complex> *)new 
          LatticePADMVector(dataLattice(), xAxisNum, yAxisNum,
                               zAxisNum, fixedPos, this);
        }
      } else {
        nImages = 1;
        DDelement.resize(nImages);
        DDelement[0] = (LatticePADisplayMethod<Complex> *)new
          LatticePADMVector(dataLattice(), xAxisNum, yAxisNum, this);
      }
    }

Motivation

Displaying 2-dimensional slices of a lattice-based data volume is a standard display requirement for astronomical data visualization and presentation.

Thrown Exceptions

To Do

Member Description

LatticePADMVector(const uInt xAxis, const uInt yAxis, const uInt mAxis, const IPosition fixedPos, LatticePADisplayData<T>* arDat)
LatticePADMVector(const uInt xAxis, const uInt yAxis, LatticePADisplayData<T>* arDat)

Constructors: >2d and 2d. xAxis and yAxis specify which axis in the Lattice (0-based) should be mapped to X and Y on the display device: ie. 2-d slices of the data to be displayed have these as axes. mAxis specifies the "movie" axis, which is the axis along which different slices are taken. fixedPos is an IPosition having the same length as the number of dimensions in the array, and indicates the fixed axis values for axes in the data that are not specified as xAxis or yAxis: indeed, fixedPos(mAxis) indicates which pixel value along the movie axis that this particular object looks after.

virtual ~LatticePADMVector()

Destructor

virtual uInt dataDrawSelf(WorldCanvas *wCanvas, const Vector<Double> &blc, const Vector<Double> &trc, const IPosition &start, const IPosition &shape, const IPosition &stride, const Bool usePixelEdges = False)

Actually draw on the display device. The WorldCanvasHolder will tell the LatticeAsVector that it should now draw, which will in turn determine which of its one or more LatticePADMVector objects should draw by matching the movie value on the WorldCanvas. The vector is drawn in the world coordinate range blc to trc.

Matrix<Float> getAmplitude(const Matrix<T>& data) const