#include <healpix_map.h>

Inheritance diagram for Healpix_Map< T >:

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)

void	Scale (T val)

double	rms () const

T	absmax () const

bool	fullyDefined () const

tsize	replaceUndefWith0 ()

Public Member Functions inherited from T_Healpix_Base< I >
	T_Healpix_Base ()

	T_Healpix_Base (int order, Healpix_Ordering_Scheme scheme)

	T_Healpix_Base (I nside, Healpix_Ordering_Scheme scheme, const nside_dummy)

void	Set (int order, Healpix_Ordering_Scheme scheme)

void	SetNside (I nside, Healpix_Ordering_Scheme scheme)

double	ring2z (I ring) const

I	pix2ring (I pix) const

I	nest2ring (I pix) const

I	ring2nest (I pix) const

I	nest2peano (I pix) const

I	peano2nest (I pix) const

I	zphi2pix (double z, double phi) const

I	ang2pix (const pointing &ang) const

I	vec2pix (const vec3 &vec) const

void	pix2zphi (I pix, double &z, double &phi) const

pointing	pix2ang (I pix) const

vec3	pix2vec (I pix) const

I	pixel_import (I pix, const T_Healpix_Base &b) const

void	query_disc (pointing ptg, double radius, rangeset< I > &pixset) const

rangeset< I >	query_disc (pointing ptg, double radius) const

void	query_disc_inclusive (pointing ptg, double radius, rangeset< I > &pixset, int fact=1) const

rangeset< I >	query_disc_inclusive (pointing ptg, double radius, int fact=1) const

void	query_disc (const pointing &dir, double radius, std::vector< I > &listpix) const

void	query_disc_inclusive (const pointing &dir, double radius, std::vector< I > &listpix, int fact=1) const

void	query_polygon (const std::vector< pointing > &vertex, rangeset< I > &pixset) const

rangeset< I >	query_polygon (const std::vector< pointing > &vertex) const

void	query_polygon_inclusive (const std::vector< pointing > &vertex, rangeset< I > &pixset, int fact=1) const

rangeset< I >	query_polygon_inclusive (const std::vector< pointing > &vertex, int fact=1) const

void	query_strip (double theta1, double theta2, bool inclusive, rangeset< I > &pixset) const

rangeset< I >	query_strip (double theta1, double theta2, bool inclusive) const

void	get_ring_info (I ring, I &startpix, I &ringpix, double &costheta, double &sintheta, bool &shifted) const

void	get_ring_info2 (I ring, I &startpix, I &ringpix, double &theta, bool &shifted) const

void	get_ring_info_small (I ring, I &startpix, I &ringpix, bool &shifted) const

void	neighbors (I pix, fix_arr< I, 8 > &result) const

void	get_interpol (const pointing &ptg, fix_arr< I, 4 > &pix, fix_arr< double, 4 > &wgt) const

int	Order () const

I	Nside () const

I	Npix () const

Healpix_Ordering_Scheme	Scheme () const

bool	conformable (const T_Healpix_Base &other) const

void	swap (T_Healpix_Base &other)

double	max_pixrad () const

double	max_pixrad (I ring) const

void	boundaries (I pix, tsize step, std::vector< vec3 > &out) const

Additional Inherited Members
Static Public Member Functions inherited from T_Healpix_Base< I >
static int	nside2order (I nside)

static I	npix2nside (I npix)

Protected Member Functions inherited from T_Healpix_Base< I >
I	ring_above (double z) const

Protected Attributes inherited from T_Healpix_Base< I >
int	order_

I	nside_

Healpix_Ordering_Scheme	scheme_

Detailed Description

template<typename T>
class Healpix_Map< T >

A HEALPix map of a given datatype

Definition at line 39 of file alm_healpix_tools.h.

Constructor & Destructor Documentation

◆ Healpix_Map() [1/4]

template<typename T>

Healpix_Map< T >::Healpix_Map ( )

inline

Constructs an unallocated map.

Definition at line 49 of file healpix_map.h.

◆ Healpix_Map() [2/4]

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 52 of file healpix_map.h.

◆ Healpix_Map() [3/4]

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 56 of file healpix_map.h.

◆ Healpix_Map() [4/4]

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 61 of file healpix_map.h.

Member Function Documentation

◆ Set() [1/2]

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.

Note: On exit, data is zero-sized!

Definition at line 68 of file healpix_map.h.

◆ Set() [2/2]

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.

Definition at line 76 of file healpix_map.h.

◆ SetNside()

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.

Definition at line 83 of file healpix_map.h.

◆ fill()

template<typename T>

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

inline

Fills the map with val.

Definition at line 90 of file healpix_map.h.

◆ Import_nograde()

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 96 of file healpix_map.h.

◆ Import_upgrade()

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 lower resolution than the current map, and this->Nside() must be an integer multiple of orig.Nside().

Definition at line 119 of file healpix_map.h.

◆ Import_degrade()

template<typename T>

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

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, and orig.Nside() must be an integer multiple of this->Nside(). 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.

◆ Import()

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 162 of file healpix_map.h.

◆ operator[]() [1/2]

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 173 of file healpix_map.h.

◆ operator[]() [2/2]

template<typename T>

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

inline

Returns a reference to the pixel with the number pix.

Definition at line 175 of file healpix_map.h.

◆ swap_scheme()

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 179 of file healpix_map.h.

◆ interpolation()

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 205 of file healpix_map.h.

◆ interpolated_value()

template<typename T>

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

inline

Returns the interpolated map value at ptg

Definition at line 219 of file healpix_map.h.

◆ Map()

template<typename T>

const arr<T>& Healpix_Map< T >::Map ( ) const

inline

Returns a constant reference to the map data.

Definition at line 228 of file healpix_map.h.

◆ minmax()

template<typename T>

template void Healpix_Map< T >::minmax	(	T &	Min,
		T &	Max
	)		const

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 75 of file healpix_map.cc.

◆ swap()

template<typename T>

void Healpix_Map< T >::swap ( Healpix_Map< T > & other )

inline

Swaps the contents of two Healpix_Map objects.

Definition at line 237 of file healpix_map.h.

◆ average()

template<typename T>

double Healpix_Map< T >::average ( ) const

inline

Returns the average of all defined map pixels.

Definition at line 244 of file healpix_map.h.

◆ Add()

template<typename T>

void Healpix_Map< T >::Add ( T val )

inline

Adds val to all defined map pixels.

Definition at line 255 of file healpix_map.h.

◆ Scale()

template<typename T>

void Healpix_Map< T >::Scale ( T val )

inline

Multiplies all defined map pixels by val.

Definition at line 263 of file healpix_map.h.

◆ rms()

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 272 of file healpix_map.h.

◆ absmax()

template<typename T>

T Healpix_Map< T >::absmax ( ) const

inline

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

Definition at line 285 of file healpix_map.h.

◆ fullyDefined()

template<typename T>

bool Healpix_Map< T >::fullyDefined ( ) const

inline

Returns true, if no pixel has the value Healpix_undef, else false.

Definition at line 297 of file healpix_map.h.

◆ replaceUndefWith0()

template<typename T>

tsize Healpix_Map< T >::replaceUndefWith0 ( )

inline

Sets all pixels with the value Healpix_undef to 0, and returns the number of modified pixels.

Definition at line 306 of file healpix_map.h.

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

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename T> class Healpix_Map< T >

Constructor & Destructor Documentation

◆ Healpix_Map() [1/4]

◆ Healpix_Map() [2/4]

◆ Healpix_Map() [3/4]

◆ Healpix_Map() [4/4]

Member Function Documentation

◆ Set() [1/2]

◆ Set() [2/2]

◆ SetNside()

◆ fill()

◆ Import_nograde()

◆ Import_upgrade()

◆ Import_degrade()

◆ Import()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ swap_scheme()

◆ interpolation()

◆ interpolated_value()

◆ Map()

◆ minmax()

◆ swap()

◆ average()

◆ Add()

◆ Scale()

◆ rms()

◆ absmax()

◆ fullyDefined()

◆ replaceUndefWith0()

template<typename T>
class Healpix_Map< T >