FitsTools< T, N > Class Template Reference

Public Member Functions

FitsTools (const int verbose=1, const bool ignore_header=false)
void addArray (MArray< T, N > &a, const MArray< T, N > &b, const bool nan=false, const T nan_value=T(0))
void addArrayConstant (MArray< T, N > &a, const MArray< T, N > &b, const T s, const bool nan=false, const T nan_value=T(0))
void addPhotonNoise2 (MArray< T, N > &e_a, const MArray< T, N > &a, const T g=T(1.0), const bool nan=false, const T nan_value=T(0.0))
void addZeroPhotonNoise2 (MArray< T, N > &e_a, const MArray< T, N > &a, const T g=T(1.0), const bool nan=false, const T nan_value=T(0.0))
bool adjustRegion2File (const FitsIn &infile, Region &region)
string averageArray (double &mean, double &sigma, const MArray< T, N > &m, const double kappa, const bool sigma_flag=false, const bool twist=false, const bool nan=false, const T nan_value=T(0))
void convert2AbsoluteError2 (MArray< T, N > &e_a, const MArray< T, N > &a, const bool nan=false, const T nan_value=T(0.0))
void convert2RelativeError2 (MArray< T, N > &e_a, const MArray< T, N > &a, const bool nan=false, const T nan_value=T(0.0))
void divideArrayConstant (MArray< T, N > &a, const MArray< T, N > &b, const T d, const bool nan=false, const T nan_value=T(0))
string expandArray (MArray< T, N > &a, const int left, const int right, const int bottom, const int top, const T value)
bool loadError2 (FitsIn &infile, MArray< T, N > &error)
bool loadError2 (const string &filename, MArray< T, N > &error)
bool loadError2 (const string &filename, MArray< T, N > &error, const Region &region)
void loadImage (FitsIn &infile, MArray< T, N > &image)
void loadImage (const string &filename, MArray< T, N > &image)
void loadImage (const string &filename, MArray< T, N > &image, const Region &region)
bool loadImageError2 (FitsIn &infile, MArray< T, N > &image, MArray< T, N > &error)
bool loadImageError2 (const string &filename, MArray< T, N > &image, MArray< T, N > &error)
bool loadImageError2 (const string &filename, MArray< T, N > &image, MArray< T, N > &error, const Region &region)
void loadImageOffset (FitsIn &infile, const double offset, MArray< T, N > &image)
string medianArray (double &median, double &sigma, const MArray< T, N > &m, const double kappa, const bool sigma_flag=false, const bool twist=false, const bool nan=false, const T nan_value=T(0))
void multiplyArrayConstant (MArray< T, N > &a, const MArray< T, N > &b, const T d, const bool nan, const T nan_value)
void multiplyConstant (MArray< T, N > &a, const T d, const bool nan=false, const T nan_value=T(0))
string prependFilename (string path, const string &prefix) const
void propagateError2 (MArray< T, N > &e_a, const MArray< T, N > &e_b, const T e_s)
void propagateZeroError2 (MArray< T, N > &e_a, const MArray< T, N > &e_b, const T e_s)
void referenceRegion (MArray< T, N > &ref, const MArray< T, N > &input, const Region &region)
string rotateReverseArray (MArray< T, N > &a, const int rot, const bool x, const bool y)
void saveError2 (MArray< T, N > &error, FitsOut &outfile)
void saveImage (MArray< T, N > &image, FitsOut &outfile)
void saveImageError2 (MArray< T, N > &a, MArray< T, N > &e_a, FitsOut &outfile)
void selectRegionFile (FitsIn &infile, Region region)
void subtractArrayConstant (MArray< T, N > &a, const MArray< T, N > &b, const T s, const bool nan=false, const T nan_value=T(0))

Private Attributes

const int verbose_
const bool quiet_please_
const bool ignore_header_

template<class T, int N>
class FitsTools< T, N >

Constructor & Destructor Documentation

template<class T, int N>

FitsTools< T, N >::FitsTools	(	const int	verbose = `1`,
		const bool	ignore_header = `false`
	)			`[inline]`

Member Function Documentation

template<class T , int N>

void FitsTools< T, N >::addArray	(	MArray< T, N > &	a,
		const MArray< T, N > &	b,
		const bool	nan = `false`,
		const T	nan_value = `T(0)`
	)			`[inline]`

Referenced by main().

template<class T , int N>

void FitsTools< T, N >::addArrayConstant	(	MArray< T, N > &	a,
		const MArray< T, N > &	b,
		const T	s,
		const bool	nan = `false`,
		const T	nan_value = `T(0)`
	)			`[inline]`

Referenced by main().

template<class T , int N>

void FitsTools< T, N >::addPhotonNoise2	(	MArray< T, N > &	e_a,
		const MArray< T, N > &	a,
		const T	g = `T(1.0)`,
		const bool	nan = `false`,
		const T	nan_value = `T(0.0)`
	)			`[inline]`

Referenced by main().

template<class T , int N>

void FitsTools< T, N >::addZeroPhotonNoise2	(	MArray< T, N > &	e_a,
		const MArray< T, N > &	a,
		const T	g = `T(1.0)`,
		const bool	nan = `false`,
		const T	nan_value = `T(0.0)`
	)			`[inline]`

Referenced by main().

template<class T , int N>

bool FitsTools< T, N >::adjustRegion2File	(	const FitsIn &	infile,
		Region &	region
	)			`[inline]`

References FitsTools< T, N >::verbose_.

Referenced by main(), and FitsTools< T, N >::selectRegionFile().

template<class T , int N>

string FitsTools< T, N >::averageArray	(	double &	mean,
		double &	sigma,
		const MArray< T, N > &	m,
		const double	kappa,
		const bool	sigma_flag = `false`,
		const bool	twist = `false`,
		const bool	nan = `false`,
		const T	nan_value = `T(0)`
	)			`[inline]`

Referenced by main().

template<class T , int N>

void FitsTools< T, N >::convert2AbsoluteError2	(	MArray< T, N > &	e_a,
		const MArray< T, N > &	a,
		const bool	nan = `false`,
		const T	nan_value = `T(0.0)`
	)			`[inline]`

Referenced by main().

template<class T , int N>

void FitsTools< T, N >::convert2RelativeError2	(	MArray< T, N > &	e_a,
		const MArray< T, N > &	a,
		const bool	nan = `false`,
		const T	nan_value = `T(0.0)`
	)			`[inline]`

Referenced by main().

template<class T , int N>

void FitsTools< T, N >::divideArrayConstant	(	MArray< T, N > &	a,
		const MArray< T, N > &	b,
		const T	d,
		const bool	nan = `false`,
		const T	nan_value = `T(0)`
	)			`[inline]`

Referenced by main().

template<class T , int N>

string FitsTools< T, N >::expandArray	(	MArray< T, N > &	a,
		const int	left,
		const int	right,
		const int	bottom,
		const int	top,
		const T	value
	)			`[inline]`

References a.

Referenced by main().

template<class T , int N>

bool FitsTools< T, N >::loadError2	(	FitsIn &	infile,
		MArray< T, N > &	error
	)			`[inline]`

References FitsTools< T, N >::verbose_.

Referenced by FitsTools< T, N >::loadError2(), FitsTools< T, N >::loadImageError2(), and main().

template<class T , int N>

bool FitsTools< T, N >::loadError2	(	const string &	filename,
		MArray< T, N > &	error
	)			`[inline]`

References FitsTools< T, N >::loadError2(), FitsTools< T, N >::prependFilename(), FitsTools< T, N >::quiet_please_, and FitsTools< T, N >::verbose_.

template<class T , int N>

bool FitsTools< T, N >::loadError2	(	const string &	filename,
		MArray< T, N > &	error,
		const Region &	region
	)			`[inline]`

References FitsTools< T, N >::loadError2(), FitsTools< T, N >::prependFilename(), FitsTools< T, N >::quiet_please_, FitsTools< T, N >::selectRegionFile(), and FitsTools< T, N >::verbose_.

template<class T , int N>

void FitsTools< T, N >::loadImage	(	FitsIn &	infile,
		MArray< T, N > &	image
	)			`[inline]`

References FitsTools< T, N >::verbose_.

Referenced by FitsTools< T, N >::loadImage(), FitsTools< T, N >::loadImageError2(), FitsTools< T, N >::loadImageOffset(), and main().

template<class T , int N>

void FitsTools< T, N >::loadImage	(	const string &	filename,
		MArray< T, N > &	image
	)			`[inline]`

References FitsTools< T, N >::ignore_header_, FitsTools< T, N >::loadImage(), and FitsTools< T, N >::quiet_please_.

template<class T , int N>

void FitsTools< T, N >::loadImage	(	const string &	filename,
		MArray< T, N > &	image,
		const Region &	region
	)			`[inline]`

References FitsTools< T, N >::ignore_header_, FitsTools< T, N >::loadImage(), FitsTools< T, N >::quiet_please_, and FitsTools< T, N >::selectRegionFile().

template<class T , int N>

bool FitsTools< T, N >::loadImageError2	(	FitsIn &	infile,
		MArray< T, N > &	image,
		MArray< T, N > &	error
	)			`[inline]`

References FitsTools< T, N >::loadError2(), and FitsTools< T, N >::loadImage().

Referenced by main().

template<class T , int N>

bool FitsTools< T, N >::loadImageError2	(	const string &	filename,
		MArray< T, N > &	image,
		MArray< T, N > &	error
	)			`[inline]`

References FitsTools< T, N >::loadError2(), and FitsTools< T, N >::loadImage().

template<class T , int N>

bool FitsTools< T, N >::loadImageError2	(	const string &	filename,
		MArray< T, N > &	image,
		MArray< T, N > &	error,
		const Region &	region
	)			`[inline]`

References FitsTools< T, N >::loadError2(), and FitsTools< T, N >::loadImage().

template<class T , int N>

void FitsTools< T, N >::loadImageOffset	(	FitsIn &	infile,
		const double	offset,
		MArray< T, N > &	image
	)			`[inline]`

References FitsTools< T, N >::loadImage().

template<class T , int N>

string FitsTools< T, N >::medianArray	(	double &	median,
		double &	sigma,
		const MArray< T, N > &	m,
		const double	kappa,
		const bool	sigma_flag = `false`,
		const bool	twist = `false`,
		const bool	nan = `false`,
		const T	nan_value = `T(0)`
	)			`[inline]`

Referenced by main().

template<class T , int N>

void FitsTools< T, N >::multiplyArrayConstant	(	MArray< T, N > &	a,
		const MArray< T, N > &	b,
		const T	d,
		const bool	nan,
		const T	nan_value
	)			`[inline]`

Referenced by main().

template<class T , int N>

void FitsTools< T, N >::multiplyConstant	(	MArray< T, N > &	a,
		const T	d,
		const bool	nan = `false`,
		const T	nan_value = `T(0)`
	)			`[inline]`

Referenced by main().

template<class T , int N>

string FitsTools< T, N >::prependFilename	(	string	path,
		const string &	prefix
	)			const `[inline]`

Referenced by FitsTools< T, N >::loadError2(), main(), and FitsTools< T, N >::saveError2().

template<class T , int N>

void FitsTools< T, N >::propagateError2	(	MArray< T, N > &	e_a,
		const MArray< T, N > &	e_b,
		const T	e_s
	)			`[inline]`

Referenced by main().

template<class T , int N>

void FitsTools< T, N >::propagateZeroError2	(	MArray< T, N > &	e_a,
		const MArray< T, N > &	e_b,
		const T	e_s
	)			`[inline]`

Referenced by main().

template<class T , int N>

void FitsTools< T, N >::referenceRegion	(	MArray< T, N > &	ref,
		const MArray< T, N > &	input,
		const Region &	region
	)			`[inline]`

Referenced by main().

template<class T , int N>

string FitsTools< T, N >::rotateReverseArray	(	MArray< T, N > &	a,
		const int	rot,
		const bool	x,
		const bool	y
	)			`[inline]`

Referenced by main().

template<class T , int N>

void FitsTools< T, N >::saveError2	(	MArray< T, N > &	error,
		FitsOut &	outfile
	)			`[inline]`

References FitsTools< T, N >::prependFilename(), and FitsTools< T, N >::saveImage().

Referenced by main(), and FitsTools< T, N >::saveImageError2().

template<class T , int N>

void FitsTools< T, N >::saveImage	(	MArray< T, N > &	image,
		FitsOut &	outfile
	)			`[inline]`

References FitsTools< T, N >::verbose_.

Referenced by main(), FitsTools< T, N >::saveError2(), and FitsTools< T, N >::saveImageError2().

template<class T , int N>

void FitsTools< T, N >::saveImageError2	(	MArray< T, N > &	a,
		MArray< T, N > &	e_a,
		FitsOut &	outfile
	)			`[inline]`

References FitsTools< T, N >::saveError2(), and FitsTools< T, N >::saveImage().

Referenced by main().

template<class T , int N>

void FitsTools< T, N >::selectRegionFile	(	FitsIn &	infile,
		Region	region
	)			`[inline]`

References FitsTools< T, N >::adjustRegion2File().

Referenced by FitsTools< T, N >::loadError2(), FitsTools< T, N >::loadImage(), and main().

template<class T , int N>

void FitsTools< T, N >::subtractArrayConstant	(	MArray< T, N > &	a,
		const MArray< T, N > &	b,
		const T	s,
		const bool	nan = `false`,
		const T	nan_value = `T(0)`
	)			`[inline]`