casa::SkyComponentFactory Class Reference

#include <SkyComponentFactory.h>

Public Types
typedef GaussianBeam	Angular2DGaussian
Static Public Member Functions
static SkyComponent	encodeSkyComponent (LogIO &os, Double &facToJy, const CoordinateSystem &cSys, const Unit &brightnessUnit, ComponentType::Shape type, const Vector< Double > &parameters, Stokes::StokesTypes stokes, Bool xIsLong, const GaussianBeam &beam)
	These functions convert between a vector of doubles holding SkyComponent values (the output from SkyComponent::toPixel) and a SkyComponent.
static SkyComponent	encodeSkyComponent (LogIO &os, Double &fluxRatio, const ImageInterface< Float > &im, casa::ComponentType::Shape modelType, const Vector< Double > &parameters, Stokes::StokesTypes stokes, Bool xIsLong, Bool deconvolveIt, const GaussianBeam &beam)
	for some reason, this method was in ImageAnalysis but also belongs here.
static SkyComponent	deconvolveSkyComponent (LogIO &os, const SkyComponent &skyIn, const GaussianBeam &beam)
	Deconvolve SkyComponent from beam moved from ImageAnalysis.
static Vector< Double >	decodeSkyComponent (const SkyComponent &sky, const ImageInfo &ii, const CoordinateSystem &cSys, const Unit &brightnessUnit, Stokes::StokesTypes stokes, Bool xIsLong)
	moved from ImageAnalysis.
static void	worldWidthsToPixel (Vector< Double > &dParameters, const Vector< Quantum< Double > > &parameters, const CoordinateSystem &cSys, const IPosition &pixelAxes, Bool doRef=False)
	Convert 2d shape from world (world parameters=x, y, major axis, minor axis, position angle) to pixel (major, minor, pa).
static Bool	pixelWidthsToWorld (GaussianBeam &wParameters, const Vector< Double > &pParameters, const CoordinateSystem &cSys, const IPosition &pixelAxes, Bool doRef=False)
	Convert 2d shape from pixels (parameters=x,y, major axis, minor axis, position angle) to world (major, minor, pa) at specified location.
Static Private Member Functions
static Bool	_skyPixelWidthsToWorld (Angular2DGaussian &gauss2d, const CoordinateSystem &cSys, const Vector< Double > &pParameters, const IPosition &pixelAxes, Bool doRef)
	Convert 2d sky shape (parameters=major axis, minor axis, position angle) from pixels to world at reference pixel.
static Double	_worldWidthToPixel (Double positionAngle, const Quantum< Double > &length, const CoordinateSystem &cSys, const IPosition &pixelAxes)
	Convert a length and position angle in world units (for a non-coupled coordinate) to pixels.
static Quantum< Double >	_pixelWidthToWorld (Double positionAngle, Double length, const CoordinateSystem &cSys, const IPosition &pixelAxes)

Detailed Description

Definition at line 41 of file SkyComponentFactory.h.

Member Typedef Documentation

typedef GaussianBeam casa::SkyComponentFactory::Angular2DGaussian

Definition at line 44 of file SkyComponentFactory.h.

Member Function Documentation

static Quantum<Double> casa::SkyComponentFactory::_pixelWidthToWorld	(	Double	positionAngle,
		Double	length,
		const CoordinateSystem &	cSys,
		const IPosition &	pixelAxes
	)			`[static, private]`

static Bool casa::SkyComponentFactory::_skyPixelWidthsToWorld	(	Angular2DGaussian &	gauss2d,
		const CoordinateSystem &	cSys,
		const Vector< Double > &	pParameters,
		const IPosition &	pixelAxes,
		Bool	doRef
	)			`[static, private]`

Convert 2d sky shape (parameters=major axis, minor axis, position angle) from pixels to world at reference pixel.

pixelAxes describes which 2 pixel axes of the coordinate system our 2D shape is in. On input pa is positive for +x -> +y in pixel frame On output pa is positive N->E Returns True if major/minor exchanged themselves on conversion to world.

static Double casa::SkyComponentFactory::_worldWidthToPixel	(	Double	positionAngle,
		const Quantum< Double > &	length,
		const CoordinateSystem &	cSys,
		const IPosition &	pixelAxes
	)			`[static, private]`

Convert a length and position angle in world units (for a non-coupled coordinate) to pixels.

The length is in some 2D plane in the CoordinateSystem specified by pixelAxes.

static Vector<Double> casa::SkyComponentFactory::decodeSkyComponent	(	const SkyComponent &	sky,
		const ImageInfo &	ii,
		const CoordinateSystem &	cSys,
		const Unit &	brightnessUnit,
		Stokes::StokesTypes	stokes,
		Bool	xIsLong
	)			`[static]`

moved from ImageAnalysis.

this needs to be moved to a more appropriate class at some point

static SkyComponent casa::SkyComponentFactory::deconvolveSkyComponent	(	LogIO &	os,
		const SkyComponent &	skyIn,
		const GaussianBeam &	beam
	)			`[static]`

Deconvolve SkyComponent from beam moved from ImageAnalysis.

this needs to be moved to a more appropriate class at some point

static SkyComponent casa::SkyComponentFactory::encodeSkyComponent	(	LogIO &	os,
		Double &	fluxRatio,
		const ImageInterface< Float > &	im,
		casa::ComponentType::Shape	modelType,
		const Vector< Double > &	parameters,
		Stokes::StokesTypes	stokes,
		Bool	xIsLong,
		Bool	deconvolveIt,
		const GaussianBeam &	beam
	)			`[static]`

for some reason, this method was in ImageAnalysis but also belongs here.

Obviously hugely confusing to have to methods with the same name and which presumably are for the same thing in two different classes. I'm moving ImageAnalysis' method here and also moving that implamentation to here as well and also being consistent regarding callers (ie those that called the ImageAnalysis method will now call this method). I couldn't tell you which of the two implementations is the better one to use for new code, but this version does call the version that already existed in ImageUtilities, so this version seems to do a bit more. I also hate having a class with anything like Utilities in the name, but I needed to move this somewhere and can only tackle one issue at a time.

static SkyComponent casa::SkyComponentFactory::encodeSkyComponent	(	LogIO &	os,
		Double &	facToJy,
		const CoordinateSystem &	cSys,
		const Unit &	brightnessUnit,
		ComponentType::Shape	type,
		const Vector< Double > &	parameters,
		Stokes::StokesTypes	stokes,
		Bool	xIsLong,
		const GaussianBeam &	beam
	)			`[static]`

These functions convert between a vector of doubles holding SkyComponent values (the output from SkyComponent::toPixel) and a SkyComponent.

The coordinate values are in the 'x' and 'y' frames. It is possible that the x and y axes of the pixel array are lat/long (xIsLong=False) rather than long/lat. facToJy converts the brightness units from whatevers per whatever to Jy per whatever (e.g. mJy/beam to Jy/beam). It is unity if it can't be done and you get a warning. In the SkyComponent the flux is integral. In the parameters vector it is peak.

pars(0) = FLux image units (e.g. Jy/beam). pars(1) = x cen abs pix pars(2) = y cen abs pix pars(3) = major pix pars(4) = minor pix pars(5) = pa radians (pos +x -> +y)

5 values for ComponentType::Gaussian, CT::Disk. 3 values for CT::Point.

static Bool casa::SkyComponentFactory::pixelWidthsToWorld	(	GaussianBeam &	wParameters,
		const Vector< Double > &	pParameters,
		const CoordinateSystem &	cSys,
		const IPosition &	pixelAxes,
		Bool	doRef = `False`
	)			`[static]`

Convert 2d shape from pixels (parameters=x,y, major axis, minor axis, position angle) to world (major, minor, pa) at specified location.

pixelAxes describes which 2 pixel axes of the coordinate system our 2D shape is in. If doRef is True, then x and y are taken from the reference pixel rather than the paraneters vector.

On input pa is positive for +x -> +y in pixel frame On output pa is positive N->E Returns True if major/minor exchanged themselves on conversion to world.

static void casa::SkyComponentFactory::worldWidthsToPixel	(	Vector< Double > &	dParameters,
		const Vector< Quantum< Double > > &	parameters,
		const CoordinateSystem &	cSys,
		const IPosition &	pixelAxes,
		Bool	doRef = `False`
	)			`[static]`

Convert 2d shape from world (world parameters=x, y, major axis, minor axis, position angle) to pixel (major, minor, pa).

Can handle quantum units 'pix'. If one width is in pixel units both must be in pixel units. pixelAxes describes which 2 pixel axes of the coordinate system our 2D shape is in. If axes are not from the same coordinate type units must be pixels. If doRef is True, then x and y are taken from the reference value rather than the parameters vector.

On input, pa is N->E (at ref pix) for celestial planes. Otherwise pa is in pixel coordinate system +x -> +y On output, pa (radians) is positive +x -> +y in pixel frame

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

code/components/ComponentModels/SkyComponentFactory.h

casa::SkyComponentFactory Class Reference

Public Types

Static Public Member Functions

Static Private Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation