Loading...
Searching...
No Matches
casacore::CompressFloat Class Reference
tables package (libcasa_tables) » DataMan_module

More...

`#include <CompressFloat.h>`

## Public Member Functions

| CompressFloat (const String &virtualColumnName, const String &storedColumnName, Float scale, Float offset=0)
| Construct an engine to scale all arrays in a column with the given offset and scale factor.
| CompressFloat (const String &virtualColumnName, const String &storedColumnName, const String &scaleColumnName, const String &offsetColumnName, Bool autoScale=True)
| Construct an engine to scale the arrays in a column.
| CompressFloat (const Record &spec)
| Construct from a record specification as created by getmanagerSpec().
| ~CompressFloat ()
| Destructor is mandatory.
CompressFloat & | operator= (const CompressFloat &)=delete
| Assignment is not needed and therefore forbidden.
virtual String | dataManagerType () const
| Return the type name of the engine (i.e.
virtual String | dataManagerName () const
| Get the name given to the engine (is the virtual column name).
virtual Record | dataManagerSpec () const
| Record a record containing data manager specifications.
Public Member Functions inherited from casacore::BaseMappedArrayEngine< Float, Short >
const String & | virtualName () const
| Get the virtual column name.
const String & | storedName () const
| Get the stored column name.
virtual Bool | isWritable () const
| The column is writable if the underlying stored column is writable.
Public Member Functions inherited from casacore::VirtualColumnEngine
| VirtualColumnEngine ()
| Create the object.
virtual | ~VirtualColumnEngine ()
| VirtualColumnEngine (const VirtualColumnEngine &)=delete
| The copy constructor cannot be used for this base class.
VirtualColumnEngine & | operator= (const VirtualColumnEngine &)=delete
| Assignment cannot be used for this base class.
Public Member Functions inherited from casacore::DataManager
| DataManager ()
| Default constructor.
virtual | ~DataManager ()
| DataManager (const DataManager &)=delete
| The copy constructor cannot be used for this base class.
DataManager & | operator= (const DataManager &)=delete
| Assignment cannot be used for this base class.
void | dataManagerInfo (Record &info) const
| Add SEQNR and SPEC (the DataManagerSpec subrecord) to the info.
virtual Record | getProperties () const
| Get data manager properties that can be modified.
virtual void | setProperties (const Record &spec)
| Modify data manager properties given in record fields.
virtual Bool | canReallocateColumns () const
| Tell if the data manager wants to reallocate the data manager column objects.
virtual DataManagerColumn * | reallocateColumn (DataManagerColumn *column)
| Reallocate the column object if it is part of this data manager.
uInt | sequenceNr () const
| Get the (unique) sequence nr of this data manager.
uInt | ncolumn () const
| Get the nr of columns in this data manager (can be zero).
Bool | asBigEndian () const
| Have the data to be stored in big or little endian canonical format?
const TSMOption & | tsmOption () const
| Get the TSM option.
std::shared_ptr< MultiFileBase > | multiFile ()
| Get the MultiFile pointer (can be 0).
String | keywordName (const String &keyword) const
| Compose a keyword name from the given keyword appended with the sequence number (e.g.
String | fileName () const
| Compose a unique filename from the table name and sequence number.
ByteIO::OpenOption | fileOption () const
| Get the AipsIO option of the underlying file.
virtual Bool | isRegular () const
| Is this a regular storage manager?
Table & | table () const
| Get the table this object is associated with.
virtual Bool | canAddColumn () const
| Does the data manager allow to add columns?
virtual Bool | canRemoveColumn () const
| Does the data manager allow to delete columns?
virtual Bool | canRenameColumn () const
| Does the data manager allow to rename columns?
virtual void | setMaximumCacheSize (uInt nMiB)
| Set the maximum cache size (in bytes) to be used by a storage manager.
virtual void | showCacheStatistics (std::ostream &) const
| Show the data manager's IO statistics.
DataManagerColumn * | createScalarColumn (const String &columnName, int dataType, const String &dataTypeId)
| Create a column in the data manager on behalf of a table column.
DataManagerColumn * | createDirArrColumn (const String &columnName, int dataType, const String &dataTypeId)
| Create a direct array column.
DataManagerColumn * | createIndArrColumn (const String &columnName, int dataType, const String &dataTypeId)
| Create an indirect array column.
DataManager * | getClone () const
| Has the object already been cloned?
void | setClone (DataManager *clone) const
| Set the pointer to the clone.
Public Member Functions inherited from casacore::VirtualArrayColumn< Float >
| VirtualArrayColumn ()
| Create a column.
virtual | ~VirtualArrayColumn ()
VirtualArrayColumn< Float > & | operator= (const VirtualArrayColumn< Float > &)=delete
| The object cannot be assigned to.
virtual int | dataType () const
| Return the data type of the column.
virtual String | dataTypeId () const
| Return the data type Id of the column.
Public Member Functions inherited from casacore::VirtualArrayColumnBase
| VirtualArrayColumnBase ()
| Create a column.
virtual | ~VirtualArrayColumnBase ()
Public Member Functions inherited from casacore::DataManagerColumn
| DataManagerColumn ()
| Create a column.
virtual | ~DataManagerColumn ()
| Frees up the storage.
| DataManagerColumn (const DataManagerColumn &)=delete
| The copy constructor cannot be used for this base class.
DataManagerColumn & | operator= (const DataManagerColumn &)=delete
| Assignment cannot be used for this base class.
void | setIsFixedShape (Bool isFixedShape)
| Set the isFixedShape flag.
Bool | isFixedShape () const
| Is this a fixed shape column?
virtual void | setMaxLength (uInt maxLength)
| Set the maximum length of the value (can be used for strings).
void | setFixedShapeColumn (const IPosition &shape)
| Set the shape of all (fixed-shaped) arrays in the column.
virtual void | setShapeTiled (rownr_t rownr, const IPosition &shape, const IPosition &tileShape)
| Set the shape and tile shape of an (variable-shaped) array in the given row.
virtual IPosition | tileShape (rownr_t rownr)
| Get the tile shape of the item in the given row.
ColumnCache & | columnCache ()
| Get access to the ColumnCache object.
const ColumnCache * | columnCachePtr () const
void | get (rownr_t rownr, Bool *dataPtr)
| Get the scalar value in the given row.
void | get (rownr_t rownr, uChar *dataPtr)
void | get (rownr_t rownr, Short *dataPtr)
void | get (rownr_t rownr, uShort *dataPtr)
void | get (rownr_t rownr, Int *dataPtr)
void | get (rownr_t rownr, uInt *dataPtr)
void | get (rownr_t rownr, Int64 *dataPtr)
void | get (rownr_t rownr, float *dataPtr)
void | get (rownr_t rownr, double *dataPtr)
void | get (rownr_t rownr, Complex *dataPtr)
void | get (rownr_t rownr, DComplex *dataPtr)
void | get (rownr_t rownr, String *dataPtr)
void | get (rownr_t rownr, void *dataPtr)
| This function is the get for all non-standard data types.
void | put (rownr_t rownr, const Bool *dataPtr)
| Put the scalar value into the given row.
void | put (rownr_t rownr, const uChar *dataPtr)
void | put (rownr_t rownr, const Short *dataPtr)
void | put (rownr_t rownr, const uShort *dataPtr)
void | put (rownr_t rownr, const Int *dataPtr)
void | put (rownr_t rownr, const uInt *dataPtr)
void | put (rownr_t rownr, const Int64 *dataPtr)
void | put (rownr_t rownr, const float *dataPtr)
void | put (rownr_t rownr, const double *dataPtr)
void | put (rownr_t rownr, const Complex *dataPtr)
void | put (rownr_t rownr, const DComplex *dataPtr)
void | put (rownr_t rownr, const String *dataPtr)
void | put (rownr_t rownr, const void *dataPtr)
| This function is the put for all non-standard data types.
void | throwGet () const
| Throw an "invalid operation" exception for the default implementation of get.
void | throwPut () const
| Throw an "invalid operation" exception for the default implementation of put.
void | setColumnName (const String &colName)
| Set the column name.
const String & | columnName () const
| Get rhe column name.

## Static Public Member Functions

static String | className ()
| Return the name of the class.
static void | registerClass ()
| Register the class name and the static makeObject "constructor".
static DataManager * | makeObject (const String &dataManagerType, const Record &spec)
| Define the "constructor" to construct this engine when a table is read back.
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.
static DataManagerCtor | getCtor (const String &dataManagerType)
| Get the "constructor" of a data manager (thread-safe).
static Bool | isRegistered (const String &dataManagerType)
| Test if a data manager is registered (thread-safe).
static DataManager * | unknownDataManager (const String &dataManagerType, const Record &spec)
| Serve as default function for theirRegisterMap, which catches all unknown data manager types.

## Private Member Functions

| CompressFloat (const CompressFloat &)
| Copy constructor is only used by clone().
virtual DataManager * | clone () const
| Clone the engine object.
virtual void | create64 (rownr_t initialNrrow)
| Initialize the object for a new table.
virtual void | prepare ()
| Preparing consists of setting the writable switch and adding the initial number of rows in case of create.
virtual void | reopenRW ()
| Reopen the engine for read/write access.
virtual void | addRowInit (rownr_t startRow, rownr_t nrrow)
| Add rows to the table.
virtual void | getArray (rownr_t rownr, Array< Float > &array)
| Get an array in the given row.
virtual void | putArray (rownr_t rownr, const Array< Float > &array)
| Put an array in the given row.
virtual void | getSlice (rownr_t rownr, const Slicer &slicer, Array< Float > &array)
| Get a section of the array in the given row.
virtual void | putSlice (rownr_t rownr, const Slicer &slicer, const Array< Float > &array)
| Put into a section of the array in the given row.
virtual void | getArrayColumn (Array< Float > &array)
| Get an entire column.
virtual void | putArrayColumn (const Array< Float > &array)
| Put an entire column.
virtual void | getArrayColumnCells (const RefRows &rownrs, Array< Float > &data)
| Get some array values in the column.
virtual void | putArrayColumnCells (const RefRows &rownrs, const Array< Float > &data)
| Put some array values in the column.
virtual void | getColumnSlice (const Slicer &slicer, Array< Float > &array)
| Get a section of all arrays in the column.
virtual void | putColumnSlice (const Slicer &slicer, const Array< Float > &array)
| Put a section of all arrays in the column.
virtual void | getColumnSliceCells (const RefRows &rownrs, const Slicer &slicer, Array< Float > &data)
| Get a section of some arrays in the column.
virtual void | putColumnSliceCells (const RefRows &rownrs, const Slicer &slicer, const Array< Float > &data)
| Put into a section of some arrays in the column.
void | scaleOnGet (Float scale, Float offset, Array< Float > &array, const Array< Short > &target)
| Scale and/or offset target to array.
void | scaleOnPut (Float scale, Float offset, const Array< Float > &array, Array< Short > &target)
| Scale and/or offset array to target.
void | scaleColumnOnGet (Array< Float > &array, const Array< Short > &target)
| Scale and/or offset target to array for the entire column.
void | scaleColumnOnPut (const Array< Float > &array, Array< Short > &target)
| Scale and/or offset array to target for the entire column.
Float | getScale (rownr_t rownr)
| Get the scale value for this row.
Float | getOffset (rownr_t rownr)
| Get the offset value for this row.
void | findMinMax (Float &minVal, Float &maxVal, const Array< Float > &array) const
| Find minimum and maximum from the array data.
void | makeScaleOffset (Float &scale, Float &offset, Float minVal, Float maxVal) const
| Make scale and offset from the minimum and maximum of the array data.
void | putPart (rownr_t rownr, const Slicer &slicer, const Array< Float > &array, Float scale, Float offset)
| Put a part of an array in a row using given scale/offset values.
void | putFullPart (rownr_t rownr, const Slicer &slicer, Array< Float > &fullArray, const Array< Float > &partArray, Float minVal, Float maxVal)
| Fill the array part into the full array and put it using the given min/max values.

## Private Attributes

String | scaleName_p
String | offsetName_p
Float | scale_p
Float | offset_p
Bool | fixed_p
Bool | autoScale_p
ScalarColumn< Float > * | scaleColumn_p
ScalarColumn< Float > * | offsetColumn_p
Array< Short > | buffer_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.
Protected Member Functions inherited from casacore::BaseMappedArrayEngine< Float, Short >
| BaseMappedArrayEngine (const String &virtualColumnName, const String &storedColumnName)
| Construct an engine to convert the virtual column to the stored column.
| ~BaseMappedArrayEngine ()
| Destructor is mandatory.
BaseMappedArrayEngine & | operator= (const BaseMappedArrayEngine &)=delete
| Assignment is not needed and therefore forbidden.
void | setWritable (Bool isWritable)
| Set if the column is writable or not.
void | setNames (const String &virtualName, const String &storedName)
| Set the virtual and stored column name.
ArrayColumn< Short > & | column ()
| Give access to the stored column.
virtual DataManagerColumn * | makeIndArrColumn (const String &columnName, int dataType, const String &dataTypeId)
| Create the column object for the array column in this engine.
void | prepare1 ()
| Do the 2 stages of the prepare (define columns and adding rows).
void | prepare2 ()
virtual void | addRow64 (rownr_t nrrow)
| Rows are added to the end of the table.
virtual void | setShapeColumn (const IPosition &shape)
| Set the shape of the FixedShape arrays in the column.
virtual void | setShape (rownr_t rownr, const IPosition &shape)
| Define the shape of the array in the given row.
virtual Bool | isShapeDefined (rownr_t rownr)
| Test if the (underlying) array is defined in the given row.
virtual uInt | ndim (rownr_t rownr)
| Get the dimensionality of the (underlying) array in the given row.
virtual IPosition | shape (rownr_t rownr)
| Get the shape of the (underlying) array in the given row.
virtual Bool | canChangeShape () const
| The data manager can handle changing the shape of an existing array when the underlying stored column can do it.
TableColumn | makeTableColumn (const String &columnName)
| Make a table column object for the given column.
virtual IPosition | getStoredShape (rownr_t rownr, const IPosition &virtualShape)
| Map the virtual shape to the stored shape.
virtual Slicer | getStoredSlicer (const Slicer &virtualSlicer) const
| Map the slicer for a virtual shape to a stored shape.
virtual void | mapOnGet (Array< Float > &array, const Array< Short > &stored)
| Map StoredType array to VirtualType array.
virtual void | mapOnPut (const Array< Float > &array, Array< Short > &stored)
| Map Bool array to bit flags array.
Protected Member Functions inherited from casacore::DataManager
void | decrementNcolumn ()
| Decrement number of columns (in case a column is deleted).
void | setEndian (Bool bigEndian)
| Tell the data manager if big or little endian format is needed.
void | setTsmOption (const TSMOption &tsmOption)
| Tell the data manager which TSM option to use.
void | setMultiFile (const std::shared_ptr< MultiFileBase > &mfile)
| Tell the data manager that MultiFile can be used.
virtual Bool | hasMultiFileSupport () const
| Does the data manager support use of MultiFile?
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.
Protected Member Functions inherited from casacore::VirtualArrayColumnBase
virtual void | getScalarColumnV (ArrayBase &dataPtr)
| The scalar access functions throw an exception.
virtual void | putScalarColumnV (const ArrayBase &dataPtr)
| Put all scalar values in the column.
virtual void | getScalarColumnCellsV (const RefRows &rownrs, ArrayBase &dataPtr)
| Get some scalar values in the column.
virtual void | putScalarColumnCellsV (const RefRows &rownrs, const ArrayBase &dataPtr)
| Put some scalar values in the column.
Protected Member Functions inherited from casacore::DataManagerColumn
virtual void | getBool (rownr_t rownr, Bool *dataPtr)
| Get the scalar value in the given row.
virtual void | getuChar (rownr_t rownr, uChar *dataPtr)
virtual void | getShort (rownr_t rownr, Short *dataPtr)
virtual void | getuShort (rownr_t rownr, uShort *dataPtr)
virtual void | getInt (rownr_t rownr, Int *dataPtr)
virtual void | getuInt (rownr_t rownr, uInt *dataPtr)
virtual void | getInt64 (rownr_t rownr, Int64 *dataPtr)
virtual void | getfloat (rownr_t rownr, float *dataPtr)
virtual void | getdouble (rownr_t rownr, double *dataPtr)
virtual void | getComplex (rownr_t rownr, Complex *dataPtr)
virtual void | getDComplex (rownr_t rownr, DComplex *dataPtr)
virtual void | getString (rownr_t rownr, String *dataPtr)
virtual void | getOther (rownr_t rownr, void *dataPtr)
| This function is the get for all non-standard data types.
virtual void | putBool (rownr_t rownr, const Bool *dataPtr)
| Put the scalar value into the given row.
virtual void | putuChar (rownr_t rownr, const uChar *dataPtr)
virtual void | putShort (rownr_t rownr, const Short *dataPtr)
virtual void | putuShort (rownr_t rownr, const uShort *dataPtr)
virtual void | putInt (rownr_t rownr, const Int *dataPtr)
virtual void | putuInt (rownr_t rownr, const uInt *dataPtr)
virtual void | putInt64 (rownr_t rownr, const Int64 *dataPtr)
virtual void | putfloat (rownr_t rownr, const float *dataPtr)
virtual void | putdouble (rownr_t rownr, const double *dataPtr)
virtual void | putComplex (rownr_t rownr, const Complex *dataPtr)
virtual void | putDComplex (rownr_t rownr, const DComplex *dataPtr)
virtual void | putString (rownr_t rownr, const String *dataPtr)
virtual void | putOther (rownr_t rownr, const void *dataPtr)
| This function is the put for all non-standard data types.
void | getScalarColumnBase (ArrayBase &dataPtr)
| The default implementations of get and put functions.
void | putScalarColumnBase (const ArrayBase &dataPtr)
void | getScalarColumnCellsBase (const RefRows &rownrs, ArrayBase &dataPtr)
void | putScalarColumnCellsBase (const RefRows &rownrs, const ArrayBase &dataPtr)
void | getArrayColumnBase (ArrayBase &data)
void | putArrayColumnBase (const ArrayBase &data)
void | getArrayColumnCellsBase (const RefRows &rownrs, ArrayBase &data)
void | putArrayColumnCellsBase (const RefRows &rownrs, const ArrayBase &data)
void | getSliceBase (rownr_t rownr, const Slicer &slicer, ArrayBase &data)
void | putSliceBase (rownr_t rownr, const Slicer &slicer, const ArrayBase &data)
void | getColumnSliceBase (const Slicer &slicer, ArrayBase &data)
void | putColumnSliceBase (const Slicer &slicer, const ArrayBase &data)
void | getColumnSliceCellsBase (const RefRows &rownrs, const Slicer &slicer, ArrayBase &data)
void | putColumnSliceCellsBase (const RefRows &rownrs, const Slicer &slicer, const ArrayBase &data)

## Detailed Description

Virtual column engine to scale a table float array

### Intended use:

Public interface

### Review Status

Reviewed By:
  UNKNOWN
Date Reviewed:
  before2004/08/25
Test programs:
  tCompressFloat

### Prerequisite

- VirtualColumnEngine
- VirtualArrayColumn

### Synopsis

CompressFloat is a virtual column engine which scales an array of one type to another type to save disk storage. This resembles the classic AIPS compress method which scales the data from float to short. The scale factor and offset values can be given in two ways:

- As a fixed values which is used for all arrays in the column. These values have to be given when constructing of the engine.
- As the name of a column. In this way each array in the column has its own scale and offset value. By default it uses auto-scaling (see below). Otherwise the scale and offset value in a row must be put before the array is put and should not be changed anymore.

Auto-scaling means that the engine will determine the scale and offset value itself when an array (or a slice) is put. It does it by mapping the values in the array to the range [-32767,32767]. At each put the scale/offset values are changed as needed. Note that with auto-scaling putSlice can be somewhat slower, because the entire array might need to be rescaled.

As in FITS the scale and offset values are used as:
True_value = Stored_value * scale + offset;

An engine object should be used for one column only, because the stored column name is part of the engine. If it would be used for more than one column, they would all share the same stored column. When the engine is bound to a column, it is checked if the name of that column matches the given virtual column name.

The engine can be used for a column containing any kind of array (thus direct or indirect, fixed or variable shaped)) as long as the virtual array can be stored in the stored array. Thus a fixed shaped virtual can use a variable shaped stored, but not vice versa. A fixed shape indirect virtual can use a stored with direct arrays.

This class can also serve as an example of how to implement a virtual column engine.

### Motivation

This class allows to store data in a smaller representation. It is needed to resemble the classic AIPS compress option.

Because the engine can serve only one column, it was possible to combine the engine and the column functionality in one class.

### Example

// Create the table description and 2 columns with indirect arrays in it.
// The Int column will be stored, while the double will be
// used as virtual.
TableDesc tableDesc ("", TableDesc::Scratch);
tableDesc.addColumn (ArrayColumnDesc<Short> ("storedArray"));
tableDesc.addColumn (ArrayColumnDesc<Float> ("virtualArray"));
tableDesc.addColumn (ScalarColumnDesc<Float> ("scale"));
tableDesc.addColumn (ScalarColumnDesc<Float> ("offset"));
// Create a new table using the table description.
SetupNewTable newtab (tableDesc, "tab.data", Table::New);
// Create the array scaling engine (with auto-scale)
// and bind it to the float column.
CompressFloat scalingEngine("virtualArray", "storedArray",
"scale", "offset");
newtab.bindColumn ("virtualArray", scalingEngine);
// Create the table.
Table table (newtab);
// Store a 3-D array (with dim. 2,3,4) into each row of the column.
// The shape of each array in the column is implicitly set by the put
// function. This will also set the shape of the underlying Int array.
ArrayColumn data (table, "virtualArray");
Array<double> someArray(IPosition(4,2,3,4));
someArray = 0;
for (rownr_t i=0, i<10; i++) { // table will have 10 rows
table.addRow();
data.put (i, someArray)
}
casacore::ArrayColumnDesc
Templated class for description of table array columns.
Definition ArrColDesc.h:235
casacore::ArrayColumn
Definition ArrayColumn.h:98
casacore::Array
Definition Array.h:155
casacore::CompressFloat::CompressFloat
CompressFloat(const String &virtualColumnName, const String &storedColumnName, Float scale, Float offset=0)
Construct an engine to scale all arrays in a column with the given offset and scale factor.
casacore::DataManager::table
Table & table() const
Get the table this object is associated with.
Definition DataManager.h:323
casacore::IPosition
Definition IPosition.h:117
casacore::ScalarColumnDesc
Definition ScaColDesc.h:162
casacore::SetupNewTable
Create a new table - define shapes, data managers, etc.
Definition SetupNewTab.h:337
casacore::TableDesc
Definition TableDesc.h:189
casacore::TableDesc::Scratch
@ Scratch
Definition TableDesc.h:193
casacore::Table
Definition Table.h:157
casacore::Table::New
@ New
create table
Definition Table.h:175
casacore::rownr_t
uInt64 rownr_t
Define the type of a row number in a table.
Definition aipsxtype.h:44

Definition at line 137 of file CompressFloat.h.

## Constructor & Destructor Documentation

## CompressFloat() [1/4]

casacore::CompressFloat::CompressFloat | ( | const String & | virtualColumnName,
|  | const String & | storedColumnName,
|  | Float | scale,
|  | Float | offset = 0 )

Construct an engine to scale all arrays in a column with the given offset and scale factor.

StoredColumnName is the name of the column where the scaled data will be put and must have data type Short. The virtual column using this engine must have data type Float.

References casacore::offset().

Referenced by CompressFloat(), and operator=().

## CompressFloat() [2/4]

casacore::CompressFloat::CompressFloat | ( | const String & | virtualColumnName,
|  | const String & | storedColumnName,
|  | const String & | scaleColumnName,
|  | const String & | offsetColumnName,
|  | Bool | autoScale = True )

Construct an engine to scale the arrays in a column.

The scale and offset values are taken from a column with the given names. In that way each array has its own scale factor and offset value. An exception is thrown if these columns do not exist. VirtualColumnName is the name of the virtual column and is used to check if the engine gets bound to the correct column. StoredColumnName is the name of the column where the scaled data will be put and must have data type Short. The virtual column using this engine must have data type Float.

References casacore::True.

## CompressFloat() [3/4]

casacore::CompressFloat::CompressFloat | ( | const Record & | spec | ) |

Construct from a record specification as created by getmanagerSpec().

References casacore::Record().

## ~CompressFloat()

casacore::CompressFloat::~CompressFloat | ( |  | ) |

Destructor is mandatory.

## CompressFloat() [4/4]

casacore::CompressFloat::CompressFloat | ( | const CompressFloat & |  | ) |

private

Copy constructor is only used by clone().

(so it is made private).

References CompressFloat().

## Member Function Documentation

## addRowInit()

virtual void casacore::CompressFloat::addRowInit | ( | rownr_t | startRow,
|  | rownr_t | nrrow )

private virtual

Add rows to the table.

If auto-scaling, it initializes the scale column with 0 to indicate that no data has been processed yet.

Reimplemented from casacore::BaseMappedArrayEngine< Float, Short >.

## className()

String casacore::CompressFloat::className | ( |  | ) |

static

Return the name of the class.

This includes the names of the template arguments.

## clone()

virtual DataManager * casacore::CompressFloat::clone | ( |  | ) | const

private virtual

Clone the engine object.

Implements casacore::DataManager.

## create64()

virtual void casacore::CompressFloat::create64 | ( | rownr_t | initialNrrow | ) |

private virtual

Initialize the object for a new table.

It defines the keywords containing the engine parameters.

Reimplemented from casacore::BaseMappedArrayEngine< Float, Short >.

## dataManagerName()

virtual String casacore::CompressFloat::dataManagerName | ( |  | ) | const

virtual

Get the name given to the engine (is the virtual column name).

Reimplemented from casacore::DataManager.

## dataManagerSpec()

virtual Record casacore::CompressFloat::dataManagerSpec | ( |  | ) | const

virtual

Record a record containing data manager specifications.

Reimplemented from casacore::DataManager.

References casacore::Record().

## dataManagerType()

virtual String casacore::CompressFloat::dataManagerType | ( |  | ) | const

virtual

Return the type name of the engine (i.e.

its class name).

Implements casacore::DataManager.

Referenced by makeObject().

## findMinMax()

void casacore::CompressFloat::findMinMax | ( | Float & | minVal,
|  | Float & | maxVal,
|  | const Array< Float > & | array ) const

private

Find minimum and maximum from the array data.

NaN and infinite values are ignored. If no values are finite, minimum and maximum are set to NaN.

References casacore::array.

## getArray()

virtual void casacore::CompressFloat::getArray | ( | rownr_t | rownr,
|  | Array< Float > & | array )

private virtual

Get an array in the given row.

This will scale and offset from the underlying array.

Reimplemented from casacore::BaseMappedArrayEngine< Float, Short >.

References casacore::array.

## getArrayColumn()

virtual void casacore::CompressFloat::getArrayColumn | ( | Array< Float > & | array | ) |

private virtual

Get an entire column.

This will scale and offset from the underlying array.

Reimplemented from casacore::BaseMappedArrayEngine< Float, Short >.

References casacore::array.

## getArrayColumnCells()

virtual void casacore::CompressFloat::getArrayColumnCells | ( | const RefRows & | rownrs,
|  | Array< Float > & | data )

private virtual

Get some array values in the column.

This will scale and offset from the underlying array.

Reimplemented from casacore::BaseMappedArrayEngine< Float, Short >.

## getColumnSlice()

virtual void casacore::CompressFloat::getColumnSlice | ( | const Slicer & | slicer,
|  | Array< Float > & | array )

private virtual

Get a section of all arrays in the column.

This will scale and offset from the underlying array.

Reimplemented from casacore::BaseMappedArrayEngine< Float, Short >.

References casacore::array.

## getColumnSliceCells()

virtual void casacore::CompressFloat::getColumnSliceCells | ( | const RefRows & | rownrs,
|  | const Slicer & | slicer,
|  | Array< Float > & | data )

private virtual

Get a section of some arrays in the column.

This will scale and offset from the underlying array.

Reimplemented from casacore::BaseMappedArrayEngine< Float, Short >.

## getOffset()

Float casacore::CompressFloat::getOffset | ( | rownr_t | rownr | ) |

inline private

Get the offset value for this row.

Definition at line 361 of file CompressFloat.h.

References fixed_p, offset_p, and offsetColumn_p.

## getScale()

Float casacore::CompressFloat::getScale | ( | rownr_t | rownr | ) |

inline private

Get the scale value for this row.

Definition at line 357 of file CompressFloat.h.

References fixed_p, scale_p, and scaleColumn_p.

## getSlice()

virtual void casacore::CompressFloat::getSlice | ( | rownr_t | rownr,
|  | const Slicer & | slicer,
|  | Array< Float > & | array )

private virtual

Get a section of the array in the given row.

This will scale and offset from the underlying array.

Reimplemented from casacore::BaseMappedArrayEngine< Float, Short >.

References casacore::array.

## makeObject()

DataManager * casacore::CompressFloat::makeObject | ( | const String & | dataManagerType,
|  | const Record & | spec )

static

Define the "constructor" to construct this engine when a table is read back.

This "constructor" has to be registered by the user of the engine. If the engine is commonly used, its registration can be added to the registerAllCtor function in DataManager.cc. That function gets automatically invoked by the table system.

References dataManagerType(), and casacore::Record().

## makeScaleOffset()

void casacore::CompressFloat::makeScaleOffset | ( | Float & | scale,
|  | Float & | offset,
|  | Float | minVal,
|  | Float | maxVal ) const

private

Make scale and offset from the minimum and maximum of the array data.

If minVal is NaN, scale is set to 0.

References casacore::offset().

## operator=()

CompressFloat & casacore::CompressFloat::operator= | ( | const CompressFloat & |  | ) |

delete

Assignment is not needed and therefore forbidden.

References CompressFloat().

## prepare()

virtual void casacore::CompressFloat::prepare | ( |  | ) |

private virtual

Preparing consists of setting the writable switch and adding the initial number of rows in case of create.

Furthermore it reads the keywords containing the engine parameters.

Reimplemented from casacore::BaseMappedArrayEngine< Float, Short >.

## putArray()

virtual void casacore::CompressFloat::putArray | ( | rownr_t | rownr,
|  | const Array< Float > & | array )

private virtual

Put an array in the given row.

This will scale and offset to the underlying array.

Reimplemented from casacore::BaseMappedArrayEngine< Float, Short >.

References casacore::array.

## putArrayColumn()

virtual void casacore::CompressFloat::putArrayColumn | ( | const Array< Float > & | array | ) |

private virtual

Put an entire column.

This will scale and offset to the underlying array.

Reimplemented from casacore::BaseMappedArrayEngine< Float, Short >.

References casacore::array.

## putArrayColumnCells()

virtual void casacore::CompressFloat::putArrayColumnCells | ( | const RefRows & | rownrs,
|  | const Array< Float > & | data )

private virtual

Put some array values in the column.

This will scale and offset to the underlying array.

Reimplemented from casacore::BaseMappedArrayEngine< Float, Short >.

## putColumnSlice()

virtual void casacore::CompressFloat::putColumnSlice | ( | const Slicer & | slicer,
|  | const Array< Float > & | array )

private virtual

Put a section of all arrays in the column.

This will scale and offset to the underlying array.

Reimplemented from casacore::BaseMappedArrayEngine< Float, Short >.

References casacore::array.

## putColumnSliceCells()

virtual void casacore::CompressFloat::putColumnSliceCells | ( | const RefRows & | rownrs,
|  | const Slicer & | slicer,
|  | const Array< Float > & | data )

private virtual

Put into a section of some arrays in the column.

This will scale and offset to the underlying array.

Reimplemented from casacore::BaseMappedArrayEngine< Float, Short >.

## putFullPart()

void casacore::CompressFloat::putFullPart | ( | rownr_t | rownr,
|  | const Slicer & | slicer,
|  | Array< Float > & | fullArray,
|  | const Array< Float > & | partArray,
|  | Float | minVal,
|  | Float | maxVal )

private

Fill the array part into the full array and put it using the given min/max values.

## putPart()

void casacore::CompressFloat::putPart | ( | rownr_t | rownr,
|  | const Slicer & | slicer,
|  | const Array< Float > & | array,
|  | Float | scale,
|  | Float | offset )

private

Put a part of an array in a row using given scale/offset values.

References casacore::array, and casacore::offset().

## putSlice()

virtual void casacore::CompressFloat::putSlice | ( | rownr_t | rownr,
|  | const Slicer & | slicer,
|  | const Array< Float > & | array )

private virtual

Put into a section of the array in the given row.

This will scale and offset to the underlying array.

Reimplemented from casacore::BaseMappedArrayEngine< Float, Short >.

References casacore::array.

## registerClass()

void casacore::CompressFloat::registerClass | ( |  | ) |

static

Register the class name and the static makeObject "constructor".

This will make the engine known to the table system.

## reopenRW()

virtual void casacore::CompressFloat::reopenRW | ( |  | ) |

private virtual

Reopen the engine for read/write access.

It makes the column writable if the underlying column is writable.

Reimplemented from casacore::DataManager.

## scaleColumnOnGet()

void casacore::CompressFloat::scaleColumnOnGet | ( | Array< Float > & | array,
|  | const Array< Short > & | target )

private

Scale and/or offset target to array for the entire column.

When the scale and offset are fixed, it will do the entire array. Otherwise it iterates through the array and applies the scale and offset per row.

References casacore::array.

## scaleColumnOnPut()

void casacore::CompressFloat::scaleColumnOnPut | ( | const Array< Float > & | array,
|  | Array< Short > & | target )

private

Scale and/or offset array to target for the entire column.

When the scale and offset are fixed, it will do the entire array. Otherwise it iterates through the array and applies the scale and offset per row.

References casacore::array.

## scaleOnGet()

void casacore::CompressFloat::scaleOnGet | ( | Float | scale,
|  | Float | offset,
|  | Array< Float > & | array,
|  | const Array< Short > & | target )

private

Scale and/or offset target to array.

This is meant when reading an array from the stored column. It optimizes for scale=1 and/or offset=0.

References casacore::array, and casacore::offset().

## scaleOnPut()

void casacore::CompressFloat::scaleOnPut | ( | Float | scale,
|  | Float | offset,
|  | const Array< Float > & | array,
|  | Array< Short > & | target )

private

Scale and/or offset array to target.

This is meant when writing an array into the stored column. It optimizes for scale=1 and/or offset=0.

References casacore::array, and casacore::offset().

## Member Data Documentation

## autoScale_p

Bool casacore::CompressFloat::autoScale_p

private

Definition at line 311 of file CompressFloat.h.

## buffer_p

Array<Short> casacore::CompressFloat::buffer_p

private

Definition at line 314 of file CompressFloat.h.

## fixed_p

Bool casacore::CompressFloat::fixed_p

private

Definition at line 310 of file CompressFloat.h.

Referenced by getOffset(), and getScale().

## offset_p

Float casacore::CompressFloat::offset_p

private

Definition at line 309 of file CompressFloat.h.

Referenced by getOffset().

## offsetColumn_p

ScalarColumn<Float>* casacore::CompressFloat::offsetColumn_p

private

Definition at line 313 of file CompressFloat.h.

Referenced by getOffset().

## offsetName_p

String casacore::CompressFloat::offsetName_p

private

Definition at line 307 of file CompressFloat.h.

## scale_p

Float casacore::CompressFloat::scale_p

private

Definition at line 308 of file CompressFloat.h.

Referenced by getScale().

## scaleColumn_p

ScalarColumn<Float>* casacore::CompressFloat::scaleColumn_p

private

Definition at line 312 of file CompressFloat.h.

Referenced by getScale().

## scaleName_p

String casacore::CompressFloat::scaleName_p

private

Definition at line 306 of file CompressFloat.h.

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

- tables/DataMan/CompressFloat.h