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

#include <ImagePolProxy.h>

Public Member Functions
	ImagePol ()
	"imagepol" constructors More...

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

virtual	~ImagePol ()

casacore::Bool	imagepoltestimage (const casacore::String &outFile="imagepol.iquv", const casacore::Vector< casacore::Double > &rm=casacore::Vector< casacore::Double >(1, 0.0), casacore::Bool rmDefault=true, casacore::Double pa0=0.0, casacore::Double sigma=0.01, casacore::Int nx=32, casacore::Int ny=32, casacore::Int nf=32, casacore::Double f0=1.4e9, casacore::Double df=128.0e6)
	Make test image. More...

casacore::Bool	open (casacore::ImageInterface< casacore::Float > &im)

casacore::Bool	open (const casacore::String &infile)

casacore::Bool	depolratio (casacore::ImageInterface< casacore::Float > *&rtnim, const casacore::String &infile, casacore::Bool debias=false, casacore::Double clip=10.0, casacore::Double sigma=-1, const casacore::String &oufile="")
	Depolarization ratio The image containing the delpolratio is in the returnrec Can be recovered using casacore::ImageInterface::fromRecord. More...

casacore::Bool	complexlinpol (const casacore::String &outfile)
	casacore::Complex linear polarization image is stored in outfile More...

void	summary () const
	Summary. More...

casacore::Float	sigma (casacore::Float clip=10.0) const
	sigma More...

casacore::Bool	stokesI (casacore::ImageInterface< casacore::Float > *&rtnim, const casacore::String &outfile="")
	casacore::Stokes I More...

casacore::Float	sigmaStokesI (casacore::Float clip=10.0) const

casacore::Bool	stokesQ (casacore::ImageInterface< casacore::Float > *&rtnim, const casacore::String &outfile="")
	casacore::Stokes Q More...

casacore::Float	sigmaStokesQ (casacore::Float clip=10.0) const

casacore::Bool	stokesU (casacore::ImageInterface< casacore::Float > *&rtnim, const casacore::String &outfile="")
	casacore::Stokes U More...

casacore::Float	sigmaStokesU (casacore::Float clip=10.0) const

casacore::Bool	stokesV (casacore::ImageInterface< casacore::Float > *&rtnim, const casacore::String &outfile="")
	casacore::Stokes V More...

casacore::Float	sigmaStokesV (casacore::Float clip=10.0) const

casacore::Float	sigmaLinPolInt (casacore::Float clip=10.0, casacore::Float sigma=-1) const

casacore::Float	sigmaTotPolInt (casacore::Float clip=10.0, casacore::Float sigma=-1) const
	Total polarized intensity. More...

void	complexLinearPolarization (const casacore::String &outfile)
	casacore::Complex linear polarization More...

void	complexFractionalLinearPolarization (const casacore::String &outfile)
	casacore::Complex linear polarization More...

casacore::Bool	sigmaLinPolPosAng (casacore::ImageInterface< casacore::Float > *&rtnim, casacore::Float clip=10.0, casacore::Float sigma=-1, const casacore::String &outfile="")
	Linearly polarized position angle. More...

casacore::Bool	fracLinPol (casacore::ImageInterface< casacore::Float > *&rtnim, casacore::Bool debias=false, casacore::Float clip=10.0, casacore::Float sigma=-1, const casacore::String &outfile="")
	Fractional linearly polarized intensity. More...

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

casacore::Bool	fracTotPol (casacore::ImageInterface< casacore::Float > *&rtnim, casacore::Bool debias=false, casacore::Float clip=10.0, casacore::Float sigma=-1, const casacore::String &outfile="")
	Fractional total polarized intensity. More...

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

casacore::Bool	depolarizationRatio (casacore::ImageInterface< casacore::Float > *&rtnim, const casacore::String &infile, casacore::Bool debias=false, casacore::Float clip=10.0, casacore::Float sigma=-1, const casacore::String &outfile="")
	Depolarization ratio. More...

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

void	fourierRotationMeasure (const casacore::String &outfile="", const casacore::String &outfileAmp="", const casacore::String &outfilePA="", const casacore::String &outfileReal="", const casacore::String &outfileImag="", casacore::Bool zeroZeroLag=false)
	Find Rotation casacore::Measure from Fourier method. More...

void	rotationMeasure (const casacore::String &outRM="", const casacore::String &outRMErr="", const casacore::String &outPA0="", const casacore::String &outPA0Err="", const casacore::String &outNTurns="", const casacore::String &outChiSq="", casacore::Int axis=-1, casacore::Float varQU=-1, casacore::Float rmFg=0.0, casacore::Float rmMax=0.0, casacore::Float maxPaErr=1e30)
	Find Rotation casacore::Measure from traditional method. More...

void	makeComplex (const casacore::String &complex, const casacore::String &real="", const casacore::String &imag="", const casacore::String &amp="", const casacore::String &phase="")
	Make a complex image. More...

SPCIIF	getImage () const

Private Member Functions
casacore::Bool	copyImage (casacore::ImageInterface< casacore::Float > *&out, const casacore::ImageInterface< casacore::Float > &in, const casacore::String &outfile="", casacore::Bool overwrite=true)

void	copyMiscellaneous (casacore::ImageInterface< casacore::Complex > &out, const casacore::ImageInterface< casacore::Float > &in)
	Copy miscellaneous (MiscInfo, casacore::ImageInfo, history, units) More...

void	copyMiscellaneous (casacore::ImageInterface< casacore::Float > &out, const casacore::ImageInterface< casacore::Float > &in)

void	fiddleStokesCoordinate (casacore::ImageInterface< casacore::Float > &ie, casacore::Stokes::StokesTypes type)

void	fiddleStokesCoordinate (casacore::ImageInterface< casacore::Complex > &ie, casacore::Stokes::StokesTypes type)

casacore::Bool	makeImage (casacore::ImageInterface< casacore::Complex > *&out, const casacore::String &outfile, const casacore::CoordinateSystem &cSys, const casacore::IPosition &shape, casacore::Bool isMasked=false, casacore::Bool tempAllowed=true)
	Make a casacore::PagedImage or casacore::TempImage output. More...

casacore::Bool	makeImage (casacore::ImageInterface< casacore::Float > *&out, const casacore::String &outfile, const casacore::CoordinateSystem &cSys, const casacore::IPosition &shape, casacore::Bool isMasked=false, casacore::Bool tempAllowed=true)

casacore::Bool	makeIQUVImage (casacore::ImageInterface< casacore::Float > *&pImOut, const casacore::String &outfile, casacore::Double sigma, casacore::Double pa0, const casacore::Vector< casacore::Float > &rm, const casacore::IPosition &shape, casacore::Double f0, casacore::Double dF)
	Make an IQUV image with some dummy RM data. More...

casacore::Bool	fillIQUV (casacore::ImageInterface< casacore::Float > &im, casacore::uInt stokesAxis, casacore::uInt spectralAxis, const casacore::Vector< casacore::Float > &rm, casacore::Float pa0)
	Fill IQUV image with casacore::Stokes values from RM data. More...

void	addNoise (casacore::Array< casacore::Float > &slice, casacore::Normal &noiseGen)
	Add noise to Array. More...

void	centreRefPix (casacore::CoordinateSystem &cSys, const casacore::IPosition &shape)
	Centre reference pixelin image. More...

casacore::Bool	makeMask (casacore::ImageInterface< casacore::Float > &out, casacore::Bool init=false)
	Make and define a mask. More...

casacore::Bool	makeMask (casacore::ImageInterface< casacore::Complex > &out, casacore::Bool init=false)

casacore::Stokes::StokesTypes	stokesType (const casacore::CoordinateSystem &cSys)
	What casacore::Stokes type? Exception if more than one. More...

Private Attributes
casacore::LogIO *	itsLog

ImagePolarimetry *	itsImPol

Detailed Description

Implementation of the image polarimetry functionality available from casapy.

Definition at line 49 of file ImagePolProxy.h.

Constructor & Destructor Documentation

casa::ImagePol::ImagePol ( )

"imagepol" constructors

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

virtual casa::ImagePol::~ImagePol ( )

virtual

Member Function Documentation

void casa::ImagePol::addNoise	(	casacore::Array< casacore::Float > &	slice,
		casacore::Normal &	noiseGen
	)

private

Add noise to Array.

void casa::ImagePol::centreRefPix	(	casacore::CoordinateSystem &	cSys,
		const casacore::IPosition &	shape
	)

private

Centre reference pixelin image.

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

casacore::Complex linear polarization

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

casacore::Complex linear polarization

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

casacore::Complex linear polarization image is stored in outfile

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

private

void casa::ImagePol::copyMiscellaneous	(	casacore::ImageInterface< casacore::Complex > &	out,
		const casacore::ImageInterface< casacore::Float > &	in
	)

private

Copy miscellaneous (MiscInfo, casacore::ImageInfo, history, units)

void casa::ImagePol::copyMiscellaneous	(	casacore::ImageInterface< casacore::Float > &	out,
		const casacore::ImageInterface< casacore::Float > &	in
	)

private

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

Depolarization ratio.

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

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

void casa::ImagePol::fiddleStokesCoordinate	(	casacore::ImageInterface< casacore::Float > &	ie,
		casacore::Stokes::StokesTypes	type
	)

private

void casa::ImagePol::fiddleStokesCoordinate	(	casacore::ImageInterface< casacore::Complex > &	ie,
		casacore::Stokes::StokesTypes	type
	)

private

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

private

Fill IQUV image with casacore::Stokes values from RM data.

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

Find Rotation casacore::Measure from Fourier method.

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

Fractional linearly polarized intensity.

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

Fractional total polarized intensity.

SPCIIF casa::ImagePol::getImage ( ) const

inline

Definition at line 164 of file ImagePolProxy.h.

References casa::ImagePolarimetry::imageInterface(), and itsImPol.

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

Make test image.

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

Make a complex image.

casacore::Bool casa::ImagePol::makeImage	(	casacore::ImageInterface< casacore::Complex > *&	out,
		const casacore::String &	outfile,
		const casacore::CoordinateSystem &	cSys,
		const casacore::IPosition &	shape,
		casacore::Bool	isMasked = `false`,
		casacore::Bool	tempAllowed = `true`
	)

private

Make a casacore::PagedImage or casacore::TempImage output.

casacore::Bool casa::ImagePol::makeImage	(	casacore::ImageInterface< casacore::Float > *&	out,
		const casacore::String &	outfile,
		const casacore::CoordinateSystem &	cSys,
		const casacore::IPosition &	shape,
		casacore::Bool	isMasked = `false`,
		casacore::Bool	tempAllowed = `true`
	)

private

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

private

Make an IQUV image with some dummy RM data.

casacore::Bool casa::ImagePol::makeMask	(	casacore::ImageInterface< casacore::Float > &	out,
		casacore::Bool	init = `false`
	)

private

Make and define a mask.

casacore::Bool casa::ImagePol::makeMask	(	casacore::ImageInterface< casacore::Complex > &	out,
		casacore::Bool	init = `false`
	)

private

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

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

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

Find Rotation casacore::Measure from traditional method.

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

sigma

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

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

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

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

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

Linearly polarized position angle.

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

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

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

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

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

Total polarized intensity.

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

casacore::Stokes I

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

casacore::Stokes Q

casacore::Stokes::StokesTypes casa::ImagePol::stokesType ( const casacore::CoordinateSystem & cSys )

private

What casacore::Stokes type? Exception if more than one.

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

casacore::Stokes U

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

casacore::Stokes V

void casa::ImagePol::summary ( ) const

Summary.

Member Data Documentation

ImagePolarimetry* casa::ImagePol::itsImPol

private

Definition at line 168 of file ImagePolProxy.h.

Referenced by getImage().

casacore::LogIO* casa::ImagePol::itsLog

private

Definition at line 167 of file ImagePolProxy.h.

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

casa/code/imageanalysis/ImageAnalysis/ImagePolProxy.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation