casacore
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::MIRIADImage Class Reference

More...

#include <MIRIADImage.h>

Public Member Functions

 MIRIADImage (const String &name)
 Construct a MIRIADImage from the disk MIRIAD dataset name and apply mask. More...
 
 MIRIADImage (const String &name, const MaskSpecifier &)
 Construct a MIRIADImage from the disk MIRIAD file name and apply mask or not. More...
 
 MIRIADImage (const MIRIADImage &other)
 Copy constructor (reference semantics) More...
 
 ~MIRIADImage ()
 Destructor does nothing. More...
 
MIRIADImageoperator= (const MIRIADImage &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 MIRIADImage). More...
 
virtual void resize (const TiledShape &newShape)
 Function which changes the shape of the MIRIADImage. More...
 
virtual const RecordInterfacemiscInfo () const
 Functions which get and set the units associated with the image pixels (i.e. More...
 
virtual Bool setMiscInfo (const RecordInterface &newInfo)
 
virtual Bool isMasked () const
 Has the object really a mask? The MIRIADImage always has a pixel mask and never has a region mask so this should always return True. More...
 
virtual Bool hasPixelMask () const
 MIRIADimage always has a pixel mask so should return 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 LatticeRegiongetRegionPtr () 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 MIRIADImage 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 MIRIADImage 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 MIRIADImage 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...
 
DataType dataType () const
 Return the (internal) data type (TpFloat or TpShort). 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 Unitunits () 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 CoordinateSystemcoordinates () const
 
virtual LELCoordinates lelCoordinates () const
 Function to get a LELCoordinate object containing the coordinates. More...
 
LoggerHolderlogger ()
 Get access to the LoggerHolder. More...
 
const LoggerHolderlogger () const
 
LogIOlogSink ()
 Allow messages to be logged to this ImageInterface. More...
 
const LogIOlogSink () const
 
void appendLog (const LoggerHolder &other)
 Add the messages from the other image logger to this one. More...
 
const TableRecordmiscInfo () const
 Often we have miscellaneous information we want to attach to an image. More...
 
const ImageInfoimageInfo () 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...
 
ImageInforwImageInfo ()
 Get non-const access to the ImageInfo. More...
 
virtual Bool setImageInfo (const ImageInfo &info)
 
virtual ImageAttrHandlerattrHandler (Bool createHandler=False)
 Get access to the attribute handler. More...
 
ImageAttrHandlerroAttrHandler () 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 ImageRegiongetImageRegionPtr (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< StringregionNames (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 LatticeRegionregion () 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< BoolgetMask (Bool removeDegenerateAxes=False) const
 
Array< BoolgetMaskSlice (const Slicer &section, Bool removeDegenerateAxes=False) const
 
Array< BoolgetMaskSlice (const IPosition &start, const IPosition &shape, Bool removeDegenerateAxes=False) const
 
Array< BoolgetMaskSlice (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...
 
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 LatticeBaseopenMIRIADImage (const String &name, const MaskSpecifier &)
 Function to open a MIRIAD image. More...
 
static void registerOpenFunction ()
 Register the open function. 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, Record &miscInfo, Bool &hasBlanks, const String &name)
 Fish things out of the MIRIAD file. More...
 
void crackHeader (CoordinateSystem &cSys, IPosition &shape, ImageInfo &imageInfo, Unit &brightnessUnit, Record &miscInfo, LogIO &os)
 

Private Attributes

String name_p
 
Int tno_p
 
MaskSpecifier maskSpec_p
 
Unit unit_p
 
Record rec_p
 
CountedPtr< TiledFileAccesspTiledFile_p
 
Lattice< Bool > * pPixelMask_p
 
TiledShape shape_p
 Float scale_p; Float offset_p; Short magic_p;. More...
 
Bool hasBlanks_p
 
DataType dataType_p
 
Int64 fileOffset_p
 
Bool isClosed_p
 

Additional Inherited Members

- Protected Member Functions inherited from casacore::ImageInterface< Float >
ImageInterfaceoperator= (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...
 
RegionHandlergetRegionHandler ()
 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...
 
LatticeBaseoperator= (const LatticeBase &)
 
void throwBoolMath () const
 Throw an exception for arithmetic on a Bool Lattice. More...
 

Detailed Description

Class providing native access to MIRIAD images.

Intended use:

Public interface

Review Status

Test programs:
tMIRIADImage

Prerequisite

Etymology

This class provides native access to MIRIAD images.

Synopsis

A MIRIADImage provides native access to MIRIAD images by accessing them with the TiledFileAccess class. – or – the native miriad I/O routines. The MIRIADImage is read only. – really – ??

Example

MIRIADImage im("cube1");
LogIO logger(or);
ImageStatistics<Float> stats(im, logger);
Bool ok = stats.display(); // Display statistics
LoggerHolder & logger()
Get access to the LoggerHolder.
MIRIADImage(const String &name)
Construct a MIRIADImage from the disk MIRIAD dataset name and apply mask.
virtual Bool ok() const
Check class invariants.
bool Bool
Define the standard types used by Casacore.
Definition: aipstype.h:42

Motivation

This provides native access to MIRIAD images.

Definition at line 99 of file MIRIADImage.h.

Constructor & Destructor Documentation

◆ MIRIADImage() [1/3]

casacore::MIRIADImage::MIRIADImage ( const String name)
explicit

Construct a MIRIADImage from the disk MIRIAD dataset name and apply mask.

◆ MIRIADImage() [2/3]

casacore::MIRIADImage::MIRIADImage ( const String name,
const MaskSpecifier  
)

Construct a MIRIADImage from the disk MIRIAD file name and apply mask or not.

◆ MIRIADImage() [3/3]

casacore::MIRIADImage::MIRIADImage ( const MIRIADImage other)

Copy constructor (reference semantics)

◆ ~MIRIADImage()

casacore::MIRIADImage::~MIRIADImage ( )

Destructor does nothing.

Member Function Documentation

◆ advisedMaxPixels()

virtual uInt casacore::MIRIADImage::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 >.

◆ clearCache()

virtual void casacore::MIRIADImage::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::MIRIADImage::cloneII ( ) const
virtual

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

Implements casacore::ImageInterface< Float >.

◆ crackHeader()

void casacore::MIRIADImage::crackHeader ( CoordinateSystem cSys,
IPosition shape,
ImageInfo imageInfo,
Unit brightnessUnit,
Record miscInfo,
LogIO os 
)
private

◆ dataType()

DataType casacore::MIRIADImage::dataType ( ) const
inlinevirtual

Return the (internal) data type (TpFloat or TpShort).

Reimplemented from casacore::Lattice< T >.

Definition at line 228 of file MIRIADImage.h.

References dataType_p.

◆ doGetMaskSlice()

virtual Bool casacore::MIRIADImage::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::MIRIADImage::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

◆ doNiceCursorShape()

virtual IPosition casacore::MIRIADImage::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::MIRIADImage::doPutSlice ( const Array< Float > &  sourceBuffer,
const IPosition where,
const IPosition stride 
)
virtual

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

◆ getImageAttributes()

void casacore::MIRIADImage::getImageAttributes ( CoordinateSystem cSys,
IPosition shape,
ImageInfo info,
Unit brightnessUnit,
Record miscInfo,
Bool hasBlanks,
const String name 
)
private

Fish things out of the MIRIAD file.

◆ getRegionPtr()

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

Get the region used.

There is no region. Always returns 0.

Implements casacore::MaskedLattice< T >.

◆ hasPixelMask()

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

MIRIADimage always has a pixel mask so should return True.

Reimplemented from casacore::MaskedLattice< T >.

◆ imageType()

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

Get the image type (returns MIRIADImage).

Implements casacore::ImageInterface< Float >.

◆ isMasked()

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

Has the object really a mask? The MIRIADImage always has a pixel mask and never has a region mask so this should always return True.

Reimplemented from casacore::MaskedLattice< T >.

◆ isPaged()

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

The lattice is paged to disk.

Reimplemented from casacore::LatticeBase.

◆ isPersistent()

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

The lattice is persistent.

Reimplemented from casacore::LatticeBase.

◆ isWritable()

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

The MIRIADImage is not writable.

Reimplemented from casacore::LatticeBase.

◆ maximumCacheSize()

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

Maximum size - not necessarily all used.

In pixels.

Reimplemented from casacore::LatticeBase.

◆ miscInfo()

virtual const RecordInterface& casacore::MIRIADImage::miscInfo ( ) const
virtual

Functions which get and set the units associated with the image pixels (i.e.

the "brightness" unit). Initially the unit is empty. Although the MIRIADimage is not writable, you can change the unit in the MIRIADImage object, but it will not be changed in the MIRIAD disk file. Often we have miscellaneous information we want to attach to an image. Although MIRIADImage is not writable, you can set a new MiscInfo record, but it will not be stored with the MIRIAD file

◆ name()

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

Returns the name of the disk file.

Implements casacore::ImageInterface< Float >.

◆ ok()

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

Check class invariants.

Implements casacore::ImageInterface< Float >.

◆ open()

void casacore::MIRIADImage::open ( )
private

Open the image (used by setup and reopen).

◆ openMIRIADImage()

static LatticeBase* casacore::MIRIADImage::openMIRIADImage ( const String name,
const MaskSpecifier  
)
static

Function to open a MIRIAD image.

◆ operator=()

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

Assignment (reference semantics)

◆ pixelMask() [1/2]

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

Reimplemented from casacore::MaskedLattice< T >.

◆ pixelMask() [2/2]

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

Get access to the pixelmask.

MIRIADImage always has a pixel mask.

Reimplemented from casacore::MaskedLattice< T >.

◆ registerOpenFunction()

static void casacore::MIRIADImage::registerOpenFunction ( )
static

Register the open function.

◆ reopen()

virtual void casacore::MIRIADImage::reopen ( )
virtual

Reopen a temporarily closed image.

Reimplemented from casacore::LatticeBase.

Referenced by reopenIfNeeded().

◆ reopenIfNeeded()

void casacore::MIRIADImage::reopenIfNeeded ( ) const
inlineprivate

Reopen the image if needed.

Definition at line 275 of file MIRIADImage.h.

References isClosed_p, and reopen().

◆ resize()

virtual void casacore::MIRIADImage::resize ( const TiledShape newShape)
virtual

Function which changes the shape of the MIRIADImage.

Throws an exception as MIRIADImage is not writable.

Implements casacore::ImageInterface< Float >.

◆ setCacheSizeFromPath()

virtual void casacore::MIRIADImage::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::MIRIADImage::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.

◆ setMaximumCacheSize()

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

Set the maximum (allowed) cache size as indicated.

Reimplemented from casacore::LatticeBase.

◆ setMiscInfo()

virtual Bool casacore::MIRIADImage::setMiscInfo ( const RecordInterface newInfo)
virtual

Reimplemented from casacore::ImageInterface< Float >.

◆ setup()

void casacore::MIRIADImage::setup ( )
private

Setup the object (used by constructors).

◆ shape()

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

return the shape of the MIRIADImage

Implements casacore::LatticeBase.

◆ showCacheStatistics()

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

Report on cache success.

Reimplemented from casacore::LatticeBase.

◆ tempClose()

virtual void casacore::MIRIADImage::tempClose ( )
virtual

Temporarily close the image.

Reimplemented from casacore::LatticeBase.

Member Data Documentation

◆ dataType_p

DataType casacore::MIRIADImage::dataType_p
private

Definition at line 270 of file MIRIADImage.h.

Referenced by dataType().

◆ fileOffset_p

Int64 casacore::MIRIADImage::fileOffset_p
private

Definition at line 271 of file MIRIADImage.h.

◆ hasBlanks_p

Bool casacore::MIRIADImage::hasBlanks_p
private

Definition at line 269 of file MIRIADImage.h.

◆ isClosed_p

Bool casacore::MIRIADImage::isClosed_p
private

Definition at line 272 of file MIRIADImage.h.

Referenced by reopenIfNeeded().

◆ maskSpec_p

MaskSpecifier casacore::MIRIADImage::maskSpec_p
private

Definition at line 260 of file MIRIADImage.h.

◆ name_p

String casacore::MIRIADImage::name_p
private

Definition at line 258 of file MIRIADImage.h.

◆ pPixelMask_p

Lattice<Bool>* casacore::MIRIADImage::pPixelMask_p
private

Definition at line 264 of file MIRIADImage.h.

◆ pTiledFile_p

CountedPtr<TiledFileAccess> casacore::MIRIADImage::pTiledFile_p
private

Definition at line 263 of file MIRIADImage.h.

◆ rec_p

Record casacore::MIRIADImage::rec_p
private

Definition at line 262 of file MIRIADImage.h.

◆ shape_p

TiledShape casacore::MIRIADImage::shape_p
private

Float scale_p; Float offset_p; Short magic_p;.

Definition at line 268 of file MIRIADImage.h.

◆ tno_p

Int casacore::MIRIADImage::tno_p
private

Definition at line 259 of file MIRIADImage.h.

◆ unit_p

Unit casacore::MIRIADImage::unit_p
private

Definition at line 261 of file MIRIADImage.h.


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