casacore
|
Virtual column engine to scale a table Complex array for Single Dish data. More...
#include <CompressComplex.h>
Public Member Functions | |
CompressComplexSD (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. More... | |
CompressComplexSD (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. More... | |
CompressComplexSD (const Record &spec) | |
Construct from a record specification as created by getmanagerSpec(). More... | |
~CompressComplexSD () | |
Destructor is mandatory. More... | |
virtual String | dataManagerType () const |
Return the type name of the engine (i.e. More... | |
Public Member Functions inherited from casacore::CompressComplex | |
CompressComplex (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. More... | |
CompressComplex (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. More... | |
CompressComplex (const Record &spec) | |
Construct from a record specification as created by getmanagerSpec(). More... | |
~CompressComplex () | |
Destructor is mandatory. More... | |
virtual String | dataManagerName () const |
Get the name given to the engine (is the virtual column name). More... | |
virtual Record | dataManagerSpec () const |
Record a record containing data manager specifications. More... | |
Public Member Functions inherited from casacore::BaseMappedArrayEngine< Complex, Int > | |
const String & | virtualName () const |
Get the virtual column name. More... | |
const String & | storedName () const |
Get the stored column name. More... | |
virtual Bool | isWritable () const |
The column is writable if the underlying stored column is writable. More... | |
Public Member Functions inherited from casacore::VirtualColumnEngine | |
VirtualColumnEngine () | |
Create the object. More... | |
virtual | ~VirtualColumnEngine () |
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 Record | getProperties () const |
Get data manager properties that can be modified. More... | |
virtual void | setProperties (const Record &spec) |
Modify data manager properties given in record fields. More... | |
virtual Bool | canReallocateColumns () const |
Tell if the data manager wants to reallocate the data manager column objects. More... | |
virtual DataManagerColumn * | reallocateColumn (DataManagerColumn *column) |
Reallocate the column object if it is part of this data manager. 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 TSMOption & | tsmOption () const |
Get the TSM option. More... | |
MultiFileBase * | multiFile () |
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... | |
Table & | table () const |
Get the table this object is associated with. 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 | setMaximumCacheSize (uInt nMiB) |
Set the maximum cache size (in bytes) to be used by a storage manager. More... | |
virtual void | showCacheStatistics (std::ostream &) const |
Show the data manager's IO statistics. More... | |
DataManagerColumn * | createScalarColumn (const String &columnName, int dataType, const String &dataTypeId) |
Create a column in the data manager on behalf of a table column. More... | |
DataManagerColumn * | createDirArrColumn (const String &columnName, int dataType, const String &dataTypeId) |
Create a direct array column. More... | |
DataManagerColumn * | createIndArrColumn (const String &columnName, int dataType, const String &dataTypeId) |
Create an indirect array column. More... | |
DataManager * | getClone () const |
Has the object already been cloned? More... | |
void | setClone (DataManager *clone) const |
Set the pointer to the clone. More... | |
Public Member Functions inherited from casacore::VirtualArrayColumn< T > | |
VirtualArrayColumn () | |
Create a column. More... | |
virtual | ~VirtualArrayColumn () |
virtual int | dataType () const |
Return the data type of the column. More... | |
virtual String | dataTypeId () const |
Return the data type Id of the column. More... | |
Public Member Functions inherited from casacore::VirtualArrayColumnBase | |
VirtualArrayColumnBase () | |
Create a column. More... | |
virtual | ~VirtualArrayColumnBase () |
Public Member Functions inherited from casacore::DataManagerColumn | |
DataManagerColumn () | |
Create a column. More... | |
virtual | ~DataManagerColumn () |
Frees up the storage. More... | |
void | setIsFixedShape (Bool isFixedShape) |
Set the isFixedShape flag. More... | |
Bool | isFixedShape () const |
Is this a fixed shape column? More... | |
virtual void | setMaxLength (uInt maxLength) |
Set the maximum length of the value (can be used for strings). More... | |
void | setFixedShapeColumn (const IPosition &shape) |
Set the shape of all (fixed-shaped) arrays in the column. More... | |
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. More... | |
virtual IPosition | tileShape (rownr_t rownr) |
Get the tile shape of the item in the given row. More... | |
ColumnCache & | columnCache () |
Get access to the ColumnCache object. More... | |
const ColumnCache * | columnCachePtr () const |
void | get (rownr_t rownr, Bool *dataPtr) |
Get the scalar value in the given row. More... | |
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. More... | |
void | put (rownr_t rownr, const Bool *dataPtr) |
Put the scalar value into the given row. More... | |
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. More... | |
void | throwGet () const |
Throw an "invalid operation" exception for the default implementation of get. More... | |
void | throwPut () const |
Throw an "invalid operation" exception for the default implementation of put. More... | |
void | setColumnName (const String &colName) |
Set the column name. More... | |
const String & | columnName () const |
Get rhe column name. More... | |
Static Public Member Functions | |
static String | className () |
Return the name of the class. More... | |
static void | registerClass () |
Register the class name and the static makeObject "constructor". More... | |
static DataManager * | makeObject (const String &dataManagerType, const Record &spec) |
Define the "constructor" to construct this engine when a table is read back. More... | |
Static Public Member Functions inherited from casacore::CompressComplex | |
static String | className () |
Return the name of the class. More... | |
static void | registerClass () |
Register the class name and the static makeObject "constructor". More... | |
static DataManager * | makeObject (const String &dataManagerType, const Record &spec) |
Define the "constructor" to construct this engine when a table is read back. More... | |
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 DataManager * | unknownDataManager (const String &dataManagerType, const Record &spec) |
Serve as default function for theirRegisterMap, which catches all unknown data manager types. More... | |
Private Member Functions | |
CompressComplexSD (const CompressComplexSD &) | |
Copy constructor is only used by clone(). More... | |
CompressComplexSD & | operator= (const CompressComplexSD &) |
Assignment is not needed and therefore forbidden (so it is made private and not implemented). More... | |
virtual DataManager * | clone () const |
Clone the engine object. More... | |
virtual void | create64 (rownr_t initialNrrow) |
Initialize the object for a new table. More... | |
virtual void | scaleOnGet (Float scale, Float offset, Array< Complex > &array, const Array< Int > &target) |
Scale and/or offset target to array. More... | |
virtual void | scaleOnPut (Float scale, Float offset, const Array< Complex > &array, Array< Int > &target) |
Scale and/or offset array to target. More... | |
virtual void | findMinMax (Float &minVal, Float &maxVal, const Array< Complex > &array) const |
Find minimum and maximum from the array data. More... | |
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::CompressComplex | |
CompressComplex (const CompressComplex &) | |
Copy constructor is only used by clone() and derived class. More... | |
Float | getScale (rownr_t rownr) |
Get the scale value for this row. More... | |
Float | getOffset (rownr_t rownr) |
Get the offset value for this row. More... | |
void | makeScaleOffset (Float &scale, Float &offset, Float minVal, Float maxVal) const |
Make scale and offset from the minimum and maximum of the array data. More... | |
void | putPart (rownr_t rownr, const Slicer &slicer, const Array< Complex > &array, Float scale, Float offset) |
Put a part of an array in a row using given scale/offset values. More... | |
void | putFullPart (rownr_t rownr, const Slicer &slicer, Array< Complex > &fullArray, const Array< Complex > &partArray, Float minVal, Float maxVal) |
Fill the array part into the full array and put it using the given min/max values. More... | |
Protected Member Functions inherited from casacore::BaseMappedArrayEngine< Complex, Int > | |
BaseMappedArrayEngine (const String &virtualColumnName, const String &storedColumnName) | |
Construct an engine to convert the virtual column to the stored column. More... | |
BaseMappedArrayEngine () | |
The default constructor is required for reconstruction of the engine when a table is read back. More... | |
BaseMappedArrayEngine (const BaseMappedArrayEngine< Complex, Int > &) | |
Copy constructor is only used by copy constructor of derived classes. More... | |
~BaseMappedArrayEngine () | |
Destructor is mandatory. More... | |
void | setWritable (Bool isWritable) |
Set if the column is writable or not. More... | |
void | setNames (const String &virtualName, const String &storedName) |
Set the virtual and stored column name. More... | |
ArrayColumn< Int > & | column () |
Give access to the stored column. More... | |
virtual DataManagerColumn * | makeIndArrColumn (const String &columnName, int dataType, const String &dataTypeId) |
Create the column object for the array column in this engine. More... | |
void | prepare1 () |
Do the 2 stages of the prepare (define columns and adding rows). More... | |
void | prepare2 () |
virtual void | addRow64 (rownr_t nrrow) |
Rows are added to the end of the table. More... | |
virtual void | setShapeColumn (const IPosition &shape) |
Set the shape of the FixedShape arrays in the column. More... | |
virtual void | setShape (rownr_t rownr, const IPosition &shape) |
Define the shape of the array in the given row. More... | |
virtual Bool | isShapeDefined (rownr_t rownr) |
Test if the (underlying) array is defined in the given row. More... | |
virtual uInt | ndim (rownr_t rownr) |
Get the dimensionality of the (underlying) array in the given row. More... | |
virtual IPosition | shape (rownr_t rownr) |
Get the shape of the (underlying) array in the given row. More... | |
virtual Bool | canChangeShape () const |
The data manager can handle changing the shape of an existing array when the underlying stored column can do it. More... | |
TableColumn | makeTableColumn (const String &columnName) |
Make a table column object for the given column. More... | |
void | getColumnSlice (const Slicer &slicer, Array< Complex > &array) |
Get a section of all arrays in the column. More... | |
void | putColumnSlice (const Slicer &slicer, const Array< Complex > &array) |
Put a section of all arrays in the column. More... | |
virtual IPosition | getStoredShape (rownr_t rownr, const IPosition &virtualShape) |
Map the virtual shape to the stored shape. More... | |
virtual Slicer | getStoredSlicer (const Slicer &virtualSlicer) const |
Map the slicer for a virtual shape to a stored shape. More... | |
virtual void | mapOnGet (Array< Complex > &array, const Array< Int > &stored) |
Map StoredType array to VirtualType array. More... | |
virtual void | mapOnPut (const Array< Complex > &array, Array< Int > &stored) |
Map Bool array to bit flags array. 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... | |
virtual Bool | hasMultiFileSupport () const |
Does the data manager support use of MultiFile? A derived class has to return True if it can use the MultiFile. 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 Member Functions inherited from casacore::VirtualArrayColumn< T > | |
virtual void | getArray (rownr_t rownr, Array< T > &data)=0 |
Get the array value in the given row. More... | |
virtual void | putArray (rownr_t rownr, const Array< T > &data) |
Put the array value into the given row. More... | |
virtual void | getSlice (rownr_t rownr, const Slicer &slicer, Array< T > &data) |
Get a section of the array in the given row. More... | |
virtual void | putSlice (rownr_t rownr, const Slicer &slicer, const Array< T > &data) |
Put into a section of the array in the given row. More... | |
virtual void | getArrayColumn (Array< T > &data) |
Get an entire column. More... | |
virtual void | putArrayColumn (const Array< T > &data) |
Put an entire column. More... | |
virtual void | getArrayColumnCells (const RefRows &rownrs, Array< T > &data) |
Get some array values in the column. More... | |
virtual void | putArrayColumnCells (const RefRows &rownrs, const Array< T > &data) |
Put some array values in the column. More... | |
virtual void | getColumnSlice (const Slicer &slicer, Array< T > &data) |
Get a section of all arrays in the column. More... | |
virtual void | putColumnSlice (const Slicer &slicer, const Array< T > &data) |
Put a section of all arrays in the column. More... | |
virtual void | getColumnSliceCells (const RefRows &rownrs, const Slicer &slicer, Array< T > &data) |
Get a section of some arrays in the column. More... | |
virtual void | putColumnSliceCells (const RefRows &rownrs, const Slicer &slicer, const Array< T > &data) |
Put into a section of some arrays in the column. More... | |
Protected Member Functions inherited from casacore::VirtualArrayColumnBase | |
virtual void | getScalarColumnV (ArrayBase &dataPtr) |
The scalar access functions throw an exception. More... | |
virtual void | putScalarColumnV (const ArrayBase &dataPtr) |
Put all scalar values in the column. More... | |
virtual void | getScalarColumnCellsV (const RefRows &rownrs, ArrayBase &dataPtr) |
Get some scalar values in the column. More... | |
virtual void | putScalarColumnCellsV (const RefRows &rownrs, const ArrayBase &dataPtr) |
Put some scalar values in the column. More... | |
Protected Member Functions inherited from casacore::DataManagerColumn | |
virtual void | getBool (rownr_t rownr, Bool *dataPtr) |
Get the scalar value in the given row. More... | |
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. More... | |
virtual void | putBool (rownr_t rownr, const Bool *dataPtr) |
Put the scalar value into the given row. More... | |
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. More... | |
void | getScalarColumnBase (ArrayBase &dataPtr) |
The default implementations of get and put functions. More... | |
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) |
Protected Attributes inherited from casacore::CompressComplex | |
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< Int > | buffer_p |
Virtual column engine to scale a table Complex array for Single Dish data.
Public interface
CompressComplexSD is similar to CompressComplex, but compresses in a slighty different way optimized for single dish data. Usually the imaginary part of single dish data is 0, so the scaling is optimized for it.
If the imaginary part is 0, the real part is scaled with 15 bits extra to get a higher precision. The least significant bit is set to 0 indicating the imag==0.
If the imaginary part is not 0, the real part is scaled normally. The imaginary part is scaled with 1 bit less. The least significant bit is set to 1 indicating that imag!=0.
This class is created on top of CompressComplex to cope with SD data in a better way. Using CompressComplex often makes the imag part non-zero if it is scaled as 0.
Definition at line 435 of file CompressComplex.h.
casacore::CompressComplexSD::CompressComplexSD | ( | 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 Int. The virtual column using this engine must have data type Complex.
casacore::CompressComplexSD::CompressComplexSD | ( | 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 Int. The virtual column using this engine must have data type Complex.
casacore::CompressComplexSD::CompressComplexSD | ( | const Record & | spec | ) |
Construct from a record specification as created by getmanagerSpec().
casacore::CompressComplexSD::~CompressComplexSD | ( | ) |
Destructor is mandatory.
|
private |
Copy constructor is only used by clone().
(so it is made private).
|
static |
Return the name of the class.
This includes the names of the template arguments.
|
privatevirtual |
Clone the engine object.
Reimplemented from casacore::CompressComplex.
|
privatevirtual |
Initialize the object for a new table.
It defines the keywords containing the engine parameters.
Reimplemented from casacore::CompressComplex.
|
virtual |
Return the type name of the engine (i.e.
its class name).
Reimplemented from casacore::CompressComplex.
|
privatevirtual |
Find minimum and maximum from the array data.
NaN and infinite values and zero imaginary parts are ignored. If no values are finite, minimum and maximum are set to NaN.
Reimplemented from casacore::CompressComplex.
|
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.
|
private |
Assignment is not needed and therefore forbidden (so it is made private and not implemented).
|
static |
Register the class name and the static makeObject "constructor".
This will make the engine known to the table system.
|
privatevirtual |
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.
Reimplemented from casacore::CompressComplex.
|
privatevirtual |
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.
Reimplemented from casacore::CompressComplex.