A column for storing compressed complex values with an approximate Gaussian distribution. More...

#include <dyscodatacolumn.h>

Classes
struct	ThreadData

Public Member Functions
	DyscoDataColumn (DyscoStMan *parent, int dtype)
	Create a new column. More...

	DyscoDataColumn (const DyscoDataColumn &source)=delete

void	operator= (const DyscoDataColumn &source)=delete

virtual	~DyscoDataColumn ()
	Destructor. More...

virtual void	Prepare (DyscoDistribution distribution, Normalization normalization, double studentsTNu, double distributionTruncation) override

void	SetStaticRandomizationSeed ()

Public Member Functions inherited from dyscostman::ThreadedDyscoColumn< std::complex< float > >
	ThreadedDyscoColumn (DyscoStMan *parent, int dtype)
	Create a new column. More...

	ThreadedDyscoColumn (const ThreadedDyscoColumn &source)=delete

void	operator= (const ThreadedDyscoColumn &source)=delete

virtual	~ThreadedDyscoColumn ()
	Destructor. More...

virtual void	setShapeColumn (const casacore::IPosition &shape) override
	Set the dimensions of values in this column. More...

virtual casacore::IPosition	shape (casacore::rownr_t) override
	Get the dimensions of the values in a particular row. More...

virtual void	getArrayV (casacore::rownr_t rowNr, casacore::ArrayBase &dataPtr) override
	Read the values for a particular row. More...

void	getArrayV (casacore::rownr_t rowNr, casacore::ArrayBase &dataPtr)

void	getArrayV (casacore::rownr_t rowNr, casacore::ArrayBase &dataPtr)

virtual void	putArrayV (casacore::rownr_t rowNr, const casacore::ArrayBase &dataPtr) override
	Write values into a particular row. More...

void	putArrayV (casacore::rownr_t rowNr, const casacore::ArrayBase &dataPtr)

void	putArrayV (casacore::rownr_t rowNr, const casacore::ArrayBase &dataPtr)

virtual void	InitializeAfterNRowsPerBlockIsKnown () override
	Prepare this column for reading/writing. More...

void	SetBitsPerSymbol (unsigned bitsPerSymbol)
	Set the bits per symbol. More...

virtual size_t	CalculateBlockSize (size_t nRowsInBlock, size_t nAntennae) const final override

virtual size_t	ExtraHeaderSize () const override
	Get number of bytes needed for column header of this column. More...

virtual void	SerializeExtraHeader (std::ostream &stream) const final override

virtual void	UnserializeExtraHeader (std::istream &stream) final override

Public Member Functions inherited from dyscostman::DyscoStManColumn
	DyscoStManColumn (DyscoStMan *parent, int dtype)
	Constructor, to be overloaded by subclass. More...

virtual	~DyscoStManColumn ()
	Destructor. More...

virtual casacore::Bool	isWritable () const override
	Whether this column is writable. More...

size_t	OffsetInBlock () const

void	SetOffsetInBlock (size_t offsetInBlock)

Public Member Functions inherited from casacore::StManColumnBase
	StManColumnBase (int dataType)
	Default constructor. More...

	~StManColumnBase ()

virtual int	dataType () const
	Return the data type of the column. More...

DataType	dtype () const

Int	elemSize () const
	Return the size of an element of the column's data type. More...

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 String	dataTypeId () const
	Get the data type id of the column for dataType==TpOther. 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	setShape (rownr_t rownr, const IPosition &shape)
	Set the shape of an (variable-shaped) array in the given row. 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 Bool	isShapeDefined (rownr_t rownr)
	Is the value shape defined in the given row? By default it returns True. More...

virtual uInt	ndim (rownr_t rownr)
	Get the dimensionality of the item in the given row. More...

virtual IPosition	shape (rownr_t rownr)
	Get the shape of the item in the given row. More...

virtual IPosition	tileShape (rownr_t rownr)
	Get the tile shape of the item in the given row. More...

virtual Bool	canChangeShape () const
	Can the data manager handle chaging the shape of an existing array? Default is no. 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...

virtual void	getScalarColumnV (ArrayBase &dataPtr)
	Get all scalar values in the column. 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...

virtual void	getArrayV (rownr_t rownr, ArrayBase &dataPtr)
	Get the array value in the given row. More...

virtual void	putArrayV (rownr_t rownr, const ArrayBase &data)
	Put the array value into the given row. More...

virtual void	getArrayColumnV (ArrayBase &data)
	Get all array values in the column. More...

virtual void	putArrayColumnV (const ArrayBase &data)
	Put all array values in the column. More...

virtual void	getArrayColumnCellsV (const RefRows &rownrs, ArrayBase &data)
	Get some array values in the column. More...

virtual void	putArrayColumnCellsV (const RefRows &rownrs, const ArrayBase &data)
	Put some array values in the column. More...

virtual void	getSliceV (rownr_t rownr, const Slicer &slicer, ArrayBase &data)
	Get a section of the array in the given row. More...

virtual void	putSliceV (rownr_t rownr, const Slicer &slicer, const ArrayBase &data)
	Put into a section of the array in the given row. More...

virtual void	getColumnSliceV (const Slicer &slicer, ArrayBase &data)
	Get a section of all arrays in the column. More...

virtual void	putColumnSliceV (const Slicer &slicer, const ArrayBase &data)
	Put into a section of all arrays in the column. More...

virtual void	getColumnSliceCellsV (const RefRows &rownrs, const Slicer &slicer, ArrayBase &data)
	Get a section of some arrays in the column. More...

virtual void	putColumnSliceCellsV (const RefRows &rownrs, const Slicer &slicer, const ArrayBase &data)
	Put into a section of some arrays in the column. 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...

Protected Member Functions
virtual void	initializeDecode (TimeBlockBuffer< data_t > buffer, const float metaBuffer, size_t nRow, size_t nAntennae) override

virtual void	decode (TimeBlockBuffer< data_t > buffer, const symbol_t data, size_t blockRow, size_t a1, size_t a2) override

virtual std::unique_ptr< ThreadDataBase >	initializeEncodeThread () override

virtual void	encode (ThreadDataBase threadData, TimeBlockBuffer< data_t > buffer, float metaBuffer, symbol_t symbolBuffer, size_t nAntennae) override

virtual size_t	metaDataFloatCount (size_t nRow, size_t nPolarizations, size_t nChannels, size_t nAntennae) const override

virtual size_t	symbolCount (size_t nRowsInBlock, size_t nPolarizations, size_t nChannels) const override

virtual size_t	defaultThreadCount () const override

Protected Member Functions inherited from dyscostman::ThreadedDyscoColumn< std::complex< float > >
const casacore::IPosition &	shape () const

virtual void	shutdown () override final
	To be called before destructing the class. More...

size_t	getBitsPerSymbol () const

Protected Member Functions inherited from dyscostman::DyscoStManColumn
DyscoStMan &	storageManager () const
	Get the storage manager for this column. More...

void	readCompressedData (size_t blockIndex, unsigned char *dest, size_t size)
	Read a row of compressed data from the stman file. More...

void	writeCompressedData (size_t blockIndex, const unsigned char *data, size_t size)
	Write a row of compressed data to the stman file. More...

uint64_t	nBlocksInFile () const
	Get the actual number of blocks in the file. More...

size_t	getBlockIndex (uint64_t row) const

size_t	getRowWithinBlock (uint64_t row) const

size_t	nRowsInBlock () const

size_t	nAntennae () const

uint64_t	getRowIndex (size_t block) const

bool	areOffsetsInitialized () const

void	initializeRowsPerBlock (size_t rowsPerBlock, size_t antennaCount)

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)

Private Attributes
std::mt19937	_rnd

std::unique_ptr< StochasticEncoder< float > >	_gausEncoder

std::unique_ptr< TimeBlockEncoder >	_decoder

DyscoDistribution	_distribution

Normalization	_normalization

double	_studentsTNu

bool	_randomize

Additional Inherited Members
Public Types inherited from dyscostman::ThreadedDyscoColumn< std::complex< float > >
typedef std::complex< float >	data_t

Static Public Member Functions inherited from casacore::StManColumnBase
static Bool	isNativeDataType (int dtype)
	Test if the given data type is supported by storage managers. More...

Protected Types inherited from dyscostman::ThreadedDyscoColumn< std::complex< float > >
typedef TimeBlockBuffer< data_t >::symbol_t	symbol_t

Detailed Description

A column for storing compressed complex values with an approximate Gaussian distribution.

Author: André Offringa

Definition at line 18 of file dyscodatacolumn.h.

Constructor & Destructor Documentation

◆ DyscoDataColumn() [1/2]

dyscostman::DyscoDataColumn::DyscoDataColumn	(	DyscoStMan *	parent,
		int	dtype
	)

inline

Create a new column.

Internally called by DyscoStMan when creating a new column.

Definition at line 24 of file dyscodatacolumn.h.

References dyscostman::kRF.

◆ DyscoDataColumn() [2/2]

dyscostman::DyscoDataColumn::DyscoDataColumn ( const DyscoDataColumn & source )

delete

◆ ~DyscoDataColumn()

virtual dyscostman::DyscoDataColumn::~DyscoDataColumn ( )

inlinevirtual

Destructor.

Definition at line 37 of file dyscodatacolumn.h.

References dyscostman::ThreadedDyscoColumn< std::complex< float > >::shutdown().

Member Function Documentation

◆ decode()

virtual void dyscostman::DyscoDataColumn::decode	(	TimeBlockBuffer< data_t > *	buffer,
		const symbol_t *	data,
		size_t	blockRow,
		size_t	a1,
		size_t	a2
	)

overrideprotectedvirtual

Implements dyscostman::ThreadedDyscoColumn< std::complex< float > >.

◆ defaultThreadCount()

virtual size_t dyscostman::DyscoDataColumn::defaultThreadCount ( ) const

overrideprotectedvirtual

Reimplemented from dyscostman::ThreadedDyscoColumn< std::complex< float > >.

◆ encode()

virtual void dyscostman::DyscoDataColumn::encode	(	ThreadDataBase *	threadData,
		TimeBlockBuffer< data_t > *	buffer,
		float *	metaBuffer,
		symbol_t *	symbolBuffer,
		size_t	nAntennae
	)

overrideprotectedvirtual

Implements dyscostman::ThreadedDyscoColumn< std::complex< float > >.

◆ initializeDecode()

virtual void dyscostman::DyscoDataColumn::initializeDecode	(	TimeBlockBuffer< data_t > *	buffer,
		const float *	metaBuffer,
		size_t	nRow,
		size_t	nAntennae
	)

overrideprotectedvirtual

Implements dyscostman::ThreadedDyscoColumn< std::complex< float > >.

◆ initializeEncodeThread()

virtual std::unique_ptr<ThreadDataBase> dyscostman::DyscoDataColumn::initializeEncodeThread ( )

overrideprotectedvirtual

Implements dyscostman::ThreadedDyscoColumn< std::complex< float > >.

◆ metaDataFloatCount()

virtual size_t dyscostman::DyscoDataColumn::metaDataFloatCount	(	size_t	nRow,
		size_t	nPolarizations,
		size_t	nChannels,
		size_t	nAntennae
	)		const

overrideprotectedvirtual

Implements dyscostman::ThreadedDyscoColumn< std::complex< float > >.

◆ operator=()

void dyscostman::DyscoDataColumn::operator= ( const DyscoDataColumn & source )

delete

◆ Prepare()

virtual void dyscostman::DyscoDataColumn::Prepare	(	DyscoDistribution	distribution,
		Normalization	normalization,
		double	studentsTNu,
		double	distributionTruncation
	)

overridevirtual

Reimplemented from dyscostman::ThreadedDyscoColumn< std::complex< float > >.

◆ SetStaticRandomizationSeed()

void dyscostman::DyscoDataColumn::SetStaticRandomizationSeed ( )

inline

Definition at line 43 of file dyscodatacolumn.h.

References _randomize, and _rnd.

◆ symbolCount()

virtual size_t dyscostman::DyscoDataColumn::symbolCount	(	size_t	nRowsInBlock,
		size_t	nPolarizations,
		size_t	nChannels
	)		const

overrideprotectedvirtual

Implements dyscostman::ThreadedDyscoColumn< std::complex< float > >.

Member Data Documentation

◆ _decoder

std::unique_ptr<TimeBlockEncoder> dyscostman::DyscoDataColumn::_decoder

private

Definition at line 83 of file dyscodatacolumn.h.

◆ _distribution

DyscoDistribution dyscostman::DyscoDataColumn::_distribution

private

Definition at line 84 of file dyscodatacolumn.h.

◆ _gausEncoder

std::unique_ptr<StochasticEncoder<float> > dyscostman::DyscoDataColumn::_gausEncoder

private

Definition at line 82 of file dyscodatacolumn.h.

◆ _normalization

Normalization dyscostman::DyscoDataColumn::_normalization

private

Definition at line 85 of file dyscodatacolumn.h.

◆ _randomize

bool dyscostman::DyscoDataColumn::_randomize

private

Definition at line 87 of file dyscodatacolumn.h.

Referenced by SetStaticRandomizationSeed().

◆ _rnd

std::mt19937 dyscostman::DyscoDataColumn::_rnd

private

Definition at line 81 of file dyscodatacolumn.h.

Referenced by SetStaticRandomizationSeed().

◆ _studentsTNu

double dyscostman::DyscoDataColumn::_studentsTNu

private

Definition at line 86 of file dyscodatacolumn.h.

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

tables/Dysco/dyscodatacolumn.h

Classes

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DyscoDataColumn() [1/2]

◆ DyscoDataColumn() [2/2]

◆ ~DyscoDataColumn()

Member Function Documentation

◆ decode()

◆ defaultThreadCount()

◆ encode()

◆ initializeDecode()

◆ initializeEncodeThread()

◆ metaDataFloatCount()

◆ operator=()

◆ Prepare()

◆ SetStaticRandomizationSeed()

◆ symbolCount()

Member Data Documentation

◆ _decoder

◆ _distribution

◆ _gausEncoder

◆ _normalization

◆ _randomize

◆ _rnd

◆ _studentsTNu