casa::StokesImageUtil Class Reference

#include <StokesImageUtil.h>

Public Types
enum	PolRep { CIRCULAR, LINEAR }
Static Public Member Functions
static void	MakeGaussianPSF (ImageInterface< Float > &psf, Vector< Float > &beam, Bool norm=False)
	Make a Gaussian PSF.
static void	MakeGaussianPSF (ImageInterface< Float > &psf, Quantity &bmaj, Quantity &bmin, Quantity &bpa, Bool norm=False)
static Bool	FitGaussianPSF (ImageInterface< Float > &psf, Vector< Float > &beam)
	Fit a Gaussian PSF.
static Bool	FitGaussianPSF (ImageInterface< Float > &psf, GaussianBeam &beam)
static Bool	FitGaussianPSF (ImageInterface< Float > &psf, ImageBeamSet &beam)
static void	locatePeakPSF (ImageInterface< Float > &psf, Int &xpos, Int &ypos, Float &amp, Matrix< Float > &psfplane)
	Locat peak of PSF return pos, peak and first plane that satisfies peak >0.9.
static void	Convolve (ImageInterface< Float > &image, ImageInterface< Float > &psf)
	Convolve a Stokes Image in place.
static void	Convolve (ImageInterface< Float > &image, Float bmaj, Float bmin, Float bpa, Bool normalizeVolume=False)
static void	Convolve (ImageInterface< Float > &image, GaussianBeam &beam, Bool normalizeVolume=False)
static void	Convolve (ImageInterface< Float > &image, ImageBeamSet &beams, Bool normalizeVolume=False)
static void	Zero (ImageInterface< Float > &image, Vector< Bool > &mask)
	Zero selected planes of a Stokes image.
static void	MaskFrom (ImageInterface< Float > &mask, ImageInterface< Float > &image, const Double threshhold)
	Mask mask iif(image > threshhold), where threshhold is in image's units.
static void	MaskFrom (ImageInterface< Float > &mask, ImageInterface< Float > &image, const Quantity &threshold)
	This version uses threshold.get("Jy").getValue().
static void	MaskOnStokesI (ImageInterface< Float > &image, const Quantity &threshold)
	Zero pixels where Stokes I < some value.
static void	BoxMask (ImageInterface< Float > &mask, const IPosition &blc, const IPosition &trc, const Float value)
	Make a box mask.
static void	Constrain (ImageInterface< Float > &image)
	Constrain a Stokes Image.
static void	From (ImageInterface< Complex > &out, const ImageInterface< Float > &in)
	Convert from Stokes Image to "correlation" image.
static void	To (ImageInterface< Float > &out, ImageInterface< Complex > &in)
	Convert to Stokes Image from "correlation" image.
static void	directCFromR (ImageInterface< Complex > &out, const ImageInterface< Float > &in)
	Direct copy from Float to Complex with.
static void	directCToR (ImageInterface< Float > &out, ImageInterface< Complex > &in)
	Direct copy To Float.
static void	ToStokesPSF (ImageInterface< Float > &out, ImageInterface< Complex > &in)
	Convert to Stokes PSF.
static void	ToStokesSumWt (Matrix< Float > sumwtStokes, Matrix< Float > sumwtCorr)
static Int	StokesPolMap (Vector< Int > &map, const CoordinateSystem &coord)
	Find the mapping from pixel on the Stokes Axis to I,Q,U,V.
static Int	CStokesPolMap (Vector< Int > &map, StokesImageUtil::PolRep &polframe, const CoordinateSystem &coord)
	Find the mapping from pixel on the Stokes Axis to either XX,XY,YX,YY of LL, LR, RL, RR.
static Bool	StokesMap (Vector< Int > &map, const CoordinateSystem &coord)
	Find all mappings from coordinate to axis number.
static CoordinateSystem	StokesCoordFromMS (const IPosition &shape, Vector< Double > &deltas, MeasurementSet &ms)
	Create a CoordinateSystem from a MeasurementSet and other info.
static CoordinateSystem	StokesCoordFromMS (const IPosition &shape, Vector< Double > &deltas, MeasurementSet &ms, Vector< Int > &whichStokes, Bool doCStokes=False, Int fieldID=0, Int SPWID=0, Int feedID=0)
	Create a CoordinateSystem from a MeasurementSet and other info.
static CoordinateSystem	CStokesCoord (const CoordinateSystem &coord, Vector< Int > &whichStokes, StokesImageUtil::PolRep polRep=StokesImageUtil::CIRCULAR)
	Create a CoordinateSystem.
static void	changeCStokesRep (ImageInterface< Complex > &image, StokesImageUtil::PolRep polRep)
	Change the stokes representation (but not the data!).
static void	changeLabelsStokesToCorrStokes (StokesCoordinate &stokesCoord, StokesImageUtil::PolRep polRep, Vector< Int > &whichStokes)
static Bool	standardImageCoordinates (const CoordinateSystem &coords)
	check to see if Image coordinates have the standard order: Direction, Stokes, Spectral.
static Bool	standardImageCoordinates (const ImageInterface< Complex > &image)
static Bool	standardImageCoordinates (const ImageInterface< Float > &image)

Detailed Description

Etymology

Synopsis

Example

Motivation

Definition at line 66 of file StokesImageUtil.h.

Member Enumeration Documentation

enum casa::StokesImageUtil::PolRep

Enumerator:

CIRCULAR
LINEAR

Definition at line 70 of file StokesImageUtil.h.

Member Function Documentation

static void casa::StokesImageUtil::BoxMask	(	ImageInterface< Float > &	mask,
		const IPosition &	blc,
		const IPosition &	trc,
		const Float	value
	)			`[static]`

Make a box mask.

static void casa::StokesImageUtil::changeCStokesRep	(	ImageInterface< Complex > &	image,
		StokesImageUtil::PolRep	polRep
	)			`[static]`

Change the stokes representation (but not the data!).

static void casa::StokesImageUtil::changeLabelsStokesToCorrStokes	(	StokesCoordinate &	stokesCoord,
		StokesImageUtil::PolRep	polRep,
		Vector< Int > &	whichStokes
	)			`[static]`

static void casa::StokesImageUtil::Constrain ( ImageInterface< Float > & image ) [static]

Constrain a Stokes Image.

static void casa::StokesImageUtil::Convolve	(	ImageInterface< Float > &	image,
		ImageBeamSet &	beams,
		Bool	normalizeVolume = `False`
	)			`[static]`

static void casa::StokesImageUtil::Convolve	(	ImageInterface< Float > &	image,
		GaussianBeam &	beam,
		Bool	normalizeVolume = `False`
	)			`[static]`

static void casa::StokesImageUtil::Convolve	(	ImageInterface< Float > &	image,
		Float	bmaj,
		Float	bmin,
		Float	bpa,
		Bool	normalizeVolume = `False`
	)			`[static]`

static void casa::StokesImageUtil::Convolve	(	ImageInterface< Float > &	image,
		ImageInterface< Float > &	psf
	)			`[static]`

Convolve a Stokes Image in place.

static CoordinateSystem casa::StokesImageUtil::CStokesCoord	(	const CoordinateSystem &	coord,
		Vector< Int > &	whichStokes,
		StokesImageUtil::PolRep	polRep = `StokesImageUtil::CIRCULAR`
	)			`[static]`

Create a CoordinateSystem.

static Int casa::StokesImageUtil::CStokesPolMap	(	Vector< Int > &	map,
		StokesImageUtil::PolRep &	polframe,
		const CoordinateSystem &	coord
	)			`[static]`

Find the mapping from pixel on the Stokes Axis to either XX,XY,YX,YY of LL, LR, RL, RR.

Return type as well: Linear:1, Circular 0

static void casa::StokesImageUtil::directCFromR	(	ImageInterface< Complex > &	out,
		const ImageInterface< Float > &	in
	)			`[static]`

Direct copy from Float to Complex with.

static void casa::StokesImageUtil::directCToR	(	ImageInterface< Float > &	out,
		ImageInterface< Complex > &	in
	)			`[static]`

Direct copy To Float.

.\.

static Bool casa::StokesImageUtil::FitGaussianPSF	(	ImageInterface< Float > &	psf,
		ImageBeamSet &	beam
	)			`[static]`

static Bool casa::StokesImageUtil::FitGaussianPSF	(	ImageInterface< Float > &	psf,
		GaussianBeam &	beam
	)			`[static]`

static Bool casa::StokesImageUtil::FitGaussianPSF	(	ImageInterface< Float > &	psf,
		Vector< Float > &	beam
	)			`[static]`

Fit a Gaussian PSF.

static void casa::StokesImageUtil::From	(	ImageInterface< Complex > &	out,
		const ImageInterface< Float > &	in
	)			`[static]`

Convert from Stokes Image to "correlation" image.

static void casa::StokesImageUtil::locatePeakPSF	(	ImageInterface< Float > &	psf,
		Int &	xpos,
		Int &	ypos,
		Float &	amp,
		Matrix< Float > &	psfplane
	)			`[static]`

Locat peak of PSF return pos, peak and first plane that satisfies peak >0.9.

static void casa::StokesImageUtil::MakeGaussianPSF	(	ImageInterface< Float > &	psf,
		Quantity &	bmaj,
		Quantity &	bmin,
		Quantity &	bpa,
		Bool	norm = `False`
	)			`[static]`

static void casa::StokesImageUtil::MakeGaussianPSF	(	ImageInterface< Float > &	psf,
		Vector< Float > &	beam,
		Bool	norm = `False`
	)			`[static]`

Make a Gaussian PSF.

static void casa::StokesImageUtil::MaskFrom	(	ImageInterface< Float > &	mask,
		ImageInterface< Float > &	image,
		const Quantity &	threshold
	)			`[static]`

This version uses threshold.get("Jy").getValue().

static void casa::StokesImageUtil::MaskFrom	(	ImageInterface< Float > &	mask,
		ImageInterface< Float > &	image,
		const Double	threshhold
	)			`[static]`

Mask mask iif(image > threshhold), where threshhold is in image's units.

static void casa::StokesImageUtil::MaskOnStokesI	(	ImageInterface< Float > &	image,
		const Quantity &	threshold
	)			`[static]`

Zero pixels where Stokes I < some value.

static Bool casa::StokesImageUtil::standardImageCoordinates ( const ImageInterface< Float > & image ) [static]

static Bool casa::StokesImageUtil::standardImageCoordinates ( const ImageInterface< Complex > & image ) [static]

static Bool casa::StokesImageUtil::standardImageCoordinates ( const CoordinateSystem & coords ) [static]

check to see if Image coordinates have the standard order: Direction, Stokes, Spectral.

Returns false if this is not the order, or if any are missing

static CoordinateSystem casa::StokesImageUtil::StokesCoordFromMS	(	const IPosition &	shape,
		Vector< Double > &	deltas,
		MeasurementSet &	ms,
		Vector< Int > &	whichStokes,
		Bool	doCStokes = `False`,
		Int	fieldID = `0`,
		Int	SPWID = `0`,
		Int	feedID = `0`
	)			`[static]`

Create a CoordinateSystem from a MeasurementSet and other info.

static CoordinateSystem casa::StokesImageUtil::StokesCoordFromMS	(	const IPosition &	shape,
		Vector< Double > &	deltas,
		MeasurementSet &	ms
	)			`[static]`

Create a CoordinateSystem from a MeasurementSet and other info.

static Bool casa::StokesImageUtil::StokesMap	(	Vector< Int > &	map,
		const CoordinateSystem &	coord
	)			`[static]`

Find all mappings from coordinate to axis number.

static Int casa::StokesImageUtil::StokesPolMap	(	Vector< Int > &	map,
		const CoordinateSystem &	coord
	)			`[static]`

Find the mapping from pixel on the Stokes Axis to I,Q,U,V.

static void casa::StokesImageUtil::To	(	ImageInterface< Float > &	out,
		ImageInterface< Complex > &	in
	)			`[static]`

Convert to Stokes Image from "correlation" image.

static void casa::StokesImageUtil::ToStokesPSF	(	ImageInterface< Float > &	out,
		ImageInterface< Complex > &	in
	)			`[static]`

Convert to Stokes PSF.

static void casa::StokesImageUtil::ToStokesSumWt	(	Matrix< Float >	sumwtStokes,
		Matrix< Float >	sumwtCorr
	)			`[static]`

static void casa::StokesImageUtil::Zero	(	ImageInterface< Float > &	image,
		Vector< Bool > &	mask
	)			`[static]`

Zero selected planes of a Stokes image.

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

code/synthesis/TransformMachines/StokesImageUtil.h