Healpix_Map< T > Class Template Reference

#include <healpix_map.h>

Inheritance diagram for Healpix_Map< T >:

Collaboration diagram for Healpix_Map< T >:

List of all members.

Public Member Functions

Healpix_Map ()

Healpix_Map (int order, Healpix_Ordering_Scheme scheme)

Healpix_Map (int nside, Healpix_Ordering_Scheme scheme, const nside_dummy)

Healpix_Map (const arr< T > &data, Healpix_Ordering_Scheme scheme)

void Set (arr< T > &data, Healpix_Ordering_Scheme scheme)

void Set (int order, Healpix_Ordering_Scheme scheme)

void SetNside (int nside, Healpix_Ordering_Scheme scheme)

void fill (const T &val)

void Import_nograde (const Healpix_Map< T > &orig)

void Import_upgrade (const Healpix_Map< T > &orig)

void Import_degrade (const Healpix_Map< T > &orig, bool pessimistic=false)

void Import (const Healpix_Map< T > &orig, bool pessimistic=false)

const T & operator[] (int pix) const

T & operator[] (int pix)

void swap_scheme ()

T interpolation (const fix_arr< int, 4 > &pix, const fix_arr< double, 4 > &wgt) const

T interpolated_value (const pointing &ptg) const

const arr< T > & Map () const

void minmax (T &Min, T &Max) const

void swap (Healpix_Map &other)

double average () const

void add (T val)

double rms () const

T absmax () const

Detailed Description

template<typename T>
class Healpix_Map< T >

A HEALPix map of a given datatype

Definition at line 39 of file healpix_map.h.

Constructor & Destructor Documentation

template<typename T>

Healpix_Map< T >::Healpix_Map ( ) [inline]

Constructs an unallocated map.

Definition at line 46 of file healpix_map.h.

template<typename T>

Healpix_Map< T >::Healpix_Map	(	int	order,
		Healpix_Ordering_Scheme	scheme
	)			`[inline]`

Constructs a map with a given order and the ordering scheme scheme.

Definition at line 49 of file healpix_map.h.

template<typename T>

Healpix_Map< T >::Healpix_Map	(	int	nside,
		Healpix_Ordering_Scheme	scheme,
		const	nside_dummy
	)			`[inline]`

Constructs a map with a given nside and the ordering scheme scheme.

Definition at line 53 of file healpix_map.h.

template<typename T>

Healpix_Map< T >::Healpix_Map	(	const arr< T > &	data,
		Healpix_Ordering_Scheme	scheme
	)			`[inline]`

Constructs a map from the contents of data and sets the ordering scheme to Scheme. The size of data must be a valid HEALPix map size.

Definition at line 58 of file healpix_map.h.

Member Function Documentation

template<typename T>

void Healpix_Map< T >::Set	(	arr< T > &	data,
		Healpix_Ordering_Scheme	scheme
	)			`[inline]`

Deletes the old map, creates a map from the contents of data and sets the ordering scheme to scheme. The size of data must be a valid HEALPix map size.

Definition at line 64 of file healpix_map.h.

template<typename T>

void Healpix_Map< T >::Set	(	int	order,
		Healpix_Ordering_Scheme	scheme
	)			`[inline]`

Deletes the old map and creates a new map with a given order and the ordering scheme scheme.

Reimplemented from Healpix_Base.

Definition at line 72 of file healpix_map.h.

template<typename T>

void Healpix_Map< T >::SetNside	(	int	nside,
		Healpix_Ordering_Scheme	scheme
	)			`[inline]`

Deletes the old map and creates a new map with a given nside and the ordering scheme scheme.

Reimplemented from Healpix_Base.

Definition at line 79 of file healpix_map.h.

template<typename T>

void Healpix_Map< T >::fill ( const T & val ) [inline]

Fills the map with val.

Definition at line 86 of file healpix_map.h.

template<typename T>

void Healpix_Map< T >::Import_nograde ( const Healpix_Map< T > & orig ) [inline]

Imports the map orig into the current map, adjusting the ordering scheme. orig must have the same resolution as the current map.

Definition at line 92 of file healpix_map.h.

template<typename T>

void Healpix_Map< T >::Import_upgrade ( const Healpix_Map< T > & orig ) [inline]

Imports the map orig into the current map, adjusting the ordering scheme and the map resolution. orig must have higher resolution than the current map.

Definition at line 114 of file healpix_map.h.

template<typename T>

void Healpix_Map< T >::Import_degrade	(	const Healpix_Map< T > &	orig,
		bool	pessimistic = `false`
	)			`[inline]`

Imports the map orig into the current map, adjusting the ordering scheme and the map resolution. orig must have higher resolution than the current map. pessimistic determines whether or not pixels are set to Healpix_undef when not all of the corresponding high-resolution pixels are defined.

This method is instantiated for float and double only.

Definition at line 37 of file healpix_map.cc.

template<typename T>

void Healpix_Map< T >::Import	(	const Healpix_Map< T > &	orig,
		bool	pessimistic = `false`
	)			`[inline]`

Imports the map orig into the current map, adjusting the ordering scheme and the map resolution if necessary. When downgrading, pessimistic determines whether or not pixels are set to Healpix_undef when not all of the corresponding high-resolution pixels are defined.

This method is instantiated for float and double only.

Definition at line 160 of file healpix_map.h.

template<typename T>

const T& Healpix_Map< T >::operator[] ( int pix ) const [inline]

Returns a constant reference to the pixel with the number pix.

Definition at line 171 of file healpix_map.h.

template<typename T>

T& Healpix_Map< T >::operator[] ( int pix ) [inline]

Returns a reference to the pixel with the number pix.

Definition at line 173 of file healpix_map.h.

template<typename T>

void Healpix_Map< T >::swap_scheme ( ) [inline]

Swaps the map ordering from RING to NEST and vice versa. This is done in-place (i.e. with negligible space overhead).

Definition at line 177 of file healpix_map.h.

template<typename T>

T Healpix_Map< T >::interpolation	(	const fix_arr< int, 4 > &	pix,
		const fix_arr< double, 4 > &	wgt
	)			const `[inline]`

performs the actual interpolation using pix and wgt.

Definition at line 227 of file healpix_map.h.

template<typename T>

T Healpix_Map< T >::interpolated_value ( const pointing & ptg ) const [inline]

Returns the interpolated map value at ptg

Definition at line 234 of file healpix_map.h.

template<typename T>

const arr<T>& Healpix_Map< T >::Map ( ) const [inline]

Returns a constant reference to the map data.

Definition at line 243 of file healpix_map.h.

template<typename T>

void Healpix_Map< T >::minmax	(	T &	Min,
		T &	Max
	)			const `[inline]`

Returns the minimum and maximum value of the map in Min and Max.

This method is instantiated for float and double only.

Definition at line 79 of file healpix_map.cc.

template<typename T>

void Healpix_Map< T >::swap ( Healpix_Map< T > & other ) [inline]

Swaps the contents of two Healpix_Map objects.

Definition at line 252 of file healpix_map.h.

template<typename T>

double Healpix_Map< T >::average ( ) const [inline]

Returns the average of all defined map pixels.

Definition at line 259 of file healpix_map.h.

template<typename T>

void Healpix_Map< T >::add ( T val ) [inline]

Adds val to all defined map pixels.

Definition at line 270 of file healpix_map.h.

template<typename T>

double Healpix_Map< T >::rms ( ) const [inline]

Returns the root mean square of the map, not counting undefined pixels.

Definition at line 279 of file healpix_map.h.

template<typename T>

T Healpix_Map< T >::absmax ( ) const [inline]

Returns the maximum absolute value in the map, ignoring undefined pixels.

Definition at line 292 of file healpix_map.h.

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

Healpix_Map< T > Class Template Reference

Public Member Functions

Detailed Description

template<typename T> class Healpix_Map< T >

Constructor & Destructor Documentation

Member Function Documentation

template<typename T>
class Healpix_Map< T >