casacore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Static Public Member Functions | List of all members
casacore::LatticeMathUtil Class Reference

Static math functions for Lattices. More...

#include <LatticeMathUtil.h>

Static Public Member Functions

template<class T >
static void collapse (Array< T > &data, const IPosition &axes, const MaskedLattice< T > &in, Bool dropDegenerateAxes)
 Collapse the specified axes by averaging and recover the pixel values. More...
 
template<class T >
static void collapse (Array< T > &data, Array< Bool > &mask, const IPosition &axes, const MaskedLattice< T > &lat, Bool dropDegenerateAxes, Bool getPixels=True, Bool getMask=True, const LatticeStatsBase::StatisticsTypes stat=LatticeStatsBase::MEAN)
 Collapse the specified axes by averaging and recover either/and the pixel values and mask. More...
 

Detailed Description

Static math functions for Lattices.

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd
Test programs:
tLatticeMathUtil

Prerequisite

Synopsis

Some static helper math functions for Lattices

Motivation

Common functionality not appropriate for Lattice member functions

To Do

Definition at line 67 of file LatticeMathUtil.h.

Member Function Documentation

template<class T >
static void casacore::LatticeMathUtil::collapse ( Array< T > &  data,
const IPosition axes,
const MaskedLattice< T > &  in,
Bool  dropDegenerateAxes 
)
static

Collapse the specified axes by averaging and recover the pixel values.

If axes is empty, then the data just contains all of the lattice (i.e. no collapse), but dropDegenerateAxes is stil honoured

template<class T >
static void casacore::LatticeMathUtil::collapse ( Array< T > &  data,
Array< Bool > &  mask,
const IPosition axes,
const MaskedLattice< T > &  lat,
Bool  dropDegenerateAxes,
Bool  getPixels = True,
Bool  getMask = True,
const LatticeStatsBase::StatisticsTypes  stat = LatticeStatsBase::MEAN 
)
static

Collapse the specified axes by averaging and recover either/and the pixel values and mask.

If axes is empty, then the data and mask just contains all of the lattice (i.e. no collapse) but dropDegenerateAxes is stil honoured


The documentation for this class was generated from the following file: