casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::TiledFileHelper Class Reference

Helper class for tiled access to an array in a file. More...

#include <TiledFileHelper.h>

Inheritance diagram for casacore::TiledFileHelper:
casacore::TiledStMan casacore::DataManager

Public Member Functions

 TiledFileHelper (const String &fileName, const IPosition &shape, DataType dtype, const TSMOption &, Bool writable, Bool bigEndian)
 Create a TiledFileHelper object. More...
 
 ~TiledFileHelper ()
 
virtual const TableDescgetDesc () const
 Get the table description needed for the hypercolumn description. More...
 
TSMFilefile ()
 
virtual String dataManagerType () const
 Return the class name. More...
 
virtual DataManagerclone () const
 These functions are pure virtual, but not needed here. More...
 
virtual Bool flush (AipsIO &, Bool)
 Flush and optionally fsync the data. More...
 
virtual void create (uInt)
 Let the data manager initialize itself for a new table. More...
 
virtual TSMCubegetHypercube (uInt)
 
virtual TSMCubegetHypercube (uInt, IPosition &)
 Get the hypercube in which the given row is stored. More...
 
virtual void readHeader (uInt, Bool)
 Let a derived class read the header info. More...
 
- Public Member Functions inherited from casacore::TiledStMan
 TiledStMan ()
 Create a TiledStMan. More...
 
 TiledStMan (const String &hypercolumnName, uInt maximumCacheSizeMiB)
 Create a TiledStMan storage manager. More...
 
virtual ~TiledStMan ()
 
virtual String dataManagerName () const
 Get the name given to the storage manager. More...
 
void setDataManagerName (const String &newHypercolumnName)
 
virtual Record dataManagerSpec () const
 Return a record containing data manager specifications. More...
 
virtual Record getProperties () const
 Get data manager properties that can be modified. More...
 
virtual void setProperties (const Record &spec)
 Modify data manager properties. More...
 
void setDataChanged ()
 Set the flag to "data has changed since last flush". More...
 
virtual void setMaximumCacheSize (uInt nMiB)
 Set the maximum cache size (in MiB) in a non-persistent way. More...
 
uInt maximumCacheSize () const
 Get the current maximum cache size (in MiB (MibiByte)). More...
 
uInt cacheSize (uInt rownr) const
 Get the current cache size (in buckets) for the hypercube in the given row. More...
 
const IPositionhypercubeShape (uInt rownr) const
 Get the hypercube shape of the data in the given row. More...
 
const IPositiontileShape (uInt rownr) const
 Get the tile shape of the data in the given row. More...
 
uInt bucketSize (uInt rownr) const
 Get the bucket size (in bytes) of the hypercube in the given row. More...
 
virtual Bool canChangeShape () const
 Can the tiled storage manager handle changing array shapes? The default is no (but TiledCellStMan can). More...
 
virtual Bool canAccessColumn (Bool &reask) const
 Can the tiled storage manager access an entire column. More...
 
virtual Bool hasMultiFileSupport () const
 The data manager supports use of MultiFile. More...
 
uInt calcCacheSize (uInt rownr, const IPosition &sliceShape, const IPosition &windowStart, const IPosition &windowLength, const IPosition &axisPath) const
 Calculate the cache size (in buckets) for accessing the hypercube containing the given row. More...
 
void setCacheSize (uInt rownr, const IPosition &sliceShape, const IPosition &windowStart, const IPosition &windowLength, const IPosition &axisPath, Bool forceSmaller)
 Set the cache size using the calcCacheSize function mentioned above. More...
 
void setCacheSize (uInt rownr, uInt nbuckets, Bool forceSmaller)
 Set the cache size for accessing the hypercube containing the given row. More...
 
void setHypercubeCacheSize (uInt hypercube, uInt nbuckets, Bool forceSmaller)
 Sets the cache size using the hypercube instead of the row number. More...
 
Bool userSetCache (uInt rownr) const
 Determine if the user set the cache size (using setCacheSize). More...
 
void emptyCaches ()
 Empty the caches used by the hypercubes in this storage manager. More...
 
void showCacheStatistics (ostream &os) const
 Show the statistics of all caches used. More...
 
uInt getLengthOffset (uInt nrPixels, Block< uInt > &dataOffset, Block< uInt > &localOffset, uInt &localTileLength) const
 Get the length of the data for the given number of pixels. More...
 
uInt nrCoordVector () const
 Get the number of coordinate vectors. More...
 
uInt nrow () const
 Get the nr of rows in this storage manager. More...
 
Bool canAddRow () const
 Does the storage manager allow to add rows? (yes) More...
 
virtual IPosition defaultTileShape () const
 Get the default tile shape. More...
 
uInt nhypercubes () const
 Return the number of hypercubes. More...
 
virtual TSMCubesingleHypercube ()
 Test if only one hypercube is used by this storage manager. More...
 
const TSMCubegetTSMCube (uInt hypercube) const
 Get the given hypercube. More...
 
TSMCubegetTSMCube (uInt hypercube)
 
const TSMCubegetHypercube (uInt rownr) const
 Get the hypercube in which the given row is stored. More...
 
TSMCubemakeTSMCube (TSMFile *file, const IPosition &cubeShape, const IPosition &tileShape, const Record &values, Int64 fileOffset=-1)
 Make the correct TSMCube type (depending on tsmOption()). More...
 
void readTile (char *local, const Block< uInt > &localOffset, const char *external, const Block< uInt > &externalOffset, uInt nrpixels)
 Read a tile and convert the data to local format. More...
 
void writeTile (char *external, const Block< uInt > &externalOffset, const char *local, const Block< uInt > &localOffset, uInt nrpixels)
 Write a tile after converting the data to external format. More...
 
TSMFilegetFile (uInt sequenceNumber)
 Get the TSMFile object with the given sequence number. More...
 
virtual void open (uInt nrrow, AipsIO &)
 Open the storage manager for an existing table. More...
 
virtual void resync (uInt nrrow)
 Resync the storage manager with the new file contents. More...
 
virtual void reopenRW ()
 Reopen all files used in this storage manager for read/write access. More...
 
virtual void deleteManager ()
 The data manager will be deleted (because all its columns are requested to be deleted). More...
 
DataManagerColumnmakeScalarColumn (const String &name, int dataType, const String &dataTypeID)
 Create a column in the storage manager on behalf of a table column. More...
 
DataManagerColumnmakeDirArrColumn (const String &name, int dataType, const String &dataTypeID)
 Create a direct array column. More...
 
DataManagerColumnmakeIndArrColumn (const String &name, int dataType, const String &dataTypeID)
 Create an indirect array column. More...
 
Bool canReallocateColumns () const
 The TiledStMan wants to do reallocateColumn. More...
 
DataManagerColumnreallocateColumn (DataManagerColumn *column)
 Reallocate the column object if it is part of this data manager. More...
 
virtual void setShape (uInt rownr, TSMCube *hypercube, const IPosition &shape, const IPosition &tileShape)
 Set the shape and tile shape of a hypercube. More...
 
void checkCubeShape (const TSMCube *hypercube, const IPosition &cubeShape) const
 Check the shape to be set for a hypercube. More...
 
int coordinateDataType (const String &columnName) const
 Get the data type of the coordinate column with the given name. More...
 
void initCoordinates (TSMCube *hypercube)
 Initialize the new coordinates for the given cube. More...
 
const TSMDataColumngetDataColumn (uInt colnr) const
 Get pointer to data column object. More...
 
- Public Member Functions inherited from casacore::DataManager
 DataManager ()
 Default constructor. More...
 
virtual ~DataManager ()
 
void dataManagerInfo (Record &info) const
 Add SEQNR and SPEC (the DataManagerSpec subrecord) to the info. More...
 
virtual Bool isStorageManager () const
 Is the data manager a storage manager? The default is yes. More...
 
uInt sequenceNr () const
 Get the (unique) sequence nr of this data manager. More...
 
uInt ncolumn () const
 Get the nr of columns in this data manager (can be zero). More...
 
Bool asBigEndian () const
 Have the data to be stored in big or little endian canonical format? More...
 
const TSMOptiontsmOption () const
 Get the TSM option. More...
 
MultiFileBasemultiFile ()
 Get the MultiFile pointer (can be 0). More...
 
String keywordName (const String &keyword) const
 Compose a keyword name from the given keyword appended with the sequence number (e.g. More...
 
String fileName () const
 Compose a unique filename from the table name and sequence number. More...
 
ByteIO::OpenOption fileOption () const
 Get the AipsIO option of the underlying file. More...
 
virtual Bool isRegular () const
 Is this a regular storage manager? It is regular if it allows addition of rows and writing data in them. More...
 
Tabletable () const
 Get the table this object is associated with. More...
 
virtual Bool canRemoveRow () const
 Does the data manager allow to delete rows? (default no) More...
 
virtual Bool canAddColumn () const
 Does the data manager allow to add columns? (default no) More...
 
virtual Bool canRemoveColumn () const
 Does the data manager allow to delete columns? (default no) More...
 
virtual Bool canRenameColumn () const
 Does the data manager allow to rename columns? (default yes) More...
 
virtual void showCacheStatistics (std::ostream &) const
 Show the data manager's IO statistics. More...
 
DataManagerColumncreateScalarColumn (const String &columnName, int dataType, const String &dataTypeId)
 Create a column in the data manager on behalf of a table column. More...
 
DataManagerColumncreateDirArrColumn (const String &columnName, int dataType, const String &dataTypeId)
 Create a direct array column. More...
 
DataManagerColumncreateIndArrColumn (const String &columnName, int dataType, const String &dataTypeId)
 Create an indirect array column. More...
 
DataManagergetClone () const
 Has the object already been cloned? More...
 
void setClone (DataManager *clone) const
 Set the pointer to the clone. More...
 

Private Member Functions

 TiledFileHelper (const TiledFileHelper &)
 Forbid copy constructor and assignment. More...
 
TiledFileHelperoperator= (const TiledFileHelper &)
 

Private Attributes

TableDesc itsDesc
 

Additional Inherited Members

- Static Public Member Functions inherited from casacore::TiledStMan
static IPosition makeTileShape (const IPosition &hypercubeShape, Double tolerance=0.5, uInt maxNrPixelsPerTile=32768)
 Derive the tile shape from the hypercube shape for the given number of pixels per tile. More...
 
static IPosition makeTileShape (const IPosition &hypercubeShape, const Vector< double > &weight, const Vector< double > &tolerance, uInt maxNrPixelsPerTile=32768)
 
- Static Public Member Functions inherited from casacore::DataManager
static void registerCtor (const String &type, DataManagerCtor func)
 Register a mapping of a data manager type to its static construction function. More...
 
static DataManagerCtor getCtor (const String &dataManagerType)
 Get the "constructor" of a data manager (thread-safe). More...
 
static Bool isRegistered (const String &dataManagerType)
 Test if a data manager is registered (thread-safe). More...
 
static DataManagerunknownDataManager (const String &dataManagerType, const Record &spec)
 Serve as default function for theirRegisterMap, which catches all unknown data manager types. More...
 
- Protected Member Functions inherited from casacore::TiledStMan
void setPersMaxCacheSize (uInt nMiB)
 Set the persistent maximum cache size (in MiB). More...
 
uInt getBindings (const Vector< String > &columnNames, PtrBlock< TSMColumn * > &colSet, Bool mustExist) const
 Get the bindings of the columns with the given names. More...
 
virtual void setupCheck (const TableDesc &tableDesc, const Vector< String > &dataNames) const
 Function setup calls this function to allow the derived class to check specific information. More...
 
void checkValues (const PtrBlock< TSMColumn * > &colSet, const Record &values) const
 Check if values are given in the record for all columns in the block. More...
 
void checkCoordinates (const PtrBlock< TSMColumn * > &coordColSet, const IPosition &cubeShape, const Record &values) const
 Check if the coordinate values are correct. More...
 
void checkShapeColumn (const IPosition &shape) const
 Check if the shapes of FixedShape data and coordinate columns match. More...
 
void checkCoordinatesShapes (const TSMCube *hypercube, const IPosition &cubeShape) const
 Check if the cube shape matches that of defined coordinates. More...
 
void checkAddHypercube (const IPosition &cubeShape, const Record &values) const
 Check if the hypercube to be added is correctly defined. More...
 
TSMCubemakeHypercube (const IPosition &cubeShape, const IPosition &tileShape, const Record &values)
 Make a new TSMCube object. More...
 
Int getCubeIndex (const Record &idValues) const
 Get the index of the hypercube with the given id-values. More...
 
uInt addedNrrow (const IPosition &shape, uInt incrInLastDim) const
 Determine how many rows need to be added for an extension (in the last dimension) of a hypercube with the given shape. More...
 
Bool flushCaches (Bool fsync)
 Flush the caches of all hypercubes. More...
 
AipsIOheaderFileCreate ()
 Create the TSM header file. More...
 
AipsIOheaderFileOpen ()
 Open the TSM header file. More...
 
void headerFilePut (AipsIO &headerFile, uInt nrCube)
 Write the data into the header file. More...
 
void headerFileGet (AipsIO &headerFile, uInt tabNrrow, Bool firstTime, Int extraNdim)
 Read the data from the header file. More...
 
void headerFileClose (AipsIO *headerFile)
 Close the header file. More...
 
void setup (Int extraNdim=-1)
 Set up the TiledStMan variables from the table description. More...
 
void createFile (uInt index)
 Create a TSMFile object and store its pointer at the given index in the block. More...
 
int arrayDataType (int dataType) const
 Convert the scalar data type to an array data type. More...
 
- Protected Member Functions inherited from casacore::DataManager
void decrementNcolumn ()
 Decrement number of columns (in case a column is deleted). More...
 
void setEndian (Bool bigEndian)
 Tell the data manager if big or little endian format is needed. More...
 
void setTsmOption (const TSMOption &tsmOption)
 Tell the data manager which TSM option to use. More...
 
void setMultiFile (MultiFileBase *mfile)
 Tell the data manager that MultiFile can be used. More...
 
void throwDataTypeOther (const String &columnName, int dataType) const
 Throw an exception in case data type is TpOther, because the storage managers (and maybe other data managers) do not support such columns. More...
 
- Protected Attributes inherited from casacore::TiledStMan
String hypercolumnName_p
 The name of the hypercolumn. More...
 
uInt nrrow_p
 The number of rows in the columns. More...
 
PtrBlock< TSMColumn * > colSet_p
 The assembly of all columns. More...
 
PtrBlock< TSMDataColumn * > dataCols_p
 The assembly of all data columns. More...
 
PtrBlock< TSMColumn * > dataColSet_p
 
PtrBlock< TSMColumn * > idColSet_p
 The assembly of all id columns. More...
 
PtrBlock< TSMColumn * > coordColSet_p
 The assembly of all coordinate columns. More...
 
PtrBlock< TSMFile * > fileSet_p
 The assembly of all TSMFile objects. More...
 
PtrBlock< TSMCube * > cubeSet_p
 The assembly of all TSMCube objects. More...
 
uInt persMaxCacheSize_p
 The persistent maximum cache size (in MiB) for a hypercube. More...
 
uInt maxCacheSize_p
 The actual maximum cache size for a hypercube (in MiB). More...
 
uInt nrdim_p
 The dimensionality of the hypercolumn. More...
 
uInt nrCoordVector_p
 The number of vector coordinates. More...
 
IPosition fixedCellShape_p
 The fixed cell shape. More...
 
Bool dataChanged_p
 Has any data changed since the last flush? More...
 

Detailed Description

Helper class for tiled access to an array in a file.

Intended use:

Internal

Review Status

Test programs:
tTiledFileAccess

Prerequisite

Synopsis

TiledFileHelper is a helper class for class TiledFileAccess. It sets up a table description containing one array column to make it possible to use the tiled storage manager to access an array in an arbitrary file.

Motivation

This class was created to be able to read an image in a FITS file.

Definition at line 73 of file TiledFileHelper.h.

Constructor & Destructor Documentation

casacore::TiledFileHelper::TiledFileHelper ( const String fileName,
const IPosition shape,
DataType  dtype,
const TSMOption ,
Bool  writable,
Bool  bigEndian 
)

Create a TiledFileHelper object.

Tell if the data is stored in big or little endian canonical format.

casacore::TiledFileHelper::~TiledFileHelper ( )
casacore::TiledFileHelper::TiledFileHelper ( const TiledFileHelper )
private

Forbid copy constructor and assignment.

Member Function Documentation

virtual DataManager* casacore::TiledFileHelper::clone ( ) const
virtual

These functions are pure virtual, but not needed here.

They throw an exception.

Implements casacore::DataManager.

virtual void casacore::TiledFileHelper::create ( uInt  nrrow)
virtual

Let the data manager initialize itself for a new table.

Implements casacore::DataManager.

virtual String casacore::TiledFileHelper::dataManagerType ( ) const
virtual

Return the class name.

Implements casacore::DataManager.

TSMFile* casacore::TiledFileHelper::file ( )
inline

Definition at line 86 of file TiledFileHelper.h.

References casacore::TiledStMan::fileSet_p.

virtual Bool casacore::TiledFileHelper::flush ( AipsIO ios,
Bool  fsync 
)
virtual

Flush and optionally fsync the data.

The AipsIO stream represents the main table file and can be used by virtual column engines to store SMALL amounts of data. It returns a True status if it had to flush (i.e. if data have changed).

Implements casacore::DataManager.

virtual const TableDesc& casacore::TiledFileHelper::getDesc ( ) const
virtual

Get the table description needed for the hypercolumn description.

Reimplemented from casacore::TiledStMan.

virtual TSMCube* casacore::TiledFileHelper::getHypercube ( uInt  )
virtual

Implements casacore::TiledStMan.

virtual TSMCube* casacore::TiledFileHelper::getHypercube ( uInt  rownr,
IPosition position 
)
virtual

Get the hypercube in which the given row is stored.

It also returns the position of the row in that hypercube.

Implements casacore::TiledStMan.

TiledFileHelper& casacore::TiledFileHelper::operator= ( const TiledFileHelper )
private
virtual void casacore::TiledFileHelper::readHeader ( uInt  nrrow,
Bool  firstTime 
)
virtual

Let a derived class read the header info.

This is used by the open and resync function.

Implements casacore::TiledStMan.

Member Data Documentation

TableDesc casacore::TiledFileHelper::itsDesc
private

Definition at line 111 of file TiledFileHelper.h.


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