casacore::FITSErrorImage Class Reference

Class providing native access to FITS Error images. More...

#include <FITSErrorImage.h>

Inheritance diagram for casacore::FITSErrorImage:

List of all members.

Public Types
enum	ErrorType {   MSE,   RMSE,   INVMSE,   INVRMSE,   UNKNOWN,   DEFAULT }
	The enum describes which types of error images exist. More...
Public Member Functions
	FITSErrorImage (const String &name, uInt whichRep=0, uInt whichHDU=0, FITSErrorImage::ErrorType errtype=MSE)
	Construct a FITSImage from the disk FITS file name and extension and apply mask.
	FITSErrorImage (const String &name, const MaskSpecifier &mask, uInt whichRep=0, uInt whichHDU=0, FITSErrorImage::ErrorType errtype=MSE)
	Construct a FITSImage from the disk FITS file name and extension and apply mask or not.
	FITSErrorImage (const FITSErrorImage &other)
	Copy constructor (reference semantics).
virtual	~FITSErrorImage ()
	Destructor.
FITSErrorImage &	operator= (const FITSErrorImage &other)
	Assignment (reference semantics).
virtual ImageInterface< Float > *	cloneII () const
	Make a copy of the object with new (reference semantics).
virtual String	imageType () const
	Get the image type (returns "FITSErrorImage").
virtual Bool	doGetSlice (Array< Float > &buffer, const Slicer &theSlice)
	Do the actual get of the data.
virtual void	doPutSlice (const Array< Float > &sourceBuffer, const IPosition &where, const IPosition &stride)
	The FITSImage is not writable, so this throws an exception.
virtual FITSErrorImage::ErrorType	errorType () const
	Return the error type.
Static Public Member Functions
static FITSErrorImage::ErrorType	stringToErrorType (String errorTypeStr)
	Convert an image type to String.
static String	errorTypeToString (FITSErrorImage::ErrorType errType)
	Convert a String to an image type.
Private Member Functions
void	setupMask ()
	Set the correct masking.
Private Attributes
Array< Float >	buffer_p
FITSErrorImage::ErrorType	errtype_p

---

Detailed Description

Class providing native access to FITS Error images.

Intended use:

Public interface

Review Status

Test programs:

tFITSErrorImage

Prerequisite

• FITSImage
• FITSMask

Etymology

Synopsis

Example

Motivation

This provides native access to FITS error images.

Definition at line 79 of file FITSErrorImage.h.

---

Member Enumeration Documentation

enum casacore::FITSErrorImage::ErrorType

The enum describes which types of error images exist.

The type is fixed during object creation and can not be changed at a later time.

Enumerator:

MSE
RMSE
INVMSE
INVRMSE
UNKNOWN
DEFAULT

Definition at line 85 of file FITSErrorImage.h.

---

Constructor & Destructor Documentation

casacore::FITSErrorImage::FITSErrorImage	(	const String &	name,
		uInt	whichRep = 0,
		uInt	whichHDU = 0,
		FITSErrorImage::ErrorType	errtype = MSE
	)			[explicit]

Construct a FITSImage from the disk FITS file name and extension and apply mask.

casacore::FITSErrorImage::FITSErrorImage	(	const String &	name,
		const MaskSpecifier &	mask,
		uInt	whichRep = 0,
		uInt	whichHDU = 0,
		FITSErrorImage::ErrorType	errtype = MSE
	)

Construct a FITSImage from the disk FITS file name and extension and apply mask or not.

casacore::FITSErrorImage::FITSErrorImage

(

const FITSErrorImage &

other

)

Copy constructor (reference semantics).

virtual casacore::FITSErrorImage::~FITSErrorImage

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual ImageInterface<Float>* casacore::FITSErrorImage::cloneII

(

)

const [virtual]

Make a copy of the object with new (reference semantics).

Reimplemented from casacore::FITSImage.

virtual Bool casacore::FITSErrorImage::doGetSlice	(	Array< Float > &	buffer,
		const Slicer &	theSlice
	)			[virtual]

Do the actual get of the data.

Returns False as the data do not reference another Array

Reimplemented from casacore::FITSImage.

virtual void casacore::FITSErrorImage::doPutSlice	(	const Array< Float > &	sourceBuffer,
		const IPosition &	where,
		const IPosition &	stride
	)			[virtual]

The FITSImage is not writable, so this throws an exception.

Reimplemented from casacore::FITSImage.

virtual FITSErrorImage::ErrorType casacore::FITSErrorImage::errorType

(

)

const [inline, virtual]

Return the error type.

Definition at line 126 of file FITSErrorImage.h.

References errtype_p.

static String casacore::FITSErrorImage::errorTypeToString

(

FITSErrorImage::ErrorType

errType

)

[static]

Convert a String to an image type.

virtual String casacore::FITSErrorImage::imageType

(

)

const [virtual]

Get the image type (returns "FITSErrorImage").

Reimplemented from casacore::FITSImage.

FITSErrorImage& casacore::FITSErrorImage::operator=

(

const FITSErrorImage &

other

)

Assignment (reference semantics).

Reimplemented from casacore::FITSImage.

void casacore::FITSErrorImage::setupMask

(

)

[private]

Set the correct masking.

static FITSErrorImage::ErrorType casacore::FITSErrorImage::stringToErrorType

(

String

errorTypeStr

)

[static]

Convert an image type to String.

---

Member Data Documentation

Array<Float> casacore::FITSErrorImage::buffer_p [private]

Definition at line 140 of file FITSErrorImage.h.

FITSErrorImage::ErrorType casacore::FITSErrorImage::errtype_p [private]

Definition at line 141 of file FITSErrorImage.h.

Referenced by errorType().

---

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

• casacore/images/Images/FITSErrorImage.h