#include <FITSImage.h>

Public Member Functions
	FITSImage (const String &name, uInt whichRep=0, uInt whichHDU=0)
	Construct a FITSImage from the disk FITS file name and extension and apply mask. More...

	FITSImage (const String &name, const MaskSpecifier &mask, uInt whichRep=0, uInt whichHDU=0)
	Construct a FITSImage from the disk FITS file name and extension and apply mask or not. More...

	FITSImage (const FITSImage &other)
	Copy constructor (reference semantics) More...

virtual	~FITSImage ()
	Destructor does nothing. More...

FITSImage &	operator= (const FITSImage &other)
	Assignment (reference semantics) More...

virtual ImageInterface< Float > *	cloneII () const
	Make a copy of the object with new (reference semantics). More...

virtual String	imageType () const
	Get the image type (returns FITSImage). More...

virtual void	resize (const TiledShape &newShape)
	Function which changes the shape of the FITSImage. More...

virtual Bool	isMasked () const
	Has the object really a mask? The FITSImage always has a pixel mask and never has a region mask so this always returns True. More...

virtual Bool	hasPixelMask () const
	FITSimage always has a pixel mask so returns True. More...

virtual const Lattice< Bool > &	pixelMask () const
	Get access to the pixelmask. More...

virtual Lattice< Bool > &	pixelMask ()

virtual Bool	doGetMaskSlice (Array< Bool > &buffer, const Slicer &section)
	Do the actual get of the mask data. More...

virtual const LatticeRegion *	getRegionPtr () const
	Get the region used. More...

virtual Bool	doGetSlice (Array< Float > &buffer, const Slicer &theSlice)
	Do the actual get of the data. More...

virtual void	doPutSlice (const Array< Float > &sourceBuffer, const IPosition &where, const IPosition &stride)
	The FITSImage is not writable, so this throws an exception. More...

virtual Bool	isPaged () const
	The lattice is paged to disk. More...

virtual Bool	isPersistent () const
	The lattice is persistent. More...

virtual Bool	isWritable () const
	The FITSImage is not writable. More...

virtual String	name (Bool stripPath=False) const
	Returns the name of the disk file. More...

virtual IPosition	shape () const
	return the shape of the FITSImage More...

virtual uInt	advisedMaxPixels () const
	Returns the maximum recommended number of pixels for a cursor. More...

virtual IPosition	doNiceCursorShape (uInt maxPixels) const
	Help the user pick a cursor for most efficient access if they only want pixel values and don't care about the order or dimension of the cursor. More...

virtual void	tempClose ()
	Temporarily close the image. More...

virtual void	reopen ()
	Reopen a temporarily closed image. More...

virtual Bool	ok () const
	Check class invariants. More...

virtual DataType	dataType () const
	Return the data type (TpFloat). More...

DataType	internalDataType () const
	Return the (internal) data type. More...

uInt	whichHDU () const
	Return the HDU number. More...

virtual uInt	maximumCacheSize () const
	Maximum size - not necessarily all used. More...

virtual void	setMaximumCacheSize (uInt howManyPixels)
	Set the maximum (allowed) cache size as indicated. More...

virtual void	setCacheSizeFromPath (const IPosition &sliceShape, const IPosition &windowStart, const IPosition &windowLength, const IPosition &axisPath)
	Set the cache size as to "fit" the indicated path. More...

virtual void	setCacheSizeInTiles (uInt howManyTiles)
	Set the actual cache size for this Array to be be big enough for the indicated number of tiles. More...

virtual void	clearCache ()
	Clears and frees up the caches, but the maximum allowed cache size is unchanged from when setCacheSize was called. More...

virtual void	showCacheStatistics (ostream &os) const
	Report on cache success. More...

Public Member Functions inherited from casacore::ImageInterface< Float >
	ImageInterface ()

	ImageInterface (const RegionHandler &regionHandler)
	Construct for a specific region handler object. More...

	ImageInterface (const ImageInterface &other)
	Copy constructor (copy semantics). More...

virtual	~ImageInterface ()

virtual MaskedLattice< Float > *	cloneML () const
	Make a copy of the derived object (reference semantics). More...

virtual Bool	setUnits (const Unit &newUnits)
	Function which get and set the units associated with the image pixels (i.e. More...

virtual const Unit &	units () const

virtual Bool	setCoordinateInfo (const CoordinateSystem &coords)
	Functions to set or replace the coordinate information in the Image Returns False on failure, e.g. More...

const CoordinateSystem &	coordinates () const

virtual LELCoordinates	lelCoordinates () const
	Function to get a LELCoordinate object containing the coordinates. More...

LoggerHolder &	logger ()
	Get access to the LoggerHolder. More...

const LoggerHolder &	logger () const

LogIO &	logSink ()
	Allow messages to be logged to this ImageInterface. More...

const LogIO &	logSink () const

void	appendLog (const LoggerHolder &other)
	Add the messages from the other image logger to this one. More...

const TableRecord &	miscInfo () const
	Often we have miscellaneous information we want to attach to an image. More...

virtual Bool	setMiscInfo (const RecordInterface &newInfo)

const ImageInfo &	imageInfo () const
	The ImageInfo object contains some miscellaneous information about the image which unlike that stored in MiscInfo, has a standard list of things, such as the restoring beam. More...

ImageInfo &	rwImageInfo ()
	Get non-const access to the ImageInfo. More...

virtual Bool	setImageInfo (const ImageInfo &info)

virtual ImageAttrHandler &	attrHandler (Bool createHandler=False)
	Get access to the attribute handler. More...

ImageAttrHandler &	roAttrHandler () const

Bool	canDefineRegion () const
	Can the image handle region definition? More...

virtual ImageRegion	makeMask (const String &name, Bool defineAsRegion=True, Bool setAsDefaultMask=True, Bool initialize=False, Bool value=True)
	Make a mask which is suitable for the type of image. More...

virtual void	defineRegion (const String &name, const ImageRegion &region, RegionHandler::GroupType, Bool overwrite=False)
	Define a region/mask belonging to the image. More...

virtual Bool	hasRegion (const String &regionName, RegionHandler::GroupType=RegionHandler::Any) const
	Does the image have a region with the given name? More...

virtual ImageRegion *	getImageRegionPtr (const String &name, RegionHandler::GroupType=RegionHandler::Any, Bool throwIfUnknown=True) const
	Get a region/mask belonging to the image from the given group (which can be Any). More...

virtual void	renameRegion (const String &newName, const String &oldName, RegionHandler::GroupType=RegionHandler::Any, Bool overwrite=False)
	Rename a region. More...

virtual void	removeRegion (const String &name, RegionHandler::GroupType=RegionHandler::Any, Bool throwIfUnknown=True)
	Remove a region/mask belonging to the image from the given group (which can be Any). More...

virtual Vector< String >	regionNames (RegionHandler::GroupType=RegionHandler::Any) const
	Get the names of all regions/masks. More...

virtual void	useMask (MaskSpecifier=MaskSpecifier())
	Use the mask as specified. More...

virtual void	setDefaultMask (const String &regionName)
	Set the default pixelmask to the mask with the given name (which has to exist in the "masks" group). More...

virtual String	getDefaultMask () const
	Get the name of the default pixelmask. More...

ImageRegion	getRegion (const String &regionName, RegionHandler::GroupType=RegionHandler::Any) const
	Get a region belonging to the image. More...

String	makeUniqueRegionName (const String &rootName, uInt startNumber=1) const
	Make a unique region name from the given root name, thus make it such that the name is not already in use for a region or mask. More...

Bool	toRecord (String &error, RecordInterface &outRec)
	Save and restore an ImageInterface object to or from a state Record. More...

Bool	fromRecord (String &error, const RecordInterface &inRec)

Public Member Functions inherited from casacore::MaskedLattice< T >
	MaskedLattice ()
	Default constructor. More...

	MaskedLattice (const MaskedLattice< T > &)
	Copy constructor. More...

virtual	~MaskedLattice ()
	a virtual destructor is needed so that it will use the actual destructor in the derived class More...

virtual Lattice< T > *	clone () const
	Make a copy of the derived object (reference semantics). More...

const LatticeRegion &	region () const
	Get the region used. More...

Bool	getMask (COWPtr< Array< Bool > > &buffer, Bool removeDegenerateAxes=False) const
	Get the mask or a slice from the mask. More...

Bool	getMaskSlice (COWPtr< Array< Bool > > &buffer, const Slicer &section, Bool removeDegenerateAxes=False) const

Bool	getMaskSlice (COWPtr< Array< Bool > > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const

Bool	getMaskSlice (COWPtr< Array< Bool > > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const

Bool	getMask (Array< Bool > &buffer, Bool removeDegenerateAxes=False)

Bool	getMaskSlice (Array< Bool > &buffer, const Slicer &section, Bool removeDegenerateAxes=False)

Bool	getMaskSlice (Array< Bool > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False)

Bool	getMaskSlice (Array< Bool > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False)

Array< Bool >	getMask (Bool removeDegenerateAxes=False) const

Array< Bool >	getMaskSlice (const Slicer &section, Bool removeDegenerateAxes=False) const

Array< Bool >	getMaskSlice (const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const

Array< Bool >	getMaskSlice (const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const

Public Member Functions inherited from casacore::Lattice< T >
virtual	~Lattice ()
	a virtual destructor is needed so that it will use the actual destructor in the derived class More...

T	operator() (const IPosition &where) const
	Return the value of the single element located at the argument IPosition. More...

virtual T	getAt (const IPosition &where) const

virtual void	putAt (const T &value, const IPosition &where)
	Put the value of a single element. More...

Bool	get (COWPtr< Array< T > > &buffer, Bool removeDegenerateAxes=False) const
	Functions which extract an Array of values from a Lattice. More...

Bool	getSlice (COWPtr< Array< T > > &buffer, const Slicer &section, Bool removeDegenerateAxes=False) const

Bool	getSlice (COWPtr< Array< T > > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const

Bool	getSlice (COWPtr< Array< T > > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const

Bool	get (Array< T > &buffer, Bool removeDegenerateAxes=False)

Bool	getSlice (Array< T > &buffer, const Slicer &section, Bool removeDegenerateAxes=False)

Bool	getSlice (Array< T > &buffer, const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False)

Bool	getSlice (Array< T > &buffer, const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False)

Array< T >	get (Bool removeDegenerateAxes=False) const

Array< T >	getSlice (const Slicer &section, Bool removeDegenerateAxes=False) const

Array< T >	getSlice (const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const

Array< T >	getSlice (const IPosition &start, const IPosition &shape, const IPosition &stride, Bool removeDegenerateAxes=False) const

void	putSlice (const Array< T > &sourceBuffer, const IPosition &where, const IPosition &stride)
	A function which places an Array of values within this instance of the Lattice at the location specified by the IPosition "where", incrementing by "stride". More...

void	putSlice (const Array< T > &sourceBuffer, const IPosition &where)

void	put (const Array< T > &sourceBuffer)

virtual void	set (const T &value)
	Set all elements in the Lattice to the given value. More...

virtual void	apply (T(*function)(T))
	Replace every element, x, of the Lattice with the result of f(x). More...

virtual void	apply (T(*function)(const T &))

virtual void	apply (const Functional< T, T > &function)

void	operator+= (const Lattice< T > &other)
	Add, subtract, multiple, or divide by another Lattice. More...

void	operator-= (const Lattice< T > &other)

void	operator*= (const Lattice< T > &other)

void	operator/= (const Lattice< T > &other)

virtual void	copyData (const Lattice< T > &from)
	Copy the data from the given lattice to this one. More...

virtual void	copyDataTo (Lattice< T > &to) const
	Copy the data from this lattice to the given lattice. More...

virtual LatticeIterInterface< T > *	makeIter (const LatticeNavigator &navigator, Bool useRef) const
	These functions are used by the LatticeIterator class to generate an iterator of the correct type for a specified Lattice. More...

virtual Bool	doGetSlice (Array< T > &buffer, const Slicer &section)=0
	The functions (in the derived classes) doing the actual work. More...

virtual void	doPutSlice (const Array< T > &buffer, const IPosition &where, const IPosition &stride)=0

Public Member Functions inherited from casacore::LatticeBase
virtual	~LatticeBase ()
	A virtual destructor is needed so that it will use the actual destructor in the derived class. More...

virtual Bool	canReferenceArray () const
	Can the lattice data be referenced as an array section? That is the case for an ArrayLattice or a Temp/SubLattice using it. More...

virtual void	save (const String &fileName) const
	Save the image in an AipsIO file with the given name. More...

virtual Bool	lock (FileLocker::LockType, uInt nattempts)
	It is strongly recommended to use class LatticeLocker to handle lattice locking. More...

virtual void	unlock ()

virtual Bool	hasLock (FileLocker::LockType) const

virtual void	resync ()
	Resynchronize the Lattice object with the lattice file. More...

virtual void	flush ()
	Flush the data (but do not unlock). More...

virtual uInt	ndim () const
	Return the number of axes in this Lattice. More...

virtual size_t	nelements () const
	Return the total number of elements in this Lattice. More...

size_t	size () const

Bool	conform (const LatticeBase &other) const
	Return a value of "True" if this instance of Lattice and 'other' have the same shape, otherwise returns a value of "False". More...

IPosition	niceCursorShape (uInt maxPixels) const
	Returns a recommended cursor shape for iterating through all the pixels in the Lattice. More...

IPosition	niceCursorShape () const

Static Public Member Functions
static LatticeBase *	openFITSImage (const String &name, const MaskSpecifier &)
	Function to open a FITS image (new parser) More...

static void	registerOpenFunction ()
	Register the open function. More...

static String	get_fitsname (const String &fullname)
	Separate any extension specification and return the pure fitsname. More...

static uInt	get_hdunum (const String &fullname)
	Get the extension index for any extension specification given in the full name. More...

static String	className ()
	returns "FITSImage". More...

Protected Member Functions
void	setMaskZero (Bool filterZero)
	Set the masking of values 0.0. More...

Protected Member Functions inherited from casacore::ImageInterface< Float >
ImageInterface &	operator= (const ImageInterface &other)
	Assignment (copy semantics) is only useful for derived classes. More...

Bool	restoreImageInfo (const RecordInterface &rec)
	Restore the image info from the record. More...

void	setLogMember (const LoggerHolder &logger)
	Set the image logger variable. More...

void	setImageInfoMember (const ImageInfo &imageInfo)
	Set the image info variable. More...

void	setCoordsMember (const CoordinateSystem &coords)
	Set the coordinate system variable. More...

void	setUnitMember (const Unit &unit)
	Set the unit variable. More...

void	setMiscInfoMember (const RecordInterface &rec)
	Set the miscinfo variable. More...

RegionHandler *	getRegionHandler ()
	Get access to the region handler. More...

Protected Member Functions inherited from casacore::MaskedLattice< T >
MaskedLattice< T > &	operator= (const MaskedLattice< T > &)
	Assignment can only be used by derived classes. More...

Protected Member Functions inherited from casacore::Lattice< T >
	Lattice ()
	Define default constructor to satisfy compiler. More...

virtual void	handleMath (const Lattice< T > &from, int oper)
	Handle the Math operators (+=, -=, *=, /=). More...

virtual void	handleMathTo (Lattice< T > &to, int oper) const

	Lattice (const Lattice< T > &)
	Copy constructor and assignment can only be used by derived classes. More...

Lattice< T > &	operator= (const Lattice< T > &)

void	handleMathTo (Lattice< Bool > &, int) const

Protected Member Functions inherited from casacore::LatticeBase
	LatticeBase ()
	Define default constructor to be used by derived classes. More...

	LatticeBase (const LatticeBase &)
	Copy constructor and assignment can only be used by derived classes. More...

LatticeBase &	operator= (const LatticeBase &)

void	throwBoolMath () const
	Throw an exception for arithmetic on a Bool Lattice. More...

Private Member Functions
void	reopenIfNeeded () const
	Reopen the image if needed. More...

void	setup ()
	Setup the object (used by constructors). More...

void	open ()
	Open the image (used by setup and reopen). More...

void	getImageAttributes (CoordinateSystem &cSys, IPosition &shape, ImageInfo &info, Unit &brightnessUnit, RecordInterface &miscInfo, Int &recsize, Int &recno, FITS::ValueType &dataType, Float &scale, Float &offset, uChar &uCharMagic, Short &shortMagic, Int &longMagic, Bool &hasBlanks, const String &name, uInt whichRep, uInt whichHDU)
	Fish things out of the FITS file. More...

template<typename T >
void	crackHeader (CoordinateSystem &cSys, IPosition &shape, ImageInfo &imageInfo, Unit &brightnessUnit, RecordInterface &miscInfo, Float &scale, Float &offset, uChar &magicUChar, Short &magicShort, Int &magicLong, Bool &hasBlanks, LogIO &os, FitsInput &infile, uInt whichRep)
	Crack a primary header. More...

template<typename T >
void	crackExtHeader (CoordinateSystem &cSys, IPosition &shape, ImageInfo &imageInfo, Unit &brightnessUnit, RecordInterface &miscInfo, Float &scale, Float &offset, uChar &uCharMagic, Short &magicShort, Int &magicLong, Bool &hasBlanks, LogIO &os, FitsInput &infile, uInt whichRep)
	Crack an image extension header. More...

Private Attributes
String	name_p

String	fullname_p

MaskSpecifier	maskSpec_p

CountedPtr< TiledFileAccess >	pTiledFile_p

Lattice< Bool > *	pPixelMask_p

TiledShape	shape_p

Float	scale_p

Float	offset_p

Short	shortMagic_p

uChar	uCharMagic_p

Int	longMagic_p

Bool	hasBlanks_p

DataType	dataType_p

Int64	fileOffset_p

Bool	isClosed_p

Bool	filterZeroMask_p

uInt	whichRep_p

uInt	whichHDU_p

Bool	_hasBeamsTable

Detailed Description

Class providing native access to FITS images.

Intended use:

Public interface

Review Status

Test programs:: tFITSImage

Prerequisite

Etymology

This class provides native access to FITS images. 64bit, 32bit floating point, 32 bit and 16bit integer FITS images are presently supported.

Synopsis

A FITSImage provides native access to FITS images by accessing them with the TiledFileAccess class. The FITSImage is read only. We could implement a writable FITSImage but putting the mask would lose data values (uses magic blanking) and FITS is really meant as an interchange medium, not an internal format.

Because FITS uses magic value blanking, the mask is generated on the fly as needed.

Example

FITSImage im("in.fits"); 
LogIO logger(or);
ImageStatistics<Float> stats(im, logger);
Bool ok = stats.display();                              // Display statistics

Motivation

This provides native access to FITS images.

Definition at line 108 of file FITSImage.h.

Constructor & Destructor Documentation

◆ FITSImage() [1/3]

casacore::FITSImage::FITSImage	(	const String &	name,
		uInt	whichRep = `0`,
		uInt	whichHDU = `0`
	)

explicit

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

◆ FITSImage() [2/3]

casacore::FITSImage::FITSImage	(	const String &	name,
		const MaskSpecifier &	mask,
		uInt	whichRep = `0`,
		uInt	whichHDU = `0`
	)

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

◆ FITSImage() [3/3]

casacore::FITSImage::FITSImage ( const FITSImage & other )

Copy constructor (reference semantics)

◆ ~FITSImage()

virtual casacore::FITSImage::~FITSImage ( )

virtual

Destructor does nothing.

Member Function Documentation

◆ advisedMaxPixels()

virtual uInt casacore::FITSImage::advisedMaxPixels ( ) const

virtual

Returns the maximum recommended number of pixels for a cursor.

This is the number of pixels in a tile.

Reimplemented from casacore::Lattice< T >.

◆ className()

static String casacore::FITSImage::className ( )

static

returns "FITSImage".

Added so callers don't require an object to get the image type.

◆ clearCache()

virtual void casacore::FITSImage::clearCache ( )

virtual

Clears and frees up the caches, but the maximum allowed cache size is unchanged from when setCacheSize was called.

Reimplemented from casacore::LatticeBase.

◆ cloneII()

virtual ImageInterface<Float>* casacore::FITSImage::cloneII ( ) const

virtual

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

Implements casacore::ImageInterface< Float >.

Reimplemented in casacore::FITSErrorImage.

◆ crackExtHeader()

template<typename T >

void casacore::FITSImage::crackExtHeader	(	CoordinateSystem &	cSys,
		IPosition &	shape,
		ImageInfo &	imageInfo,
		Unit &	brightnessUnit,
		RecordInterface &	miscInfo,
		Float &	scale,
		Float &	offset,
		uChar &	uCharMagic,
		Short &	magicShort,
		Int &	magicLong,
		Bool &	hasBlanks,
		LogIO &	os,
		FitsInput &	infile,
		uInt	whichRep
	)

private

Crack an image extension header.

◆ crackHeader()

template<typename T >

void casacore::FITSImage::crackHeader	(	CoordinateSystem &	cSys,
		IPosition &	shape,
		ImageInfo &	imageInfo,
		Unit &	brightnessUnit,
		RecordInterface &	miscInfo,
		Float &	scale,
		Float &	offset,
		uChar &	magicUChar,
		Short &	magicShort,
		Int &	magicLong,
		Bool &	hasBlanks,
		LogIO &	os,
		FitsInput &	infile,
		uInt	whichRep
	)

private

Crack a primary header.

◆ dataType()

virtual DataType casacore::FITSImage::dataType ( ) const

virtual

Return the data type (TpFloat).

Reimplemented from casacore::Lattice< T >.

◆ doGetMaskSlice()

virtual Bool casacore::FITSImage::doGetMaskSlice	(	Array< Bool > &	buffer,
		const Slicer &	section
	)

virtual

Do the actual get of the mask data.

The return value is always False, thus the buffer does not reference another array.

Reimplemented from casacore::MaskedLattice< T >.

◆ doGetSlice()

virtual Bool casacore::FITSImage::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 in casacore::FITSErrorImage.

◆ doNiceCursorShape()

virtual IPosition casacore::FITSImage::doNiceCursorShape ( uInt maxPixels ) const

virtual

Help the user pick a cursor for most efficient access if they only want pixel values and don't care about the order or dimension of the cursor.

Reimplemented from casacore::LatticeBase.

◆ doPutSlice()

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

virtual

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

Reimplemented in casacore::FITSErrorImage.

◆ get_fitsname()

static String casacore::FITSImage::get_fitsname ( const String & fullname )

static

Separate any extension specification and return the pure fitsname.

◆ get_hdunum()

static uInt casacore::FITSImage::get_hdunum ( const String & fullname )

static

Get the extension index for any extension specification given in the full name.

◆ getImageAttributes()

void casacore::FITSImage::getImageAttributes	(	CoordinateSystem &	cSys,
		IPosition &	shape,
		ImageInfo &	info,
		Unit &	brightnessUnit,
		RecordInterface &	miscInfo,
		Int &	recsize,
		Int &	recno,
		FITS::ValueType &	dataType,
		Float &	scale,
		Float &	offset,
		uChar &	uCharMagic,
		Short &	shortMagic,
		Int &	longMagic,
		Bool &	hasBlanks,
		const String &	name,
		uInt	whichRep,
		uInt	whichHDU
	)

private

Fish things out of the FITS file.

◆ getRegionPtr()

virtual const LatticeRegion* casacore::FITSImage::getRegionPtr ( ) const

virtual

Get the region used.

There is no region. Always returns 0.

Implements casacore::MaskedLattice< T >.

◆ hasPixelMask()

virtual Bool casacore::FITSImage::hasPixelMask ( ) const

virtual

FITSimage always has a pixel mask so returns True.

Reimplemented from casacore::MaskedLattice< T >.

◆ imageType()

virtual String casacore::FITSImage::imageType ( ) const

virtual

Get the image type (returns FITSImage).

Implements casacore::ImageInterface< Float >.

Reimplemented in casacore::FITSErrorImage.

◆ internalDataType()

DataType casacore::FITSImage::internalDataType ( ) const

inline

Return the (internal) data type.

Definition at line 230 of file FITSImage.h.

References dataType_p.

◆ isMasked()

virtual Bool casacore::FITSImage::isMasked ( ) const

virtual

Has the object really a mask? The FITSImage always has a pixel mask and never has a region mask so this always returns True.

Reimplemented from casacore::MaskedLattice< T >.

◆ isPaged()

virtual Bool casacore::FITSImage::isPaged ( ) const

virtual

The lattice is paged to disk.

Reimplemented from casacore::LatticeBase.

◆ isPersistent()

virtual Bool casacore::FITSImage::isPersistent ( ) const

virtual

The lattice is persistent.

Reimplemented from casacore::LatticeBase.

◆ isWritable()

virtual Bool casacore::FITSImage::isWritable ( ) const

virtual

The FITSImage is not writable.

Reimplemented from casacore::LatticeBase.

◆ maximumCacheSize()

virtual uInt casacore::FITSImage::maximumCacheSize ( ) const

virtual

Maximum size - not necessarily all used.

In pixels.

Reimplemented from casacore::LatticeBase.

◆ name()

virtual String casacore::FITSImage::name ( Bool stripPath = False ) const

virtual

Returns the name of the disk file.

Implements casacore::ImageInterface< Float >.

◆ ok()

virtual Bool casacore::FITSImage::ok ( ) const

virtual

Check class invariants.

Implements casacore::ImageInterface< Float >.

◆ open()

void casacore::FITSImage::open ( )

private

Open the image (used by setup and reopen).

◆ openFITSImage()

static LatticeBase* casacore::FITSImage::openFITSImage	(	const String &	name,
		const MaskSpecifier &
	)

static

Function to open a FITS image (new parser)

◆ operator=()

FITSImage& casacore::FITSImage::operator= ( const FITSImage & other )

Assignment (reference semantics)

◆ pixelMask() [1/2]

virtual Lattice<Bool>& casacore::FITSImage::pixelMask ( )

virtual

Reimplemented from casacore::MaskedLattice< T >.

◆ pixelMask() [2/2]

virtual const Lattice<Bool>& casacore::FITSImage::pixelMask ( ) const

virtual

Get access to the pixelmask.

FITSImage always has a pixel mask.

Reimplemented from casacore::MaskedLattice< T >.

◆ registerOpenFunction()

static void casacore::FITSImage::registerOpenFunction ( )

static

Register the open function.

◆ reopen()

virtual void casacore::FITSImage::reopen ( )

virtual

Reopen a temporarily closed image.

Reimplemented from casacore::LatticeBase.

Referenced by reopenIfNeeded().

◆ reopenIfNeeded()

void casacore::FITSImage::reopenIfNeeded ( ) const

inlineprivate

Reopen the image if needed.

Definition at line 289 of file FITSImage.h.

References isClosed_p, and reopen().

◆ resize()

virtual void casacore::FITSImage::resize ( const TiledShape & newShape )

virtual

Function which changes the shape of the FITSImage.

Throws an exception as FITSImage is not writable.

Implements casacore::ImageInterface< Float >.

◆ setCacheSizeFromPath()

virtual void casacore::FITSImage::setCacheSizeFromPath	(	const IPosition &	sliceShape,
		const IPosition &	windowStart,
		const IPosition &	windowLength,
		const IPosition &	axisPath
	)

virtual

Set the cache size as to "fit" the indicated path.

Reimplemented from casacore::LatticeBase.

◆ setCacheSizeInTiles()

virtual void casacore::FITSImage::setCacheSizeInTiles ( uInt howManyTiles )

virtual

Set the actual cache size for this Array to be be big enough for the indicated number of tiles.

This cache is not shared with PagedArrays in other rows and is always clipped to be less than the maximum value set using the setMaximumCacheSize member function. tiles. Tiles are cached using a first in first out algorithm.

Reimplemented from casacore::LatticeBase.

◆ setMaskZero()

void casacore::FITSImage::setMaskZero ( Bool filterZero )

protected

Set the masking of values 0.0.

◆ setMaximumCacheSize()

virtual void casacore::FITSImage::setMaximumCacheSize ( uInt howManyPixels )

virtual

Set the maximum (allowed) cache size as indicated.

Reimplemented from casacore::LatticeBase.

◆ setup()

void casacore::FITSImage::setup ( )

private

Setup the object (used by constructors).

◆ shape()

virtual IPosition casacore::FITSImage::shape ( ) const

virtual

return the shape of the FITSImage

Implements casacore::LatticeBase.

◆ showCacheStatistics()

virtual void casacore::FITSImage::showCacheStatistics ( ostream & os ) const

virtual

Report on cache success.

Reimplemented from casacore::LatticeBase.

◆ tempClose()

virtual void casacore::FITSImage::tempClose ( )

virtual

Temporarily close the image.

Reimplemented from casacore::LatticeBase.

◆ whichHDU()

uInt casacore::FITSImage::whichHDU ( ) const

inline

Return the HDU number.

Definition at line 234 of file FITSImage.h.

References whichHDU_p.

Member Data Documentation

◆ _hasBeamsTable

Bool casacore::FITSImage::_hasBeamsTable

private

Definition at line 286 of file FITSImage.h.

◆ dataType_p

DataType casacore::FITSImage::dataType_p

private

Definition at line 280 of file FITSImage.h.

Referenced by internalDataType().

◆ fileOffset_p

Int64 casacore::FITSImage::fileOffset_p

private

Definition at line 281 of file FITSImage.h.

◆ filterZeroMask_p

Bool casacore::FITSImage::filterZeroMask_p

private

Definition at line 283 of file FITSImage.h.

◆ fullname_p

String casacore::FITSImage::fullname_p

private

Definition at line 269 of file FITSImage.h.

◆ hasBlanks_p

Bool casacore::FITSImage::hasBlanks_p

private

Definition at line 279 of file FITSImage.h.

◆ isClosed_p

Bool casacore::FITSImage::isClosed_p

private

Definition at line 282 of file FITSImage.h.

Referenced by reopenIfNeeded().

◆ longMagic_p

Int casacore::FITSImage::longMagic_p

private

Definition at line 278 of file FITSImage.h.

◆ maskSpec_p

MaskSpecifier casacore::FITSImage::maskSpec_p

private

Definition at line 270 of file FITSImage.h.

◆ name_p

String casacore::FITSImage::name_p

private

Definition at line 268 of file FITSImage.h.

◆ offset_p

Float casacore::FITSImage::offset_p

private

Definition at line 275 of file FITSImage.h.

◆ pPixelMask_p

Lattice<Bool>* casacore::FITSImage::pPixelMask_p

private

Definition at line 272 of file FITSImage.h.

◆ pTiledFile_p

CountedPtr<TiledFileAccess> casacore::FITSImage::pTiledFile_p

private

Definition at line 271 of file FITSImage.h.

◆ scale_p

Float casacore::FITSImage::scale_p

private

Definition at line 274 of file FITSImage.h.

◆ shape_p

TiledShape casacore::FITSImage::shape_p

private

Definition at line 273 of file FITSImage.h.

◆ shortMagic_p

Short casacore::FITSImage::shortMagic_p

private

Definition at line 276 of file FITSImage.h.

◆ uCharMagic_p

uChar casacore::FITSImage::uCharMagic_p

private

Definition at line 277 of file FITSImage.h.

◆ whichHDU_p

uInt casacore::FITSImage::whichHDU_p

private

Definition at line 285 of file FITSImage.h.

Referenced by whichHDU().

◆ whichRep_p

uInt casacore::FITSImage::whichRep_p

private

Definition at line 284 of file FITSImage.h.

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

images/Images/FITSImage.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Example

Motivation

Constructor & Destructor Documentation

◆ FITSImage() [1/3]

◆ FITSImage() [2/3]

◆ FITSImage() [3/3]

◆ ~FITSImage()

Member Function Documentation

◆ advisedMaxPixels()

◆ className()

◆ clearCache()

◆ cloneII()

◆ crackExtHeader()

◆ crackHeader()

◆ dataType()

◆ doGetMaskSlice()

◆ doGetSlice()

◆ doNiceCursorShape()

◆ doPutSlice()

◆ get_fitsname()

◆ get_hdunum()

◆ getImageAttributes()

◆ getRegionPtr()

◆ hasPixelMask()

◆ imageType()

◆ internalDataType()

◆ isMasked()

◆ isPaged()

◆ isPersistent()

◆ isWritable()

◆ maximumCacheSize()

◆ name()

◆ ok()

◆ open()

◆ openFITSImage()

◆ operator=()

◆ pixelMask() [1/2]

◆ pixelMask() [2/2]

◆ registerOpenFunction()

◆ reopen()

◆ reopenIfNeeded()

◆ resize()

◆ setCacheSizeFromPath()

◆ setCacheSizeInTiles()

◆ setMaskZero()

◆ setMaximumCacheSize()

◆ setup()

◆ shape()

◆ showCacheStatistics()

◆ tempClose()

◆ whichHDU()

Member Data Documentation

◆ _hasBeamsTable

◆ dataType_p

◆ fileOffset_p

◆ filterZeroMask_p

◆ fullname_p

◆ hasBlanks_p

◆ isClosed_p

◆ longMagic_p

◆ maskSpec_p

◆ name_p

◆ offset_p

◆ pPixelMask_p

◆ pTiledFile_p

◆ scale_p

◆ shape_p

◆ shortMagic_p

◆ uCharMagic_p