casa::ImagePol Class Reference

Implementation of the image polarimetry functionality available from casapy. More...

#include <ImagePolProxy.h>

Public Member Functions
	ImagePol ()
	"imagepol" constructors
	ImagePol (ImageInterface< Float > &im)
virtual	~ImagePol ()
Bool	imagepoltestimage (const String &outFile="imagepol.iquv", const Vector< Double > &rm=Vector< Double >(1, 0.0), Bool rmDefault=True, Double pa0=0.0, Double sigma=0.01, Int nx=32, Int ny=32, Int nf=32, Double f0=1.4e9, Double df=128.0e6)
	Make test image.
Bool	open (ImageInterface< Float > &im)
Bool	open (const String &infile)
Bool	depolratio (ImageInterface< Float > *&rtnim, const String &infile, Bool debias=False, Double clip=10.0, Double sigma=-1, const String &oufile="")
	Depolarization ratio The image containing the delpolratio is in the returnrec Can be recovered using ImageInterface::fromRecord.
Bool	complexlinpol (const String &outfile)
	Complex linear polarization image is stored in outfile.
void	summary () const
	Summary.
Float	sigma (Float clip=10.0) const
	sigma
Bool	stokesI (ImageInterface< Float > *&rtnim, const String &outfile="")
	Stokes I.
Float	sigmaStokesI (Float clip=10.0) const
Bool	stokesQ (ImageInterface< Float > *&rtnim, const String &outfile="")
	Stokes Q.
Float	sigmaStokesQ (Float clip=10.0) const
Bool	stokesU (ImageInterface< Float > *&rtnim, const String &outfile="")
	Stokes U.
Float	sigmaStokesU (Float clip=10.0) const
Bool	stokesV (ImageInterface< Float > *&rtnim, const String &outfile="")
	Stokes V.
Float	sigmaStokesV (Float clip=10.0) const
Bool	linPolInt (ImageInterface< Float > *&rtnim, Bool debias=False, Float clip=10.0, Float sigma=-1, const String &outfile="")
	Linearly polarized intensity.
Float	sigmaLinPolInt (Float clip=10.0, Float sigma=-1) const
Bool	totPolInt (ImageInterface< Float > *&rtnim, Bool debias=False, Float clip=10.0, Float sigma=-1, const String &outfile="")
	Total polarized intensity.
Float	sigmaTotPolInt (Float clip=10.0, Float sigma=-1) const
void	complexLinearPolarization (const String &outfile)
	Complex linear polarization.
void	complexFractionalLinearPolarization (const String &outfile)
	Complex linear polarization.
Bool	linPolPosAng (ImageInterface< Float > *&rtnim, const String &outfile="")
	Linearly polarized position angle.
Bool	sigmaLinPolPosAng (ImageInterface< Float > *&rtnim, Float clip=10.0, Float sigma=-1, const String &outfile="")
Bool	fracLinPol (ImageInterface< Float > *&rtnim, Bool debias=False, Float clip=10.0, Float sigma=-1, const String &outfile="")
	Fractional linearly polarized intensity.
Bool	sigmaFracLinPol (ImageInterface< Float > *&rtnim, Float clip=10.0, Float sigma=-1, const String &outfile="")
Bool	fracTotPol (ImageInterface< Float > *&rtnim, Bool debias=False, Float clip=10.0, Float sigma=-1, const String &outfile="")
	Fractional total polarized intensity.
Bool	sigmaFracTotPol (ImageInterface< Float > *&rtnim, Float clip=10.0, Float sigma=-1, const String &outfile="")
Bool	depolarizationRatio (ImageInterface< Float > *&rtnim, const String &infile, Bool debias=False, Float clip=10.0, Float sigma=-1, const String &outfile="")
	Depolarization ratio.
Bool	sigmaDepolarizationRatio (ImageInterface< Float > *&rtnim, const String &infile, Bool debias=False, Float clip=10.0, Float sigma=-1, const String &outfile="")
void	fourierRotationMeasure (const String &outfile="", const String &outfileAmp="", const String &outfilePA="", const String &outfileReal="", const String &outfileImag="", Bool zeroZeroLag=False)
	Find Rotation Measure from Fourier method.
void	rotationMeasure (const String &outRM="", const String &outRMErr="", const String &outPA0="", const String &outPA0Err="", const String &outNTurns="", const String &outChiSq="", Int axis=-1, Float varQU=-1, Float rmFg=0.0, Float rmMax=0.0, Float maxPaErr=1e30)
	Find Rotation Measure from traditional method.
void	makeComplex (const String &complex, const String &real="", const String &imag="", const String &amp="", const String &phase="")
	Make a complex image.
Private Member Functions
Bool	copyImage (ImageInterface< Float > *&out, const ImageInterface< Float > &in, const String &outfile="", Bool overwrite=true)
void	copyMiscellaneous (ImageInterface< Complex > &out, const ImageInterface< Float > &in)
	Copy miscellaneous (MiscInfo, ImageInfo, history, units).
void	copyMiscellaneous (ImageInterface< Float > &out, const ImageInterface< Float > &in)
void	fiddleStokesCoordinate (ImageInterface< Float > &ie, Stokes::StokesTypes type)
void	fiddleStokesCoordinate (ImageInterface< Complex > &ie, Stokes::StokesTypes type)
Bool	makeImage (ImageInterface< Complex > *&out, const String &outfile, const CoordinateSystem &cSys, const IPosition &shape, Bool isMasked=False, Bool tempAllowed=True)
	Make a PagedImage or TempImage output.
Bool	makeImage (ImageInterface< Float > *&out, const String &outfile, const CoordinateSystem &cSys, const IPosition &shape, Bool isMasked=False, Bool tempAllowed=True)
Bool	makeIQUVImage (ImageInterface< Float > *&pImOut, const String &outfile, Double sigma, Double pa0, const Vector< Float > &rm, const IPosition &shape, Double f0, Double dF)
	Make an IQUV image with some dummy RM data.
Bool	fillIQUV (ImageInterface< Float > &im, uInt stokesAxis, uInt spectralAxis, const Vector< Float > &rm, Float pa0)
	Fill IQUV image with Stokes values from RM data.
void	addNoise (Array< Float > &slice, Normal &noiseGen)
	Add noise to Array.
void	centreRefPix (CoordinateSystem &cSys, const IPosition &shape)
	Centre reference pixelin image.
Bool	makeMask (ImageInterface< Float > &out, Bool init=False)
	Make and define a mask.
Bool	makeMask (ImageInterface< Complex > &out, Bool init=False)
Stokes::StokesTypes	stokesType (const CoordinateSystem &cSys)
	What Stokes type? Exception if more than one.
Private Attributes
LogIO *	itsLog
ImagePolarimetry *	itsImPol

Detailed Description

Implementation of the image polarimetry functionality available from casapy.

Definition at line 45 of file ImagePolProxy.h.

Constructor & Destructor Documentation

casa::ImagePol::ImagePol ( )

"imagepol" constructors

casa::ImagePol::ImagePol ( ImageInterface< Float > & im )

virtual casa::ImagePol::~ImagePol ( ) [virtual]

Member Function Documentation

void casa::ImagePol::addNoise	(	Array< Float > &	slice,
		Normal &	noiseGen
	)			`[private]`

Add noise to Array.

void casa::ImagePol::centreRefPix	(	CoordinateSystem &	cSys,
		const IPosition &	shape
	)			`[private]`

Centre reference pixelin image.

void casa::ImagePol::complexFractionalLinearPolarization ( const String & outfile )

Complex linear polarization.

void casa::ImagePol::complexLinearPolarization ( const String & outfile )

Complex linear polarization.

Bool casa::ImagePol::complexlinpol ( const String & outfile )

Complex linear polarization image is stored in outfile.

Bool casa::ImagePol::copyImage	(	ImageInterface< Float > *&	out,
		const ImageInterface< Float > &	in,
		const String &	outfile = `""`,
		Bool	overwrite = `true`
	)			`[private]`

void casa::ImagePol::copyMiscellaneous	(	ImageInterface< Float > &	out,
		const ImageInterface< Float > &	in
	)			`[private]`

void casa::ImagePol::copyMiscellaneous	(	ImageInterface< Complex > &	out,
		const ImageInterface< Float > &	in
	)			`[private]`

Copy miscellaneous (MiscInfo, ImageInfo, history, units).

Bool casa::ImagePol::depolarizationRatio	(	ImageInterface< Float > *&	rtnim,
		const String &	infile,
		Bool	debias = `False`,
		Float	clip = `10.0`,
		Float	sigma = `-1`,
		const String &	outfile = `""`
	)

Depolarization ratio.

Bool casa::ImagePol::depolratio	(	ImageInterface< Float > *&	rtnim,
		const String &	infile,
		Bool	debias = `False`,
		Double	clip = `10.0`,
		Double	sigma = `-1`,
		const String &	oufile = `""`
	)

Depolarization ratio The image containing the delpolratio is in the returnrec Can be recovered using ImageInterface::fromRecord.

void casa::ImagePol::fiddleStokesCoordinate	(	ImageInterface< Complex > &	ie,
		Stokes::StokesTypes	type
	)			`[private]`

void casa::ImagePol::fiddleStokesCoordinate	(	ImageInterface< Float > &	ie,
		Stokes::StokesTypes	type
	)			`[private]`

Bool casa::ImagePol::fillIQUV	(	ImageInterface< Float > &	im,
		uInt	stokesAxis,
		uInt	spectralAxis,
		const Vector< Float > &	rm,
		Float	pa0
	)			`[private]`

Fill IQUV image with Stokes values from RM data.

void casa::ImagePol::fourierRotationMeasure	(	const String &	outfile = `""`,
		const String &	outfileAmp = `""`,
		const String &	outfilePA = `""`,
		const String &	outfileReal = `""`,
		const String &	outfileImag = `""`,
		Bool	zeroZeroLag = `False`
	)

Find Rotation Measure from Fourier method.

Bool casa::ImagePol::fracLinPol	(	ImageInterface< Float > *&	rtnim,
		Bool	debias = `False`,
		Float	clip = `10.0`,
		Float	sigma = `-1`,
		const String &	outfile = `""`
	)

Fractional linearly polarized intensity.

Bool casa::ImagePol::fracTotPol	(	ImageInterface< Float > *&	rtnim,
		Bool	debias = `False`,
		Float	clip = `10.0`,
		Float	sigma = `-1`,
		const String &	outfile = `""`
	)

Fractional total polarized intensity.

Bool casa::ImagePol::imagepoltestimage	(	const String &	outFile = `"imagepol.iquv"`,
		const Vector< Double > &	rm = `Vector< Double >(1, 0.0)`,
		Bool	rmDefault = `True`,
		Double	pa0 = `0.0`,
		Double	sigma = `0.01`,
		Int	nx = `32`,
		Int	ny = `32`,
		Int	nf = `32`,
		Double	f0 = `1.4e9`,
		Double	df = `128.0e6`
	)

Make test image.

Bool casa::ImagePol::linPolInt	(	ImageInterface< Float > *&	rtnim,
		Bool	debias = `False`,
		Float	clip = `10.0`,
		Float	sigma = `-1`,
		const String &	outfile = `""`
	)

Linearly polarized intensity.

Bool casa::ImagePol::linPolPosAng	(	ImageInterface< Float > *&	rtnim,
		const String &	outfile = `""`
	)

Linearly polarized position angle.

void casa::ImagePol::makeComplex	(	const String &	complex,
		const String &	real = `""`,
		const String &	imag = `""`,
		const String &	amp = `""`,
		const String &	phase = `""`
	)

Make a complex image.

Bool casa::ImagePol::makeImage	(	ImageInterface< Float > *&	out,
		const String &	outfile,
		const CoordinateSystem &	cSys,
		const IPosition &	shape,
		Bool	isMasked = `False`,
		Bool	tempAllowed = `True`
	)			`[private]`

Bool casa::ImagePol::makeImage	(	ImageInterface< Complex > *&	out,
		const String &	outfile,
		const CoordinateSystem &	cSys,
		const IPosition &	shape,
		Bool	isMasked = `False`,
		Bool	tempAllowed = `True`
	)			`[private]`

Make a PagedImage or TempImage output.

Bool casa::ImagePol::makeIQUVImage	(	ImageInterface< Float > *&	pImOut,
		const String &	outfile,
		Double	sigma,
		Double	pa0,
		const Vector< Float > &	rm,
		const IPosition &	shape,
		Double	f0,
		Double	dF
	)			`[private]`

Make an IQUV image with some dummy RM data.

Bool casa::ImagePol::makeMask	(	ImageInterface< Complex > &	out,
		Bool	init = `False`
	)			`[private]`

Bool casa::ImagePol::makeMask	(	ImageInterface< Float > &	out,
		Bool	init = `False`
	)			`[private]`

Make and define a mask.

Bool casa::ImagePol::open ( const String & infile )

Bool casa::ImagePol::open ( ImageInterface< Float > & im )

void casa::ImagePol::rotationMeasure	(	const String &	outRM = `""`,
		const String &	outRMErr = `""`,
		const String &	outPA0 = `""`,
		const String &	outPA0Err = `""`,
		const String &	outNTurns = `""`,
		const String &	outChiSq = `""`,
		Int	axis = `-1`,
		Float	varQU = `-1`,
		Float	rmFg = `0.0`,
		Float	rmMax = `0.0`,
		Float	maxPaErr = `1e30`
	)

Find Rotation Measure from traditional method.

Float casa::ImagePol::sigma ( Float clip = 10.0 ) const

sigma

Bool casa::ImagePol::sigmaDepolarizationRatio	(	ImageInterface< Float > *&	rtnim,
		const String &	infile,
		Bool	debias = `False`,
		Float	clip = `10.0`,
		Float	sigma = `-1`,
		const String &	outfile = `""`
	)

Bool casa::ImagePol::sigmaFracLinPol	(	ImageInterface< Float > *&	rtnim,
		Float	clip = `10.0`,
		Float	sigma = `-1`,
		const String &	outfile = `""`
	)

Bool casa::ImagePol::sigmaFracTotPol	(	ImageInterface< Float > *&	rtnim,
		Float	clip = `10.0`,
		Float	sigma = `-1`,
		const String &	outfile = `""`
	)

Float casa::ImagePol::sigmaLinPolInt	(	Float	clip = `10.0`,
		Float	sigma = `-1`
	)			const

Bool casa::ImagePol::sigmaLinPolPosAng	(	ImageInterface< Float > *&	rtnim,
		Float	clip = `10.0`,
		Float	sigma = `-1`,
		const String &	outfile = `""`
	)

Float casa::ImagePol::sigmaStokesI ( Float clip = 10.0 ) const

Float casa::ImagePol::sigmaStokesQ ( Float clip = 10.0 ) const

Float casa::ImagePol::sigmaStokesU ( Float clip = 10.0 ) const

Float casa::ImagePol::sigmaStokesV ( Float clip = 10.0 ) const

Float casa::ImagePol::sigmaTotPolInt	(	Float	clip = `10.0`,
		Float	sigma = `-1`
	)			const

Bool casa::ImagePol::stokesI	(	ImageInterface< Float > *&	rtnim,
		const String &	outfile = `""`
	)

Stokes I.

Bool casa::ImagePol::stokesQ	(	ImageInterface< Float > *&	rtnim,
		const String &	outfile = `""`
	)

Stokes Q.

Stokes::StokesTypes casa::ImagePol::stokesType ( const CoordinateSystem & cSys ) [private]

What Stokes type? Exception if more than one.

Bool casa::ImagePol::stokesU	(	ImageInterface< Float > *&	rtnim,
		const String &	outfile = `""`
	)

Stokes U.

Bool casa::ImagePol::stokesV	(	ImageInterface< Float > *&	rtnim,
		const String &	outfile = `""`
	)

Stokes V.

void casa::ImagePol::summary ( ) const

Summary.

Bool casa::ImagePol::totPolInt	(	ImageInterface< Float > *&	rtnim,
		Bool	debias = `False`,
		Float	clip = `10.0`,
		Float	sigma = `-1`,
		const String &	outfile = `""`
	)

Total polarized intensity.

Member Data Documentation

ImagePolarimetry* casa::ImagePol::itsImPol [private]

Definition at line 172 of file ImagePolProxy.h.

LogIO* casa::ImagePol::itsLog [private]

Definition at line 171 of file ImagePolProxy.h.

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

code/imageanalysis/ImageAnalysis/ImagePolProxy.h

casa::ImagePol Class Reference

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation