casacore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::TiledCellStMan Class Reference

Tiled Cell Storage Manager. More...

#include <TiledCellStMan.h>

Inheritance diagram for casacore::TiledCellStMan:
casacore::TiledStMan casacore::DataManager

Public Member Functions

 TiledCellStMan (const String &hypercolumnName, const IPosition &defaultTileShape, uInt64 maximumCacheSize=0)
 Create a TiledDataStMan storage manager for the hypercolumn with the given name. More...
 
 TiledCellStMan (const String &hypercolumnName, const Record &spec)
 
 ~TiledCellStMan ()
 
DataManagerclone () const
 Clone this object. More...
 
String dataManagerType () const
 Get the type name of the data manager (i.e. More...
 
Bool canChangeShape () const
 This tiled storage manager can handle changing array shapes. More...
 
virtual void setShape (rownr_t rownr, TSMCube *hypercube, const IPosition &shape, const IPosition &tileShape)
 Set the shape and tile shape of the hypercube. 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 (rownr_t rownr) const
 Get the current cache size (in buckets) for the hypercube in the given row. More...
 
const IPositionhypercubeShape (rownr_t rownr) const
 Get the hypercube shape of the data in the given row. More...
 
const IPositiontileShape (rownr_t rownr) const
 Get the tile shape of the data in the given row. More...
 
uInt64 bucketSize (rownr_t rownr) const
 Get the bucket size (in bytes) of the hypercube in the given row. More...
 
virtual Bool canAccessColumn () 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 (rownr_t 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 (rownr_t 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 (rownr_t 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 (rownr_t 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...
 
uInt64 getLengthOffset (uInt64 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...
 
rownr_t 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...
 
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 (rownr_t 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 rownr_t open64 (rownr_t nrrow, AipsIO &)
 Open the storage manager for an existing table. More...
 
virtual rownr_t resync64 (rownr_t 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...
 
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...
 

Static Public Member Functions

static DataManagermakeObject (const String &dataManagerType, const Record &spec)
 Make the object from the type name string. More...
 
- Static Public Member Functions inherited from casacore::TiledStMan
static IPosition makeTileShape (const IPosition &hypercubeShape, Double tolerance=0.5, uInt64 maxNrPixelsPerTile=4 *1024 *1024)
 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, uInt64 maxNrPixelsPerTile=4 *1024 *1024)
 
- 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...
 

Private Member Functions

 TiledCellStMan ()
 Create a TiledCellStMan. More...
 
 TiledCellStMan (const TiledCellStMan &)
 Forbid copy constructor. More...
 
TiledCellStManoperator= (const TiledCellStMan &)
 Forbid assignment. More...
 
virtual IPosition defaultTileShape () const
 Get the default tile shape. More...
 
void addRow64 (rownr_t nrrow)
 Add rows to the storage manager. More...
 
virtual TSMCubegetHypercube (rownr_t rownr)
 Get the hypercube in which the given row is stored. More...
 
virtual TSMCubegetHypercube (rownr_t rownr, IPosition &position)
 Get the hypercube in which the given row is stored. More...
 
virtual void setupCheck (const TableDesc &tableDesc, const Vector< String > &dataNames) const
 Check if the hypercolumn definition fits this storage manager. More...
 
virtual Bool flush (AipsIO &, Bool fsync)
 Flush and optionally fsync the data. More...
 
virtual void create64 (rownr_t nrrow)
 Let the storage manager create files as needed for a new table. More...
 
virtual void readHeader (rownr_t nrrow, Bool firstTime)
 Read the header info. More...
 

Private Attributes

IPosition defaultTileShape_p
 

Additional Inherited Members

- Static Public Attributes inherited from casacore::DataManager
static rownr_t MAXROWNR32
 Define the highest row number that can be represented as signed 32-bit. 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 const TableDescgetDesc () const
 Get the table description needed for the hypercolumn description. 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...
 
rownr_t 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, uInt64 nrCube)
 Write the data into the header file. More...
 
uInt headerFileGet (AipsIO &headerFile, rownr_t 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...
 
rownr_t 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

Tiled Cell Storage Manager.

Intended use:

Public interface

Review Status

Reviewed By:
UNKNOWN
Date Reviewed:
before2004/08/25

Prerequisite

Etymology

TiledCellStMan is the Tiled Storage Manager storing each cell as a separate hypercube.

Synopsis

TiledCellStMan is a derivation from TiledStMan, the abstract tiled storage manager class. A description of the basics of tiled storage managers is given in the Tables module description.

TiledCellStMan allows the user to create a tiled hypercube for each data cell in an automatic way. It is meant to be used for storing regularly shaped data like images (where the table contains a possibly differently shaped image in each row).

The TiledCellStMan has the following (extra) properties:

Motivation

This tiled storage manager does not require any special action (like calling add/extendHypercube) when used with a column containing variable shaped arrays.

Example

// Define the table description and the columns in it.
TableDesc td ("", "1", TableDesc::Scratch);
td.addColumn (ArrayColumnDesc<float> ("RA", 1));
td.addColumn (ArrayColumnDesc<float> ("Dec", 1));
td.addColumn (ArrayColumnDesc<float> ("Velocity", 1));
td.addColumn (ArrayColumnDesc<float> ("Image", 3));
// Define the 3-dim hypercolumn with its data and coordinate columns.
// Note that its dimensionality must match the dimensionality
// of the data cells.
td.defineHypercolumn ("TSMExample",
3,
stringToVector ("Image"),
stringToVector ("RA,Dec,Velocity"));
// Now create a new table from the description.
SetupNewTable newtab("tTiledCellStMan_tmp.data", td, Table::New);
// Create a TiledCellStMan storage manager for the hypercolumn
// and bind the columns to it.
TiledCellStMan sm1 ("TSMExample");
newtab.bindAll (sm1);
// Create the table.
Table table(newtab);
// Define the values for the coordinates of the hypercube.
Vector<float> raValues(512);
Vector<float> DecValues(512);
Vector<float> VelocityValues(64);
indgen (raValues);
indgen (decValues, float(100));
indgen (velocityValues, float(200));
ArrayColumn<float> ra (table, "RA");
ArrayColumn<float> dec (table, "Dec");
ArrayColumn<float> velocity (table, "Velocity");
ArrayColumn<float> image (table, "Image");
Cube<float> imageValues(IPosition(3,512,512,64));
indgen (imageValues);
// Write some data into the data columns.
for (uInt i=0; i<4; i++) {
table.addRow();
image.put (i, imageValues);
ra.put (i, raValues);
dec.put (i, decValues);
velocity.put (i, velocityValues);
}

Definition at line 156 of file TiledCellStMan.h.

Constructor & Destructor Documentation

casacore::TiledCellStMan::TiledCellStMan ( const String hypercolumnName,
const IPosition defaultTileShape,
uInt64  maximumCacheSize = 0 
)

Create a TiledDataStMan storage manager for the hypercolumn with the given name.

The columns used should have the FixedShape attribute set. The hypercolumn name is also the name of the storage manager. The given tile shape will be used as the default for the hypercube in each cell. Per cell it can be redefined via ArrayColumn::setShape. The given maximum cache size (default is unlimited) is persistent, thus will be reused when the table is read back. Note that the class ROTiledStManAccessor allows one to overwrite the maximum cache size temporarily. Its description contains a discussion about the effects of setting a maximum cache.
The constructor taking a Record expects fields in the record with the name of the arguments in uppercase. If not defined, their default value is used.

casacore::TiledCellStMan::TiledCellStMan ( const String hypercolumnName,
const Record spec 
)
casacore::TiledCellStMan::~TiledCellStMan ( )
casacore::TiledCellStMan::TiledCellStMan ( )
private

Create a TiledCellStMan.

This constructor is private, because it should only be used by makeObject.

casacore::TiledCellStMan::TiledCellStMan ( const TiledCellStMan )
private

Forbid copy constructor.

Member Function Documentation

void casacore::TiledCellStMan::addRow64 ( rownr_t  nrrow)
privatevirtual

Add rows to the storage manager.

Reimplemented from casacore::DataManager.

Bool casacore::TiledCellStMan::canChangeShape ( ) const
virtual

This tiled storage manager can handle changing array shapes.

Reimplemented from casacore::TiledStMan.

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

Clone this object.

It does not clone TSMColumn objects possibly used.

Implements casacore::DataManager.

virtual void casacore::TiledCellStMan::create64 ( rownr_t  nrrow)
privatevirtual

Let the storage manager create files as needed for a new table.

This allows a column with an indirect array to create its file.

Reimplemented from casacore::DataManager.

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

Get the type name of the data manager (i.e.

TiledCellStMan).

Implements casacore::DataManager.

virtual IPosition casacore::TiledCellStMan::defaultTileShape ( ) const
privatevirtual

Get the default tile shape.

Reimplemented from casacore::TiledStMan.

virtual Bool casacore::TiledCellStMan::flush ( AipsIO ,
Bool  fsync 
)
privatevirtual

Flush and optionally fsync the data.

It returns a True status if it had to flush (i.e. if data have changed).

Implements casacore::DataManager.

virtual TSMCube* casacore::TiledCellStMan::getHypercube ( rownr_t  rownr)
privatevirtual

Get the hypercube in which the given row is stored.

Implements casacore::TiledStMan.

virtual TSMCube* casacore::TiledCellStMan::getHypercube ( rownr_t  rownr,
IPosition position 
)
privatevirtual

Get the hypercube in which the given row is stored.

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

Implements casacore::TiledStMan.

static DataManager* casacore::TiledCellStMan::makeObject ( const String dataManagerType,
const Record spec 
)
static

Make the object from the type name string.

This function gets registered in the DataManager "constructor" map.

TiledCellStMan& casacore::TiledCellStMan::operator= ( const TiledCellStMan )
private

Forbid assignment.

virtual void casacore::TiledCellStMan::readHeader ( rownr_t  nrrow,
Bool  firstTime 
)
privatevirtual

Read the header info.

Implements casacore::TiledStMan.

virtual void casacore::TiledCellStMan::setShape ( rownr_t  rownr,
TSMCube hypercube,
const IPosition shape,
const IPosition tileShape 
)
virtual

Set the shape and tile shape of the hypercube.

Reimplemented from casacore::TiledStMan.

virtual void casacore::TiledCellStMan::setupCheck ( const TableDesc tableDesc,
const Vector< String > &  dataNames 
) const
privatevirtual

Check if the hypercolumn definition fits this storage manager.

Reimplemented from casacore::TiledStMan.

Member Data Documentation

IPosition casacore::TiledCellStMan::defaultTileShape_p
private

Definition at line 246 of file TiledCellStMan.h.


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